{
  "opencollection": "1.0.0",
  "info": {
    "name": "eBay Account Advertising_eligibility Traffic_report API",
    "version": "v1.9.2"
  },
  "items": [
    {
      "info": {
        "name": "Traffic_report",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "getTrafficReport",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.ebay.com{basePath}/traffic_report",
            "params": [
              {
                "name": "dimension",
                "value": "",
                "type": "query",
                "description": "This query parameter specifies the <i>dimension</i>, or \"attribute,\" that is applied to the report <b>metric</b>.  <br><br><b>Valid values:</b> <code>DAY</code> or <code>LISTING</code>  <br><br><b>Examples</b> <ul><li>If you specify <code>dimension=DAY</code> and <code>metric=CLICK_THROUGH_RATE</code>, 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: <br><code>12-06-17: 32, 12-07-17: 54, ...</code></li> <li>If you specify <code>dimension=LISTING</code> and <code>metric=LISTING_IMPRESSION_STORE</code>, the traffic report contains the number of times that listing appeared on the seller's store during the specified date range. <br><br>For example, <code>LISTING_IMPRESSION_STORE: 157</code> means the item appeared 157 times in the store during the date range.</li><li>If you specify <code>dimension=LISTING</code> without specifying any <b>listing_ids</b> in the parameter filter, the traffic report returned in the response contains a maximum of 200 listings.</li></ul> <!-- Dimension - Enables user to specify input to slice the data that the user is interested in - For example specify listing and days as dimensions to get traffic report for all the sellers listings grouped by listing and days. Refer to DimensionEnum) -->"
              },
              {
                "name": "filter",
                "value": "",
                "type": "query",
                "description": "This query parameter refines the information returned in the traffic report. <br><p><span class=\"tablenote\"><b>Note: </b> URL encode all the values you supply in the <b>filter</b> parameter. See <b>URL encoding query parameter values</b> as described in <a href=\"/api-docs/static/rest-request-components.html#parameters\" target=\"_blank\">URL parameters</a>.</span></p>Configure the following properties of the <b>filter</b> parameter to tune the traffic report to your needs: <ul> <li><b>date_range</b> <br>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.<ul><li><b>For America/Los_Angeles time zone</b>, input the date range using <code>YYMMDD</code> 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 (\"<code>[ ]</code>\"), as follows:<br><br><code>[YYYYMMDD..YYYYMMDD]</code><br><br>For example:<br><pre>[20240101..20240131]</pre></li><li><b>For all other time zones</b>, input the date range using <a href=\"https://www.iso.org/iso-8601-date-and-time-format.html\" target=\"_blank\">ISO 8601</a> 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 <a href=\"https://www.utctime.net/utc-time-zone-converter\" target=\"_blank\">UTC Time Zone Converter</a> for offset values for your time zone). Enclose the earliest date and end date for the report in brackets (\"<code>[ ]</code>\"), as follows:<br><br><code>[yyyy-MM-dd'T'HH:mm:ss.SSS+|-hh:mm..yyyy-MM-dd'T'HH:mm:ss.SSS+|-hh:mm]</code><br><br>For example:<br><pre>[2024-01-01T02:00:00.000-05:00..2024-01-31T02:00:00.000-05:00]</pre><span class=\"tablenote\"><b>Note:</b> All time values entered in this format will be dropped, and will be replaced with <code>00:00:00.000</code> for <b>startDate</b> and <code>23:59:59.000</code> for <b>endDate</b> in the response body.</span></li></ul>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 &#42; 2), not accounting for Leap Year.<br><br><a name=\"lastUDate\"></a>The last date for which traffic data exists is a value called <b>lastUpdatedDate</b>. 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.<br><br><b>Required:</b> Always</li> <li><b>listing_ids</b> <br>This filter limits the results to only the supplied list of <b>listingId</b> values. <br><br><span class=\"tablenote\"><b>Note:</b> If you specify <code>dimension=LISTING</code> without specifying any listing_ids in this parameter, the traffic report returned in the response contains a maximum of 200 listings.</span><br>You can specify to 200 different <b>listingId</b> values. Enclose the list of IDs with curly braces (\"<code>{ }</code>\"), and separate multiple values with a pipe character (\"<code>|</code>\").  <br><br>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 <b>marketplace_ids</b> filter argument.</li> <li><b>marketplace_ids</b> <br>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 (\"<code>{ }</code>\").  <br><br><b>Valid values:</b> <ul class=\"compact\"><li><code>EBAY_AU</code></li> <li><code>EBAY_DE</code></li><li><code>EBAY_ES</code></li><li><code>EBAY_FR</code></li> <li><code>EBAY_GB</code></li> <li><code>EBAY_IT</code></li><li><code>EBAY_US</code></li> <li><code>EBAY_MOTORS_US</code></li></ul> <br><b>Required if</b> you set the <b>dimension</b> parameter to <code>DAY</code>.</li></ul> <br><b>Example filter parameter</b> <br>The following example shows how to configure the <b>filter</b> parameter with the <b>marketplace_ids</b> and <b>date_range</b> filters: <p><code>filter=marketplace_ids:{EBAY_US},date_range:[20170601..20170828]</code><br><br>Encoding this portion of the query parameter sample yields: <p><code>filter=marketplace_ids:%7BEBAY_US%7D,date_range:%5B20230601..20230828%5D</code> </p><br>See <a href=\" /api-docs/sell/analytics/resources/traffic_report/methods/getTrafficReport#h2-samples\">samples</a> for additional examples.<!-- **Filter results based on the specified filter parameters- window_days (WindowDaysEnum), date_range, marketplace_id (MarketplaceIdEnum - Only EBAY_US, EBAY_MOTORS_US, EBAY_GB, EBAY_AU, EBAY_DE are supported), listing_ids, traffic_source (Takes a list. Supported values: ORGANIC, PROMOTED_LISTINGS). Valid filters come from QueryParamEnum --> For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/sell/analytics/types/csb:FilterField"
              },
              {
                "name": "metric",
                "value": "",
                "type": "query",
                "description": "<a name=\"metrics\"></a>This query parameter specifies the metrics you want covered in the report. <br><p><span class=\"tablenote\"><b>Note: </b> Unlike names for parameters and enumerated values, metric values are not case sensitive.</span></p><b>Valid values:</b><ul>    <li><a href=\"/api-docs/sell/static/performance/traffic-report.html#click_through_rate\" target=\"_blank\">CLICK_THROUGH_RATE</a></li>    <li><a href=\"/api-docs/sell/static/performance/traffic-report.html#listing_impression_search_results_page\" target=\"_blank\">LISTING_IMPRESSION_SEARCH_RESULTS_PAGE</a> </li>    <li><a href=\"/api-docs/sell/static/performance/traffic-report.html#listing_impression_store\" target=\"_blank\">LISTING_IMPRESSION_STORE</a></li>    <li><a href=\"/api-docs/sell/static/performance/traffic-report.html#listing_impression_total\" target=\"_blank\">LISTING_IMPRESSION_TOTAL</a></li>    <li><a href=\"/api-docs/sell/static/performance/traffic-report.html#listing_views_source_direct\" target=\"_blank\">LISTING_VIEWS_SOURCE_DIRECT</a></li>    <li><a href=\"/api-docs/sell/static/performance/traffic-report.html#listing_views_source_off_ebay\" target=\"_blank\">LISTING_VIEWS_SOURCE_OFF_EBAY</a></li>    <li><a href=\"/api-docs/sell/static/performance/traffic-report.html#listing_views_source_other_ebay\" target=\"_blank\">LISTING_VIEWS_SOURCE_OTHER_EBAY</a></li>    <li><a href=\"/api-docs/sell/static/performance/traffic-report.html#listing_views_source_search_results_page\" target=\"_blank\">LISTING_VIEWS_SOURCE_SEARCH_RESULTS_PAGE</a></li>    <li><a href=\"/api-docs/sell/static/performance/traffic-report.html#listing_views_source_store\" target=\"_blank\">LISTING_VIEWS_SOURCE_STORE</a></li>    <li><a href=\"/api-docs/sell/static/performance/traffic-report.html#listing_views_total\" target=\"_blank\">LISTING_VIEWS_TOTAL</a></li>    <li><a href=\"/api-docs/sell/static/performance/traffic-report.html#sales_conversion_rate\" target=\"_blank\">SALES_CONVERSION_RATE</a></li>    <li><a href=\"/api-docs/sell/static/performance/traffic-report.html#total_impression_total\" target=\"_blank\">TOTAL_IMPRESSION_TOTAL</a></li>    <li><a href=\"/api-docs/sell/static/performance/traffic-report.html#transaction\" target=\"_blank\">TRANSACTION</a></li></ul>Specify a comma-separated list of the metrics to include them in the report. See <a href=\"/api-docs/sell/static/performance/traffic-report.html#metric-parameters\" target=\"_blank\">Using different metric parameters</a> for more information including detailed metric descriptions and localized names.<!-- Metric - Lets the user specify the list of fields that they would like to see in the report. Allowed values: CLICK_THROUGH_RATE, LISTING_IMPRESSION_SEARCH_RESULTS_PAGE, LISTING_IMPRESSION_STORE, LISTING_IMPRESSION_TOTAL, LISTING_VIEWS_SOURCE_DIRECT, LISTING_VIEWS_SOURCE_OFF_EBAY, LISTING_VIEWS_SOURCE_OTHER_EBAY, LISTING_VIEWS_SOURCE_SEARCH_RESULTS_PAGE, LISTING_VIEWS_SOURCE_STORE, LISTING_VIEWS_TOTAL, SALES_CONVERSION_RATE (DataMetricEnum), TOTAL_IMPRESSION_TOTAL, TRANSACTION -->"
              },
              {
                "name": "sort",
                "value": "",
                "type": "query",
                "description": "This query parameter sorts the report on the specified metric.  <br><br>You can only specify a single metric in the sort parameter and the specified metric must be included in the configuration of the report's <a href=\"#metrics\">metric</a> parameter.  <br><br>Sorting is helpful when you want to review how a specific metric is performing, such as the CLICK_THROUGH_RATE.  <br><br>Most reports can be sorted in ascending or descending order. Precede the value of a descending-order request with a minus sign (\"<code>-</code>\"), for example: <code>sort=-CLICK_THROUGH_RATE</code>.<br /><br /><span class=\"tablenote\"><b>Note:</b> There are a couple of constraints on sorting the report by different metrics:<ul><li>Sorting on the <code>SALES_CONVERSION_RATE</code> metric is not supported</li><li>The <code>TRANSACTION</code> metric can only be sorted in the descending order (sorting in the ascending order is not supported).</li></ul></span> <!-- Sort order for a collection of resources: Specify the metric value to be sorted. Allowed values are from DataMetricEnum --> For implementation help, refer to eBay API documentation at https://developer.ebay.com/api-docs/sell/analytics/types/csb:SortField"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "https://auth.ebay.com/oauth2/authorize",
              "accessTokenUrl": "https://api.ebay.com/identity/v1/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "This method returns a report that details the user traffic received by a seller's listings. <br><br>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.  <br><br>For more information, see <a href=\"/api-docs/sell/static/performance/traffic-report.html\" target=\"_blank\">Traffic "
        }
      ]
    }
  ],
  "bundled": true
}