marketing APIv1.10.0

getReportMetadata

GET
/ad_report_metadata
This call retrieves information that details the fields used in each of the Promoted Listings reports. Use the returned information to configure the different types of Promoted Listings reports.

The request for this method does not use a payload or any URI parameters.

Input

Resource URI (production)

GET https://api.ebay.com/sell/marketing/v1/ad_report_metadata

URI parameters

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 client credentials 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

See OAuth access tokens for more information.

Output

HTTP response headers

Output container/fieldTypeDescription
reportMetadataarray of ReportMetadataA list of the metadata for the associated report type.

Occurrence: Always

reportMetadata.dimensionMetadataarray of DimensionMetadataA list containing the metadata for the dimension used in the report.

Occurrence: Always

reportMetadata.dimensionMetadata.dataTypeDataTypeEnumThe data type of the dimension value used to create the report.

Occurrence: Always

reportMetadata.dimensionMetadata.dimensionKeystringThe name of the dimension used to create the report.

Occurrence: Always

reportMetadata.dimensionMetadata.dimensionKeyAnnotationsarray of DimensionKeyAnnotationAn list of annotation keys associated with the specified dimension of the report.

Occurrence: Always

reportMetadata.dimensionMetadata.dimensionKeyAnnotations.annotationKeystringAn annotation key associated with the dimension.

Occurrence: Always

reportMetadata.dimensionMetadata.dimensionKeyAnnotations.dataTypeDataTypeEnumThe data type of the annotation key value.

Occurrence: Always

reportMetadata.maxNumberOfDimensionsToRequestintegerThe maximum number of dimensions that can be requested for the specified report type.

Occurrence: Always

reportMetadata.maxNumberOfMetricsToRequestintegerThe maximum number of metrics that can be requested for the specified report type.

Occurrence: Always

reportMetadata.metricMetadataarray of MetricMetadataA list containing the metadata for the metrics in the report.

Occurrence: Always

reportMetadata.metricMetadata.dataTypeDataTypeEnumThe data type of the returned metric value.

Occurrence: Always

reportMetadata.metricMetadata.metricKeystringThe name of the metric.

Occurrence: Always

reportMetadata.reportTypeReportTypeEnumThe report_type, as specified in the request to create the report task.

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.

StatusMeaning
200Success
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.

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: Get Metadata for All Reports

This sample returns the metadata that is included in each report type.

Input

This call does not use a request payload.
GET
https://api.ebay.com/sell/marketing/v1/ad_report_metadata

Output

If successful, the call returns a container for each report type with the dimensionMetadata, metricMetadata, maxNumberOfDimensionsToRequest, and maxNumberOfMetricsToRequest fields for the associated report type.