GET /v1/commerce/analytics/top-products

GET/v1/commerce/analytics/top-products

Authorization

bearerAuthbearerAuthrequired

apiKeyAuthapiKeyAuthrequired

Query parameters

windowstring

Window: 7, 30, or 90

default: "7"

Responses

200OK

itemsTopProduct[] | nullrequired

Show properties

Array of TopProduct

product_idstringrequired

revenueinteger<int64>required

titlestringrequired

unitsinteger<int64>required

defaultError

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

Request

curl -X GET "/v1/commerce/analytics/top-products"

const response = await fetch("/v1/commerce/analytics/top-products", {
  method: "GET"
});

import requests

response = requests.get(
    "/v1/commerce/analytics/top-products",
)

Response

{
  "items": [
    {
      "product_id": "string",
      "revenue": 0,
      "title": "string",
      "units": 0
    }
  ]
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}