Analytics

List Sessions

Returns a paginated list of sessions with address, cart progression, order, and commission data. Scoped to all tokens belonging to the authenticated client.

Filtering

start_date / end_date: ISO 8601 date strings to bound the query window
updated_since: Return only sessions whose session or order data changed on or after this time; results are ordered by most recent change first
token_ids[]: Restrict to specific API tokens (must belong to your account)
with_clicks: When true, only returns sessions with click activity

Pagination

Results are paginated at 50 sessions per page. Use the page parameter and the meta.pages field to navigate.

Syncing order status

To keep a local copy of order status current, poll with updated_since set to the time of your last successful sync and page through all results. A session is returned whenever the session or its order changed, including installs, cancellations, and commission updates on sessions created long ago. Treat each returned row as authoritative and overwrite your stored copy. Do not use start_date as a sync cursor: it filters on session creation time, so status changes on previously synced sessions are never returned. Unrecognized parameters are ignored.

get/analytics/sessions

Query parameters

pageinteger

Example:1

Page number (default 1, 50 results per page)

start_datestring date-time

Example:2026-01-01T00:00:00Z

Filter sessions created on or after this date (ISO 8601)

end_datestring date-time

Example:2026-03-31T23:59:59Z

Filter sessions created on or before this date (ISO 8601)

updated_sincestring date-time

Example:2026-03-10T00:00:00Z

Return only sessions whose session or order data changed on or after this time (ISO 8601). When provided, results are ordered by most recent change first. Invalid datetime values are ignored.

token_ids[]string[]

Filter to sessions from specific API tokens. All provided token IDs must belong to the authenticated client or a 403 is returned.

with_clicksboolean

When true, only return sessions that have click activity

Response

Paginated list of analytics sessions

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_number": "HUM-A1B2C3D4",
      "status": "complete",
      "ordered_at": "2026-03-01T12:30:00Z",
      "installed": true,
      "installed_at": "2026-03-05T14:00:00Z",
      "commission_cents": 5000
    }
  ],
  "meta": {
    "responded_at": "2024-09-20T23:13:31.179Z",
    "page": 1,
    "pages": 5,
    "count": 237
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.