Checkout

Read the behavioural roll-up + the intent/abandonment diagnosis of a session

GET
/v1/checkouts/sessions/{sessionId}/behavior

Authorization

selectkey<token>

API key para requisições autenticadas. Envie sua chave no cabeçalho selectkey (sandbox sk_test_…, produção sk_live_…).

In: header

Path Parameters

sessionId*string

Public identifier (sess_/ckts_/ses_…)

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/checkouts/sessions/string/behavior"
{
  "object": "checkout.session.behavior",
  "id": "sess_0a1b2c3d4e5f60718293",
  "status": "string",
  "engagement": {
    "totalTimeSpentMs": 5000,
    "activeTimeMs": 0,
    "maxStepReached": 0,
    "visitCount": 0,
    "eventCount": 0,
    "lastTelemetryAt": "string"
  },
  "insights": {
    "intentScore": 0,
    "abandonmentRisk": 0,
    "automationScore": 0,
    "confidence": 0,
    "stage": "browsing",
    "frictionPoints": [
      {
        "area": "string",
        "severity": "low",
        "evidence": "string"
      }
    ],
    "recommendedAction": "none",
    "reasons": [
      "string"
    ],
    "summary": "string",
    "computedAt": "string"
  },
  "behavior": {}
}
{
  "error": {
    "status": "Unauthorized",
    "statusCode": 401,
    "category": "authentication",
    "code": "unauthorized",
    "message": "Authentication is required to access this resource.",
    "resource": "server"
  }
}
{
  "error": {
    "status": "Forbidden",
    "statusCode": 403,
    "category": "authorization",
    "code": "forbidden",
    "message": "You do not have permission to perform this action.",
    "resource": "server"
  }
}
{
  "error": {
    "status": "Not Found",
    "statusCode": 404,
    "category": "client",
    "code": "notFound",
    "message": "The requested resource was not found.",
    "resource": "server"
  }
}
{
  "error": {
    "status": "Internal Server Error",
    "statusCode": 500,
    "category": "server",
    "code": "serverError",
    "message": "An unexpected error occurred. Please try again later.",
    "resource": "server",
    "details": "If the problem persists, contact support with the correlationId from the response headers."
  }
}