Please note that this feature requires a unique API key and password. Please contact your account representative for more information.

Introduction

Content.ad offers this REST API to make the data in the Traffic Sources Report in a publisher’s account login available in either XML or JSON format.

Implementation FAQ

How do I configure my sources and campaigns so that they appear in this report?
See our FAQ on setting up the Traffic Sources Report.

How often is performance data updated?
Performance reports are updated by Content.ad once per hour.

How long can I run the report for?
This report can be run for any period 31 days or less. You can use the “startDate” and “endDate” parameters to specify a date range.

How is reporting data grouped?
This report can group data by hour, day or aggregate time period and groups performance by widget, source (clientID) and campaign (clientID2). See the “Optional Query String Parameters” section below for more information.

Setting Up the API Call

Place the desired parameters into the API call below. Omitting domain or widget parameters will return all data in that category.

https://rest.content.ad/reports/publisher/traffic-sources

Optional Query String Parameters

Example XML Result Set

<Report>
 <Rows>
  <Row>
   <Time>2014-05-01T00:00:00-07:00</Time>
   <DomainID>00001</DomainID>
   <DomainName>http://example.com</DomainName>
   <WidgetID>00001</WidgetID>
   <WidgetGUID>00000x00-1yyy-222z-33a3-bbb444bb4444</WidgetGUID>
   <WidgetDescription>Widget 1</WidgetDescription>
   <Source>organic</Source>
   <Campaign>123</Campaign>
   <Impressions>14400</Impressions>
   <CTR>2.3000</CTR>
   <eCPM>1.2000</eCPM>
   <ClicksPaid>180</ClicksPaid>
   <ClicksInternal>151</ClicksInternal>
   <Revenue>17.28</Revenue>
  </Row>
  <Row>
   <Time>2014-05-02T00:00:00-07:00</Time>
   <DomainID>00001</DomainID>
   <DomainName>http://example.com</DomainName>
   <WidgetID>00001</WidgetID>
   <WidgetGUID>00000x00-1yyy-222z-33a3-bbb444bb4444</WidgetGUID>
   <WidgetDescription>Widget 1</WidgetDescription>
   <Source>organic</Source>
   <Campaign>123</Campaign>
   <Impressions>14400</Impressions>
   <CTR>2.3000</CTR>
   <eCPM>1.2000</eCPM>
   <ClicksPaid>180</ClicksPaid>
   <ClicksInternal>151</ClicksInternal>
   <Revenue>17.28</Revenue>
  </Row>
 </Rows>
</Report>
Did this answer your question?