Sign in
Analytics

Get Session Detail

Returns a single session with address, order, commission, and full cart progression timeline. The session must belong to the authenticated client. The path accepts either the session UUID returned by the analytics index endpoint or the session token returned by session create.

get/analytics/sessions/{id}

Path parameters

idstring required
Example:a1b2c3d4-e5f6-7890-abcd-ef1234567890

Session UUID returned by analytics index or session token returned by session create

Response

Session detail with cart progression

messagestring required

A message returned by the API. Includes a human-readable message about the status of the request.

request_status'ok' | 'warning' | 'error' required

An informational summary returned in API response bodies: ok for successful responses, warning for standard request errors, and error for endpoint-specific failures. Integrations must use the HTTP status code, not request_status, to determine whether a request succeeded.

Example response

{
  "message": "What happened in the most recent request.",
  "request_status": "ok",
  "data": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "created_at": "2026-03-01T12:00:00Z",
    "context": "move_in",
    "campaign_id": "spring_promo_2026",
    "address": {
      "street1": "123 Main St",
      "street2": "Apt 4B",
      "city": "Detroit",
      "state": "MI",
      "zip": "48201"
    },
    "furthest_step": 6,
    "order": {
      "order_number": "HUM-A1B2C3D4",
      "status": "complete",
      "ordered_at": "2026-03-01T12:30:00Z",
      "installed": true,
      "installed_at": "2026-03-05T14:00:00Z",
      "commission_cents": 5000
    },
    "cart_progression": [
      {
        "step": 1,
        "step_name": "plan_selection",
        "timestamp": "2026-03-01T12:05:00Z"
      }
    ]
  },
  "meta": {
    "responded_at": "2024-09-20T23:13:31.179Z"
  }
}

Changes