CDP REST APIAPI Reference
Profile Sessions
Read a profile's session history, scope-filtered to your shop.
GET /cdp/profiles/{id}/sessions — read a profile's session history. Sessions belonging to
another shop are filtered out, so a profile merged across shops only surfaces this
brand's sessions.
Request
GET /cdp/profiles/{id}/sessions
Authorization: Bearer vyg_…Path parameters
| Param | Type | Description |
|---|---|---|
id | string | The profile itemId. |
Query parameters
| Param | Type | Default | Description |
|---|---|---|---|
limit | integer | 25 | Page size, clamped to a maximum of 100. |
offset | integer | 0 | Offset; offset + limit must stay within the 10,000-row window. |
sort | string | — | Sort key. |
Response 200
{
"list": [{ "itemId": "ses_1", "scope": "your-shop.myshopify.com" }],
"totalSize": 1,
"offset": 0,
"pageSize": 25
}| Field | Type | Description |
|---|---|---|
list | array | The page of sessions (only this brand's sessions). |
totalSize | integer | Total after scope-filtering, capped at 10,000. |
offset | integer | Offset this page started at. |
pageSize | integer | Effective page size. |
This endpoint does not return a nextCursor — sessions are post-filtered by scope, so deep
cursor enumeration is not offered. Use offset/limit within the result window.
Example
curl -s "https://cdp.vyg.app/cdp/profiles/shopify_your-shop_1234/sessions?limit=25" \
-H "Authorization: Bearer vyg_your_key_here"Errors
| Status | When |
|---|---|
400 | Missing profile id, or a deep offset past the result window. |
401 | Missing or invalid credential. |
403 | No connected shop resolves a scope. |
405 | Non-GET method. |
See Errors for the full envelope.