--- title: "GET /ad_report_task" method: GET path: "/ad_report_task" tags: ["ad_report_task"] --- # GET /ad_report_task `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.

## Query parameters - `limit` string - `offset` string - `report_task_statuses` string ## Response `200` Success - ReportTaskPagedCollection — This type defines the fields that paginate the reports tasks returned by the request. The entire result set consists of 0 or more sequenced response pages, where each page consists of 0 or more items from the complete result set. - `href` string — The URI of the current page of results from the result set. - `limit` integer — The number of items returned on a single page from the result set. This value can be set in the request with the limit query parameter. - `next` string — The URI for the following page of results. This value is returned only if there is an additional page of results to display from the result set.

Max length: 2048 - `offset` integer — The number of results skipped in the result set before listing the first returned result. This value can be set in the request with the offset query parameter.

Note: The items in a paginated result set use a zero-based list where the first item in the list has an offset of 0. - `prev` string — The URI for the preceding page of results. This value is returned only if there is a previous page of results to display from the result set.

Max length: 2048 - `reportTasks` ReportTask[] — A list of report tasks contained on this page from the paginated response. - `campaignIds` string[] — A list of IDs for the campaigns that are included in the report. A campaign ID is a unique eBay-assigned identifier of the campaign that's generated when the campaign is created.

Call getCampaigns to return the current campaign IDs for a seller. - `dateFrom` string — The date defining the start of the timespan covered by the report, formatted as an ISO 8601 timestamp. - `dateTo` string — The date defining the end of the timespan covered by the report, formatted as an ISO 8601 timestamp. - `dimensions` Dimension[] — A list containing the dimension in the report. - `annotationKeys` string[] — A list of annotations associated with the dimension of the report. - `dimensionKey` string — The name of the dimension on which the report is based.

A dimension is an attribute to which the report data applies.

- `fundingModels` string[] — The funding model for the campaign that shall be included in the report.

Note: The default funding model for Promoted Listings reports is COST_PER_SALE.

Valid Values:

COST_PER_SALE
COST_PER_CLICK

- `inventoryReferences` InventoryReference[] — If supplied in the request, this field returns a list of the seller's inventory reference IDs included in the report.

Each item is referenced by a pair of inventoryRefernceID and inventoryReferenceType values, where an inventory reference ID can be either a seller-defined SKU value or an inventoryItemGroupKey. An inventoryItemGroupKey is seller-defined ID for an inventory item group (a multiple-variation listing), and is created and used by the Inventory API.

- `inventoryReferenceId` string — The seller's inventory reference ID for an item that is managed with the Inventory API.

An inventory reference is either the ID of a single listing or the ID of the parent of an item group listing (a multi-variation listing, such as a shirt that is available in multiple sizes and colors).

Required if if you supply an inventoryReferenceType. - `inventoryReferenceType` string — Indicates the type of item indicated by the inventoryReferenceId.

This value can be set to either INVENTORY_ITEM or INVENTORY_ITEM_GROUP (if the ID points to a multi-variation listing).

Required if if you supply an inventoryReferenceId. For implementation help, refer to eBay API documentation - `listingIds` string[] — If supplied in the request, this field returns a list of the listing IDs included in the report. A listing ID is an eBay-assigned ID that's generated when a listing is created. - `marketplaceId` string — The ID of the eBay marketplace used by the report task. For implementation help, refer to eBay API documentation - `metricKeys` string[] — A list of metrics for the report task. - `reportExpirationDate` string — The date after which the report is no longer be available. Reports are available for 30 days and you cannot download a report after it has expired.

Format (UTC): yyyy-MM-ddThh:mm:ss.sssZ - `reportFormat` string — Indicates the format of the report. Currently, only TSV_GZIP is supported. For implementation help, refer to eBay API documentation - `reportHref` string — The URL of the generated report, which can be used to download the report once it has been generated. - `reportId` string — A unique eBay-assigned ID for the report. - `reportName` string — An eBay-assigned name for the report that's created by the createReportTask call. This name is unique for the seller. - `reportTaskCompletionDate` string — The date the report task completed the report generation.

Format (UTC): yyyy-MM-ddThh:mm:ss.sssZ - `reportTaskCreationDate` string — The date the report task was created.

Format (UTC): yyyy-MM-ddThh:mm:ss.sssZ - `reportTaskExpectedCompletionDate` string — The date the report task is expected to complete the report generation.

Format (UTC): yyyy-MM-ddThh:mm:ss.sssZ - `reportTaskId` string — The unique eBay-assigned ID of the report task. This value is generated when the report task is created with a call to createReportTask. - `reportTaskStatus` string — Indicates the current state of the report task. For implementation help, refer to eBay API documentation - `reportTaskStatusMessage` string — A status message with additional information about the report task. - `reportType` string — Indicates type of report associated with the report task.

Note: INVENTORY_PERFORMANCE_REPORT is not currently available; availability date is pending. For implementation help, refer to eBay API documentation - `total` integer — The total number of items retrieved in the result set.

If no items are found, this field is returned with a value of 0. ## Other responses - `400` — Bad Request - `500` — Internal Server Error --- [API](https://skmtc.net/ebay/apis/sell-marketing.md) · [All operations](https://skmtc.net/ebay/apis/sell-marketing/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ebay/sell-marketing/versions/de10a5d47510/schema)