GET api/Campaign?sessionId={sessionId}&advertiserId={advertiserId}&statistics={statistics}&orderBy={orderBy}&order={order}&offset={offset}&limit={limit}&includeClosed={includeClosed}

Reads all campaigns for advertiser

Request Information

URI Parameters

NameDescriptionTypeAdditional information
sessionId

string

Required

advertiserId

integer

Required

statistics

string

Default value is none

orderBy

string

None.

order

string

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 APICampaign
NameDescriptionTypeAdditional information
Id

Unique identifier

integer

None.

AdvertiserId

Unique identifier of advertiser to which this belongs

integer

None.

State

Status: Active, Closed or Suspended

string

None.

NewReviewingRequired

Denotes that campaign is new and requires reviewing

boolean

None.

ModifiedReviewingRequired

Denotes that campaign has been modified and requires reviewing

boolean

None.

Description

Textual description of campaign

string

None.

MatchBasis

Basis used for matching keyword bids: Exact, Phrase or Broad

string

None.

MatchBasisRestriction

Restriction on basis used for matching keyword bids: Exact, Phrase or None

string

None.

Ranking

Ranking level for campaign: Inherit, Highest, Higher, High, Normal, Low, Lower or Lowest

string

None.

RedirectorId

Unique identifier of redirector to use or zero to use default

integer

None.

CreationTimestamp

Timestamp when this was created

string

None.

StartTimestamp

Timestamp from whence this becomes active

string

None.

ReminderTimestamp

Timestamp when account manager should be reminded

string

None.

ReminderTimestampNotified

Denotes that account manager has been reminded

boolean

None.

EndTimestamp

Timestamp until which this remains active

string

None.

EndTimestampNotified

Denotes that advertiser has been notified that the end timestamp has been reached

boolean

None.

BudgetLimit

Budget limit

decimal number

None.

InsertionOrderEndTimestamp

Timestamp until which the current insertion remains active

string

None.

AssignedBudgetLimit

Assigned budget limit

decimal number

None.

SpendToday

Spend today

decimal number

None.

SpendThisMonth

Spend this month

decimal number

None.

SpendToDate

Spend to date

decimal number

None.

AvailableFunds

Funds available

decimal number

None.

RenewalThreshold

Renewal threshold

decimal number

None.

RenewalAction

Renewal action: NoAction or EmailNotification

string

None.

RenewalAccountManagerNotificationRequired

Denotes that account manager should be notified when renewal threshold is reached

boolean

None.

RenewalReached

Denotes that campaign has reached renewal threshold

boolean

None.

RenewalNotified

Denotes that advertiser has been notified of having reached renewal threshold

boolean

None.

LimitNotificationRequired

Denotes that advertiser should be notified when the limit of available funds is reached

boolean

None.

LimitReached

Denotes that campaign has reached the limit of available funds

boolean

None.

LimitNotified

Denotes that advertiser has been notified of having reached the limit of available funds

boolean

None.

PostImpressionFrequencyDuration

Frequency capping duration applied after an impression

integer

None.

PostImpressionFrequencyCap

Frequency capping limit applied after an impression

integer

None.

PostImpressionInterval

Frequency capping interval applied after an impression

integer

None.

PostClickFrequencyDuration

Frequency capping duration applied after a click

integer

None.

PostClickFrequencyCap

Frequency capping limit applied after a click

integer

None.

PostClickInterval

Frequency capping interval applied after a click

integer

None.

ManuallyHalted

Denotes that this has been manually paused by the advertiser

boolean

None.

CopySelection

Denotes whether advert selection should use all copies or favour the best performing copy: Best or Even

string

None.

MinimumImpressionPrice

Minimum impression price for adverts

decimal number

None.

MinimumClickPrice

Minimum click price for adverts

decimal number

None.

ImpressionPrice

Default impression price

decimal number

None.

ClickPrice

Default click price

decimal number

None.

DisablePacing

Denotes that pacing should not be used

boolean

None.

DailyExpenditureLimit

Maximum spend amount per day

decimal number

None.

DailyExpenditureDisableRollover

Denotes that any unspent funds should not be carried forward

boolean

None.

DailyExpenditureEnableRollunder

Denotes that any overspend should be carried forward

boolean

None.

DailyImpressionLimit

Maximum number of impressions per day

integer

None.

DailyImpressionDisableRollover

Denotes that any unused impressions should not be carried forward

boolean

None.

DailyImpressionEnableRollunder

Denotes that any excess impressions should be carried forward

boolean

None.

DailyClickLimit

Maximum number of clicks per day

integer

None.

DailyClickDisableRollover

Denotes that any unused clicks should not be carried forward

boolean

None.

DailyClickEnableRollunder

Denotes that any excess clicks should be carried forward

boolean

None.

MonthlyExpenditureLimit

Maximum spend per month

decimal number

None.

MonthlyImpressionLimit

Maximum number of impressions per month

integer

None.

MonthlyClickLimit

Maximum number of click per month

integer

None.

FirstSecondOfDay

First second of day from whence this becomes active

integer

None.

LastSecondOfDay

Last second of day until which this remains active

integer

None.

FirstDayOfWeek

First day of week from whence this becomes active

integer

None.

LastDayOfWeek

Last day of week until which this remains active

integer

None.

FirstDayOfMonth

First day of month from whence this becomes active

integer

None.

LastDayOfMonth

Last day of month until which this remains active

integer

None.

FirstSecondOfDay2

First second of day from whence this becomes active

integer

None.

LastSecondOfDay2

Last second of day until which this remains active

integer

None.

FirstDayOfWeek2

First day of week from whence this becomes active

integer

None.

LastDayOfWeek2

Last day of week until which this remains active

integer

None.

FirstDayOfMonth2

First day of month from whence this becomes active

integer

None.

LastDayOfMonth2

Last day of month until which this remains active

integer

None.

LastActiveTimestamp

Timestamp when this was last active

string

None.

NielsenSectorId

Unique identifier of Nielsen Sector to which this belongs

integer

None.

NielsenCategoryId

Unique identifier of Nielsen Category to which this belongs

integer

None.

NielsenProductId

Unique identifier of Nielsen Product to which this belongs

integer

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,
    "advertiserId": 2,
    "state": "sample string 3",
    "newReviewingRequired": true,
    "modifiedReviewingRequired": true,
    "description": "sample string 4",
    "matchBasis": "sample string 5",
    "matchBasisRestriction": "sample string 6",
    "ranking": "sample string 7",
    "redirectorId": 1,
    "creationTimestamp": "sample string 8",
    "startTimestamp": "sample string 9",
    "reminderTimestamp": "sample string 10",
    "reminderTimestampNotified": true,
    "endTimestamp": "sample string 11",
    "endTimestampNotified": true,
    "budgetLimit": 1.1,
    "insertionOrderEndTimestamp": "sample string 12",
    "assignedBudgetLimit": 1.1,
    "spendToday": 1.1,
    "spendThisMonth": 1.1,
    "spendToDate": 1.1,
    "availableFunds": 1.1,
    "renewalThreshold": 1.1,
    "renewalAction": "sample string 13",
    "renewalAccountManagerNotificationRequired": true,
    "renewalReached": true,
    "renewalNotified": true,
    "limitNotificationRequired": true,
    "limitReached": true,
    "limitNotified": true,
    "postImpressionFrequencyDuration": 1,
    "postImpressionFrequencyCap": 1,
    "postImpressionInterval": 1,
    "postClickFrequencyDuration": 1,
    "postClickFrequencyCap": 1,
    "postClickInterval": 1,
    "manuallyHalted": true,
    "copySelection": "sample string 14",
    "minimumImpressionPrice": 1.1,
    "minimumClickPrice": 1.1,
    "impressionPrice": 1.1,
    "clickPrice": 1.1,
    "disablePacing": true,
    "dailyExpenditureLimit": 1.1,
    "dailyExpenditureDisableRollover": true,
    "dailyExpenditureEnableRollunder": true,
    "dailyImpressionLimit": 1,
    "dailyImpressionDisableRollover": true,
    "dailyImpressionEnableRollunder": true,
    "dailyClickLimit": 1,
    "dailyClickDisableRollover": true,
    "dailyClickEnableRollunder": true,
    "monthlyExpenditureLimit": 1.1,
    "monthlyImpressionLimit": 1,
    "monthlyClickLimit": 1,
    "firstSecondOfDay": 1,
    "lastSecondOfDay": 1,
    "firstDayOfWeek": 1,
    "lastDayOfWeek": 1,
    "firstDayOfMonth": 1,
    "lastDayOfMonth": 1,
    "firstSecondOfDay2": 1,
    "lastSecondOfDay2": 1,
    "firstDayOfWeek2": 1,
    "lastDayOfWeek2": 1,
    "firstDayOfMonth2": 1,
    "lastDayOfMonth2": 1,
    "lastActiveTimestamp": "sample string 15",
    "nielsenSectorId": 1,
    "nielsenCategoryId": 1,
    "nielsenProductId": 1,
    "impressionCount": 1,
    "clickCount": 1,
    "spent": 1.1
  },
  {
    "id": 1,
    "advertiserId": 2,
    "state": "sample string 3",
    "newReviewingRequired": true,
    "modifiedReviewingRequired": true,
    "description": "sample string 4",
    "matchBasis": "sample string 5",
    "matchBasisRestriction": "sample string 6",
    "ranking": "sample string 7",
    "redirectorId": 1,
    "creationTimestamp": "sample string 8",
    "startTimestamp": "sample string 9",
    "reminderTimestamp": "sample string 10",
    "reminderTimestampNotified": true,
    "endTimestamp": "sample string 11",
    "endTimestampNotified": true,
    "budgetLimit": 1.1,
    "insertionOrderEndTimestamp": "sample string 12",
    "assignedBudgetLimit": 1.1,
    "spendToday": 1.1,
    "spendThisMonth": 1.1,
    "spendToDate": 1.1,
    "availableFunds": 1.1,
    "renewalThreshold": 1.1,
    "renewalAction": "sample string 13",
    "renewalAccountManagerNotificationRequired": true,
    "renewalReached": true,
    "renewalNotified": true,
    "limitNotificationRequired": true,
    "limitReached": true,
    "limitNotified": true,
    "postImpressionFrequencyDuration": 1,
    "postImpressionFrequencyCap": 1,
    "postImpressionInterval": 1,
    "postClickFrequencyDuration": 1,
    "postClickFrequencyCap": 1,
    "postClickInterval": 1,
    "manuallyHalted": true,
    "copySelection": "sample string 14",
    "minimumImpressionPrice": 1.1,
    "minimumClickPrice": 1.1,
    "impressionPrice": 1.1,
    "clickPrice": 1.1,
    "disablePacing": true,
    "dailyExpenditureLimit": 1.1,
    "dailyExpenditureDisableRollover": true,
    "dailyExpenditureEnableRollunder": true,
    "dailyImpressionLimit": 1,
    "dailyImpressionDisableRollover": true,
    "dailyImpressionEnableRollunder": true,
    "dailyClickLimit": 1,
    "dailyClickDisableRollover": true,
    "dailyClickEnableRollunder": true,
    "monthlyExpenditureLimit": 1.1,
    "monthlyImpressionLimit": 1,
    "monthlyClickLimit": 1,
    "firstSecondOfDay": 1,
    "lastSecondOfDay": 1,
    "firstDayOfWeek": 1,
    "lastDayOfWeek": 1,
    "firstDayOfMonth": 1,
    "lastDayOfMonth": 1,
    "firstSecondOfDay2": 1,
    "lastSecondOfDay2": 1,
    "firstDayOfWeek2": 1,
    "lastDayOfWeek2": 1,
    "firstDayOfMonth2": 1,
    "lastDayOfMonth2": 1,
    "lastActiveTimestamp": "sample string 15",
    "nielsenSectorId": 1,
    "nielsenCategoryId": 1,
    "nielsenProductId": 1,
    "impressionCount": 1,
    "clickCount": 1,
    "spent": 1.1
  }
]

application/xml, text/xml

Sample:
<ArrayOfAPICampaign xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Rochester.Models">
  <APICampaign>
    <AdvertiserId>2</AdvertiserId>
    <AssignedBudgetLimit>1.1</AssignedBudgetLimit>
    <AvailableFunds>1.1</AvailableFunds>
    <BudgetLimit>1.1</BudgetLimit>
    <ClickCount>1</ClickCount>
    <ClickPrice>1.1</ClickPrice>
    <CopySelection>sample string 14</CopySelection>
    <CreationTimestamp>sample string 8</CreationTimestamp>
    <DailyClickDisableRollover>true</DailyClickDisableRollover>
    <DailyClickEnableRollunder>true</DailyClickEnableRollunder>
    <DailyClickLimit>1</DailyClickLimit>
    <DailyExpenditureDisableRollover>true</DailyExpenditureDisableRollover>
    <DailyExpenditureEnableRollunder>true</DailyExpenditureEnableRollunder>
    <DailyExpenditureLimit>1.1</DailyExpenditureLimit>
    <DailyImpressionDisableRollover>true</DailyImpressionDisableRollover>
    <DailyImpressionEnableRollunder>true</DailyImpressionEnableRollunder>
    <DailyImpressionLimit>1</DailyImpressionLimit>
    <Description>sample string 4</Description>
    <DisablePacing>true</DisablePacing>
    <EndTimestamp>sample string 11</EndTimestamp>
    <EndTimestampNotified>true</EndTimestampNotified>
    <FirstDayOfMonth>1</FirstDayOfMonth>
    <FirstDayOfMonth2>1</FirstDayOfMonth2>
    <FirstDayOfWeek>1</FirstDayOfWeek>
    <FirstDayOfWeek2>1</FirstDayOfWeek2>
    <FirstSecondOfDay>1</FirstSecondOfDay>
    <FirstSecondOfDay2>1</FirstSecondOfDay2>
    <Id>1</Id>
    <ImpressionCount>1</ImpressionCount>
    <ImpressionPrice>1.1</ImpressionPrice>
    <InsertionOrderEndTimestamp>sample string 12</InsertionOrderEndTimestamp>
    <LastActiveTimestamp>sample string 15</LastActiveTimestamp>
    <LastDayOfMonth>1</LastDayOfMonth>
    <LastDayOfMonth2>1</LastDayOfMonth2>
    <LastDayOfWeek>1</LastDayOfWeek>
    <LastDayOfWeek2>1</LastDayOfWeek2>
    <LastSecondOfDay>1</LastSecondOfDay>
    <LastSecondOfDay2>1</LastSecondOfDay2>
    <LimitNotificationRequired>true</LimitNotificationRequired>
    <LimitNotified>true</LimitNotified>
    <LimitReached>true</LimitReached>
    <ManuallyHalted>true</ManuallyHalted>
    <MatchBasis>sample string 5</MatchBasis>
    <MatchBasisRestriction>sample string 6</MatchBasisRestriction>
    <MinimumClickPrice>1.1</MinimumClickPrice>
    <MinimumImpressionPrice>1.1</MinimumImpressionPrice>
    <ModifiedReviewingRequired>true</ModifiedReviewingRequired>
    <MonthlyClickLimit>1</MonthlyClickLimit>
    <MonthlyExpenditureLimit>1.1</MonthlyExpenditureLimit>
    <MonthlyImpressionLimit>1</MonthlyImpressionLimit>
    <NewReviewingRequired>true</NewReviewingRequired>
    <NielsenCategoryId>1</NielsenCategoryId>
    <NielsenProductId>1</NielsenProductId>
    <NielsenSectorId>1</NielsenSectorId>
    <PostClickFrequencyCap>1</PostClickFrequencyCap>
    <PostClickFrequencyDuration>1</PostClickFrequencyDuration>
    <PostClickInterval>1</PostClickInterval>
    <PostImpressionFrequencyCap>1</PostImpressionFrequencyCap>
    <PostImpressionFrequencyDuration>1</PostImpressionFrequencyDuration>
    <PostImpressionInterval>1</PostImpressionInterval>
    <Ranking>sample string 7</Ranking>
    <RedirectorId>1</RedirectorId>
    <ReminderTimestamp>sample string 10</ReminderTimestamp>
    <ReminderTimestampNotified>true</ReminderTimestampNotified>
    <RenewalAccountManagerNotificationRequired>true</RenewalAccountManagerNotificationRequired>
    <RenewalAction>sample string 13</RenewalAction>
    <RenewalNotified>true</RenewalNotified>
    <RenewalReached>true</RenewalReached>
    <RenewalThreshold>1.1</RenewalThreshold>
    <SpendThisMonth>1.1</SpendThisMonth>
    <SpendToDate>1.1</SpendToDate>
    <SpendToday>1.1</SpendToday>
    <Spent>1.1</Spent>
    <StartTimestamp>sample string 9</StartTimestamp>
    <State>sample string 3</State>
  </APICampaign>
  <APICampaign>
    <AdvertiserId>2</AdvertiserId>
    <AssignedBudgetLimit>1.1</AssignedBudgetLimit>
    <AvailableFunds>1.1</AvailableFunds>
    <BudgetLimit>1.1</BudgetLimit>
    <ClickCount>1</ClickCount>
    <ClickPrice>1.1</ClickPrice>
    <CopySelection>sample string 14</CopySelection>
    <CreationTimestamp>sample string 8</CreationTimestamp>
    <DailyClickDisableRollover>true</DailyClickDisableRollover>
    <DailyClickEnableRollunder>true</DailyClickEnableRollunder>
    <DailyClickLimit>1</DailyClickLimit>
    <DailyExpenditureDisableRollover>true</DailyExpenditureDisableRollover>
    <DailyExpenditureEnableRollunder>true</DailyExpenditureEnableRollunder>
    <DailyExpenditureLimit>1.1</DailyExpenditureLimit>
    <DailyImpressionDisableRollover>true</DailyImpressionDisableRollover>
    <DailyImpressionEnableRollunder>true</DailyImpressionEnableRollunder>
    <DailyImpressionLimit>1</DailyImpressionLimit>
    <Description>sample string 4</Description>
    <DisablePacing>true</DisablePacing>
    <EndTimestamp>sample string 11</EndTimestamp>
    <EndTimestampNotified>true</EndTimestampNotified>
    <FirstDayOfMonth>1</FirstDayOfMonth>
    <FirstDayOfMonth2>1</FirstDayOfMonth2>
    <FirstDayOfWeek>1</FirstDayOfWeek>
    <FirstDayOfWeek2>1</FirstDayOfWeek2>
    <FirstSecondOfDay>1</FirstSecondOfDay>
    <FirstSecondOfDay2>1</FirstSecondOfDay2>
    <Id>1</Id>
    <ImpressionCount>1</ImpressionCount>
    <ImpressionPrice>1.1</ImpressionPrice>
    <InsertionOrderEndTimestamp>sample string 12</InsertionOrderEndTimestamp>
    <LastActiveTimestamp>sample string 15</LastActiveTimestamp>
    <LastDayOfMonth>1</LastDayOfMonth>
    <LastDayOfMonth2>1</LastDayOfMonth2>
    <LastDayOfWeek>1</LastDayOfWeek>
    <LastDayOfWeek2>1</LastDayOfWeek2>
    <LastSecondOfDay>1</LastSecondOfDay>
    <LastSecondOfDay2>1</LastSecondOfDay2>
    <LimitNotificationRequired>true</LimitNotificationRequired>
    <LimitNotified>true</LimitNotified>
    <LimitReached>true</LimitReached>
    <ManuallyHalted>true</ManuallyHalted>
    <MatchBasis>sample string 5</MatchBasis>
    <MatchBasisRestriction>sample string 6</MatchBasisRestriction>
    <MinimumClickPrice>1.1</MinimumClickPrice>
    <MinimumImpressionPrice>1.1</MinimumImpressionPrice>
    <ModifiedReviewingRequired>true</ModifiedReviewingRequired>
    <MonthlyClickLimit>1</MonthlyClickLimit>
    <MonthlyExpenditureLimit>1.1</MonthlyExpenditureLimit>
    <MonthlyImpressionLimit>1</MonthlyImpressionLimit>
    <NewReviewingRequired>true</NewReviewingRequired>
    <NielsenCategoryId>1</NielsenCategoryId>
    <NielsenProductId>1</NielsenProductId>
    <NielsenSectorId>1</NielsenSectorId>
    <PostClickFrequencyCap>1</PostClickFrequencyCap>
    <PostClickFrequencyDuration>1</PostClickFrequencyDuration>
    <PostClickInterval>1</PostClickInterval>
    <PostImpressionFrequencyCap>1</PostImpressionFrequencyCap>
    <PostImpressionFrequencyDuration>1</PostImpressionFrequencyDuration>
    <PostImpressionInterval>1</PostImpressionInterval>
    <Ranking>sample string 7</Ranking>
    <RedirectorId>1</RedirectorId>
    <ReminderTimestamp>sample string 10</ReminderTimestamp>
    <ReminderTimestampNotified>true</ReminderTimestampNotified>
    <RenewalAccountManagerNotificationRequired>true</RenewalAccountManagerNotificationRequired>
    <RenewalAction>sample string 13</RenewalAction>
    <RenewalNotified>true</RenewalNotified>
    <RenewalReached>true</RenewalReached>
    <RenewalThreshold>1.1</RenewalThreshold>
    <SpendThisMonth>1.1</SpendThisMonth>
    <SpendToDate>1.1</SpendToDate>
    <SpendToday>1.1</SpendToday>
    <Spent>1.1</Spent>
    <StartTimestamp>sample string 9</StartTimestamp>
    <State>sample string 3</State>
  </APICampaign>
</ArrayOfAPICampaign>