Commerce repeat-customer and cohort analytics

GET /commerce/analytics/customers

Commerce repeat-customer and cohort analytics

cURL

curl --request GET \
  --url https://api.pineyard.ai/commerce/analytics/customers \
  --header 'Authorization: Bearer <token>'

200

{
  "identifiedOrders": 123,
  "identityCoveragePct": 123,
  "newCustomers": 123,
  "returningCustomers": 123,
  "repeatCustomerRate": 123,
  "cohorts": [
    {
      "cohort": "<string>",
      "customers": 123,
      "retention": [
        123
      ]
    }
  ]
}

Required scope: sales.view

Requires commerce analytics enabled for your workspace. Otherwise the request is refused; see Errors.

Authorizations

Authorization · string · header · required

Your API key, e.g. pk_live_xxxxxxxxxxxxxxxxxxxxxxxx.

Query Parameters

range · enum<string> · default: 30d

Available options: today, 7d, 30d, 90d

Response

200

application/json

OK

identifiedOrders · number · required

identityCoveragePct · number | null · required

newCustomers · number · required

returningCustomers · number · required

repeatCustomerRate · number | null · required

cohorts · object[] · required

Show child attributes