Reports: get

  • Polls for the status of a report request to determine if it's ready for download, still processing, or if an error occurred.

  • The response includes an isReportReady flag indicating the report status and, if ready, provides details like the number of report files.

  • Uses a GET request to the specified endpoint, including the report ID as a path parameter, to retrieve the report status.

  • Requires authorization with the https://www.googleapis.com/auth/doubleclicksearch scope for access.

  • A successful response returns a Reports resource containing information about the requested report.

Polls for the status of a report request. Try it now.

The response indicates the status of the report:

  • If the report is ready for download, the response contains isReportReady: true. The response also contains information such as the number of report files.
  • If the report is still being worked on, the response contains isReportReady: false.
  • If DoubleClick Search is unable to complete the report, the response contains the error code 410 Gone and one of the reasons documented in Response Codes.

Request

HTTP request

GET https://www.googleapis.com/doubleclicksearch/v2/reports/reportId

Parameters

Parameter name Value Description
Path parameters
reportId string ID of the report request being polled.

Authorization

This request requires authorization with the following scope:

Scope
https://www.googleapis.com/auth/doubleclicksearch

For more information, see the authentication and authorization page.

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a Reports resource in the response body.

Try it!

Use the APIs Explorer below to call this method on live data and see the response. Alternatively, try the standalone Explorer.