GET api/Advertiser/{id}?sessionId={sessionId}&statistics={statistics}

Reads a specific advertiser

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

integer

Required

sessionId

string

Required

statistics

string

Default value is none

Body Parameters

None.

Response Information

Resource Description

APIAdvertiser
NameDescriptionTypeAdditional information
Id

Unique identifier

integer

None.

State

Status: Active, Closed or Suspended

string

None.

NewReviewingRequired

Denotes that advertiser is new and requires reviewing

boolean

None.

ModifiedReviewingRequired

Denotes that advertiser has been modified and requires reviewing

boolean

None.

AccountNumber

Automatically allocated numberical reference number

integer

None.

AccountName

Name of account

string

None.

CustomerReferenceNumber

Client allocated customer reference number

string

None.

SalesReferenceNumber

Client allocated sales reference number

string

None.

FirstName

First name of default contact

string

None.

Surname

Surname of default contact

string

None.

EmailAddress

Email address of default contact

string

None.

Company

Company name

string

None.

Address1

First line of address

string

None.

Address2

Second line of address

string

None.

Address3

Third line of address

string

None.

Address4

Fourth line of address

string

None.

County

County of address

string

None.

Postcode

Postcode of address

string

None.

Country

Country of address

string

None.

Telephone

Telephone number

string

None.

CompanyRegistrationNumber

Company registration number

string

None.

VATRegistrationNumber

VAT registration number

string

None.

VATExemptionReferenceNumber

VAT exemption reference number

string

None.

VATId

Unique identifier of VAT rate to which this relates

integer

None.

LanguageName

Advertiser's language name

string

None.

TimezoneId

Unique identifier of timezone to which this relates

integer

None.

Currency

Advertiser's currency: GBP, USD, EUR, INR or TRY

string

None.

PaymentTermsId

Unique identifier of payment terms to which this relates

integer

None.

RedirectorId

Unique identifier of redirector to use or zero to use default

integer

None.

CreationTimestamp

Timestamp when this was created

string

None.

WelcomeEmailRequired

Denotes that welcome email should be sent

boolean

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.

AgencyDiscountPercentage

Discount percentage to be applied to prices

decimal number

None.

ProviderDiscountPercentage

Discount percentage to be applied to prices

decimal number

None.

AccountType

Type of account: Credit, Budget or Prepayment

string

None.

AutomaticDeductionEnabled

Denotes that automatic credit card deductions are allowed

boolean

None.

AutomaticDeductionSuspended

Denotes that automatic credit card deductions have been suspended

boolean

None.

PaymentFailure

Denotes that credit card deduction failed

boolean

None.

PaymentFailureReason

Reason that credit card deduction failed

string

None.

PaymentFailureNotified

Denotes that advertiser has been notified of credit card deduction failure

boolean

None.

PaymentsToDate

Payments to date

decimal number

None.

CreditLimit

Credit limit

decimal number

None.

BudgetLimit

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

Available funds

decimal number

None.

CancelResidualIOBalance

Denotes that future insertion order should cancel any existing insertion orders

boolean

None.

RenewalThreshold

Renewal threshold

decimal number

None.

RenewalAction

Renewal action: NoAction, EmailNotification or AutomaticDeductions

string

None.

RenewalFirstName

First name of renewal notification recipient

string

None.

RenewalSurname

Surname of renewal notification recipient

string

None.

RenewalEmailAddress

Email address of renewal notification recipient

string

None.

RenewalAccountManagerNotificationRequired

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

boolean

None.

RenewalReached

Denotes that advertiser 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 advertiser 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.

MinimumImpressionPrice

Minimum impression price for adverts

decimal number

None.

MinimumClickPrice

Minimum click price for adverts

decimal number

None.

SingleListingRestriction

Denotes that only one advert from all campaigns may be returned in any single search

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.

DailyExpenditureLimit

Maximum spend amount per day

decimal number

None.

DailyExpenditureDisableRollover

Denotes that any unspent funds from daily limits should not be carried forward

boolean

None.

DailyExpenditureEnableRollunder

Denotes that any overspend from daily limits should be carried forward

boolean

None.

DailyImpressionLimit

Maximum number of impressions per day

integer

None.

DailyImpressionDisableRollover

Denotes that any unused impressions from daily limit should not be carried forward

boolean

None.

DailyImpressionEnableRollunder

Denotes that any excess impressions from daily limits should be carried forward

boolean

None.

DailyClickLimit

Maximum number of clicks per day

integer

None.

DailyClickDisableRollover

Denotes that any unused clicks from daily limit should not be carried forward

boolean

None.

DailyClickEnableRollunder

Denotes that any excess clicks from daily limits should be carried forward

boolean

None.

MonthlyExpenditureLimit

Maximum spend amount per month

decimal number

None.

MonthlyImpressionLimit

Maximum number of impressions per month

integer

None.

MonthlyClickLimit

Maximum number of clicks per month

integer

None.

PostalInvoicesRequired

Denotes that postal invoices should be sent

boolean

None.

BillingFirstName

First name of billing contact

string

None.

BillingSurname

Surname of billing contact

string

None.

BillingEmailAddress

Email address of billing contact

string

None.

BillingCompany

Billing company name

string

None.

BillingAddress1

First line of billing address

string

None.

BillingAddress2

Second line of billing address

string

None.

BillingAddress3

Third line of billing address

string

None.

BillingAddress4

Fourth line of billing address

string

None.

BillingCounty

County of billing address

string

None.

BillingPostcode

Postcode of billing address

string

None.

BillingCountry

Country of billing address

string

None.

BillingTelephone

Billing telephone number

string

None.

AccountManagerFirstName

First name of account manager

string

None.

AccountManagerSurname

Surname of account manager

string

None.

AccountManagerEmailAddress

Email address of account manager

string

None.

LastActiveTimestamp

Timestamp when this was last active

string

None.

DisableBidArchiving

Denotes that long term inactive bids should not be archived

boolean

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,
  "state": "sample string 2",
  "newReviewingRequired": true,
  "modifiedReviewingRequired": true,
  "accountNumber": 1,
  "accountName": "sample string 3",
  "customerReferenceNumber": "sample string 4",
  "salesReferenceNumber": "sample string 5",
  "firstName": "sample string 6",
  "surname": "sample string 7",
  "emailAddress": "sample string 8",
  "company": "sample string 9",
  "address1": "sample string 10",
  "address2": "sample string 11",
  "address3": "sample string 12",
  "address4": "sample string 13",
  "county": "sample string 14",
  "postcode": "sample string 15",
  "country": "sample string 16",
  "telephone": "sample string 17",
  "companyRegistrationNumber": "sample string 18",
  "vatRegistrationNumber": "sample string 19",
  "vatExemptionReferenceNumber": "sample string 20",
  "vatId": 1,
  "languageName": "sample string 21",
  "timezoneId": 1,
  "currency": "sample string 22",
  "paymentTermsId": 1,
  "redirectorId": 1,
  "creationTimestamp": "sample string 23",
  "welcomeEmailRequired": true,
  "startTimestamp": "sample string 24",
  "reminderTimestamp": "sample string 25",
  "reminderTimestampNotified": true,
  "endTimestamp": "sample string 26",
  "endTimestampNotified": true,
  "agencyDiscountPercentage": 1.1,
  "providerDiscountPercentage": 1.1,
  "accountType": "sample string 27",
  "automaticDeductionEnabled": true,
  "automaticDeductionSuspended": true,
  "paymentFailure": true,
  "paymentFailureReason": "sample string 28",
  "paymentFailureNotified": true,
  "paymentsToDate": 1.1,
  "creditLimit": 1.1,
  "budgetLimit": 1.1,
  "spendToday": 1.1,
  "spendThisMonth": 1.1,
  "spendToDate": 1.1,
  "availableFunds": 1.1,
  "cancelResidualIOBalance": true,
  "renewalThreshold": 1.1,
  "renewalAction": "sample string 29",
  "renewalFirstName": "sample string 30",
  "renewalSurname": "sample string 31",
  "renewalEmailAddress": "sample string 32",
  "renewalAccountManagerNotificationRequired": true,
  "renewalReached": true,
  "renewalNotified": true,
  "limitNotificationRequired": true,
  "limitReached": true,
  "limitNotified": true,
  "minimumImpressionPrice": 1.1,
  "minimumClickPrice": 1.1,
  "singleListingRestriction": true,
  "postImpressionFrequencyDuration": 1,
  "postImpressionFrequencyCap": 1,
  "postImpressionInterval": 1,
  "postClickFrequencyDuration": 1,
  "postClickFrequencyCap": 1,
  "postClickInterval": 1,
  "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,
  "postalInvoicesRequired": true,
  "billingFirstName": "sample string 33",
  "billingSurname": "sample string 34",
  "billingEmailAddress": "sample string 35",
  "billingCompany": "sample string 36",
  "billingAddress1": "sample string 37",
  "billingAddress2": "sample string 38",
  "billingAddress3": "sample string 39",
  "billingAddress4": "sample string 40",
  "billingCounty": "sample string 41",
  "billingPostcode": "sample string 42",
  "billingCountry": "sample string 43",
  "billingTelephone": "sample string 44",
  "accountManagerFirstName": "sample string 45",
  "accountManagerSurname": "sample string 46",
  "accountManagerEmailAddress": "sample string 47",
  "lastActiveTimestamp": "sample string 48",
  "disableBidArchiving": true,
  "impressionCount": 1,
  "clickCount": 1,
  "spent": 1.1
}

application/xml, text/xml

Sample:
<APIAdvertiser xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Rochester.Models">
  <AccountManagerEmailAddress>sample string 47</AccountManagerEmailAddress>
  <AccountManagerFirstName>sample string 45</AccountManagerFirstName>
  <AccountManagerSurname>sample string 46</AccountManagerSurname>
  <AccountName>sample string 3</AccountName>
  <AccountNumber>1</AccountNumber>
  <AccountType>sample string 27</AccountType>
  <Address1>sample string 10</Address1>
  <Address2>sample string 11</Address2>
  <Address3>sample string 12</Address3>
  <Address4>sample string 13</Address4>
  <AgencyDiscountPercentage>1.1</AgencyDiscountPercentage>
  <AutomaticDeductionEnabled>true</AutomaticDeductionEnabled>
  <AutomaticDeductionSuspended>true</AutomaticDeductionSuspended>
  <AvailableFunds>1.1</AvailableFunds>
  <BillingAddress1>sample string 37</BillingAddress1>
  <BillingAddress2>sample string 38</BillingAddress2>
  <BillingAddress3>sample string 39</BillingAddress3>
  <BillingAddress4>sample string 40</BillingAddress4>
  <BillingCompany>sample string 36</BillingCompany>
  <BillingCountry>sample string 43</BillingCountry>
  <BillingCounty>sample string 41</BillingCounty>
  <BillingEmailAddress>sample string 35</BillingEmailAddress>
  <BillingFirstName>sample string 33</BillingFirstName>
  <BillingPostcode>sample string 42</BillingPostcode>
  <BillingSurname>sample string 34</BillingSurname>
  <BillingTelephone>sample string 44</BillingTelephone>
  <BudgetLimit>1.1</BudgetLimit>
  <CancelResidualIOBalance>true</CancelResidualIOBalance>
  <ClickCount>1</ClickCount>
  <Company>sample string 9</Company>
  <CompanyRegistrationNumber>sample string 18</CompanyRegistrationNumber>
  <Country>sample string 16</Country>
  <County>sample string 14</County>
  <CreationTimestamp>sample string 23</CreationTimestamp>
  <CreditLimit>1.1</CreditLimit>
  <Currency>sample string 22</Currency>
  <CustomerReferenceNumber>sample string 4</CustomerReferenceNumber>
  <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>
  <DisableBidArchiving>true</DisableBidArchiving>
  <EmailAddress>sample string 8</EmailAddress>
  <EndTimestamp>sample string 26</EndTimestamp>
  <EndTimestampNotified>true</EndTimestampNotified>
  <FirstName>sample string 6</FirstName>
  <Id>1</Id>
  <ImpressionCount>1</ImpressionCount>
  <LanguageName>sample string 21</LanguageName>
  <LastActiveTimestamp>sample string 48</LastActiveTimestamp>
  <LimitNotificationRequired>true</LimitNotificationRequired>
  <LimitNotified>true</LimitNotified>
  <LimitReached>true</LimitReached>
  <MinimumClickPrice>1.1</MinimumClickPrice>
  <MinimumImpressionPrice>1.1</MinimumImpressionPrice>
  <ModifiedReviewingRequired>true</ModifiedReviewingRequired>
  <MonthlyClickLimit>1</MonthlyClickLimit>
  <MonthlyExpenditureLimit>1.1</MonthlyExpenditureLimit>
  <MonthlyImpressionLimit>1</MonthlyImpressionLimit>
  <NewReviewingRequired>true</NewReviewingRequired>
  <PaymentFailure>true</PaymentFailure>
  <PaymentFailureNotified>true</PaymentFailureNotified>
  <PaymentFailureReason>sample string 28</PaymentFailureReason>
  <PaymentTermsId>1</PaymentTermsId>
  <PaymentsToDate>1.1</PaymentsToDate>
  <PostClickFrequencyCap>1</PostClickFrequencyCap>
  <PostClickFrequencyDuration>1</PostClickFrequencyDuration>
  <PostClickInterval>1</PostClickInterval>
  <PostImpressionFrequencyCap>1</PostImpressionFrequencyCap>
  <PostImpressionFrequencyDuration>1</PostImpressionFrequencyDuration>
  <PostImpressionInterval>1</PostImpressionInterval>
  <PostalInvoicesRequired>true</PostalInvoicesRequired>
  <Postcode>sample string 15</Postcode>
  <ProviderDiscountPercentage>1.1</ProviderDiscountPercentage>
  <RedirectorId>1</RedirectorId>
  <ReminderTimestamp>sample string 25</ReminderTimestamp>
  <ReminderTimestampNotified>true</ReminderTimestampNotified>
  <RenewalAccountManagerNotificationRequired>true</RenewalAccountManagerNotificationRequired>
  <RenewalAction>sample string 29</RenewalAction>
  <RenewalEmailAddress>sample string 32</RenewalEmailAddress>
  <RenewalFirstName>sample string 30</RenewalFirstName>
  <RenewalNotified>true</RenewalNotified>
  <RenewalReached>true</RenewalReached>
  <RenewalSurname>sample string 31</RenewalSurname>
  <RenewalThreshold>1.1</RenewalThreshold>
  <SalesReferenceNumber>sample string 5</SalesReferenceNumber>
  <SingleListingRestriction>true</SingleListingRestriction>
  <SpendThisMonth>1.1</SpendThisMonth>
  <SpendToDate>1.1</SpendToDate>
  <SpendToday>1.1</SpendToday>
  <Spent>1.1</Spent>
  <StartTimestamp>sample string 24</StartTimestamp>
  <State>sample string 2</State>
  <Surname>sample string 7</Surname>
  <Telephone>sample string 17</Telephone>
  <TimezoneId>1</TimezoneId>
  <VATExemptionReferenceNumber>sample string 20</VATExemptionReferenceNumber>
  <VATId>1</VATId>
  <VATRegistrationNumber>sample string 19</VATRegistrationNumber>
  <WelcomeEmailRequired>true</WelcomeEmailRequired>
</APIAdvertiser>