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

Get a specific publisher

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

APIPublisher
NameDescriptionTypeAdditional information
Id

Unique identifier

integer

None.

State

Status: Active, Closed or Suspended

string

None.

NewReviewingRequired

Denotes that publisher is new and requires reviewing

boolean

None.

ModifiedReviewingRequired

Denotes that publisher has been modified and requires reviewing

boolean

None.

PublisherNumber

Automatically allocated numerical reference number

integer

None.

FirstName

First name of primary contact

string

None.

Surname

Surname of primary contact

string

None.

EmailAddress

Email address of primary 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

Publisher's language name

string

None.

TimezoneId

Unique identifier pf timezone to which this relates

integer

None.

CreationTimestamp

Timestamp when this was created

string

None.

StartTimestamp

Timestamp from whence this becomes active

string

None.

EndTimestamp

Timestamp until which this remains active

string

None.

MaximumQueriesPerSecond

Maximum number of queries allowed each second

integer

None.

MaximumQueriesPerDay

Maximum number of queries allowed each day

integer

None.

MaximumQueriesPerMonth

Maximum number of queries allowed each month

integer

None.

MaximumImpressionsPerDay

Maximum number of impressions allowed each day

integer

None.

MaximumImpressionsPerMonth

Maximum number of impressions allowed each month

integer

None.

MaximumClicksPerDay

Maximum number of clicks allowed each day

integer

None.

MaximumClicksPerMonth

Maximum number of clicks allowed each month

integer

None.

RestrictToKnownSitesOnly

Denotes that only queries from known sites should be allowed

boolean

None.

MinimumImpressionPrice

Minimum impression price for adverts

decimal number

None.

MinimumClickPrice

Minimum click price for adverts

decimal number

None.

MinimumImpressionRevenueShare

Minimum impression revenue share for adverts

decimal number

None.

MinimumClickRevenueShare

Minimum click revenue share for adverts

decimal number

None.

IgnoreContraRevenuePercentage

Ignore percentage adjustment for charges and refunds

boolean

None.

ClickFraudAlgorithm

Disabled, Guid, IpAddress, GuidAndIpAddress

string

None.

AdoptLocationIfUnknown

Denotes that users should adopt publisher location if otherwise unknown

boolean

None.

AdoptBrowserIfUnknown

Denotes that users should adopt publisher browser if otherwise unknown

boolean

None.

AdoptDeviceIfUnknown

Denotes that users should adopt publisher device if otherwise unknown

boolean

None.

AdoptCarrierIfUnknown

Denotes that users should adopt publisher carrier if otherwise unknown

boolean

None.

AdoptOperatingSystemIfUnknown

Denotes that users should adopt publisher operating system if otherwise unknown

boolean

None.

AdoptConnectionTypeIfUnknown

Denotes that users should adopt publisher connection type if otherwise unknown

boolean

None.

AdoptDeviceTypeIfUnknown

Denotes that users should adopt publisher device type if otherwise unknown

boolean

None.

RefererMissingSearchFilter

Enabled, Disabled or Inherit

string

None.

UseragentMissingSearchFilter

Enabled, Disabled or Inherit

string

None.

IPIntelligenceSearchFilter

Enabled, Disabled or Inherit

string

None.

RefererMissingClickFilter

Enabled, Disabled or Inherit

string

None.

UseragentMissingClickFilter

Enabled, Disabled or Inherit

string

None.

RefererMismatchClickFilter

Enabled, Disabled or Inherit

string

None.

UseragentMismatchClickFilter

Enabled, Disabled or Inherit

string

None.

IPAddressMismatchClickFilter

Enabled, Disabled or Inherit

string

None.

PartialIPAddressMismatchClickFilter

Enabled, Disabled or Inherit

string

None.

CookiesNotEnabledClickFilter

Enabled, Disabled or Inherit

string

None.

ClickPositionMissingClickFilter

Enabled, Disabled or Inherit

string

None.

ClickPositionOffScreenClickFilter

Enabled, Disabled or Inherit

string

None.

AutomatedCrawlerClickFilter

Enabled, Disabled or Inherit

string

None.

WindowTooSmallClickFilter

Enabled, Disabled or Inherit

string

None.

MinimumWindowPercentage

Minimum window percentage for clicks

integer

None.

ConfidenceClickFilter

Enabled, Disabled or Inherit

string

None.

ConfidenceThreshold

Minimum confidence threshold for clicks

integer

None.

MaximumSearchToImpressionFilter

Enabled, Disabled or Inherit

string

None.

MaximumSearchToImpressionInterval

Maximum time in seconds between search and impression

integer

None.

MinimumSearchToClickFilter

Enabled, Disabled or Inherit

string

None.

MinimumSearchToClickInterval

Minimum time in seconds between search and click

integer

None.

MaximumSearchToClickFilter

Enabled, Disabled or Inherit

string

None.

MaximumSearchToClickInterval

Maximum time in seconds between search and click

integer

None.

MinimumClickToClickFilter

Enabled, Disabled or Inherit

string

None.

MinimumClickToClickInterval

Minimum time in seconds between clicks

integer

None.

MaximumSearchClicksFilter

Enabled, Disabled or Inherit

string

None.

MaximumSearchClicks

Maximum number of clicks per search

integer

None.

MaximumResultClicksFilter

Enabled, Disabled or Inherit

string

None.

MaximumResultClicks

Maximum number of clicks per result

integer

None.

MaximumAdvertClicksFilter

Enabled, Disabled or Inherit

string

None.

MaximumAdvertClicks

Maximum number of clicks per advert

integer

None.

MaximumOverallClicksFilter

Enabled, Disabled or Inherit

string

None.

MaximumOverallClicks

Maximum number of clicks overall

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,
  "state": "sample string 2",
  "newReviewingRequired": true,
  "modifiedReviewingRequired": true,
  "publisherNumber": 1,
  "firstName": "sample string 3",
  "surname": "sample string 4",
  "emailAddress": "sample string 5",
  "company": "sample string 6",
  "address1": "sample string 7",
  "address2": "sample string 8",
  "address3": "sample string 9",
  "address4": "sample string 10",
  "county": "sample string 11",
  "postcode": "sample string 12",
  "country": "sample string 13",
  "telephone": "sample string 14",
  "companyRegistrationNumber": "sample string 15",
  "vatRegistrationNumber": "sample string 16",
  "vatExemptionReferenceNumber": "sample string 17",
  "vatId": 1,
  "languageName": "sample string 18",
  "timezoneId": 1,
  "creationTimestamp": "sample string 19",
  "startTimestamp": "sample string 20",
  "endTimestamp": "sample string 21",
  "maximumQueriesPerSecond": 1,
  "maximumQueriesPerDay": 1,
  "maximumQueriesPerMonth": 1,
  "maximumImpressionsPerDay": 1,
  "maximumImpressionsPerMonth": 1,
  "maximumClicksPerDay": 1,
  "maximumClicksPerMonth": 1,
  "restrictToKnownSitesOnly": true,
  "minimumImpressionPrice": 1.1,
  "minimumClickPrice": 1.1,
  "minimumImpressionRevenueShare": 1.1,
  "minimumClickRevenueShare": 1.1,
  "ignoreContraRevenuePercentage": true,
  "clickFraudAlgorithm": "sample string 22",
  "adoptLocationIfUnknown": true,
  "adoptBrowserIfUnknown": true,
  "adoptDeviceIfUnknown": true,
  "adoptCarrierIfUnknown": true,
  "adoptOperatingSystemIfUnknown": true,
  "adoptConnectionTypeIfUnknown": true,
  "adoptDeviceTypeIfUnknown": true,
  "refererMissingSearchFilter": "sample string 23",
  "useragentMissingSearchFilter": "sample string 24",
  "ipIntelligenceSearchFilter": "sample string 25",
  "refererMissingClickFilter": "sample string 26",
  "useragentMissingClickFilter": "sample string 27",
  "refererMismatchClickFilter": "sample string 28",
  "useragentMismatchClickFilter": "sample string 29",
  "ipAddressMismatchClickFilter": "sample string 30",
  "partialIPAddressMismatchClickFilter": "sample string 31",
  "cookiesNotEnabledClickFilter": "sample string 32",
  "clickPositionMissingClickFilter": "sample string 33",
  "clickPositionOffScreenClickFilter": "sample string 34",
  "automatedCrawlerClickFilter": "sample string 35",
  "windowTooSmallClickFilter": "sample string 36",
  "minimumWindowPercentage": 1,
  "confidenceClickFilter": "sample string 37",
  "confidenceThreshold": 1,
  "maximumSearchToImpressionFilter": "sample string 38",
  "maximumSearchToImpressionInterval": 1,
  "minimumSearchToClickFilter": "sample string 39",
  "minimumSearchToClickInterval": 1,
  "maximumSearchToClickFilter": "sample string 40",
  "maximumSearchToClickInterval": 1,
  "minimumClickToClickFilter": "sample string 41",
  "minimumClickToClickInterval": 1,
  "maximumSearchClicksFilter": "sample string 42",
  "maximumSearchClicks": 1,
  "maximumResultClicksFilter": "sample string 43",
  "maximumResultClicks": 1,
  "maximumAdvertClicksFilter": "sample string 44",
  "maximumAdvertClicks": 1,
  "maximumOverallClicksFilter": "sample string 45",
  "maximumOverallClicks": 1,
  "impressionCount": 1,
  "clickCount": 1,
  "spent": 1.1
}

application/xml, text/xml

Sample:
<APIPublisher xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Rochester.Models">
  <Address1>sample string 7</Address1>
  <Address2>sample string 8</Address2>
  <Address3>sample string 9</Address3>
  <Address4>sample string 10</Address4>
  <AdoptBrowserIfUnknown>true</AdoptBrowserIfUnknown>
  <AdoptCarrierIfUnknown>true</AdoptCarrierIfUnknown>
  <AdoptConnectionTypeIfUnknown>true</AdoptConnectionTypeIfUnknown>
  <AdoptDeviceIfUnknown>true</AdoptDeviceIfUnknown>
  <AdoptDeviceTypeIfUnknown>true</AdoptDeviceTypeIfUnknown>
  <AdoptLocationIfUnknown>true</AdoptLocationIfUnknown>
  <AdoptOperatingSystemIfUnknown>true</AdoptOperatingSystemIfUnknown>
  <AutomatedCrawlerClickFilter>sample string 35</AutomatedCrawlerClickFilter>
  <ClickCount>1</ClickCount>
  <ClickFraudAlgorithm>sample string 22</ClickFraudAlgorithm>
  <ClickPositionMissingClickFilter>sample string 33</ClickPositionMissingClickFilter>
  <ClickPositionOffScreenClickFilter>sample string 34</ClickPositionOffScreenClickFilter>
  <Company>sample string 6</Company>
  <CompanyRegistrationNumber>sample string 15</CompanyRegistrationNumber>
  <ConfidenceClickFilter>sample string 37</ConfidenceClickFilter>
  <ConfidenceThreshold>1</ConfidenceThreshold>
  <CookiesNotEnabledClickFilter>sample string 32</CookiesNotEnabledClickFilter>
  <Country>sample string 13</Country>
  <County>sample string 11</County>
  <CreationTimestamp>sample string 19</CreationTimestamp>
  <EmailAddress>sample string 5</EmailAddress>
  <EndTimestamp>sample string 21</EndTimestamp>
  <FirstName>sample string 3</FirstName>
  <IPAddressMismatchClickFilter>sample string 30</IPAddressMismatchClickFilter>
  <IPIntelligenceSearchFilter>sample string 25</IPIntelligenceSearchFilter>
  <Id>1</Id>
  <IgnoreContraRevenuePercentage>true</IgnoreContraRevenuePercentage>
  <ImpressionCount>1</ImpressionCount>
  <LanguageName>sample string 18</LanguageName>
  <MaximumAdvertClicks>1</MaximumAdvertClicks>
  <MaximumAdvertClicksFilter>sample string 44</MaximumAdvertClicksFilter>
  <MaximumClicksPerDay>1</MaximumClicksPerDay>
  <MaximumClicksPerMonth>1</MaximumClicksPerMonth>
  <MaximumImpressionsPerDay>1</MaximumImpressionsPerDay>
  <MaximumImpressionsPerMonth>1</MaximumImpressionsPerMonth>
  <MaximumOverallClicks>1</MaximumOverallClicks>
  <MaximumOverallClicksFilter>sample string 45</MaximumOverallClicksFilter>
  <MaximumQueriesPerDay>1</MaximumQueriesPerDay>
  <MaximumQueriesPerMonth>1</MaximumQueriesPerMonth>
  <MaximumQueriesPerSecond>1</MaximumQueriesPerSecond>
  <MaximumResultClicks>1</MaximumResultClicks>
  <MaximumResultClicksFilter>sample string 43</MaximumResultClicksFilter>
  <MaximumSearchClicks>1</MaximumSearchClicks>
  <MaximumSearchClicksFilter>sample string 42</MaximumSearchClicksFilter>
  <MaximumSearchToClickFilter>sample string 40</MaximumSearchToClickFilter>
  <MaximumSearchToClickInterval>1</MaximumSearchToClickInterval>
  <MaximumSearchToImpressionFilter>sample string 38</MaximumSearchToImpressionFilter>
  <MaximumSearchToImpressionInterval>1</MaximumSearchToImpressionInterval>
  <MinimumClickPrice>1.1</MinimumClickPrice>
  <MinimumClickRevenueShare>1.1</MinimumClickRevenueShare>
  <MinimumClickToClickFilter>sample string 41</MinimumClickToClickFilter>
  <MinimumClickToClickInterval>1</MinimumClickToClickInterval>
  <MinimumImpressionPrice>1.1</MinimumImpressionPrice>
  <MinimumImpressionRevenueShare>1.1</MinimumImpressionRevenueShare>
  <MinimumSearchToClickFilter>sample string 39</MinimumSearchToClickFilter>
  <MinimumSearchToClickInterval>1</MinimumSearchToClickInterval>
  <MinimumWindowPercentage>1</MinimumWindowPercentage>
  <ModifiedReviewingRequired>true</ModifiedReviewingRequired>
  <NewReviewingRequired>true</NewReviewingRequired>
  <PartialIPAddressMismatchClickFilter>sample string 31</PartialIPAddressMismatchClickFilter>
  <Postcode>sample string 12</Postcode>
  <PublisherNumber>1</PublisherNumber>
  <RefererMismatchClickFilter>sample string 28</RefererMismatchClickFilter>
  <RefererMissingClickFilter>sample string 26</RefererMissingClickFilter>
  <RefererMissingSearchFilter>sample string 23</RefererMissingSearchFilter>
  <RestrictToKnownSitesOnly>true</RestrictToKnownSitesOnly>
  <Spent>1.1</Spent>
  <StartTimestamp>sample string 20</StartTimestamp>
  <State>sample string 2</State>
  <Surname>sample string 4</Surname>
  <Telephone>sample string 14</Telephone>
  <TimezoneId>1</TimezoneId>
  <UseragentMismatchClickFilter>sample string 29</UseragentMismatchClickFilter>
  <UseragentMissingClickFilter>sample string 27</UseragentMissingClickFilter>
  <UseragentMissingSearchFilter>sample string 24</UseragentMissingSearchFilter>
  <VATExemptionReferenceNumber>sample string 17</VATExemptionReferenceNumber>
  <VATId>1</VATId>
  <VATRegistrationNumber>sample string 16</VATRegistrationNumber>
  <WindowTooSmallClickFilter>sample string 36</WindowTooSmallClickFilter>
</APIPublisher>