Skip to main content


This call returns the details of a specific Promoted Listings report task, as specified by the report_task_id path parameter.

The report task includes the report criteria (such as the report dimensions, metrics, and included listing) and the report-generation rules (such as starting and ending dates for the specified report task).

Report-task IDs are generated by eBay when you call createReportTask. Get a complete list of a seller's report-task IDs by calling getReportTasks.

Important!For ad_report and ad_report_task methods, the API call limit is subject to a per user quota. These API calls can only be executed a maximum of 200 times per hour for each seller/user. If the number of calls per hour exceeds this limit, any new calls will be blocked for the next hour.


Resource URI


This method is supported in Sandbox environment. To access the endpoint, just replace the root URI with

URI parameters

report_task_idstringThis path parameter specifies the unique identifier of the report task being retrieved.

Use the getReportTasks method to retrieve report task Ids.

Occurrence: Required

HTTP request headers

All requests made to eBay REST operations require you to provide the Authorization HTTP header for authentication authorization.

All other standard RESTful request headers are optional. For more information on standard RESTful request headers, see the HTTP request headers- opens rest request components page table.

OAuth scope

This request requires an access token created with the authorization code grant flow, using one or more scopes from the following list (please check your Application Keys page for a list of OAuth scopes available to your application):

See OAuth access tokens for more information.

Request payload

This call has no payload.

Request fields

This call has no field definitions.


HTTP response headers

This call has no response headers.

Response payload

Response fields

Output container/fieldTypeDescription
campaignIdsarray of 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.

Occurrence: Conditional

channelsarray of ChannelEnum

The channel for the advertising campaign that will be included in the report task. This value indicates whether the data included in the report task is for an Onsite or Offsite advertising campaign.

Occurrence: Conditional


The date defining the start of the timespan covered by the report, formatted as an ISO 8601 timestamp.

Occurrence: Always


The date defining the end of the timespan covered by the report, formatted as an ISO 8601 timestamp.

Occurrence: Always

dimensionsarray of Dimension

A list containing the dimension in the report.

Occurrence: Always

dimensions.annotationKeysarray of string

A list of annotations associated with the dimension of the report.

Occurrence: Always


The name of the dimension on which the report is based.

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

Occurrence: Always

fundingModelsarray of FundingModelEnum

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:


Occurrence: Conditional

inventoryReferencesarray of 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.

Occurrence: Conditional


The unique identifier of a single-item listing or a multi-variation listing.

To create an ad for a single-item listing, set the inventoryReferenceType value to INVENTORY_ITEM and specify an item ID or a SKU (if the SKU is defined in the listing).

To create an ad for a multi-variation listing, set the inventoryReferenceType value to INVENTORY_ITEM_GROUP and specify the item ID for the multi-variation listing or the inventoryitemGroupKey value as defined in the Inventory API.

Required if if you supply an inventoryReferenceType.

Occurrence: Conditional


Indicates the type of item indicated by the inventoryReferenceId.

This value can be set to either INVENTORY_ITEM or INVENTORY_ITEM_GROUP.

Required if if you supply an inventoryReferenceId.

Occurrence: Conditional

listingIdsarray of 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.

Occurrence: Conditional


The ID of the eBay marketplace used by the report task.

Occurrence: Always

metricKeysarray of string

A list of metrics for the report task.

Occurrence: Always


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

Occurrence: Always


Indicates the format of the report. Currently, only TSV_GZIP is supported.

Occurrence: Always


The URL of the generated report, which can be used to download the report once it has been generated.

Occurrence: Always


A unique eBay-assigned ID for the report.

Occurrence: Always


An eBay-assigned name for the report that's created by the createReportTask call. This name is unique for the seller.

Occurrence: Always


The date the report task completed the report generation.

Format (UTC): yyyy-MM-ddThh:mm:ss.sssZ

Occurrence: Always


The date the report task was created.

Format (UTC): yyyy-MM-ddThh:mm:ss.sssZ

Occurrence: Always


The date the report task is expected to complete the report generation.

Format (UTC): yyyy-MM-ddThh:mm:ss.sssZ

Occurrence: Always


The unique eBay-assigned ID of the report task. This value is generated when the report task is created with a call to createReportTask.

Occurrence: Always


Indicates the current state of the report task.

Occurrence: Always


A status message with additional information about the report task.

Occurrence: Conditional


Indicates type of report associated with the report task.

Note: INVENTORY_PERFORMANCE_REPORT is not currently available; availability date is pending.

Occurrence: Always

HTTP status codes

This call can return one of the following HTTP status codes. For an overview of the status codes, see HTTP status codes in Using eBay RESTful APIs.

404Not found
500Internal Server error

Error codes

For more on errors, plus the codes of other common errors, see Handling errors.

35001API_MARKETINGAPPLICATIONThere was a problem with an eBay internal system or process. Contact eBay Developer Technical Support for assistance.
35140API_MARKETINGREQUESTNo ReportTask found for 'report_task_id' {report_task_id}. Please correct the 'report_task_id' and try again.


This call has no warnings.


New to making API calls? Please see Making a Call.

Note: Identifiers, such as order IDs or user IDs, and personal data in these samples might be anonymized or may no longer be active on eBay. If necessary, substitute current, relevant eBay data in your requests.

Sample 1: Get Specific Report Task

This sample retrieves the details of a specific report task.


Specify the report task you want to retrieve using the report_task_id URI parameter. The ID for a report task is returned in the Location HTTP response header of the createReportTask call you used to create the task.



If successful, the call returns details of the specified report task.

Got thoughts? Click the feedback button – your insights help us improve!