marketing APIv1.10.0

getReport

GET
/ad_report/{report_id}
This call downloads the report as specified by the report_id path parameter.

Call createReportTask to schedule and generate a Promoted Listings report. All date values are returned in UTC format (yyyy-MM-ddThh:mm:ss.sssZ).

Input

Resource URI (production)

GET https://api.ebay.com/sell/marketing/v1/ad_report/{report_id}

URI parameters

ParameterTypeDescription
report_idstringThe unique ID of the Promoted Listings report you want to get.

This ID is generated by eBay when you run a report task with a call to createReportTask. Get all the seller's report IDs by calling getReportTasks.

Occurrence: Required

HTTP request headers

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

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):

https://api.ebay.com/oauth/api_scope/sell.marketing

See OAuth access tokens for more information.

Output

HTTP response headers

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.

StatusMeaning
200Success
404Not Found
500Internal Server error

Error codes

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

CodeDomainCategoryMeaning
35001API_MARKETINGAPPLICATIONThere was a problem with an eBay internal system or process. Contact eBay Developer Technical Support for assistance.
35110API_MARKETINGREQUESTThe 'report_id' {report_id} was not found. Correct the 'report_id' and try the call again.

Warnings

Samples

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: Download a Report

This sample downloads the report with the ID of 1********4. The report file has an extension of .tsv.gz.

Input

This call does not use a request payload; specify the report you want to retrieve using the report_id URI parameter.
GET
https://api.ebay.com/sell/marketing/v1/ad_report/1********4

Output

A successful call returns the HTTP status code 200 Success. This method has no response payload.