GET api/BeaconBid?systemName={systemName}&username={username}&password={password}&campaignId={campaignId}&statistics={statistics}&offset={offset}&limit={limit}&includeClosed={includeClosed}

Gets all beacon bids for campaign

Request Information

URI Parameters

Name	Type	Additional information
systemName	string	Required
username	string	Required
password	string	Required
campaignId	integer	Required
statistics	string	Default value is none
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 APIBeaconBid

Name	Description	Type	Additional information
Id	Unique identifier	integer	None.
AdGroupId	Unique identifier of ad group to which this belongs	integer	None.
State	Status: Active, Closed or Suspended	string	None.
NewReviewingRequired	Denotes that bid is new and requires reviewing	boolean	None.
ModifiedReviewingRequired	Denotes that bid has been modified and requires reviewing	boolean	None.
BeaconId	Unique identifier of beacon to which this relates	integer	None.
Ranking	Ranking level for bid: Inherit, Highest, Higher, High, Normal, Low, Lower or Lowest	string	None.
CreationTimestamp	Timestamp when this was created	string	None.
ManuallyHalted	Denotes that this has been manually halted	boolean	None.
ImpressionPrice	Override impression price	decimal number	None.
ClickPrice	Override click price	decimal number	None.
URLSuffix	Suffix appended to click through URL	string	None.
ImpressionCount	Statistics impression count	integer	None.
ClickCount	Statistics click count	integer	None.
Spent	Statistics spent	decimal number	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "id": 1,
    "adGroupId": 2,
    "state": "sample string 3",
    "newReviewingRequired": true,
    "modifiedReviewingRequired": true,
    "beaconId": 1,
    "ranking": "sample string 4",
    "creationTimestamp": "sample string 5",
    "manuallyHalted": true,
    "impressionPrice": 1.1,
    "clickPrice": 1.1,
    "urlSuffix": "sample string 6",
    "impressionCount": 1,
    "clickCount": 1,
    "spent": 1.1
  },
  {
    "id": 1,
    "adGroupId": 2,
    "state": "sample string 3",
    "newReviewingRequired": true,
    "modifiedReviewingRequired": true,
    "beaconId": 1,
    "ranking": "sample string 4",
    "creationTimestamp": "sample string 5",
    "manuallyHalted": true,
    "impressionPrice": 1.1,
    "clickPrice": 1.1,
    "urlSuffix": "sample string 6",
    "impressionCount": 1,
    "clickCount": 1,
    "spent": 1.1
  }
]

application/xml, text/xml

Sample:

<ArrayOfAPIBeaconBid xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Rochester.Models">
  <APIBeaconBid>
    <AdGroupId>2</AdGroupId>
    <BeaconId>1</BeaconId>
    <ClickCount>1</ClickCount>
    <ClickPrice>1.1</ClickPrice>
    <CreationTimestamp>sample string 5</CreationTimestamp>
    <Id>1</Id>
    <ImpressionCount>1</ImpressionCount>
    <ImpressionPrice>1.1</ImpressionPrice>
    <ManuallyHalted>true</ManuallyHalted>
    <ModifiedReviewingRequired>true</ModifiedReviewingRequired>
    <NewReviewingRequired>true</NewReviewingRequired>
    <Ranking>sample string 4</Ranking>
    <Spent>1.1</Spent>
    <State>sample string 3</State>
    <URLSuffix>sample string 6</URLSuffix>
  </APIBeaconBid>
  <APIBeaconBid>
    <AdGroupId>2</AdGroupId>
    <BeaconId>1</BeaconId>
    <ClickCount>1</ClickCount>
    <ClickPrice>1.1</ClickPrice>
    <CreationTimestamp>sample string 5</CreationTimestamp>
    <Id>1</Id>
    <ImpressionCount>1</ImpressionCount>
    <ImpressionPrice>1.1</ImpressionPrice>
    <ManuallyHalted>true</ManuallyHalted>
    <ModifiedReviewingRequired>true</ModifiedReviewingRequired>
    <NewReviewingRequired>true</NewReviewingRequired>
    <Ranking>sample string 4</Ranking>
    <Spent>1.1</Spent>
    <State>sample string 3</State>
    <URLSuffix>sample string 6</URLSuffix>
  </APIBeaconBid>
</ArrayOfAPIBeaconBid>