Profile Events

GET /cdp/profiles/{id}/events — read a profile’s event history. For a profile merged across shops, only this brand’s events are returned.

Request

GET /cdp/profiles/{id}/events
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.
cursor	string	—	Opaque scope-bound, profile-bound deep-pagination token. When present, offset is ignored.
eventType	string	—	Filter to a single event type.
from	string	—	Start of a time range.
to	string	—	End of a time range.
sort	string	itemId.keyword:asc	Sort key. The default stable sort is cursor-eligible; any other sort makes the page offset-only.

Response 200

{
  "list": [{ "itemId": "evt_1", "eventType": "view" }],
  "totalSize": 1,
  "offset": 0,
  "pageSize": 25,
  "nextCursor": null
}

Field	Type	Description
list	array	The page of events.
totalSize	integer	Estimated total, capped at 10,000.
offset	integer	Offset this page started at.
pageSize	integer	Effective page size.
nextCursor	string | null	Token for the next page, or null when exhausted.

Example

curl -s "https://cdp.vyg.app/cdp/profiles/shopify_your-shop_1234/events?eventType=view&limit=25" \
  -H "Authorization: Bearer vyg_your_key_here"

Errors

Status	When
400	Missing profile id; a deep offset; or a cursor that is malformed, for a different endpoint, or for a different profile.
401	Missing or invalid credential.
403	No connected shop resolves a scope; or a cursor minted for a different brand.
405	Non-GET method.

See Pagination for cursor semantics.