LiveRecoverVYG Developer Docs
CDP REST APIAPI Reference

Profile Events

Read a profile's event history, scope-bound to your shop.

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

ParamTypeDescription
idstringThe profile itemId.

Query parameters

ParamTypeDefaultDescription
limitinteger25Page size, clamped to a maximum of 100.
offsetinteger0Offset; offset + limit must stay within the 10,000-row window.
cursorstringOpaque scope-bound, profile-bound deep-pagination token. When present, offset is ignored.
eventTypestringFilter to a single event type.
fromstringStart of a time range.
tostringEnd of a time range.
sortstringitemId.keyword:ascSort 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
}
FieldTypeDescription
listarrayThe page of events.
totalSizeintegerEstimated total, capped at 10,000.
offsetintegerOffset this page started at.
pageSizeintegerEffective page size.
nextCursorstring | nullToken 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

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

See Pagination for cursor semantics.

On this page