GET /report¶

Warning

This call is scheduled to be deprecated. Please use the faster replacement GET /metrics/report or the more flexible generic endpoint POST /metrics/data instead. Keep in mind that the new endpoint only returns data for ads which have had performance-related activity in the requested period.

v3 | v2 | v1

v3¶

Scope	`console_ro` or `api_ro`
Accept	`application/sellside.report-v3+json, application/json`
Content-Type	`application/sellside.report-v3+json`

Version 3 of this URL returns a performance report for a date period. The report contains statistics for performance events like impressions, clicks, url clicks, emails for all ads which match the filter criteria.

Note

The V3 endpoint replaces the V2 endpoint. Please move to V3 if you are still using V2.

Parameters¶

Field	Example	Type	Info
startDate	“2014-11-24”	string	Report start date
endDate	“2014-11-24”	string	Report end date (inclusive)
adIds	“1,2,3”	string	Comma-separated-list of ad id’s which to filter the result set on. Optional, default empty to include data for all ads.
status	“ACTIVE,DELETED”	string	Comma-separated-list of ad statuses which to filter the result set on. Optional, default is ACTIVE.
_include	“totalSpent,title”	string	Comma-separated-list of fields to include. Optional, default is all fields.
_exclude	“totalSpent,title”	string	Comma-separated-list of fields to omit. Optional, default empty.

Fields¶

Field	Example	Type	Info
createDate	“2014-12-05T16:12:53Z”	dateTime	The date/time this report call got requested.
startDate	“2014-11-23”	string	The start of the period this report covers.
endDate	“2014-11-24”	string	The end of the period this report covers.
data	see below	array	The report data; each element in this array represents the data for an ad.

Data contents¶

Field	Example	Type	Info
adId	12	long	Id of the ad to which the report row belongs to.
categoryId	631	int	Category id of the ad.
title	“Brother Fax voor 99,99”	string	Title of the ad.
startDate	“2012-08-31T16:12:53Z”	date	Creation date of the ad.
endDate	“2012-08-31T16:12:53Z”	date	Deletion date of the ad if the ad is deleted, null otherwise.
totalBudget	5000	long	Total budget of the ad.
dailyLimit	2000	long	Daily limit of the ad.
totalSpent	2000	long	Total amount spent for this ad.
cpc	12	int	Cpc of the ad.
impressions	40	long	Number of impressions this ad received.
clicks	10	long	Number of clicks this ad received.
urlClicks	3	int	Number of url clicks this ad received.
emails	2	int	Number of email requests this ad received.
externalId	“c3po-r2d2”	string	External id of the ad.
vendorId	“vndr”	string	Vendor id of the ad.
engagement	5	int	Engagement count of the ad. Depending on the tenant, this could be the same as urlClicks, or a summation of several metrics.

Example¶

GET /api/sellside/report?startDate=2014-11-24&endDate=2014-11-25
Accept: application/sellside.report-v3+json

200 OK
Content-Type: application/sellside.report-v3+json; charset=utf-8

{
  "createDate":"2014-12-05T14:47:04Z",
  "startDate":"2014-11-24",
  "endDate":"2014-11-25",
  "data":[
    {
      "adId":1262,
      "categoryId":573,
      "title":"Test Ad",
      "startDate":"1970-01-17T09:27:18Z",
      "endDate":null,
      "totalBudget":4900,
      "dailyLimit":999,
      "totalSpent":43,
      "cpc":1,
      "impressions":13,
      "clicks":43,
      "urlClicks":73,
      "emails":1,
      "externalId":"ad123ecec",
      "vendorId":"vndr",
      "engagement": 74
    }
  ]
}

v2¶

Warning

V2 is deprecated. Date of removal is still TBD.

Scope	`console_ro` or `api_ro`
Accept	`application/sellside.report-v2+json, application/json`
Content-Type	`application/sellside.report-v2+json`

Version 2 of this URL returns a performance report for a date period. The report contains statistics for performance events like impressions, clicks, url clicks, emails for all ads which match the filter criteria.

Note

Contrary to the rest of the API all dates are in GMT+1 timezone. This will be fixed in a later release.

Parameters¶

Field	Example	Type	Info
startDate	“2014-11-24”	string	Report start date
endDate	“2014-11-24”	string	Report end date (inclusive)
adIds	“1,2,3”	string	Comma-separated-list of ad id’s which to filter the result set on. Optional, default empty to include data for all ads.
status	“ACTIVE,DELETED”	string	Comma-separated-list of ad statuses which to filter the result set on. Optional, default is ACTIVE.
_include	“totalSpent,title”	string	Comma-separated-list of fields to include. Optional, default is all fields.
_exclude	“totalSpent,title”	string	Comma-separated-list of fields to omit. Optional, default empty.

Fields¶

Field	Example	Type	Info
createDate	“2014-12-05T16:12:53Z”	dateTime	The date/time this report call got requested.
startDate	“2014-11-23T01:00:00Z”	dateTime	The start of the period this report covers.
endDate	“2014-11-24T01:00:00Z”	dateTime	The end of the period this report covers.
data	see below	array	The report data; each element in this array represents the data for an ad.

Data contents¶

Field	Example	Type	Info
adId	12	long	Id of the ad to which the report row belongs to.
categoryId	631	int	Category id of the ad.
title	“Brother Fax voor 99,99”	string	Title of the ad.
startDate	“2012-08-31T16:12:53Z”	date	Creation date of the ad.
endDate	“2012-08-31T16:12:53Z”	date	Deletion date of the ad if the ad is deleted, null otherwise.
totalBudget	5000	long	Total budget of the ad.
dailyLimit	2000	long	Daily limit of the ad.
totalSpent	2000	long	Total amount spent for this ad.
cpc	12	int	Cpc of the ad.
impressions	40	long	Number of impressions this ad received.
clicks	10	long	Number of clicks this ad received.
urlClicks	3	int	Number of url clicks this ad received.
emails	2	int	Number of email requests this ad received.
externalId	“c3po-r2d2”	string	External id of the ad.
vendorId	“vndr”	string	Vendor id of the ad.

Example¶

GET /api/sellside/report?startDate=2014-11-24&endDate=2014-11-25
Accept: application/sellside.report-v2+json

200 OK
Content-Type: application/sellside.report-v2+json; charset=utf-8

{
  "createDate":"2014-12-05T14:47:04Z",
  "startDate":"2014-11-23T23:00:00Z",
  "endDate":"2014-11-24T23:00:00Z",
  "data":[
    {
      "adId":1262,
      "categoryId":573,
      "title":"Test Ad",
      "startDate":"1970-01-17T09:27:18Z",
      "endDate":null,
      "totalBudget":4900,
      "dailyLimit":999,
      "totalSpent":43,
      "cpc":1,
      "impressions":13,
      "clicks":43,
      "urlClicks":73,
      "emails":0,
      "externalId":"ad123ecec",
      "vendorId":"vndr"
    }
  ]
}

v1¶

Scope	`api_ro` or `console_ro`
Accept	`application/sellside.report-v1+json, application/json`

Version 1 of this URL returns a performance report for a specific date. The report contains statistics for performance events like impressions, clicks, url clicks, emails for all ads which received at least one event that day.

Warning

Version 1 is deprecated and will be removed after September 2015.

Parameters¶

Field	Example	Type	Info
date	“2014-01-30”	string	Report date.
_include	“id,date,title”	string	Comma-separated-list of fields to include. Optional, default is all fields.
_exclude	“id,date,title”	string	Comma-separated-list of fields to omit. Optional, default empty.

Fields¶

Field	Example	Type	Info
id	42	long	Id of the report row.
date	“2012-08-31T16:12:53Z”	date	Date of the report.
adId	12	long	Id of the ad to which the report row belongs to.
categoryId	631	int	Category id of the ad.
title	“Brother Fax voor 99,99”	string	Title of the ad.
startDate	“2012-08-31T16:12:53Z”	date	Creation date of the ad.
endDate	“2012-08-31T16:12:53Z”	date	Deletion date of the ad if the ad is deleted, null otherwise.
totalBudget	5000	long	Total budget of the ad.
dailyLimit	2000	long	Daily limit of the ad.
totalSpent	2000	long	Total amount spent for this ad.
cpc	12	int	Cpc of the ad.
impressions	40	long	Number of impressions this ad received.
clicks	10	long	Number of clicks this ad received.
urlClicks	3	int	Number of url clicks this ad received.
emails	2	int	Number of email requests this ad received.
externalId	“c3po-r2d2”	string	External id of the ad.
vendorId	“vndr”	string	Vendor id of the ad.

Example¶

GET /report/?date=2014-01-30
Accept: application/sellside.report-v1+json, application/json

200 OK
Content-Type: application/sellside.report-v1+json; charset=utf-8

[
    {
            "id":544023,
            "date":"2014-01-29T23:00:00Z",
            "adId":210338,
            "categoryId":2,
            "title":"Test Ad 1",
            "startDate":"2014-01-30T10:05:41Z",
            "endDate":"2014-01-30T10:11:21Z",
            "totalBudget":5000,
            "dailyLimit":1000,
            "totalSpent":60,
            "cpc":10,
            "impressions":120,
            "clicks":6,
            "urlClicks":3,
            "emails":1,
            "externalId":"f985f7eecc",
            "vendorId":"vndr"
    },
    {
            "id":544028,
            "date":"2014-01-29T23:00:00Z",
            "adId":210339,
            "categoryId":3,
            "title":"Test Ad 2",
            "startDate":"2014-01-30T10:11:28Z",
            "endDate":null,
            "totalBudget":5000,
            "dailyLimit":1000,
            "totalSpent":20,
            "cpc":10,
            "impressions":24,
            "clicks":2,
            "urlClicks":0,
            "emails":0,
            "externalId":"bffb7103d5",
            "vendorId":""
    }
]