GET /v1/commerce/analytics/rfm

GET/v1/commerce/analytics/rfm

Authorization

bearerAuthbearerAuthrequired

apiKeyAuthapiKeyAuthrequired

Query parameters

limitinteger<int32>

default: 100

offsetinteger<int32>

default: 0

Responses

200OK

contactsRFMContact[] | nullrequired

Show properties

Array of RFMContact

contact_idstringrequired

f_scoreinteger<int32>required

frequencyinteger<int32>required

m_scoreinteger<int32>required

monetaryinteger<int64>required

r_scoreinteger<int32>required

recency_daysinteger<int32>required

segmentstringrequired

segmentsRFMSegmentSummary[] | nullrequired

Show properties

Array of RFMSegmentSummary

customer_countinteger<int64>required

segmentstringrequired

total_monetaryinteger<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/analytics/rfm"

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

import requests

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

Response

{
  "contacts": [
    {
      "contact_id": "string",
      "f_score": 0,
      "frequency": 0,
      "m_score": 0,
      "monetary": 0,
      "r_score": 0,
      "recency_days": 0,
      "segment": "string"
    }
  ],
  "segments": [
    {
      "customer_count": 0,
      "segment": "string",
      "total_monetary": 0
    }
  ]
}

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