getReportMetadataForReportType: eBay Marketing API

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

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

funding_model=string&

channel=string

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
report_type	string	This path parameter specifies the name of the report type whose metadata you want to retrieve. For details about available report types and their descriptions, refer to the ReportTypeEnum. Occurrence: Required
funding_model	string	The funding model used in the report. The funding model must be compatible with the report type specified in the path parameter. Refer to the FundingModelEnum type for supported values. Occurrence: Optional
channel	string	The channel used in the report. The channel must be compatible with the report type specified in the path parameter. 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

Copy complete valid JSON to clipboard

{ /* ReportMetadata */

"dimensionMetadata" : [

{ /* DimensionMetadata */

"dataType" : "DataTypeEnum : [DATE,INTEGER,DOUBLE...]",

"dimensionKey" : "string",

"dimensionKeyAnnotations" : [

{ /* DimensionKeyAnnotation */

"annotationKey" : "string",

"dataType" : "DataTypeEnum : [DATE,INTEGER,DOUBLE...]"

}

]

}

"maxNumberOfDimensionsToRequest" : "integer",

"maxNumberOfMetricsToRequest" : "integer",

"channel" : "ChannelEnum : [ON_SITE,OFF_SITE]",

"metricMetadata" : [

{ /* MetricMetadata */

"dataType" : "DataTypeEnum : [DATE,INTEGER,DOUBLE...]",

"metricKey" : "string"

}

"reportType" : "ReportTypeEnum : [ACCOUNT_PERFORMANCE_REPORT,ALL_CAMPAIGN_PERFORMANCE_SUMMARY_REPORT,CAMPAIGN_PERFORMANCE_REPORT...]"

}

Response fields

Output container/field	Type	Description
dimensionMetadata	array of DimensionMetadata	A list containing the metadata for the dimension used in the report. Occurrence: Always
dimensionMetadata.dataType	DataTypeEnum	The data type of the dimension value used to create the report. Occurrence: Always
dimensionMetadata.dimensionKey	string	The name of the dimension used to create the report. Occurrence: Always
dimensionMetadata.dimensionKeyAnnotations	array of DimensionKeyAnnotation	An list of annotation keys associated with the specified dimension of the report. Occurrence: Always
dimensionMetadata.dimensionKeyAnnotations.annotationKey	string	An annotation key associated with the dimension. Occurrence: Always
dimensionMetadata.dimensionKeyAnnotations.dataType	DataTypeEnum	The data type of the annotation key value. Occurrence: Always
maxNumberOfDimensionsToRequest	integer	The maximum number of dimensions that can be requested for the specified report type. Occurrence: Always
maxNumberOfMetricsToRequest	integer	The maximum number of metrics that can be requested for the specified report type. Occurrence: Always
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
metricMetadata	array of MetricMetadata	A list containing the metadata for the metrics in the report. Occurrence: Always
metricMetadata.dataType	DataTypeEnum	The data type of the returned metric value. Occurrence: Always
metricMetadata.metricKey	string	The name of the metric. Occurrence: Always
reportType	ReportTypeEnum	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.

Status	Meaning
200	Success
400	Bad Request
403	Forbidden
404	Not Found
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.
35089	API_MARKETING	REQUEST	You are currently not authorized to access the Promoted Listings Advanced program. Please contact support.
35116	API_MARKETING	REQUEST	Supplied 'report_type' not found. Valid values are: {supportedReportTypes}.
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}.
35132	API_MARKETING	REQUEST	The 'channels' {supportedChannels} are not supported for the 'report_type' {reportType}.
35133	API_MARKETING	REQUEST	The 'fundingModel' is not supported for the 'report_type' {reportType}.

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 LISTING_PERFORMANCE_REPORT

Sample 2: Get Metadata for Cost-per-Sale LISTING_PERFORMANCE_REPORT

Sample 3: Get Metadata for Cost-per-Click LISTING_PERFORMANCE_REPORT

Sample 1: Get Metadata for LISTING_PERFORMANCE_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/LISTING_PERFORMANCE_REPORT

Output

If successful, the call returns a reportType container with the dimensionMetadata, metricMetadata, maxNumberOfDimensionsToRequest, and maxNumberOfMetricsToRequest fields for the specified report type. The following sample is shown if both funding_model and channel are both null.

{
   "reportType": "LISTING_PERFORMANCE_REPORT",
   "dimensionMetadata": [
       {
           "dimensionKey": "campaign_id",
           "dataType": "LONG",
           "dimensionKeyAnnotations": [
               {
                   "annotationKey": "campaign_name",
                   "dataType": "STRING"
               },
               {
                   "annotationKey": "campaign_start_date",
                   "dataType": "DATE"
               },
               {
                   "annotationKey": "campaign_end_date",
                   "dataType": "DATE"
               },
               {
                   "annotationKey": "target_type",
                   "dataType": "STRING"
               },
               {
                   "annotationKey": "daily_budget",
                   "dataType": "STRING"
               }
           ]
       },
       {
           "dimensionKey": "listing_id",
           "dataType": "LONG",
           "dimensionKeyAnnotations": [
               {
                   "annotationKey": "listing_title",
                   "dataType": "STRING"
               },
               {
                   "annotationKey": "listing_quantity_sold",
                   "dataType": "LONG"
               },
               {
                   "annotationKey": "listing_quantity_available",
                   "dataType": "LONG"
               },
               {
                   "annotationKey": "listing_start_date",
                   "dataType": "DATE"
               },
               {
                   "annotationKey": "listing_end_date",
                   "dataType": "DATE"
               },
               {
                   "annotationKey": "listing_price",
                   "dataType": "DOUBLE"
               },
               {
                   "annotationKey": "listing_title",
                   "dataType": "STRING"
               },
               {
                   "annotationKey": "listing_format",
                   "dataType": "STRING"
               }
           ]
       },
       {
           "dimensionKey": "ad_group_id",
           "dataType": "LONG",
           "dimensionKeyAnnotations": [
               {
                   "annotationKey": "ad_group_name",
                   "dataType": "STRING"
               }
           ]
       },
       {
           "dimensionKey": "inventory_reference_id",
           "dataType": "STRING"
       },
       {
           "dimensionKey": "inventory_reference_type",
           "dataType": "STRING"
       },
       {
           "dimensionKey": "day",
           "dataType": "DATE"
       }
   ],
   "metricMetadata": [
       {
           "metricKey": "impressions",
           "dataType": "LONG"
       },
       {
           "metricKey": "clicks",
           "dataType": "LONG"
       },
       {
           "metricKey": "ad_fees",
           "dataType": "DOUBLE"
       },
       {
           "metricKey": "sales",
           "dataType": "LONG"
       },
       {
           "metricKey": "sale_amount",
           "dataType": "DOUBLE"
       },
       {
           "metricKey": "ctr",
           "dataType": "DOUBLE"
       },
       {
           "metricKey": "avg_cost_per_sale",
           "dataType": "DOUBLE"
       },
       {
           "metricKey": "cpc_impressions",
           "dataType": "DOUBLE"
       },
       {
           "metricKey": "cpc_clicks",
           "dataType": "DOUBLE"
       },
       {
           "metricKey": "cpc_attributed_sales",
           "dataType": "LONG"
       },
       {
           "metricKey": "cpc_ctr",
           "dataType": "DOUBLE"
       },
       {
           "metricKey": "cpc_ad_fees_listingsite_currency",
           "dataType": "DOUBLE"
       },
       {
           "metricKey": "cpc_sale_amount_listingsite_currency",
           "dataType": "DOUBLE"
       },
       {
           "metricKey": "cpc_avg_cost_per_sale",
           "dataType": "DOUBLE"
       },
       {
           "metricKey": "cpc_return_on_ad_spend",
           "dataType": "DOUBLE"
       },
       {
           "metricKey": "cpc_conversion_rate",
           "dataType": "DOUBLE"
       },
       {
           "metricKey": "cpc_sale_amount_payout_currency",
           "dataType": "DOUBLE"
       },
       {
           "metricKey": "cost_per_click",
           "dataType": "DOUBLE"
       },
       {
           "metricKey": "cpc_ad_fees_payout_currency",
           "dataType": "DOUBLE"
       }
   ],
   "maxNumberOfDimensionsToRequest": 6,
   "maxNumberOfMetricsToRequest": 19
}

Sample 2: Get Metadata for Cost-per-Sale LISTING_PERFORMANCE_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 and the funding_model URI parameter.

GEThttps://api.ebay.com/sell/marketing/v1/ad_report_metadata/LISTING_PERFORMANCE_REPORT?funding_model=COST_PER_SALE

Output

If successful, the call returns a reportType container with the dimensionMetadata, metricMetadata, maxNumberOfDimensionsToRequest, and maxNumberOfMetricsToRequest fields for the specified report type. If funding_model is COST_PER_SALE, only COST_PER_SALE metrics is shown in metricMetadata and dimensionMetaData.

Sample 3: Get Metadata for Cost-per-Click LISTING_PERFORMANCE_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, the funding_model URI parameter and the channel URI parameter.

GEThttps://api.ebay.com/sell/marketing/v1/ad_report_metadata/LISTING_PERFORMANCE_REPORT?funding_model=COST_PER_CLICK&channel=ON_SITE

Output

If successful, the call returns a reportType container with the dimensionMetadata, metricMetadata, channel, maxNumberOfDimensionsToRequest, and maxNumberOfMetricsToRequest fields for the specified report type. If funding_model is COST_PER_CLICK and channel is null or ON_SITE, only COST_PER_CLICK metrics is shown in metricMetadata and dimensionMetaData as seen from below sample. If funding_model is COST_PER_CLICK and channel is OFF_SITE, only SFA metrics is shown in metricMetadata and dimensionMetadata.

{
   "reportType": "LISTING_PERFORMANCE_REPORT",
   "dimensionMetadata": [
       {
           "dimensionKey": "campaign_id",
           "dataType": "LONG",
           "dimensionKeyAnnotations": [
               {
                   "annotationKey": "campaign_name",
                   "dataType": "STRING"
               },
               {
                   "annotationKey": "campaign_start_date",
                   "dataType": "DATE"
               },
               {
                   "annotationKey": "campaign_end_date",
                   "dataType": "DATE"
               },
               {
                   "annotationKey": "target_type",
                   "dataType": "STRING"
               },
               {
                   "annotationKey": "daily_budget",
                   "dataType": "STRING"
               }
           ]
       },
       {
           "dimensionKey": "listing_id",
           "dataType": "LONG",
           "dimensionKeyAnnotations": [
               {
                   "annotationKey": "listing_title",
                   "dataType": "STRING"
               },
               {
                   "annotationKey": "listing_quantity_sold",
                   "dataType": "LONG"
               },
               {
                   "annotationKey": "listing_quantity_available",
                   "dataType": "LONG"
               },
               {
                   "annotationKey": "listing_start_date",
                   "dataType": "DATE"
               },
               {
                   "annotationKey": "listing_end_date",
                   "dataType": "DATE"
               },
               {
                   "annotationKey": "listing_price",
                   "dataType": "DOUBLE"
               },
               {
                   "annotationKey": "listing_title",
                   "dataType": "STRING"
               },
               {
                   "annotationKey": "listing_format",
                   "dataType": "STRING"
               }
           ]
       },
       {
           "dimensionKey": "ad_group_id",
           "dataType": "LONG",
           "dimensionKeyAnnotations": [
               {
                   "annotationKey": "ad_group_name",
                   "dataType": "STRING"
               }
           ]
       },
       {
           "dimensionKey": "inventory_reference_id",
           "dataType": "STRING"
       },
       {
           "dimensionKey": "inventory_reference_type",
           "dataType": "STRING"
       },
       {
           "dimensionKey": "day",
           "dataType": "DATE"
       }
   ],
   "channel": "ON_SITE",
   "metricMetadata": [
       {
           "metricKey": "cpc_impressions",
           "dataType": "DOUBLE"
       },
       {
           "metricKey": "cpc_clicks",
           "dataType": "DOUBLE"
       },
       {
           "metricKey": "cpc_attributed_sales",
           "dataType": "LONG"
       },
       {
           "metricKey": "cpc_ctr",
           "dataType": "DOUBLE"
       },
       {
           "metricKey": "cpc_ad_fees_listingsite_currency",
           "dataType": "DOUBLE"
       },
       {
           "metricKey": "cpc_sale_amount_listingsite_currency",
           "dataType": "DOUBLE"
       },
       {
           "metricKey": "cpc_avg_cost_per_sale",
           "dataType": "DOUBLE"
       },
       {
           "metricKey": "cpc_return_on_ad_spend",
           "dataType": "DOUBLE"
       },
       {
           "metricKey": "cpc_conversion_rate",
           "dataType": "DOUBLE"
       },
       {
           "metricKey": "cpc_sale_amount_payout_currency",
           "dataType": "DOUBLE"
       },
       {
           "metricKey": "cost_per_click",
           "dataType": "DOUBLE"
       },
       {
           "metricKey": "cpc_ad_fees_payout_currency",
           "dataType": "DOUBLE"
       }
   ],
   "maxNumberOfDimensionsToRequest": 6,
   "maxNumberOfMetricsToRequest": 12
}