Campaign Report

Important Notification:Delete ipuimp and ipuclk in all combinations and Report- Change dims=geo to dims=province.

Get the authorized campaign report

GET /campaigns/:campaign_id/reports

Parameters

time
Required string
It is connected with start_time and end_time.
  • hourly Get hourly unique data.
  • daily Get daily unique data.
dims
Optional string - The dimensions parameter defines the primary data keys for your Campaign report. Use dimensions to segment your metrics. If you want to ask for several dimensions, you should use ‘,’. Example : media , placement, time.
  • time- The result will contains date messages.
  • media
  • placement
  • keyword
  • creative
  • province

When using dimensions in a feed request, be aware of the following constraints:

network_media_id
Optional integer - Network Media ID
placement_id
Optional integer - Placement ID
keyword_id
Optional integer - Keyword ID
creative_id
Optional integer - Creative ID
geo_id
Optional integer - Geography ID
start_time
Optional hour - Listing campaigns which beginning time date earlier than start_date. The format of start_time is connected with time.The parament start_time is formatted according to the ISO 8601 standard.
time start_time description
hourly YYYY-MM-DDThh:mm:ss+08:00 2012-11-06T01:00:00+08:00
daily YYYY-MM-DD 2012-11-06
end_time
Optional hour - Listing campaigns which final date later than end_time. The format of end_time is connected with time.The parament end_time is formatted according to the ISO 8601 standard.
time end_time description
hourly YYYY-MM-DDThh:mm:ss+08:00 2012-11-06T01:00:00+08:00
daily YYYY-MM-DD 2012-11-06
sort
Optional string - The order to retrieve the results.
  • time - Sorting occurs by time.
  • imp - Sorting occurs by impression.
  • clk - Sorting occurs by click.
  • uimp - Sorting occurs by unique impression.
  • uclk - Sorting occurs by unique click.
  • network_media_id - Sorting occurs by network_media_id
  • placement_id - Sorting occurs by placement_id
direction
Optional string - The direction to retrieve the results.
  • asc Ascend (Default)
  • desc Descend
page
Optional integer - the start index

If not supplied, the page is 1. (Feed pages are 1-based. That is, the first entry is entry 1, not entry 0.) Use this parameter as a pagination mechanism along with the per_page parameter for situations when totalResults exceeds 30 and you want to retrieve entries indexed at 31 and beyond.

per_page
Optional integer - the max-results

You can use this in combination with page to retrieve a subset of elements, or use it alone to restrict the number of returned elements, starting with the first. If you do not use the per_page parameter in your query, your feed returns the default maximum of 30 entries.

Response

Status: 200 OK
Link: <http://track.admasterapi.com/campaigns/12/reports?page=2>; rel="next",
      <http://track.admasterapi.com/campaigns/12/reports?page=10>; rel="last"
[
  {
    "campaign_id": 10185,//Campaign ID
    "network_media_id": 1484,//Network Media ID
    "time": "2012-08-03",//The parament `time` is formatted according to the ISO 8601 standard and `start_time`.
    "imp": 90,//Impression
    "uimp": 60,//Unique Impression
    "clk": 30,//Click
    "uclk": 23,//Unique Click
  }
]

Dimensions Description

Field Type Description
imp integer Impression
uimp integer Unique Impression
clk integer Click
uclk integer Unique Click

Valid Combinations Description
Not all combinations can be queried together. Only certain combinations can be used together to create valid combinations.

Valid Combinations
time=daily
time=daily&dims=province
time=daily&dims=creative
time=daily&dims=media
time=daily&dims=media,province
time=daily&dims=media,creative
time=daily&dims=media,placement
time=daily&dims=media,placement,province
time=daily&dims=media,placement,creative
time=daily&dims=media,placement,keyword
time=hourly
time=hourly&dims=creative
time=hourly&dims=province
time=hourly&dims=media
time=hourly&dims=media,creative
time=hourly&dims=media,province
time=hourly&dims=media,placement
time=hourly&dims=media,placement,creative
time=hourly&dims=media,placement,province

Example

dims contain time

[
    {
        "campaign_id": 10116,
        "time": "2012-11-01",
        "imp": 3,
        "uimp": 3,
        "clk": 7,
        "uclk": 7,
    },
    {
        "campaign_id": 10116,
        "time": "2012-11-02",
    …
]

dims without time

[
    {
        "campaign_id": 10116,
        "imp": 28,
        "uimp": 27,
        "clk": 72,
        "uclk": 39,
    }
]