GET /v1/commerce/analytics/sales-kpi

GET/v1/commerce/analytics/sales-kpi

Authorization

bearerAuthbearerAuthrequired

apiKeyAuthapiKeyAuthrequired

Query parameters

windowstring

Window: 7, 30, or 90

default: "7"

Responses

200OK

cur_new_customersinteger<int64>required

cur_ordersinteger<int64>required

cur_products_soldinteger<int64>required

cur_salesinteger<int64>required

new_customers_pct_changenumber<double> | nullrequired

orders_pct_changenumber<double> | nullrequired

prev_new_customersinteger<int64>required

prev_ordersinteger<int64>required

prev_products_soldinteger<int64>required

prev_salesinteger<int64>required

products_pct_changenumber<double> | nullrequired

sales_pct_changenumber<double> | nullrequired

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/sales-kpi"

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

import requests

response = requests.get(
    "/v1/commerce/analytics/sales-kpi",
)

Response

{
  "cur_new_customers": 0,
  "cur_orders": 0,
  "cur_products_sold": 0,
  "cur_sales": 0,
  "new_customers_pct_change": 0,
  "orders_pct_change": 0,
  "prev_new_customers": 0,
  "prev_orders": 0,
  "prev_products_sold": 0,
  "prev_sales": 0,
  "products_pct_change": 0,
  "sales_pct_change": 0
}

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