Traffic Sources API Documentation

Use the Traffic Sources API for Amazon traffic analysis. Review request parameters, response fields, and runnable examples.

Availability: Available

This endpoint is active in the v1 gateway, OpenAPI, and subscription catalog. A successful call consumes 1 billing unit.

POST /v1/amazon/traffic/sources

The request and response fields below match the current public contract.

Quick call

First create an API key, then store it in a server-side environment variable:

export ECOMMERCE_DATA_API_KEY="your_api_key"

curl --request POST \
  --url https://ecommercedataapi.com/v1/amazon/traffic/sources \
  --header "Content-Type: application/json" \
  --header "X-API-Key: ${ECOMMERCE_DATA_API_KEY}" \
  --data '{
  "marketplace": "US",
  "page": 1,
  "size": 1,
  "q": "Q"
}'

Integrate with an AI CLI

Copy for your AI CLI

Paste this task into Codex, Claude Code, Gemini CLI, or another coding agent.

Integrate the "Traffic Sources" endpoint from Ecommerce Data API into the current repository. Make the changes directly instead of only returning sample code.

API documentation: https://ecommercedataapi.com/en/docs/amazon/traffic/sources
Endpoint: POST https://ecommercedataapi.com/v1/amazon/traffic/sources
API key environment variable: ECOMMERCE_DATA_API_KEY

Example request:
{
"marketplace": "US",
"page": 1,
"size": 1,
"q": "Q"
}

Requirements:
1. Read the API documentation first, then inspect the repository's language, framework, HTTP client, directory structure, and environment-variable conventions.
2. Reuse the existing API client and error-handling patterns. If none exist, add the smallest reusable Ecommerce Data API client and an endpoint-specific wrapper.
3. Read the key from the server-side ECOMMERCE_DATA_API_KEY environment variable and send Content-Type: application/json plus the X-API-Key header. Never write a real key into source code, browser code, logs, test snapshots, or Git.
4. If the environment variable is missing, tell me to configure ECOMMERCE_DATA_API_KEY myself. Do not request, print, or invent the real key, and continue implementing code and tests that do not require a live request.
5. Implement request and response types from the documentation. Handle non-2xx responses, request_id, error.code, error.message, and 429 rate limits.
6. Add a minimal usage example or test that follows the repository's conventions. Run one minimal live request only when the key is already configured and external requests are allowed; otherwise use mocks or static validation.
7. Run the relevant formatter, type checker, and tests. Report changed files, usage, verification results, and any environment variable I still need to configure.

Need an API key?Create API key

Open this request in Postman

Download the preconfigured collection for this endpoint, then import it into Postman.

Download Postman config

Set the apiKey collection variable after import.Create API key

Node.js example

const response = await fetch(
  'https://ecommercedataapi.com/v1/amazon/traffic/sources',
  {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      'X-API-Key': process.env.ECOMMERCE_DATA_API_KEY,
    },
    body: JSON.stringify({
      marketplace: 'US',
      page: 1,
      size: 1,
      q: 'Q',
    }),
  }
);

const result = await response.json();

if (!response.ok) {
  throw new Error(`${result.error?.code}: ${result.error?.message}`);
}

console.log(result.data);

Python example

import os
import requests

response = requests.post(
    "https://ecommercedataapi.com/v1/amazon/traffic/sources",
    headers={
        "Content-Type": "application/json",
        "X-API-Key": os.environ["ECOMMERCE_DATA_API_KEY"],
    },
    json={
        "marketplace": "US",
        "page": 1,
        "size": 1,
        "q": "Q",
    },
    timeout=30,
)

response.raise_for_status()
print(response.json()["data"])

Request body

Send the fields below directly in the JSON body without an extra wrapper. Undefined fields are rejected.

Field	Type	Required	Description	Example
`marketplace`	String	Yes	Amazon marketplace code. Supported values are listed in the schema.	US
`month`	String	No	Data month. Use the format documented for this endpoint, usually yyyyMM.	202203
`order`	Object	No	Sort definition.	{}
`order.desc`	Boolean	No	Use true for descending order or false for ascending order.	true
`order.field`	String	No	Field used to sort the results.	searches
`page`	Integer	No	Page number starting at 1.	1
`q`	String	Yes	Q.	B07Z82895W
`returnFields`	String	No	Optional comma-separated response fields. Omit it to receive the standard payload.	keywords,searchKeywords,acKeywords
`size`	Integer	No	Number of results per page.	50

Response structure

Field	Type	Description
`request_id`	String	Unique identifier for this request.
`data`	Object	Endpoint business data.

The fields below are inside data. For array endpoints they describe one array item; for paginated endpoints they describe one record in items[].

Response fields

Field	Type	Description	Example
`keywords`	Integer	Keywords.	1
`searchKeywords`	Integer	Search keywords.	12
`acKeywords`	String	Ac keywords.	13
`editorialKeywords`	Integer	Editorial keywords.	13
`fourStarsKeywords`	Integer	Four stars keywords.	14
`hrKeywords`	Integer	Hr keywords.	1
`adKeywords`	Integer	Ad keywords.	3
`videoKeywords`	Integer	Video keywords.	4
`brandKeywords`	Integer	Brand keywords.	5
`badgeLabels`	Array	Badge labels.	[“SEARCH”, “OFFICIAL”, “AD”]
`badgeDetails`	String	Badge details.	{“SEARCH”: [“NATURAL_SEARCHING”],”OFFICIAL”: [“AMAZON_CHOICE”],”AD”: [“SPONSOR_BRAND”,”SPONSOR_VIDEO”,”HIGHLY_RATED”,”ADS”]}
`asinInfo`	Object	ASIN info.	-
`asinInfo.asin`	String	ASIN.	B078J8VPVW
`asinInfo.asinUrl`	String	ASIN URL.	https://www.amazon.com/dp/B08GHW4TBS
`asinInfo.currency`	String	Currency.	$
`asinInfo.price`	Number	Price.	23
`asinInfo.rating`	Number	Rating.	234
`asinInfo.reviews`	Integer	Reviews.	23
`asinInfo.title`	String	Title.	Diapers Size 2, 186 Count - Pampers Swaddlers Disposable Baby Diapers, ONE MONTH SUPPLY
`asinInfo.sku`	String	Sku.	["Color: Beige","Size: 47 inches"]
`asinInfo.variations`	Integer	Variations.	2
`asinInfo.nodeId`	Integer	Node ID.	12097479011
`asinInfo.nodeIdPath`	String	Node ID path.	172282:24046923011:172541:12097479011
`asinInfo.nodeLabelPath`	String	Node label path.	Electronics:Headphones, Earbuds & Accessories:Headphones & Earbuds:Over-Ear Headphones
`asinInfo.bsrRank`	Integer	BSR rank.	175204

Response example

{
  "request_id": "8fb43e59-4ff9-4dc8-a4b7-2ed164e45ab8",
  "data": {
    "guestId": null,
    "pages": 0,
    "page": 1,
    "size": 1,
    "total": 9,
    "took": 0,
    "url": null,
    "order": {
      "field": "",
      "desc": true
    },
    "items": [
      {
        "keywords": 1128,
        "searchKeywords": 1037,
        "acKeywords": 0,
        "editorialKeywords": 0,
        "fourStarsKeywords": 0,
        "hrKeywords": 13,
        "adKeywords": 225,
        "videoKeywords": 9,
        "brandKeywords": 0,
        "badgeDetails": {
          "AD": ["SPONSOR_VIDEO"],
          "SEARCH": ["NATURAL_SEARCHING"]
        },
        "badgeLabels": ["SEARCH"],
        "asinInfo": {
          "asin": "B07Z82895W",
          "asinUrl": "https://www.amazon.com/dp/B07Z82895W?psc=1",
          "currency": null,
          "price": 9.99,
          "rating": 4.5,
          "reviews": 68849,
          "sku": "Color: BLACK",
          "title": "LISEN Cell Phone Stand Adjustable for iPhone Phone Holder for Desk, Office Desk Accessories Computer PC for iPhone Stand Gaming Essentials Fit Otterbox Case Phones Switch Kindle iPad Air Tablet 4-10in",
          "variations": 9,
          "category1Id": null,
          "category1Name": null,
          "nodeId": 23690036011,
          "nodeIdPath": "2335752011:2407755011:23690036011",
          "nodeLabelPath": "Cell Phones & Accessories:Accessories:Stands",
          "bsrRank": 422,
          "bsrId": "wireless",
          "bsrLabel": "Cell Phones & Accessories"
        }
      }
    ],
    "terminal": null,
    "hasNextPage": null,
    "guestVisited": false
  }
}

See Errors and rate limits for error payloads, request tracing, and rate-limit headers.

Availability: Available

This endpoint is active in the v1 gateway, OpenAPI, and subscription catalog. A successful call consumes 1 billing unit.

POST /v1/amazon/traffic/sources

The request and response fields below match the current public contract.

Quick call

First create an API key, then store it in a server-side environment variable:

export ECOMMERCE_DATA_API_KEY="your_api_key"

curl --request POST \
  --url https://ecommercedataapi.com/v1/amazon/traffic/sources \
  --header "Content-Type: application/json" \
  --header "X-API-Key: ${ECOMMERCE_DATA_API_KEY}" \
  --data '{
  "marketplace": "US",
  "page": 1,
  "size": 1,
  "q": "Q"
}'

Integrate with an AI CLI

Copy for your AI CLI

Paste this task into Codex, Claude Code, Gemini CLI, or another coding agent.

Integrate the "Traffic Sources" endpoint from Ecommerce Data API into the current repository. Make the changes directly instead of only returning sample code.

Example request:
{
"marketplace": "US",
"page": 1,
"size": 1,
"q": "Q"
}

Need an API key?Create API key

Open this request in Postman

Download the preconfigured collection for this endpoint, then import it into Postman.

Download Postman config

Set the apiKey collection variable after import.Create API key

Node.js example

const response = await fetch(
  'https://ecommercedataapi.com/v1/amazon/traffic/sources',
  {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      'X-API-Key': process.env.ECOMMERCE_DATA_API_KEY,
    },
    body: JSON.stringify({
      marketplace: 'US',
      page: 1,
      size: 1,
      q: 'Q',
    }),
  }
);

const result = await response.json();

if (!response.ok) {
  throw new Error(`${result.error?.code}: ${result.error?.message}`);
}

console.log(result.data);

Python example

import os
import requests

response = requests.post(
    "https://ecommercedataapi.com/v1/amazon/traffic/sources",
    headers={
        "Content-Type": "application/json",
        "X-API-Key": os.environ["ECOMMERCE_DATA_API_KEY"],
    },
    json={
        "marketplace": "US",
        "page": 1,
        "size": 1,
        "q": "Q",
    },
    timeout=30,
)

response.raise_for_status()
print(response.json()["data"])

Request body

Send the fields below directly in the JSON body without an extra wrapper. Undefined fields are rejected.

Field	Type	Required	Description	Example
`marketplace`	String	Yes	Amazon marketplace code. Supported values are listed in the schema.	US
`month`	String	No	Data month. Use the format documented for this endpoint, usually yyyyMM.	202203
`order`	Object	No	Sort definition.	{}
`order.desc`	Boolean	No	Use true for descending order or false for ascending order.	true
`order.field`	String	No	Field used to sort the results.	searches
`page`	Integer	No	Page number starting at 1.	1
`q`	String	Yes	Q.	B07Z82895W
`returnFields`	String	No	Optional comma-separated response fields. Omit it to receive the standard payload.	keywords,searchKeywords,acKeywords
`size`	Integer	No	Number of results per page.	50

Response structure

Field	Type	Description
`request_id`	String	Unique identifier for this request.
`data`	Object	Endpoint business data.

The fields below are inside data. For array endpoints they describe one array item; for paginated endpoints they describe one record in items[].

Response fields

Field	Type	Description	Example
`keywords`	Integer	Keywords.	1
`searchKeywords`	Integer	Search keywords.	12
`acKeywords`	String	Ac keywords.	13
`editorialKeywords`	Integer	Editorial keywords.	13
`fourStarsKeywords`	Integer	Four stars keywords.	14
`hrKeywords`	Integer	Hr keywords.	1
`adKeywords`	Integer	Ad keywords.	3
`videoKeywords`	Integer	Video keywords.	4
`brandKeywords`	Integer	Brand keywords.	5
`badgeLabels`	Array	Badge labels.	[“SEARCH”, “OFFICIAL”, “AD”]
`badgeDetails`	String	Badge details.	{“SEARCH”: [“NATURAL_SEARCHING”],”OFFICIAL”: [“AMAZON_CHOICE”],”AD”: [“SPONSOR_BRAND”,”SPONSOR_VIDEO”,”HIGHLY_RATED”,”ADS”]}
`asinInfo`	Object	ASIN info.	-
`asinInfo.asin`	String	ASIN.	B078J8VPVW
`asinInfo.asinUrl`	String	ASIN URL.	https://www.amazon.com/dp/B08GHW4TBS
`asinInfo.currency`	String	Currency.	$
`asinInfo.price`	Number	Price.	23
`asinInfo.rating`	Number	Rating.	234
`asinInfo.reviews`	Integer	Reviews.	23
`asinInfo.title`	String	Title.	Diapers Size 2, 186 Count - Pampers Swaddlers Disposable Baby Diapers, ONE MONTH SUPPLY
`asinInfo.sku`	String	Sku.	["Color: Beige","Size: 47 inches"]
`asinInfo.variations`	Integer	Variations.	2
`asinInfo.nodeId`	Integer	Node ID.	12097479011
`asinInfo.nodeIdPath`	String	Node ID path.	172282:24046923011:172541:12097479011
`asinInfo.nodeLabelPath`	String	Node label path.	Electronics:Headphones, Earbuds & Accessories:Headphones & Earbuds:Over-Ear Headphones
`asinInfo.bsrRank`	Integer	BSR rank.	175204

Response example

{
  "request_id": "8fb43e59-4ff9-4dc8-a4b7-2ed164e45ab8",
  "data": {
    "guestId": null,
    "pages": 0,
    "page": 1,
    "size": 1,
    "total": 9,
    "took": 0,
    "url": null,
    "order": {
      "field": "",
      "desc": true
    },
    "items": [
      {
        "keywords": 1128,
        "searchKeywords": 1037,
        "acKeywords": 0,
        "editorialKeywords": 0,
        "fourStarsKeywords": 0,
        "hrKeywords": 13,
        "adKeywords": 225,
        "videoKeywords": 9,
        "brandKeywords": 0,
        "badgeDetails": {
          "AD": ["SPONSOR_VIDEO"],
          "SEARCH": ["NATURAL_SEARCHING"]
        },
        "badgeLabels": ["SEARCH"],
        "asinInfo": {
          "asin": "B07Z82895W",
          "asinUrl": "https://www.amazon.com/dp/B07Z82895W?psc=1",
          "currency": null,
          "price": 9.99,
          "rating": 4.5,
          "reviews": 68849,
          "sku": "Color: BLACK",
          "title": "LISEN Cell Phone Stand Adjustable for iPhone Phone Holder for Desk, Office Desk Accessories Computer PC for iPhone Stand Gaming Essentials Fit Otterbox Case Phones Switch Kindle iPad Air Tablet 4-10in",
          "variations": 9,
          "category1Id": null,
          "category1Name": null,
          "nodeId": 23690036011,
          "nodeIdPath": "2335752011:2407755011:23690036011",
          "nodeLabelPath": "Cell Phones & Accessories:Accessories:Stands",
          "bsrRank": 422,
          "bsrId": "wireless",
          "bsrLabel": "Cell Phones & Accessories"
        }
      }
    ],
    "terminal": null,
    "hasNextPage": null,
    "guestVisited": false
  }
}

See Errors and rate limits for error payloads, request tracing, and rate-limit headers.

Traffic Sources

API data samples

Quick call

Integrate with an AI CLI

Copy for your AI CLI

Open this request in Postman

Node.js example

Python example

Request body

Response structure

Response fields

Response example

On this page

Traffic Sources

API data samples

Quick call

Integrate with an AI CLI

Copy for your AI CLI

Open this request in Postman

Node.js example

Python example

Request body

Response structure

Response fields

Response example

On this page