summary¶

Warning

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

GET /report/summary V2 | GET /report/summary V1

GET /report/summary V2¶

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

This URL returns the summarized performance data for all ads (including deleted) from the user in the provided period.

Parameters¶

Name	Type	Description
startDate	String	Start date of the period for the report summary. Must be a valid date in format ‘yyyy-MM-dd’
endDate	String	End date of the period for the report summary. Must be a valid date in format ‘yyyy-MM-dd’

Errors¶

Field	Code	Error message	Description
startDate	2001	invalid argument	must be a valid date in format ‘yyyy-MM-dd’
endDate	2001	invalid argument	must be a valid date in format ‘yyyy-MM-dd’
startDate/endDate	2002	out of range	endDate should be after startDate

Fields¶

The returned object is as follows.

Field	Type	Description
spent	int	Spent amount for all ads in the period
impressions	int	Number of impressions for all ads in the period
clicks	int	Number of clicks for all ads in the period
engagement	int	Number of leads generated (clickouts, emails, …)
averageCtr	double	Average ctr over all ads in the period, in percentages

Example¶

GET /api/sellside/report/summary?startDate=2015-03-12&endDate=2015-06-21
Accept: application/sellside.report.summary-v2+json, application/json

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

{
  spent: 640100,
  impressions: 162533,
  clicks: 12823,
  engagement: 713,
  averageCtr: 0.078894748
}

GET /report/summary V1¶

Deprecated. Please use GET /report/summary V2.

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