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. You can retrieve metadata for all report types,funding models and channels, or you can filter based on funding model and/or channel.
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
This method is supported in Sandbox environment. To access the endpoint, just replace the api.ebay.com root URI with api.sandbox.ebay.com
URI parameters
| Parameter | Type | Description |
|---|---|---|
| funding_model | string | This query parameter is used only if the user wants to see report metadata for a specific funding model. Refer to the FundingModelEnum type for supported values. Occurrence: Optional |
| channel | string | This query parameter is used only if the user wants to see COST_PER_CLICK report metadata for a specific channel. Refer to the ChannelEnum type for supported values. Note: The channel parameter is only applicable for COST_PER_CLICK funding model. Occurrence: Optional |
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 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/field | Type | Description |
|---|---|---|
| reportMetadata | array of ReportMetadata | A list of the metadata for the associated report type. Occurrence: Always |
| reportMetadata.dimensionMetadata | array of DimensionMetadata | A list containing the metadata for the dimension used in the report. Occurrence: Always |
| reportMetadata.dimensionMetadata.dataType | DataTypeEnum | The data type of the dimension value used to create the report. Occurrence: Always |
| reportMetadata.dimensionMetadata.dimensionKey | string | The name of the dimension used to create the report. Occurrence: Always |
| reportMetadata.dimensionMetadata.dimensionKeyAnnotations | array of DimensionKeyAnnotation | An list of annotation keys associated with the specified dimension of the report. Occurrence: Always |
| reportMetadata.dimensionMetadata.dimensionKeyAnnotations.annotationKey | string | An annotation key associated with the dimension. Occurrence: Always |
| reportMetadata.dimensionMetadata.dimensionKeyAnnotations.dataType | DataTypeEnum | The data type of the annotation key value. Occurrence: Always |
| reportMetadata.maxNumberOfDimensionsToRequest | integer | The maximum number of dimensions that can be requested for the specified report type. Occurrence: Always |
| reportMetadata.maxNumberOfMetricsToRequest | integer | The maximum number of metrics that can be requested for the specified report type. Occurrence: Always |
| reportMetadata.channel | ChannelEnum | This field indicates whether a COST_PER_CLICK report type is related to an ON_SITE or OFF_SITE Promoted Listings campaign. This field is not returned for COST_PER_SALE report types since COST_PER_SALE campaigns are only available ON_SITE. Occurrence: Conditional |
| reportMetadata.metricMetadata | array of MetricMetadata | A list containing the metadata for the metrics in the report. Occurrence: Always |
| reportMetadata.metricMetadata.dataType | DataTypeEnum | The data type of the returned metric value. Occurrence: Always |
| reportMetadata.metricMetadata.metricKey | string | The name of the metric. Occurrence: Always |
| reportMetadata.reportType | ReportTypeEnum | The 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.
| Status | Meaning |
|---|---|
| 200 | Success |
| 400 | Bad Request |
| 500 | Internal Server error |
Error codes
For more on errors, plus the codes of other common errors, see Handling errors.
| Code | Domain | Category | Meaning |
|---|---|---|---|
| 35001 | API_MARKETING | APPLICATION | There was a problem with an eBay internal system or process. Contact eBay Developer Technical Support for assistance. |
| 35121 | API_MARKETING | REQUEST | The 'fundingModel' is invalid. Valid values are: {supportedFundingModels}. |
| 35125 | API_MARKETING | REQUEST | The 'channel' is invalid. Valid values are: {supportedChannels}. |
| 35127 | API_MARKETING | REQUEST | The 'channels' are not supported for the 'fundingModel' {fundingModel}. |
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 All Reports
This sample returns the metadata that is included in each report type.
Input
This call does not use a request payload.
GEThttps://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, and channel(sometimes) fields for the associated report type.