This query parameter refines the information returned in the traffic report.

Note: URL encode all the values you supply in the filter parameter. See URL encoding query parameter values as described in URL parameters.

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. This value can be formatted in one of two ways depending on the user's time zone.
- For America/Los_Angeles time zone, input the date range using YYMMDD format. As this is the default time zone used for timestamps in the report, the time zone does not need to be specified. Enclose the earliest date and end date for the report in brackets ("[ ]"), as follows:
  
  [YYYYMMDD..YYYYMMDD]
  
  For example:
```
[20240101..20240131]
```
- For all other time zones, input the date range using ISO 8601 format, and specify the time zone using a UTC offset. A time zone offset is a positive or negative value that represents the number of hours a time zone is from UTC (see UTC Time Zone Converter for offset values for your time zone). Enclose the earliest date and end date for the report in brackets ("[ ]"), as follows:
  
  [yyyy-MM-dd'T'HH:mm:ss.SSS+|-hh:mm..yyyy-MM-dd'T'HH:mm:ss.SSS+|-hh:mm]
  
  For example:
```
[2024-01-01T02:00:00.000-05:00..2024-01-31T02:00:00.000-05:00]
```
  Note: All time values entered in this format will be dropped, and will be replaced with 00:00:00.000 for startDate and 23:59:59.000 for endDate in the response body.
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.

Note: If you specify dimension=LISTING without specifying any listing_ids in this parameter, the traffic report returned in the response contains a maximum of 200 listings.
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_ES
- EBAY_FR
- EBAY_GB
- EBAY_IT
- 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]

Encoding this portion of the query parameter sample yields:

filter=marketplace_ids:%7BEBAY_US%7D,date_range:%5B20230601..20230828%5D

See samples for additional examples.

Type that uses Metadata

Call that uses Metadata

Fields