GET /v1/commerce/analytics/cohorts

GET/v1/commerce/analytics/cohorts

Authorization

bearerAuthbearerAuthrequired

apiKeyAuthapiKeyAuthrequired

Query parameters

limitinteger<int32>

default: 100

Responses

200OK

itemsCohortRetentionRow[] | nullrequired

Show properties

Array of CohortRetentionRow

cohort_monthstringrequired

cohort_sizeinteger<int64>required

months_since_firstinteger<int32>required

retained_countinteger<int64>required

retention_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/cohorts"

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

import requests

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

Response

{
  "items": [
    {
      "cohort_month": "string",
      "cohort_size": 0,
      "months_since_first": 0,
      "retained_count": 0,
      "retention_rate": 0
    }
  ]
}

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