GET /v1/commerce/analytics/funnel

GET/v1/commerce/analytics/funnel

Authorization

bearerAuthbearerAuthrequired

apiKeyAuthapiKeyAuthrequired

Responses

200OK

cart_to_order_ratenumber<double> | nullrequired

carts_countinteger<int64>required

fulfilled_countinteger<int64>required

order_to_paid_ratenumber<double> | nullrequired

orders_countinteger<int64>required

paid_countinteger<int64>required

paid_to_fulfill_ratenumber<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/funnel"

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

import requests

response = requests.get(
    "/v1/commerce/analytics/funnel",
)

Response

{
  "cart_to_order_rate": 0,
  "carts_count": 0,
  "fulfilled_count": 0,
  "order_to_paid_rate": 0,
  "orders_count": 0,
  "paid_count": 0,
  "paid_to_fulfill_rate": 0
}

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