POST /report/detail

Scope	console_rw or api_rw
Accept	application/sellside.report.detail.response-v1+json, application/json
Content-Type	application/sellside.report.detail.request-v1+json; charset=utf-8

Warning

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

This URL requests a new report for the current user. Creating the report may take a long time which depends on the number of ads and the requested date range. Therefore you

1. Request a new report with POST /report/detail which returns a unique id

2. Poll GET /report/detail until the id is in the result

3. Fetch the report with GET /report/detail/{id}

Fields

Field of the report request is as follows:

Field	Type	Mandatory	Description
startDate	string	yes	Start date of the report in yyyy-MM-dd format
endDate	string	yes	End date of the report in yyyy-MM-dd format (inclusive)
includeDeleted	bool	no	Deleted ads are included/excluded. Default false

Errors

Both startDate and endDate fields in the request must be in yyyy-MM-dd format. Both fields must point to dates in the past.

Field	Code	Error message	Description
startDate	2000	missing argument	The field startDate was missing
startDate	2001	invalid argument	The value of field startDate was invalid
startDate	2002	out of range	The value of the field startDate was out of range
startDate	2004	too short	The minimum length of field startDate is 1 characters
endDate	2000	missing argument	The field endDate was missing
endDate	2001	invalid argument	The value of field endDate was invalid
endDate	2002	out of range	The value of the field endDate was out of range
endDate	2004	too short	The minimum length of field endDate is 1 characters

Example Request

POST /api/sellside/report/detail
Accept: application/sellside.report.detail.response-v1+json, application/json
Content-Type: application/sellside.report.detail.request-v1+json; charset=utf-8

{
    "startDate": "2015-04-04",
    "endDate": "2015-04-17",
    "includeDeleted": true
}

Example Response

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

{
    "id": "02f1aaa6-2605-4a32-86af-b8175eba554f"
}