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.
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.
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.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/schema.json","name":"Hum Documentation","colors":{"primary":"#2a77fa","light":"#F1F5F9","dark":"#0c76f9"},"logo":{"light":"https://mintcdn.com/hum/EGVZNDogcsGNqYtL/logo/hum.svg?fit=max\u0026auto=format\u0026n=EGVZNDogcsGNqYtL\u0026q=85\u0026s=8bd29d065c4bb046f4c7c7f49da36bbb","dark":"https://mintcdn.com/hum/EO5jHcOxNKbOuoxY/logo/hum_white.png?fit=max\u0026auto=format\u0026n=EO5jHcOxNKbOuoxY\u0026q=85\u0026s=3827bdfbb39a028c883c7893813b1b64"},"favicon":"https://mintcdn.com/hum/EGVZNDogcsGNqYtL/favicon.svg?fit=max\u0026auto=format\u0026n=EGVZNDogcsGNqYtL\u0026q=85\u0026s=dff27db0a310e983c60e337475bafbc7","background":{"image":{"light":"https://mintcdn.com/hum/EO5jHcOxNKbOuoxY/images/main-bg_home.svg?fit=max\u0026auto=format\u0026n=EO5jHcOxNKbOuoxY\u0026q=85\u0026s=4f5502fc6992ad9135f88385a79089a8","dark":"https://mintcdn.com/hum/EO5jHcOxNKbOuoxY/images/main-bg_home.svg?fit=max\u0026auto=format\u0026n=EO5jHcOxNKbOuoxY\u0026q=85\u0026s=4f5502fc6992ad9135f88385a79089a8"},"color":{"light":"#ffffff","dark":"#000000"}},"navbar":{"links":[{"href":"mailto:support@letshum.com","label":"Support"}],"primary":{"type":"button","label":"Get Started","href":"https://letshum.com/contact"}},"footer":{"socials":{"github":"https://github.com/letshum","linkedin":"https://www.linkedin.com/company/letshum"}},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Website","icon":"globe","href":"https://letshum.com"},{"anchor":"Support","icon":"envelope","href":"mailto:support@letshum.com"},{"anchor":"Operational Status","icon":"chart-simple","href":"https://status.letshum.com"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"hum","hasAudioNarration":false,"actualSubdomain":"hum","customDomains":["docs.letshum.com"],"gitSource":{"type":"github","owner":"letshum","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ab549279a16cafd7957b298","collectionId":"5e80e5ec-8af4-412b-a9b6-48188e05313f","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ab549279a16cafd7957b298"},"feedback":{"thumbs":true,"edits":true,"issues":true},"entitlements":{},"buildId":"6ab549279a16cafd7957b298","clientVersion":"0.0.3965","searchFilterCounts":[{"language":"default","tag":"Guides","count":9},{"language":"default","tag":"API Reference","count":8},{"language":"default","tag":"MCP","count":7},{"language":"default","tag":"Hum Broadband MCP","count":7},{"language":"default","tag":"Integration","count":6},{"language":"default","tag":"Widget Integration","count":4},{"language":"default","tag":"Get Started","count":3},{"language":"default","tag":"Sessions","count":3},{"language":"default","tag":"Analytics","count":2},{"language":"default","tag":"Health Check","count":1}]},"assistantConfig":{},"hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/analytics/list-sessions","slug":"/api-reference/analytics/list-sessions","pageMetadata":{"title":"List Sessions","description":"Returns a paginated list of sessions with address, cart progression, order, and commission data.\nScoped to all tokens belonging to the authenticated client.\n\n## Filtering\n- `start_date` / `end_date`: ISO 8601 date strings to bound the query window\n- `updated_since`: Return only sessions whose session or order data changed on or after this time; results are ordered by most recent change first\n- `token_ids[]`: Restrict to specific API tokens (must belong to your account)\n- `with_clicks`: When `true`, only returns sessions with click activity\n\n## Pagination\nResults are paginated at 50 sessions per page. Use the `page` parameter and\nthe `meta.pages` field to navigate.\n\n## Syncing order status\nTo keep a local copy of order status current, poll with `updated_since` set to the time of\nyour last successful sync and page through all results. A session is returned whenever the\nsession or its order changed, including installs, cancellations, and commission updates on\nsessions created long ago. Treat each returned row as authoritative and overwrite your stored\ncopy. Do not use `start_date` as a sync cursor: it filters on session creation time, so status\nchanges on previously synced sessions are never returned. Unrecognized parameters are ignored.\n","deprecated":null,"version":null,"openapi":"/swagger.yaml get /analytics/sessions","href":"/api-reference/analytics/list-sessions","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n h2: \"h2\",\n li: \"li\",\n p: \"p\",\n ul: \"ul\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Returns a paginated list of sessions with address, cart progression, order, and commission data.\\nScoped to all tokens belonging to the authenticated client.\"\n }), \"\\n\", _jsx(_components.h2, {\n children: \"Filtering\"\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"start_date\"\n }), \" / \", _jsx(_components.code, {\n children: \"end_date\"\n }), \": ISO 8601 date strings to bound the query window\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"updated_since\"\n }), \": Return only sessions whose session or order data changed on or after this time; results are ordered by most recent change first\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"token_ids[]\"\n }), \": Restrict to specific API tokens (must belong to your account)\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"with_clicks\"\n }), \": When \", _jsx(_components.code, {\n children: \"true\"\n }), \", only returns sessions with click activity\"]\n }), \"\\n\"]\n }), \"\\n\", _jsx(_components.h2, {\n children: \"Pagination\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Results are paginated at 50 sessions per page. Use the \", _jsx(_components.code, {\n children: \"page\"\n }), \" parameter and\\nthe \", _jsx(_components.code, {\n children: \"meta.pages\"\n }), \" field to navigate.\"]\n }), \"\\n\", _jsx(_components.h2, {\n children: \"Syncing order status\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"To keep a local copy of order status current, poll with \", _jsx(_components.code, {\n children: \"updated_since\"\n }), \" set to the time of\\nyour last successful sync and page through all results. A session is returned whenever the\\nsession or its order changed, including installs, cancellations, and commission updates on\\nsessions created long ago. Treat each returned row as authoritative and overwrite your stored\\ncopy. Do not use \", _jsx(_components.code, {\n children: \"start_date\"\n }), \" as a sync cursor: it filters on session creation time, so status\\nchanges on previously synced sessions are never returned. Unrecognized parameters are ignored.\"]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"List Sessions","description":"Returns a paginated list of sessions with address, cart progression, order, and commission data.\nScoped to all tokens belonging to the authenticated client.\n\n## Filtering\n- `start_date` / `end_date`: ISO 8601 date strings to bound the query window\n- `updated_since`: Return only sessions whose session or order data changed on or after this time; results are ordered by most recent change first\n- `token_ids[]`: Restrict to specific API tokens (must belong to your account)\n- `with_clicks`: When `true`, only returns sessions with click activity\n\n## Pagination\nResults are paginated at 50 sessions per page. Use the `page` parameter and\nthe `meta.pages` field to navigate.\n\n## Syncing order status\nTo keep a local copy of order status current, poll with `updated_since` set to the time of\nyour last successful sync and page through all results. A session is returned whenever the\nsession or its order changed, including installs, cancellations, and commission updates on\nsessions created long ago. Treat each returned row as authoritative and overwrite your stored\ncopy. Do not use `start_date` as a sync cursor: it filters on session creation time, so status\nchanges on previously synced sessions are never returned. Unrecognized parameters are ignored.\n","deprecated":null,"version":null,"openapi":"/swagger.yaml get /analytics/sessions","href":"/api-reference/analytics/list-sessions","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"listAnalyticsSessions","security":["913d881c-24e0-40a4-8a93-0604594981b8"],"tags":["Analytics"],"summary":"List Sessions","description":"Returns a paginated list of sessions with address, cart progression, order, and commission data.\nScoped to all tokens belonging to the authenticated client.\n\n## Filtering\n- `start_date` / `end_date`: ISO 8601 date strings to bound the query window\n- `updated_since`: Return only sessions whose session or order data changed on or after this time; results are ordered by most recent change first\n- `token_ids[]`: Restrict to specific API tokens (must belong to your account)\n- `with_clicks`: When `true`, only returns sessions with click activity\n\n## Pagination\nResults are paginated at 50 sessions per page. Use the `page` parameter and\nthe `meta.pages` field to navigate.\n\n## Syncing order status\nTo keep a local copy of order status current, poll with `updated_since` set to the time of\nyour last successful sync and page through all results. A session is returned whenever the\nsession or its order changed, including installs, cancellations, and commission updates on\nsessions created long ago. Treat each returned row as authoritative and overwrite your stored\ncopy. Do not use `start_date` as a sync cursor: it filters on session creation time, so status\nchanges on previously synced sessions are never returned. Unrecognized parameters are ignored.\n","parameters":["83c5a6dc-53d7-40df-9dc6-b5190c455e9f","3b4d8a1a-7d56-41e2-b115-349048ecab28","b797925c-40e5-4b48-9970-6e7d87914685","1296036f-0b38-47dc-b5fb-47588b21111d","6b7882c0-0929-4820-82a6-702ee533c8dd","be17a3b5-4ef3-4a2f-bea3-686f72be3b4c"],"responses":{"200":"e63f7fc6-0d58-4aa1-918a-7c56ebc6b167","401":"274bb7f7-144a-4d89-8745-7d81d2dd6891","403":"e5acfb10-6e9e-4322-a97c-318fbd897695","429":"1f6fa014-b85d-46a1-84d3-80f7530f4f2f","500":"81727f74-6e65-4738-b8b1-64baa9813bf2"},"method":"get","type":"path","servers":["a0fb7d8d-c46d-46cf-b53e-90b496207a53","50a481b3-b8e5-4d61-b045-e37902a020f0"],"path":"/analytics/sessions","baseUrlOptions":["https://api-sandbox.letshum.com","https://api.letshum.com"],"title":"List Sessions","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"83c5a6dc-53d7-40df-9dc6-b5190c455e9f":{"name":"page","in":"query","description":"Page number (default 1, 50 results per page)","required":false,"schema":{"type":"integer","minimum":1,"default":1,"example":1,"isRequired":false,"description":"Page number (default 1, 50 results per page)","uniqueKey":"","typeLabel":"integer"}},"3b4d8a1a-7d56-41e2-b115-349048ecab28":{"name":"start_date","in":"query","description":"Filter sessions created on or after this date (ISO 8601)","required":false,"schema":{"type":"string","format":"date-time","example":"2026-01-01T00:00:00Z","isRequired":false,"description":"Filter sessions created on or after this date (ISO 8601)","uniqueKey":"","typeLabel":"string\u003cdate-time>"}},"b797925c-40e5-4b48-9970-6e7d87914685":{"name":"end_date","in":"query","description":"Filter sessions created on or before this date (ISO 8601)","required":false,"schema":{"type":"string","format":"date-time","example":"2026-03-31T23:59:59Z","isRequired":false,"description":"Filter sessions created on or before this date (ISO 8601)","uniqueKey":"","typeLabel":"string\u003cdate-time>"}},"1296036f-0b38-47dc-b5fb-47588b21111d":{"name":"updated_since","in":"query","description":"Return only sessions whose session or order data changed on or after this time\n(ISO 8601). When provided, results are ordered by most recent change first.\nInvalid datetime values are ignored.\n","required":false,"schema":{"type":"string","format":"date-time","example":"2026-03-10T00:00:00Z","isRequired":false,"description":"Return only sessions whose session or order data changed on or after this time\n(ISO 8601). When provided, results are ordered by most recent change first.\nInvalid datetime values are ignored.\n","uniqueKey":"","typeLabel":"string\u003cdate-time>"}},"6b7882c0-0929-4820-82a6-702ee533c8dd":{"name":"token_ids[]","in":"query","description":"Filter to sessions from specific API tokens. All provided token IDs\nmust belong to the authenticated client or a 403 is returned.\n","required":false,"schema":{"type":"array","items":{"type":"string","format":"uuid","uniqueKey":"items.[INDEX]","typeLabel":"string\u003cuuid>"},"isRequired":false,"description":"Filter to sessions from specific API tokens. All provided token IDs\nmust belong to the authenticated client or a 403 is returned.\n","uniqueKey":"","typeLabel":"string\u003cuuid>[]"}},"be17a3b5-4ef3-4a2f-bea3-686f72be3b4c":{"name":"with_clicks","in":"query","description":"When true, only return sessions that have click activity","required":false,"schema":{"type":"boolean","default":false,"isRequired":false,"description":"When true, only return sessions that have click activity","uniqueKey":"","typeLabel":"boolean"}}},"responses":{"e63f7fc6-0d58-4aa1-918a-7c56ebc6b167":{"description":"Paginated list of analytics sessions","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"What happened in the most recent request.","description":"A message returned by the API. Includes a human-readable message about the status of the request.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"request_status":{"type":"string","enum":["ok","warning","error"],"example":"ok","description":"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.\n","isRequired":true,"uniqueKey":"request_status","typeLabel":"enum\u003cstring>"},"data":{"type":"array","items":{"type":"object","description":"Session summary returned in the list endpoint.","properties":{"id":{"type":"string","format":"uuid","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","uniqueKey":"data.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"created_at":{"type":"string","format":"date-time","example":"2026-03-01T12:00:00Z","uniqueKey":"data.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"context":{"type":"string","enum":["move_in","move_out"],"example":"move_in","description":"Traffic context for the session, set from the API token that created it. `move_in` is a resident setting up service at a home they are moving into. `move_out` is a resident leaving a partner's property. Note that the address on a move-out session is the resident's destination home, not the partner's building. Sessions created before this field was introduced read `move_in`.","uniqueKey":"data.items.[INDEX].context","typeLabel":"enum\u003cstring>"},"campaign_id":{"oneOf":[{"type":"string","example":"spring_promo_2026","description":"Campaign tracking identifier, if provided when the session was created.","uniqueKey":"data.items.[INDEX].campaign_id.oneOf.0","typeLabel":"string"},{"type":"null","example":"spring_promo_2026","description":"Campaign tracking identifier, if provided when the session was created.","uniqueKey":"data.items.[INDEX].campaign_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].campaign_id","typeLabel":"string | null"},"address":{"type":"object","description":"Service address for the session.","properties":{"street1":{"oneOf":[{"type":"string","example":"123 Main St","uniqueKey":"data.items.[INDEX].address.street1.oneOf.0","typeLabel":"string"},{"type":"null","example":"123 Main St","uniqueKey":"data.items.[INDEX].address.street1.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].address.street1","typeLabel":"string | null"},"street2":{"oneOf":[{"type":"string","example":"Apt 4B","uniqueKey":"data.items.[INDEX].address.street2.oneOf.0","typeLabel":"string"},{"type":"null","example":"Apt 4B","uniqueKey":"data.items.[INDEX].address.street2.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].address.street2","typeLabel":"string | null"},"city":{"oneOf":[{"type":"string","example":"Detroit","uniqueKey":"data.items.[INDEX].address.city.oneOf.0","typeLabel":"string"},{"type":"null","example":"Detroit","uniqueKey":"data.items.[INDEX].address.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].address.city","typeLabel":"string | null"},"state":{"oneOf":[{"type":"string","example":"MI","uniqueKey":"data.items.[INDEX].address.state.oneOf.0","typeLabel":"string"},{"type":"null","example":"MI","uniqueKey":"data.items.[INDEX].address.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].address.state","typeLabel":"string | null"},"zip":{"oneOf":[{"type":"string","example":"48201","uniqueKey":"data.items.[INDEX].address.zip.oneOf.0","typeLabel":"string"},{"type":"null","example":"48201","uniqueKey":"data.items.[INDEX].address.zip.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].address.zip","typeLabel":"string | null"}},"uniqueKey":"data.items.[INDEX].address","typeLabel":"object"},"furthest_step":{"oneOf":[{"type":"integer","minimum":1,"maximum":8,"example":6,"description":"Highest checkout step reached during this session (1-8). Null if no cart events.","uniqueKey":"data.items.[INDEX].furthest_step.oneOf.0","typeLabel":"integer"},{"type":"null","minimum":1,"maximum":8,"example":6,"description":"Highest checkout step reached during this session (1-8). Null if no cart events.","uniqueKey":"data.items.[INDEX].furthest_step.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].furthest_step","typeLabel":"integer | null"},"order_number":{"oneOf":[{"type":"string","example":"HUM-A1B2C3D4","description":"Order number, if an order was placed.","uniqueKey":"data.items.[INDEX].order_number.oneOf.0","typeLabel":"string"},{"type":"null","example":"HUM-A1B2C3D4","description":"Order number, if an order was placed.","uniqueKey":"data.items.[INDEX].order_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].order_number","typeLabel":"string | null"},"status":{"oneOf":[{"type":"string","enum":["draft","submitted","processing","confirmed","complete","cancelled"],"example":"complete","description":"Order status. Null if no order was placed. Cancelled orders are final.","uniqueKey":"data.items.[INDEX].status.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["draft","submitted","processing","confirmed","complete","cancelled"],"example":"complete","description":"Order status. Null if no order was placed. Cancelled orders are final.","uniqueKey":"data.items.[INDEX].status.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].status","typeLabel":"enum\u003cstring> | null"},"ordered_at":{"oneOf":[{"type":"string","format":"date-time","example":"2026-03-01T12:30:00Z","description":"When the order was submitted.","uniqueKey":"data.items.[INDEX].ordered_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","example":"2026-03-01T12:30:00Z","description":"When the order was submitted.","uniqueKey":"data.items.[INDEX].ordered_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].ordered_at","typeLabel":"string\u003cdate-time> | null"},"installed":{"oneOf":[{"type":"boolean","example":true,"description":"Whether the service has been installed. Always false for cancelled orders.","uniqueKey":"data.items.[INDEX].installed.oneOf.0","typeLabel":"boolean"},{"type":"null","example":true,"description":"Whether the service has been installed. Always false for cancelled orders.","uniqueKey":"data.items.[INDEX].installed.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].installed","typeLabel":"boolean | null"},"installed_at":{"oneOf":[{"type":"string","format":"date-time","example":"2026-03-05T14:00:00Z","description":"When the service was installed. Null for cancelled orders.","uniqueKey":"data.items.[INDEX].installed_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","example":"2026-03-05T14:00:00Z","description":"When the service was installed. Null for cancelled orders.","uniqueKey":"data.items.[INDEX].installed_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].installed_at","typeLabel":"string\u003cdate-time> | null"},"commission_cents":{"oneOf":[{"type":"integer","example":5000,"description":"Locked commission in cents. Null if no commission recorded and for cancelled orders.","uniqueKey":"data.items.[INDEX].commission_cents.oneOf.0","typeLabel":"integer"},{"type":"null","example":5000,"description":"Locked commission in cents. Null if no commission recorded and for cancelled orders.","uniqueKey":"data.items.[INDEX].commission_cents.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].commission_cents","typeLabel":"integer | null"}},"uniqueKey":"data.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"data","typeLabel":"object[]"},"meta":{"type":"object","description":"Pagination metadata for list responses.","properties":{"responded_at":{"type":"string","description":"The timestamp when the response was generated.","format":"date-time","example":"2024-09-20T23:13:31.179Z","uniqueKey":"meta.responded_at","typeLabel":"string\u003cdate-time>"},"page":{"type":"integer","example":1,"description":"Current page number.","uniqueKey":"meta.page","typeLabel":"integer"},"pages":{"type":"integer","example":5,"description":"Total number of pages.","uniqueKey":"meta.pages","typeLabel":"integer"},"count":{"type":"integer","example":237,"description":"Total number of sessions matching the query.","uniqueKey":"meta.count","typeLabel":"integer"}},"isRequired":true,"uniqueKey":"meta","typeLabel":"object"}},"required":["message","request_status","data","meta"],"uniqueKey":"","typeLabel":"object"},"examples":{"with_results":{"title":"with_results","value":{"message":"Analytics sessions","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},{"id":"b2c3d4e5-f6a7-8901-bcde-f12345678901","created_at":"2026-03-01T11:00:00Z","context":"move_out","campaign_id":null,"address":{"street1":"456 Oak Ave","street2":null,"city":"Ann Arbor","state":"MI","zip":"48104"},"furthest_step":3,"order_number":null,"status":null,"ordered_at":null,"installed":null,"installed_at":null,"commission_cents":null}],"meta":{"responded_at":"2026-03-12T15:00:00Z","page":1,"pages":5,"count":237}}},"empty_results":{"title":"empty_results","value":{"message":"Analytics sessions","request_status":"ok","data":[],"meta":{"responded_at":"2026-03-12T15:00:00Z","page":1,"pages":0,"count":0}}}},"exampleType":"examples"}},"exampleType":"examples"},"274bb7f7-144a-4d89-8745-7d81d2dd6891":{"description":"Unauthorized. Use the HTTP status code, not `request_status`, to detect the error.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"What happened in the most recent request.","description":"A message returned by the API. Includes a human-readable message about the status of the request.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"request_status":{"type":"string","enum":["warning","error"],"description":"Informational severity only; use the HTTP status code for control flow.","isRequired":true,"uniqueKey":"request_status","typeLabel":"enum\u003cstring>"},"request_id":{"type":"string","example":"3f1c3c07-785d-4c59-97dd-25cb38f670d7","description":"Best-effort support reference for the request. Include the approximate request timestamp when reporting an error. A request logging failure can leave no matching API log row.\n","isRequired":true,"uniqueKey":"request_id","typeLabel":"string"},"errors":{"type":"object","description":"Validation errors for session creation (e.g. missing/invalid address combination, street1, state, or zip).","properties":{"base":{"type":"array","items":{"type":"string","example":"Provide either (street1 and zip), (street1, city, and state), or (street1, city, and zip)","uniqueKey":"errors.base.items.[INDEX]","typeLabel":"string"},"uniqueKey":"errors.base","typeLabel":"string[]"},"street1":{"type":"array","items":{"type":"string","example":"can't be blank","uniqueKey":"errors.street1.items.[INDEX]","typeLabel":"string"},"uniqueKey":"errors.street1","typeLabel":"string[]"},"city":{"type":"array","items":{"type":"string","example":"can't be blank","uniqueKey":"errors.city.items.[INDEX]","typeLabel":"string"},"uniqueKey":"errors.city","typeLabel":"string[]"},"state":{"type":"array","items":{"type":"string","example":"must be a valid state or US territory/commonwealth","uniqueKey":"errors.state.items.[INDEX]","typeLabel":"string"},"uniqueKey":"errors.state","typeLabel":"string[]"},"zip":{"type":"array","items":{"type":"string","example":"must be in the form 12345 or 12345-1234","uniqueKey":"errors.zip.items.[INDEX]","typeLabel":"string"},"uniqueKey":"errors.zip","typeLabel":"string[]"}},"uniqueKey":"errors","typeLabel":"object"}},"required":["message","request_status","request_id"],"uniqueKey":"","typeLabel":"object"},"example":{"message":"Unauthorized access","request_status":"warning","request_id":"3f1c3c07-785d-4c59-97dd-25cb38f670d7"},"examples":{"Example":{"title":"Example","value":{"message":"Unauthorized access","request_status":"warning","request_id":"3f1c3c07-785d-4c59-97dd-25cb38f670d7"}}},"exampleType":"examples"}},"exampleType":"examples"},"e5acfb10-6e9e-4322-a97c-318fbd897695":{"description":"Forbidden. The requested resource does not belong to the authenticated account, or a security policy blocked the request.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"What happened in the most recent request.","description":"A message returned by the API. Includes a human-readable message about the status of the request.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"request_status":{"type":"string","enum":["warning","error"],"description":"Informational severity only; use the HTTP status code for control flow.","isRequired":true,"uniqueKey":"request_status","typeLabel":"enum\u003cstring>"},"request_id":{"type":"string","example":"3f1c3c07-785d-4c59-97dd-25cb38f670d7","description":"Best-effort support reference for the request. Include the approximate request timestamp when reporting an error. A request logging failure can leave no matching API log row.\n","isRequired":true,"uniqueKey":"request_id","typeLabel":"string"},"errors":{"type":"object","description":"Validation errors for session creation (e.g. missing/invalid address combination, street1, state, or zip).","properties":{"base":{"type":"array","items":{"type":"string","example":"Provide either (street1 and zip), (street1, city, and state), or (street1, city, and zip)","uniqueKey":"errors.base.items.[INDEX]","typeLabel":"string"},"uniqueKey":"errors.base","typeLabel":"string[]"},"street1":{"type":"array","items":{"type":"string","example":"can't be blank","uniqueKey":"errors.street1.items.[INDEX]","typeLabel":"string"},"uniqueKey":"errors.street1","typeLabel":"string[]"},"city":{"type":"array","items":{"type":"string","example":"can't be blank","uniqueKey":"errors.city.items.[INDEX]","typeLabel":"string"},"uniqueKey":"errors.city","typeLabel":"string[]"},"state":{"type":"array","items":{"type":"string","example":"must be a valid state or US territory/commonwealth","uniqueKey":"errors.state.items.[INDEX]","typeLabel":"string"},"uniqueKey":"errors.state","typeLabel":"string[]"},"zip":{"type":"array","items":{"type":"string","example":"must be in the form 12345 or 12345-1234","uniqueKey":"errors.zip.items.[INDEX]","typeLabel":"string"},"uniqueKey":"errors.zip","typeLabel":"string[]"}},"uniqueKey":"errors","typeLabel":"object"}},"required":["message","request_status","request_id"],"uniqueKey":"","typeLabel":"object"},"example":{"message":"Forbidden: token_ids contain tokens not belonging to your account","request_status":"warning","request_id":"3f1c3c07-785d-4c59-97dd-25cb38f670d7"},"examples":{"Example":{"title":"Example","value":{"message":"Forbidden: token_ids contain tokens not belonging to your account","request_status":"warning","request_id":"3f1c3c07-785d-4c59-97dd-25cb38f670d7"}}},"exampleType":"examples"}},"exampleType":"examples"},"1f6fa014-b85d-46a1-84d3-80f7530f4f2f":{"description":"Rate Limit Exceeded","headers":{"Retry-After":{"description":"Number of seconds to wait before retrying the request.","schema":{"type":"integer"},"example":60,"required":true}},"content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"What happened in the most recent request.","description":"A message returned by the API. Includes a human-readable message about the status of the request.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"request_status":{"type":"string","enum":["warning","error"],"description":"Informational severity only; use the HTTP status code for control flow.","isRequired":true,"uniqueKey":"request_status","typeLabel":"enum\u003cstring>"},"request_id":{"type":"string","example":"3f1c3c07-785d-4c59-97dd-25cb38f670d7","description":"Best-effort support reference for the request. Include the approximate request timestamp when reporting an error. A request logging failure can leave no matching API log row.\n","isRequired":true,"uniqueKey":"request_id","typeLabel":"string"},"errors":{"type":"object","description":"Validation errors for session creation (e.g. missing/invalid address combination, street1, state, or zip).","properties":{"base":{"type":"array","items":{"type":"string","example":"Provide either (street1 and zip), (street1, city, and state), or (street1, city, and zip)","uniqueKey":"errors.base.items.[INDEX]","typeLabel":"string"},"uniqueKey":"errors.base","typeLabel":"string[]"},"street1":{"type":"array","items":{"type":"string","example":"can't be blank","uniqueKey":"errors.street1.items.[INDEX]","typeLabel":"string"},"uniqueKey":"errors.street1","typeLabel":"string[]"},"city":{"type":"array","items":{"type":"string","example":"can't be blank","uniqueKey":"errors.city.items.[INDEX]","typeLabel":"string"},"uniqueKey":"errors.city","typeLabel":"string[]"},"state":{"type":"array","items":{"type":"string","example":"must be a valid state or US territory/commonwealth","uniqueKey":"errors.state.items.[INDEX]","typeLabel":"string"},"uniqueKey":"errors.state","typeLabel":"string[]"},"zip":{"type":"array","items":{"type":"string","example":"must be in the form 12345 or 12345-1234","uniqueKey":"errors.zip.items.[INDEX]","typeLabel":"string"},"uniqueKey":"errors.zip","typeLabel":"string[]"}},"uniqueKey":"errors","typeLabel":"object"}},"required":["message","request_status","request_id"],"uniqueKey":"","typeLabel":"object"},"example":{"message":"Rate limit exceeded. Please try again later.","request_status":"warning","request_id":"3f1c3c07-785d-4c59-97dd-25cb38f670d7"},"examples":{"Example":{"title":"Example","value":{"message":"Rate limit exceeded. Please try again later.","request_status":"warning","request_id":"3f1c3c07-785d-4c59-97dd-25cb38f670d7"}}},"exampleType":"examples"}},"exampleType":"examples"},"81727f74-6e65-4738-b8b1-64baa9813bf2":{"description":"Unexpected internal error handled by an API controller.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"What happened in the most recent request.","description":"A message returned by the API. Includes a human-readable message about the status of the request.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"request_status":{"type":"string","enum":["warning","error"],"description":"Informational severity only; use the HTTP status code for control flow.","isRequired":true,"uniqueKey":"request_status","typeLabel":"enum\u003cstring>"},"request_id":{"type":"string","example":"3f1c3c07-785d-4c59-97dd-25cb38f670d7","description":"Best-effort support reference for the request. Include the approximate request timestamp when reporting an error. A request logging failure can leave no matching API log row.\n","isRequired":true,"uniqueKey":"request_id","typeLabel":"string"},"errors":{"type":"object","description":"Validation errors for session creation (e.g. missing/invalid address combination, street1, state, or zip).","properties":{"base":{"type":"array","items":{"type":"string","example":"Provide either (street1 and zip), (street1, city, and state), or (street1, city, and zip)","uniqueKey":"errors.base.items.[INDEX]","typeLabel":"string"},"uniqueKey":"errors.base","typeLabel":"string[]"},"street1":{"type":"array","items":{"type":"string","example":"can't be blank","uniqueKey":"errors.street1.items.[INDEX]","typeLabel":"string"},"uniqueKey":"errors.street1","typeLabel":"string[]"},"city":{"type":"array","items":{"type":"string","example":"can't be blank","uniqueKey":"errors.city.items.[INDEX]","typeLabel":"string"},"uniqueKey":"errors.city","typeLabel":"string[]"},"state":{"type":"array","items":{"type":"string","example":"must be a valid state or US territory/commonwealth","uniqueKey":"errors.state.items.[INDEX]","typeLabel":"string"},"uniqueKey":"errors.state","typeLabel":"string[]"},"zip":{"type":"array","items":{"type":"string","example":"must be in the form 12345 or 12345-1234","uniqueKey":"errors.zip.items.[INDEX]","typeLabel":"string"},"uniqueKey":"errors.zip","typeLabel":"string[]"}},"uniqueKey":"errors","typeLabel":"object"}},"required":["message","request_status","request_id"],"uniqueKey":"","typeLabel":"object"},"example":{"message":"Internal server error","request_status":"error","request_id":"3f1c3c07-785d-4c59-97dd-25cb38f670d7"},"examples":{"Example":{"title":"Example","value":{"message":"Internal server error","request_status":"error","request_id":"3f1c3c07-785d-4c59-97dd-25cb38f670d7"}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"913d881c-24e0-40a4-8a93-0604594981b8":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Bearer token authentication using API tokens.\nInclude the token in the Authorization header as: `Authorization: Bearer \u003ctoken>`\n\nObtain tokens from your Hum representative or contact support@letshum.com. There is no self-serve API key dashboard.\n","scopes":[]}}},"servers":{"a0fb7d8d-c46d-46cf-b53e-90b496207a53":{"url":"https://api-sandbox.letshum.com","description":"Sandbox environment"},"50a481b3-b8e5-4d61-b045-e37902a020f0":{"url":"https://api.letshum.com","description":"Production environment"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Bearer token authentication using API tokens.\nInclude the token in the Authorization header as: `Authorization: Bearer \u003ctoken>`\n\nObtain tokens from your Hum representative or contact support@letshum.com. There is no self-serve API key dashboard.\n","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer token authentication using API tokens.\nInclude the token in the Authorization header as: `Authorization: Bearer \u003ctoken>`\n\nObtain tokens from your Hum representative or contact support@letshum.com. There is no self-serve API key dashboard.\n","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"swagger.yaml"},"subdomain":"hum","siteName":"Hum Documentation","title":"List Sessions - Hum Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-08-13T23:37:37.602Z","originalFileLocation":"api-reference/analytics/list-sessions.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"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.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Hum Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/hum/MQJGe1qKygFPeCex/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/hum/MQJGe1qKygFPeCex/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/hum/MQJGe1qKygFPeCex/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/hum/MQJGe1qKygFPeCex/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/hum/MQJGe1qKygFPeCex/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/hum/MQJGe1qKygFPeCex/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/hum/MQJGe1qKygFPeCex/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/hum/MQJGe1qKygFPeCex/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/hum/MQJGe1qKygFPeCex/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"List Sessions - Hum Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"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.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Hum Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.letshum.com/api-reference/analytics/list-sessions\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://hum.mintlify.app/_mintlify/api/og/v2?division=Analytics\u0026amp;title=List+Sessions\u0026amp;description=Returns+a+paginated+list+of+sessions+with+address%2C+cart+progression%2C+order%2C+and+commission+data.%0AScoped+to+all+tokens+belonging+to+the+authenticated+client.%0A%0A%23%23\u0026amp;theme=681961f9c74f9e589caf8b82\u0026amp;signature=24ab394c28fce2426755bf889d482293eef217ec3cddc0c47fc4123fbcbce483\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"List Sessions - Hum Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"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.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://hum.mintlify.app/_mintlify/api/og/v2?division=Analytics\u0026amp;title=List+Sessions\u0026amp;description=Returns+a+paginated+list+of+sessions+with+address%2C+cart+progression%2C+order%2C+and+commission+data.%0AScoped+to+all+tokens+belonging+to+the+authenticated+client.%0A%0A%23%23\u0026amp;theme=681961f9c74f9e589caf8b82\u0026amp;signature=24ab394c28fce2426755bf889d482293eef217ec3cddc0c47fc4123fbcbce483\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/hum/MQJGe1qKygFPeCex/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Hum Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#2a77fa\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.letshum.com/api-reference/analytics/list-sessions\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/analytics/list-sessions.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.letshum.com/#organization\",\"name\":\"Hum Documentation\",\"url\":\"https://docs.letshum.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/hum/EGVZNDogcsGNqYtL/logo/hum.svg?fit=max\u0026auto=format\u0026n=EGVZNDogcsGNqYtL\u0026q=85\u0026s=8bd29d065c4bb046f4c7c7f49da36bbb\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.letshum.com#website\",\"name\":\"Hum Documentation\",\"url\":\"https://docs.letshum.com\",\"publisher\":{\"@id\":\"https://docs.letshum.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.letshum.com/api-reference/analytics/list-sessions#webpage\",\"url\":\"https://docs.letshum.com/api-reference/analytics/list-sessions\",\"name\":\"List Sessions\",\"description\":\"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.\",\"dateModified\":\"2026-08-13T23:37:37.602Z\",\"isPartOf\":{\"@id\":\"https://docs.letshum.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.letshum.com/api-reference/analytics/list-sessions#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.letshum.com/api-reference/analytics/list-sessions#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Hum Documentation\",\"item\":\"https://docs.letshum.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"List Sessions\",\"item\":\"https://docs.letshum.com/api-reference/analytics/list-sessions\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.letshum.com/api-reference/analytics/list-sessions#apireference\",\"headline\":\"List Sessions\",\"name\":\"List Sessions\",\"description\":\"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.\",\"url\":\"https://docs.letshum.com/api-reference/analytics/list-sessions\",\"mainEntityOfPage\":{\"@id\":\"https://docs.letshum.com/api-reference/analytics/list-sessions#webpage\"},\"dateModified\":\"2026-08-13T23:37:37.602Z\",\"publisher\":{\"@id\":\"https://docs.letshum.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.letshum.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Hum Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Hum Documentation","nav":{"global":{"anchors":[{"anchor":"Website","icon":"globe","href":"https://letshum.com"},{"anchor":"Support","icon":"envelope","href":"mailto:support@letshum.com"},{"anchor":"Operational Status","icon":"chart-simple","href":"https://status.letshum.com"}]},"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":"/introduction"}]},{"tab":"MCP","pages":[{"title":"MCP","href":"/mcp/overview"}]},{"tab":"API Reference","groups":[{"group":"Sessions","pages":[{"title":"Create New Session","deprecated":null,"version":null,"openapi":"/swagger.yaml post /sessions","href":"/api-reference/sessions/create-new-session"},{"title":"Get Session Status","deprecated":null,"version":null,"openapi":"/swagger.yaml get /sessions/{token}","href":"/api-reference/sessions/get-session-status"},{"title":"Close Session","deprecated":null,"version":null,"openapi":"/swagger.yaml delete /sessions/{token}","href":"/api-reference/sessions/close-session"}]},{"group":"Service Availability","pages":[{"title":"Get Internet Service Availability","deprecated":null,"version":null,"openapi":"/swagger.yaml get /sessions/{token}/services/internet","href":"/api-reference/service-availability/get-internet-service-availability"}]},{"group":"Health Check","pages":[{"title":"API Health Check","deprecated":null,"version":null,"openapi":"/swagger.yaml get /ping","href":"/api-reference/health-check/api-health-check"}]},{"group":"Informational","pages":[{"title":"Get FCC Service Providers","description":"Retrieves a comprehensive list of FCC service providers and their supplemental brands. \nThis endpoint provides access to the complete database of Internet service providers \nthat are tracked by the FCC and used by Hum for service availability lookups.\n\n## Use Cases\n- Building provider selection interfaces\n- Validating provider names and IDs\n- Understanding provider coverage and scale\n- Integration with external systems\n\n## Data Structure\nThe response includes both primary FCC providers and their supplemental brands:\n- **Primary Providers**: Main FCC-registered service providers\n- **Supplemental Brands**: Subsidiary brands and service lines under parent providers\n- **Total Residential Units**: Coverage metrics for each provider\n\n## Provider Types\n- `fcc_provider`: Primary FCC-registered service provider\n- `supplemental_brand`: Supplemental brand that inherits coverage from parent provider\n- Supplemental brands are grouped immediately after their parent provider\n\n## Response Format\nProviders are ordered by total residential units (largest first) with supplemental \nbrands immediately following their parent provider in the list.\n\n## Example Response\n```json\n{\n \"providers\": [\n {\n \"id\": \"130403\",\n \"name\": \"T-Mobile\",\n \"fcc_name\": \"T-Mobile USA, Inc.\",\n \"total_residential_units\": 97951103,\n \"type\": \"fcc_provider\"\n },\n { \n \"id\": \"130077\",\n \"name\": \"AT\u0026T\",\n \"fcc_name\": \"AT\u0026T Inc.\",\n \"total_residential_units\": 80864481,\n \"type\": \"fcc_provider\"\n },\n {\n \"id\": \"130317\",\n \"name\": \"Xfinity\",\n \"fcc_name\": \"Comcast Corporation\",\n \"total_residential_units\": 57287455,\n \"type\": \"fcc_provider\"\n },\n {\n \"id\": \"130317-1\",\n \"name\": \"Now XFinity\",\n \"fcc_name\": \"Comcast Corporation\",\n \"total_residential_units\": 57287455,\n \"type\": \"supplemental_brand\"\n },\n {\n \"id\": \"131425\",\n \"name\": \"Verizon\",\n \"fcc_name\": \"Verizon Communications Inc.\",\n \"total_residential_units\": 50554772,\n \"type\": \"fcc_provider\"\n }\n ]\n}\n```\n\n## Important Notes\n- All requests require a valid bearer token\n- Response includes both active and inactive providers\n- Supplemental brands reference their parent provider's FCC name\n- Total residential units represent the parent provider's coverage\n","deprecated":null,"version":null,"openapi":"/swagger.yaml get /service_providers","href":"/api-reference/informational/get-fcc-service-providers"}]},{"group":"Analytics","pages":[{"title":"List Sessions","deprecated":null,"version":null,"openapi":"/swagger.yaml get /analytics/sessions","href":"/api-reference/analytics/list-sessions"},{"title":"Get Session Detail","description":"Returns a single session with address, order, commission, and full cart progression timeline.\nThe session must belong to the authenticated client.\nThe path accepts either the session UUID returned by the analytics index endpoint or\nthe session token returned by session create.\n","deprecated":null,"version":null,"openapi":"/swagger.yaml get /analytics/sessions/{id}","href":"/api-reference/analytics/get-session-detail"}]}]}]},"title":"List Sessions - Hum Documentation","buildId":"dpl_849ArpqvBiCczQiT1Y1stNGpbqHT","deploymentId":"dpl_849ArpqvBiCczQiT1Y1stNGpbqHT","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-Bbp7I60D.js","utils-C3RIvJha.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DqD-vLt8.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-B31Loprg.js","snippetPresets-DKpk-b8t.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-Cj65AhOR.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BXtn5gcC.js","shallow-RY2b03Cp.js","getApiPlaygroundDisplay-B0jeiPk3.js","CodeSnippet-CYgBjjwn.js","CodeSnippets-DOngDrYB.js","Page-n7I5XbKb.js","getPastedJson-DRQbJx-T.js","icon-CQiQCicY.js","MethodPill-BKTLdNtu.js","DuplicateIcon-B9jpAdat.js","createIcon-DCddRrXv.js","DynamicMarkdown-a8hUKrw6.js","SectionHeading-eECVV2eH.js","axios-vUo_bRtp.js","Markdown--GF7ZIpf.js","clsx-DZLdJUrt.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-2LoAhjKH.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Zwc0ZncM.js"]}