GET /v1/commerce/orders/metrics/trend

GET/v1/commerce/orders/metrics/trend

Authorization

bearerAuthbearerAuthrequired

apiKeyAuthapiKeyAuthrequired

Query parameters

windowstring

Window period: 7, 30, or mtd

default: "7"

Responses

200OK

currentOrderMetricsWindowrequired

Show properties

gmvinteger<int64>required

order_countinteger<int64>required

paid_countinteger<int64>required

gmv_pct_changenumber<double> | nullrequired

order_count_pct_changenumber<double> | nullrequired

paid_count_pct_changenumber<double> | nullrequired

previousOrderMetricsWindowrequired

Show properties

gmvinteger<int64>required

order_countinteger<int64>required

paid_countinteger<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/orders/metrics/trend"

const response = await fetch("/v1/commerce/orders/metrics/trend", {
  method: "GET"
});

import requests

response = requests.get(
    "/v1/commerce/orders/metrics/trend",
)

Response

{
  "current": {
    "gmv": 0,
    "order_count": 0,
    "paid_count": 0
  },
  "gmv_pct_change": 0,
  "order_count_pct_change": 0,
  "paid_count_pct_change": 0,
  "previous": {
    "gmv": 0,
    "order_count": 0,
    "paid_count": 0
  }
}

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