v1

latestOpenAPI 3.1.02026-07-2419782400.4 KB

Collection Usage

Retrieve collection views

get/v7/analytics/api/v2/collection/views

Query parameters

limitinteger

The maximum number of analytics events to retrieve. Allowed values are between 1 and 10000.

cursorinteger

Cursor mark returned in the response headers to be used for pagination purposes.

fromDateTimestring date-time

Retrieve view events occurred after this date. ISO8601 format yyyy-mm-ddThh:mm[:ssZ] with optional seconds.

toDateTimestring date-time

Set a date range together with the "fromDateTime" parameter. ISO8601 format yyyy-mm-ddThh:mm[:ssZ] with optional seconds.

Response

Successful response

eventIdstring

eventTypestring

userIdstring

dateTimestring date-time

collectionIdstring

isOwnerboolean

viewOriginstring

userAgentstring

isBynderSupportboolean

Example response

[
  {
    "eventId": "936280dd-b06e-44be-ae9f-85e2661510a1",
    "eventType": "CollectionViewed",
    "userId": "1A84D758-2B3A-141F-8F07D71AA1F223BD",
    "dateTime": "2021-11-15T10:07:57.781+00:00",
    "collectionId": "DA621393-F40F-5C39-BC7555DEE3C2D6D1",
    "isOwner": true,
    "viewOrigin": "portal",
    "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7)"
  }
]