GET api/FeedBeaconBid?sessionId={sessionId}&feedAdGroupId={feedAdGroupId}&beaconId={beaconId}&offset={offset}&limit={limit}&includeClosed={includeClosed}

Gets all feed beacon bids for feed ad group matching beacon id

Request Information

URI Parameters

NameDescriptionTypeAdditional information
sessionId

string

Required

feedAdGroupId

integer

Required

beaconId

integer

Required

offset

integer

Default value is 0

limit

integer

Default value is 0

includeClosed

boolean

Default value is False

Body Parameters

None.

Response Information

Resource Description

Collection of APIFeedBeaconBid
NameDescriptionTypeAdditional information
Id

Unique identifier

integer

None.

FeedAdGroupId

Unique identifier of feed ad group to which this belongs

integer

None.

State

Status: Active, Closed or Suspended

string

None.

BeaconId

Unique identifier of beacon to which this relates

integer

None.

CreationTimestamp

Timestamp when this was created

string

None.

ManuallyHalted

Denotes that this has been manually paused

boolean

None.

DefaultImpressionPrice

Default impression price

decimal number

None.

DefaultClickPrice

Default click price

decimal number

None.

URLSuffix

Suffix appended to click through URL

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "id": 1,
    "feedAdGroupId": 2,
    "state": "sample string 3",
    "beaconId": 1,
    "creationTimestamp": "sample string 4",
    "manuallyHalted": true,
    "defaultImpressionPrice": 1.1,
    "defaultClickPrice": 1.1,
    "urlSuffix": "sample string 5"
  },
  {
    "id": 1,
    "feedAdGroupId": 2,
    "state": "sample string 3",
    "beaconId": 1,
    "creationTimestamp": "sample string 4",
    "manuallyHalted": true,
    "defaultImpressionPrice": 1.1,
    "defaultClickPrice": 1.1,
    "urlSuffix": "sample string 5"
  }
]

application/xml, text/xml

Sample:
<ArrayOfAPIFeedBeaconBid xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Rochester.Models">
  <APIFeedBeaconBid>
    <BeaconId>1</BeaconId>
    <CreationTimestamp>sample string 4</CreationTimestamp>
    <DefaultClickPrice>1.1</DefaultClickPrice>
    <DefaultImpressionPrice>1.1</DefaultImpressionPrice>
    <FeedAdGroupId>2</FeedAdGroupId>
    <Id>1</Id>
    <ManuallyHalted>true</ManuallyHalted>
    <State>sample string 3</State>
    <URLSuffix>sample string 5</URLSuffix>
  </APIFeedBeaconBid>
  <APIFeedBeaconBid>
    <BeaconId>1</BeaconId>
    <CreationTimestamp>sample string 4</CreationTimestamp>
    <DefaultClickPrice>1.1</DefaultClickPrice>
    <DefaultImpressionPrice>1.1</DefaultImpressionPrice>
    <FeedAdGroupId>2</FeedAdGroupId>
    <Id>1</Id>
    <ManuallyHalted>true</ManuallyHalted>
    <State>sample string 3</State>
    <URLSuffix>sample string 5</URLSuffix>
  </APIFeedBeaconBid>
</ArrayOfAPIFeedBeaconBid>