GET /ad_report_task

This method returns information on all the existing report tasks related to a seller.

Use the report_task_statuses query parameter to control which reports to return. You can paginate the result set by specifying a limit, which dictates how many report tasks to return on each page of the response. Use the offset parameter to specify how many reports to skip in the result set before returning the first result.

Servers

Query parameters

Name Type Required Description
limit String No

Specifies the maximum number of report tasks to return on a page in the paginated response.

Default: 10
Maximum: 500

report_task_statuses String No

This parameter filters the returned report tasks by their status. Supply a comma-separated list of the report statuses you want returned. The results are filtered to include only the report statuses you specify.

Note: The results might not include some report tasks if other search conditions exclude them.

Valid values:
   PENDING
   SUCCESS
   FAILED

offset String No

Specifies the number of report tasks to skip in the result set before returning the first report in the paginated response.

Combine offset with the limit query parameter to control the reports returned in the response. For example, if you supply an offset of 0 and a limit of 10, the response contains the first 10 reports from the complete list of report tasks retrieved by the call. If offset is 10 and limit is 10, the first page of the response contains reports 11-20 from the complete result set.

Default: 0

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.