Skip to main content

GET/ad_report_metadata/{report_type}

This call retrieves metadata that details the fields used by a specific Promoted Listings report type. Use the report_type path parameter to indicate metadata to retrieve.

This method does not use a request payload.

Note: The reporting of some data related to sales and ad-fees may require a 72-hour (maximum) adjustment period which is often referred to as the Reconciliation Period. Such adjustment periods should, on average, be minimal. However, at any given time, the payments tab may be used to view those amounts that have actually been charged.

Input

Resource URI (production)

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

URI parameters

ParameterTypeDescription
report_typestringThe name of the report type whose metadata you want to retrieve.

Tip: For details about available report types and their descriptions, refer to the ReportTypeEnum.

Occurrence: Required

HTTP request headers

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

This method has no additional required headers. See HTTP request headers- opens rest request components page for details.

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.

Request payload

This call has no payload.

Request fields

This call has no field definitions.

Output

HTTP response headers

This call has no response headers.

Response payload

Response fields

Output container/fieldTypeDescription
dimensionMetadataarray of DimensionMetadata

A list containing the metadata for the dimension used in the report.

Occurrence: Always

dimensionMetadata.dataTypeDataTypeEnum

The data type of the dimension value used to create the report.

Occurrence: Always

dimensionMetadata.dimensionKeystring

The name of the dimension used to create the report.

Occurrence: Always

dimensionMetadata.dimensionKeyAnnotationsarray of DimensionKeyAnnotation

An list of annotation keys associated with the specified dimension of the report.

Occurrence: Always

dimensionMetadata.dimensionKeyAnnotations.annotationKeystring

An annotation key associated with the dimension.

Occurrence: Always

dimensionMetadata.dimensionKeyAnnotations.dataTypeDataTypeEnum

The data type of the annotation key value.

Occurrence: Always

maxNumberOfDimensionsToRequestinteger

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

Occurrence: Always

maxNumberOfMetricsToRequestinteger

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

Occurrence: Always

metricMetadataarray of MetricMetadata

A list containing the metadata for the metrics in the report.

Occurrence: Always

metricMetadata.dataTypeDataTypeEnum

The data type of the returned metric value.

Occurrence: Always

metricMetadata.metricKeystring

The name of the metric.

Occurrence: Always

reportTypeReportTypeEnum

The report_type, as specified in the request to create 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.

StatusMeaning
200Success
403Forbidden
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.
35089API_MARKETINGREQUESTYou are currently not authorized to access the Promoted Listings Advanced program. Please contact support
35116API_MARKETINGREQUESTSupplied 'report_type' not found. Valid values are: {supportedReportTypes}.

Warnings

This call has no 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 a Specific Report

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

Input

Specify the report type you want returned using the report_type URI parameter.

GEThttps://api.ebay.com/sell/marketing/v1/ad_report_metadata/ACCOUNT_PERFORMANCE_REPORT

Output

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