getTrafficReport: eBay Analytics API | eBay Developers Program

GET/traffic_report

This method returns a report that details the user traffic received by a seller's listings.

A traffic report gives sellers the ability to review how often their listings appeared on eBay, how many times their listings are viewed, and how many purchases were made. The report also returns the report's start and end dates, and the date the information was last updated.

When using this call:

Be sure to URL-encode the values you pass in query parameters, as described in URI parameters. See the request samples below for details.
You can only specify a single metric in the sort parameter and the specified metric must be listed in the metric parameter of your request.
Parameter names are case sensitive, but metric names are not.
For example, the following are correct:
- sort=LISTING_IMPRESSION_TOTAL
- sort=listing_impression_total
- metric=listing_impression_total
However, these are incorrect:
- SORT=LISTING_IMPRESSION_TOTAL
- SORT=listing_impression_total
- Metric=listing_impression_total

For more information, see Traffic report details

Note: Beginning on October 4, 2021, the options for the following metric inputs will change:

Sorting on the SALES_CONVERSION_RATE metric will no longer be supported
Sorting on the TRANSACTION metric will no longer support ascending order; only descending order will be supported
LISTING_VIEWS_SOURCE_DIRECT will only support a 90-day query range from October 4, 2021 until early January 2022, at which time it will again support a two year query range.

Input

Resource URI

GET https://api.ebay.com/sell/analytics/v1/traffic_report?

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
dimension	array of string	This query parameter specifies the dimension, or "attribute," that is applied to the report metric. Valid values: `DAY` or `LISTING` Examples If you specify `dimension=DAY` and `metric=CLICK_THROUGH_RATE`, the traffic report contains the number of times an item displayed on a search results page and the buyer clicked through to the View Item page for each day in the date range, as in: `12-06-17: 32, 12-07-17: 54, ...` If you specify `dimension=LISTING` and `metric=LISTING_IMPRESSION_STORE`, the traffic report contains the number of times that listing appeared on the seller's store during the specified date range. For example, `LISTING_IMPRESSION_STORE: 157` means the item appeared 157 times in the store during the date range. Occurrence: Required
metric	array of string	This query parameter specifies the metrics you want covered in the report. Specify a comma-separated list of the metrics you want included in the report. Valid values: CLICK_THROUGH_RATE The number of times an item displays on the search results page divided by the number of times buyers clicked through to its View Item page. Localized name: Click through rate LISTING_IMPRESSION_SEARCH_RESULTS_PAGE The number of times the seller's listings displayed on the search results page. Note, the listing might not have been visible to the buyer due to its position on the page. Localized name: Listing impressions from the search results page LISTING_IMPRESSION_STORE The number of times the seller's listings displayed on the seller's store. Note, the listing might not have been visible to the buyer due to its position on the page. Localized name: Listing impressions from your Store LISTING_IMPRESSION_TOTAL The total number of times the seller's listings displayed on the search results page OR in the seller's store. The item is counted each time it displays on either page. However, the listing might not have been visible to the buyer due to its position on the page. This is a combination of: LISTING_IMPRESSION_SEARCH_RESULTS_PAGE + LISTING_IMPRESSION_STORE. Localized name: Total listing impressions LISTING_VIEWS_SOURCE_DIRECT The number of times a View Item page was directly accessed, such as when a buyer navigates to the page using a bookmark. Localized name: Direct views LISTING_VIEWS_SOURCE_OFF_EBAY The number of times a View Item page was accessed via a site other than eBay, such as when a buyer clicks on a link to the listing from a search engine page. Localized name: Off eBay views LISTING_VIEWS_SOURCE_OTHER_EBAY The number of times a View Item page was accessed from an eBay page that is not either the search results page or the seller's store. Localized name: Views from non-search and non-store pages within eBay LISTING_VIEWS_SOURCE_SEARCH_RESULTS_PAGE The number of times the item displayed on the search results page. Localized name: Views on the search results page LISTING_VIEWS_SOURCE_STORE The number of times a View Item page was accessed via the seller's store. Localized name: Views from your Store LISTING_VIEWS_TOTAL Total number of listings viewed. This number sums: LISTING_VIEWS_SOURCE_DIRECT LISTING_VIEWS_SOURCE_OFF_EBAY LISTING_VIEWS_SOURCE_OTHER_EBAY LISTING_VIEWS_SOURCE_SEARCH_RESULTS_PAGE LISTING_VIEWS_SOURCE_STORE. Localized name: Total views SALES_CONVERSION_RATE The number of completed transactions divided by the number of View Item page views. Equals: TRANSACTION / LISTING_VIEWS_TOTAL Localized name: Sales conversion rate TRANSACTION The total number of completed transactions. Localized name: Transaction count Occurrence: Required
filter	array of FilterField	This query parameter refines the information returned in the traffic report. Configure the following properties of the filter parameter to tune the traffic report to your needs: date_range Limits the report to the specified range of dates. Format the date range by enclosing the earliest date and end date for the report in brackets ("`[ ]`"), as follows: `[YYYYMMDD..YYYYMMDD]` The maximum range between the start and end dates is 90 days, and the earliest start date you can specify is two years prior to the current date, which is defined as 730 days (365 * 2), not accounting for Leap Year. The last date for which traffic data exists is a value called lastUpdatedDate. eBay returns an error if you specify a date range greater than 90 days, or the start date is after the lastUpdatedDate. If the specified end date is beyond the lastUpdatedDate, eBay returns data up to the lastUpdatedDate. Required: Always listing_ids This filter limits the results to only the supplied list of listingId values. You can specify to 200 different listingId values. Enclose the list of IDs with curly braces ("`{ }`"), and separate multiple values with a pipe character ("`\|`"). This filter only returns data for listings that have been either active or sold in last 90 days, and any unsold listings in the last 30 days. All listings must be the seller's and they must be listed on the marketplace specified by the marketplace_ids filter argument. marketplace_ids This filter limits the report to seller data related to only the specified marketplace ID (currently the filter allows only a single marketplace ID). Enclose the marketplace ID in curly braces ("`{ }`"). Valid values: `EBAY_AU` `EBAY_DE` `EBAY_GB` `EBAY_US` `EBAY_MOTORS_US` Required if you set the dimension parameter to `DAY`. Example filter parameter The following example shows how to configure the filter parameter with the marketplace_ids and date_range filters: `filter=marketplace_ids:{EBAY_US},date_range:[20170601..20170828]` Note: You must URL encode all the values you supply in the filter parameter, as described in URL parameters. Occurrence: Required
sort	array of SortField	This query parameter sorts the report on the specified metric. The metric you specify must be included in the configuration of the report's metric parameter. Sorting is helpful when you want to review how a specific metric is performing, such as the CLICK_THROUGH_RATE. Reports can be sorted in ascending or descending order. Precede the value of a descending-order request with a minus sign ("`-`"), for example: `sort=-CLICK_THROUGH_RATE`. Note: Beginning on October 4, 2021, the options for the following metric inputs will change: Sorting on the SALES_CONVERSION_RATE metric will no longer be supported Sorting on the TRANSACTION metric will no longer support ascending order; only descending order will be supported LISTING_VIEWS_SOURCE_DIRECT will only support a 90-day query range from October 4, 2021 until early January 2022, at which time it will again support a two year query range. 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 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.analytics.readonly

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

{ /* Report */

"dimensionMetadata" : [

{ /* Metadata */

"metadataHeader" :

{ /* MetadataHeader */

"key" : "string",

"metadataKeys" : [

{ /* Definition */

"dataType" : "DataTypeEnum : [NUMBER,STRING,DATE]",

"key" : "string",

"localizedName" : "string"

}

]

"metadataRecords" : [

{ /* MetadataRecord */

"metadataValues" : [

{ /* Value */

"applicable" : "boolean",

"value" : "any"

}

"value" :

{ /* Value */

"applicable" : "boolean",

"value" : "any"

}

]

}

"endDate" : "string",

"header" :

{ /* Header */

"dimensionKeys" : [

{ /* Definition */

"dataType" : "DataTypeEnum : [NUMBER,STRING,DATE]",

"key" : "string",

"localizedName" : "string"

}

"metrics" : [

{ /* Definition */

"dataType" : "DataTypeEnum : [NUMBER,STRING,DATE]",

"key" : "string",

"localizedName" : "string"

}

]

"lastUpdatedDate" : "string",

"records" : [

{ /* Record */

"dimensionValues" : [

{ /* Value */

"applicable" : "boolean",

"value" : "any"

}

"metricValues" : [

{ /* Value */

"applicable" : "boolean",

"value" : "any"

}

]

}

"startDate" : "string",

"warnings" : [

{ /* ErrorDetailV3 */

"category" : "string",

"domain" : "string",

"errorId" : "integer",

"inputRefIds" : [

"string"

"longMessage" : "string",

"message" : "string",

"outputRefIds" : [

"string"

"parameters" : [

{ /* ErrorParameterV3 */

"name" : "string",

"value" : "string"

}

"subdomain" : "string"

}

]

}

Response fields

Output container/field	Type	Description
dimensionMetadata	array of Metadata	A complex type containing the header of the report and the type of data containted in the rows of the report. Occurrence: Always
dimensionMetadata.metadataHeader	MetadataHeader	The container that returns the dimensionKeys and metrics headers for the report. Occurrence: Always
dimensionMetadata.metadataHeader.key	string	The key value used for the report. For example: `"key": "LISTING_ID"` Occurrence: Always
dimensionMetadata.metadataHeader.metadataKeys	array of Definition	The list of dimension key values used for the report header. Each list element contains the key name, its data type, and its localized name. For example: `"metadataKeys": [ "key": "LISTING_TITLE", "localizedName": "Listing title", "dataType": "STRING"` Occurrence: Always
dimensionMetadata.metadataHeader.metadataKeys.dataType	DataTypeEnum	Indicates the data type of the returned dimension. For example, if the dimension is `day`, the data type is `DATE`. Occurrence: Always
dimensionMetadata.metadataHeader.metadataKeys.key	string	The value the dimension or metric parameter as submitted in the request. Occurrence: Always
dimensionMetadata.metadataHeader.metadataKeys.localizedName	string	The localized name of the metric or dimension (translated into the language specified in the Accept-Language HTTP request header). For example, if Accept-Language is set to `de-DE`, the value "day" in the dimension container is returned as "tag", and a metric of TRANSACTION is returned as "Transaktionsanzahl". Occurrence: Always
dimensionMetadata.metadataRecords	array of MetadataRecord	A list of the individual report records. Occurrence: Always
dimensionMetadata.metadataRecords.metadataValues	array of Value	A list of data in a row returned in the traffic report. The data in each of the cells match the labels in headers of the report. Occurrence: Always
dimensionMetadata.metadataRecords.metadataValues.applicable	boolean	If set to `true`, this flag indicates the value in the value field is valid as computed. A value of `false` indicates one or more of the values used to calculate the value was invalid. The occurrence of this is a rare, however consider this case: suppose a buyer navigates to a View Item page at 11:59 pm (the end of the day) and purchases the item at 12:05am the next day. In this case, the item would have been purchased with `0` views for the day. Occurrence: Always
dimensionMetadata.metadataRecords.metadataValues.value	any	The value of the report data. Occurrence: Always
dimensionMetadata.metadataRecords.value	Value	The value of the key on which the report is based. For example, if the key is the listing ID, the value of this container could be: `"value": { "value": "142133954229", "applicable": true }` Occurrence: Always
dimensionMetadata.metadataRecords.value.applicable	boolean	If set to `true`, this flag indicates the value in the value field is valid as computed. A value of `false` indicates one or more of the values used to calculate the value was invalid. The occurrence of this is a rare, however consider this case: suppose a buyer navigates to a View Item page at 11:59 pm (the end of the day) and purchases the item at 12:05am the next day. In this case, the item would have been purchased with `0` views for the day. Occurrence: Always
dimensionMetadata.metadataRecords.value.value	any	The value of the report data. Occurrence: Always
endDate	string	The time stamp is formatted as an ISO 8601 string, which is based on the 24-hour Universal Coordinated Time (UTC) clock. If you specify an end date that is beyond the lastUpdatedDate value, eBay returns a report that contains data only up to the lastUpdateDate date. Format: `[YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z` Example: `2018-08-20T07:09:00.000Z` Occurrence: Always
header	Header	A complex type containing the header for the report. Occurrence: Always
header.dimensionKeys	array of Definition	A list of the dimension or metric keys returned in the report. The values for each are is returned in the associated key fields. Occurrence: Always
header.dimensionKeys.dataType	DataTypeEnum	Indicates the data type of the returned dimension. For example, if the dimension is `day`, the data type is `DATE`. Occurrence: Always
header.dimensionKeys.key	string	The value the dimension or metric parameter as submitted in the request. Occurrence: Always
header.dimensionKeys.localizedName	string	The localized name of the metric or dimension (translated into the language specified in the Accept-Language HTTP request header). For example, if Accept-Language is set to `de-DE`, the value "day" in the dimension container is returned as "tag", and a metric of TRANSACTION is returned as "Transaktionsanzahl". Occurrence: Always
header.metrics	array of Definition	The list of metrics returned in the report. The values for each are is returned in the associated key fields. Occurrence: Always
header.metrics.dataType	DataTypeEnum	Indicates the data type of the returned dimension. For example, if the dimension is `day`, the data type is `DATE`. Occurrence: Always
header.metrics.key	string	The value the dimension or metric parameter as submitted in the request. Occurrence: Always
header.metrics.localizedName	string	The localized name of the metric or dimension (translated into the language specified in the Accept-Language HTTP request header). For example, if Accept-Language is set to `de-DE`, the value "day" in the dimension container is returned as "tag", and a metric of TRANSACTION is returned as "Transaktionsanzahl". Occurrence: Always
lastUpdatedDate	string	The date and time, in ISO 8601 format, that indicates the last time the data returned in the report was updated. Occurrence: Always
records	array of Record	A complex type containing the individual data records for the traffic report. Occurrence: Always
records.dimensionValues	array of Value	A list where each element contains either the string `DAY` (if the dimension is `DAY`), or the listing ID for which the record's metric data is computed. A second array member, applicable, is always `true` for dimension values. Occurrence: Always
records.dimensionValues.applicable	boolean	If set to `true`, this flag indicates the value in the value field is valid as computed. A value of `false` indicates one or more of the values used to calculate the value was invalid. The occurrence of this is a rare, however consider this case: suppose a buyer navigates to a View Item page at 11:59 pm (the end of the day) and purchases the item at 12:05am the next day. In this case, the item would have been purchased with `0` views for the day. Occurrence: Always
records.dimensionValues.value	any	The value of the report data. Occurrence: Always
records.metricValues	array of Value	A list where each element contains a value field that indicates the record's value for the metric. Each element also contains an applicable field that indicates the veracity of the computed value. Note that there are no metric names or IDs associated with the values returned in this array. The metadata to which these values relate can be found in the key values in metadataKeys. The order of the metric values in this array equals the order of the key values in metadataHeader. Occurrence: Always
records.metricValues.applicable	boolean	If set to `true`, this flag indicates the value in the value field is valid as computed. A value of `false` indicates one or more of the values used to calculate the value was invalid. The occurrence of this is a rare, however consider this case: suppose a buyer navigates to a View Item page at 11:59 pm (the end of the day) and purchases the item at 12:05am the next day. In this case, the item would have been purchased with `0` views for the day. Occurrence: Always
records.metricValues.value	any	The value of the report data. Occurrence: Always
startDate	string	The start date of the date range used to calculate the report, in ISO 8601 format. Occurrence: Always
warnings	array of ErrorDetailV3	An array of any process errors or warnings that were generated during the processing of the call processing. Occurrence: Conditional
warnings.category	string	Identifies whether the error was in the REQUEST or happened when running the APPLICATION. Occurrence: Conditional
warnings.domain	string	The primary system where the error occurred. This is relevant for application errors. For Analytics errors, it always has the value `API_ANALYTICS`. Occurrence: Conditional
warnings.errorId	integer	A positive integer that uniquely identifies the specific error condition that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms. Traffic report error IDs range from 50001 to 50500. Occurrence: Conditional
warnings.inputRefIds	array of string	Identifies specific request elements associated with the error, if any. inputRefId's response is format specific. For JSON, use JSONPath notation. Occurrence: Conditional
warnings.longMessage	string	A more detailed explanation of the error than given in the `message` error field. Occurrence: Conditional
warnings.message	string	Information on how to correct the problem, in the end user's terms and language where applicable. Its value is at most 50 characters long. If applicable, the value is localized in the end user's requested locale. Occurrence: Conditional
warnings.outputRefIds	array of string	Identifies specific response elements associated with the error, if any. Path format is the same as `inputRefId`. Occurrence: Conditional
warnings.parameters	array of ErrorParameterV3	This optional list of name/value pairs that contain context-specific `ErrorParameter` objects, with each item in the list being a parameter (or input field name) that caused an error condition. Each `ErrorParameter` object consists of two fields, a `name` and a `value`. Occurrence: Conditional
warnings.parameters.name	string	Name of the entity that threw the error. Occurrence: Conditional
warnings.parameters.value	string	A description of the error. Occurrence: Conditional
warnings.subdomain	string	If present, indicates which subsystem in which the error occurred. Occurrence: Conditional

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
50001	API_ANALYTICS	REQUEST	Invalid dimension specified. For help, see the documentation.
50002	API_ANALYTICS	REQUEST	Invalid metric {metricName} specified. For help, see the documentation.
50003	API_ANALYTICS	REQUEST	Invalid date range. End date must be before or equal to start date.
50004	API_ANALYTICS	REQUEST	Invalid date range. Start date must be before or equal to end date.
50005	API_ANALYTICS	REQUEST	No filter is specified, which is required. For help, see the documentation.
50006	API_ANALYTICS	REQUEST	The sort field value {sortField} is not supported.
50008	API_ANALYTICS	REQUEST	The call requires at least one metric. For help, see the documentation.
50009	API_ANALYTICS	REQUEST	The call requires at least one URI query parameter. For help, see the documentation.
50013	API_ANALYTICS	REQUEST	Invalid date range format - Start Date. The format is yyyyMMdd.
50014	API_ANALYTICS	REQUEST	Invalid date range format - End Date. The format is yyyyMMdd.
50018	API_ANALYTICS	REQUEST	Neither the start date nor the end date can be in the future.
50021	API_ANALYTICS	REQUEST	Invalid filter field {filterField} specified.
50022	API_ANALYTICS	REQUEST	Specify at least one marketplace ID.
50023	API_ANALYTICS	REQUEST	The marketplace ID {marketplaceId} is not supported by this call. For help, see the documentation.
50024	API_ANALYTICS	REQUEST	The marketplace ID {marketplaceId} is not valid.
50025	API_ANALYTICS	REQUEST	The start date is too far in the past. The start date must be less than or equal to {maxStartDateInThePast}.
50026	API_ANALYTICS	REQUEST	The date range is too long. The date range must be less than or equal to {maxDateWindow}.
50027	API_ANALYTICS	REQUEST	The 'listing_id' value is empty.
50028	API_ANALYTICS	REQUEST	The maximum number of listing IDs has been exceeded. The maximum number of listing IDs is {maxListingIdsNumber}.
50029	API_ANALYTICS	REQUEST	Invalid listing ID {listingId}.
50030	API_ANALYTICS	REQUEST	Data for the listing ID {listingId} could not be found.
50031	API_ANALYTICS	REQUEST	Date range is required.
50032	API_ANALYTICS	APPLICATION	We are unable to process data for accounts, like this one, which have listed in more than a few thousand leaf categories in the past couple years.
50033	API_ANALYTICS	REQUEST	Invalid date range filter format {invalidDateRangeFilter}.
50034	API_ANALYTICS	REQUEST	Invalid listing ids filter format {invalidListingIdsFilter}.
50035	API_ANALYTICS	REQUEST	Requested sort field is not part of the list of metrics requested.
50036	API_ANALYTICS	REQUEST	{sortOrder} sort order is not supported for {sortField} metric.
50037	API_ANALYTICS	REQUEST	The Metric {metricName} does not have data available for the requested date range.
50050	API_ANALYTICS	APPLICATION	We are doing some maintenance and cannot show all your information right now. We are still tracking everything, and you will see your updated stats soon.
50500	API_ANALYTICS	APPLICATION	Internal server error. Wait a few minutes and try the call again. If error persists contact the eBay Developer Program.
50600	API_ANALYTICS	REQUEST	Data for the listing Ids {delayedListingIds} is not yet updated to {endDate}

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: Generate Traffic Report by Days

Sample 2: Generate Traffic Report by Listing

Sample 1: Generate Traffic Report by Days

This sample generates the metrics for how often the seller's listings appeared in the search results page and the seller's store, and the sales conversion rate for each date in the date range. It also limits the report to the seller's listings on the eBay US site.

Input

The input fields are marketplace_ids, date_range, dimension, and metric fields.

GEThttps://api.ebay.com/sell/analytics/v1/traffic_report?filter=marketplace_ids:%7BEBAY_US%7D,date_range:%5B20160601..20160828%5D&dimension=DAY&metric=LISTING_IMPRESSION_SEARCH_RESULTS_PAGE,LISTING_IMPRESSION_STORE,SALES_CONVERSION_RATE

Output

The output contains the metrics (metrics.key) and the records container. Each record contains the aggregate records.dimensionValues.value, which is the date, and the metric value (metricValues.value) of the metric.

{
  "reportType": "TRAFFIC",
  "header": {
    "dimensionKeys": [
      {
        "key": "DAY",
        "localizedName": "day",
        "dataType": "DATE"
      }
    ],
    "metrics": [
      {
        "key": "LISTING_IMPRESSION_SEARCH_RESULTS_PAGE",
        "localizedName": "Listing impressions from the search results page",
        "dataType": "NUMBER"
      },
      {
        "key": "LISTING_IMPRESSION_STORE",
        "localizedName": "Listing impressions from your Store",
        "dataType": "NUMBER"
      },
      {
        "key": "SALES_CONVERSION_RATE",
        "localizedName": "Sales conversion rate",
        "dataType": "NUMBER"
      }
    ]
  },
  "records": [
    {
      "dimensionValues": [
        {
          "value": "2********1",
          "applicable": true
        }
      ],
      "metricValues": [
        {
          "value": 655,
          "applicable": true
        },
        {
          "value": 0,
          "applicable": true
        },
        {
          "value": 0,
          "applicable": true
        }
      ]
    },
    {
      "dimensionValues": [
        {
          "value": "2********2",
          "applicable": true
        }
      ],
      "metricValues": [
        {
          "value": 945,
          "applicable": true
        },
        {
          "value": 23,
          "applicable": true
        },
        {
          "value": 7.41,
          "applicable": true
        }
      ]
    },
    {
      "dimensionValues": [
        {
          "value": "2********3",
          "applicable": true
        }
      ],
      "metricValues": [
        {
          "value": 896,
          "applicable": true
        },
        {
          "value": 0,
          "applicable": true
        },
        {
          "value": 15.38,
          "applicable": true
        },
        { "etc": "..." }
      ]
    }
  ],
  "startDate": "2016-06-01T07:00.00.000Z",
  "endDate": "2016-08-29T06:59.59.059Z",
  "lastUpdatedDate": "2016-09-02T06:59.059Z"
}

Sample 2: Generate Traffic Report by Listing

This sample generates the metrics for how often the seller's listings appeared in the search results page and the seller's store, and the sales conversion rate for each listing within the date range. It also limits the report to the seller's listing on the eBay US site and sorts the LISTING_IMPRESSION_STORE metric in ascending order.

Input

The input fields are marketplace_ids, date_range, dimension, and metric fields.

GEThttps://api.ebay.com/sell/analytics/v1/traffic_report?filter=marketplace_ids:%7BEBAY_US%7D,date_range:%5B20161007..20161009%5D&dimension=LISTING&metric=LISTING_IMPRESSION_SEARCH_RESULTS_PAGE,LISTING_IMPRESSION_STORE,SALES_CONVERSION_RATE&sort=LISTING_IMPRESSION_STORE

Output

The output contains the metrics (metrics.key), and the records container (records). Each record contains the aggregate records.dimensionValues.value, which is the listing Id, and the metric value (metricValues.value) of the metric.

It also includes the metadata (metadataKeys.key) and metadata records container (metadataRecords). Each of these records contain the metadataRecords.value, which is the listing Id and the (metadataRecords.metadataValues.value), which in this case, the listing title.

{
  "reportType": "TRAFFIC",
  "header": {
    "dimensionKeys": [
      {
        "key": "LISTING",
        "localizedName": "Listing id",
        "dataType": "STRING"
      }
    ],
    "metrics": [
      {
        "key": "LISTING_IMPRESSION_SEARCH_RESULTS_PAGE",
        "localizedName": "Listing impressions from the search results page",
        "dataType": "NUMBER"
      },
      {
        "key": "LISTING_IMPRESSION_STORE",
        "localizedName": "Listing impressions from your Store",
        "dataType": "NUMBER"
      },
      {
        "key": "SALES_CONVERSION_RATE",
        "localizedName": "Sales conversion rate",
        "dataType": "NUMBER"
      }
    ]
  },
  "records": [
    {
      "dimensionValues": [
        {
          "value": "1********9",
          "applicable": true
        }
      ],
      "metricValues": [
        {
          "value": 1,
          "applicable": true
        },
        {
          "value": 3,
          "applicable": true
        },
        {
          "value": 1,
          "applicable": true
        }
      ]
    },
    {
      "dimensionValues": [
        {
          "value": "1********9",
          "applicable": true
        }
      ],
      "metricValues": [
        {
          "value": 3,
          "applicable": true
        },
        {
          "value": 1,
          "applicable": true
        },
        {
          "value": 3,
          "applicable": true
        }
      ]
    },
    {
      "dimensionValues": [
        {
          "value": "3********8",
          "applicable": true
        }
      ],
      "metricValues": [
        {
          "value": 4,
          "applicable": true
        },
        {
          "value": 0,
          "applicable": true
        },
        {
          "value": 4,
          "applicable": true
        }
      ]
    }
  ],
  "dimensionMetadata": [
    {
      "metadataHeader": {
        "key": "LISTING_ID",
        "metadataKeys": [
          {
            "key": "LISTING_TITLE",
            "localizedName": "Listing title",
            "dataType": "STRING"
          }
        ]
      },
      "metadataRecords": [
        {
          "value": {
            "value": "1********9",
            "applicable": true
          },
          "metadataValues": [
            {
              "value": "Paul Mitchell curls detangling shampoo 8.5oz., leave-IN 6.8oz. & cream-gel 5.1oz.",
              "applicable": true
            }
          ]
        },
        {
          "value": {
            "value": "1********9",
            "applicable": true
          },
          "metadataValues": [
            {
              "value": "Matrix Total Results Mega Sleek  Shampoo AND Conditioner 33.8 oz.",
              "applicable": true
            }
          ]
        },
        {
          "value": {
            "value": "3********8",
            "applicable": true
          },
          "metadataValues": [
            {
              "value": "Paul MITCHELL WILD GINGER SHAMPOO 8.5 OZ AND KERATIN CREAM RINSE 8.5 OZ.",
              "applicable": true
            }
          ]
        }
      ]
    }
  ],
  "startDate": "2016-10-07T07:00:00.000Z",
  "endDate": "2016-10-10T06:59:59.999Z",
  "lastUpdatedDate": "2016-12-04T06:59:59.999Z"
}