v1

latestOpenAPI 3.1.02026-07-2419782400.4 KB

Collection Usage

Retrieve collection view events

get/v7/analytics/api/v1/collection/views

Query parameters

limitinteger

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

cursorstring

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

collectionIdstring

eventTypestring

dateTimestring date-time

userIdstring

isOwnerboolean

viewOriginstring

ipAddressstring

userAgentstring

isBynderSupportboolean

Example response

[
  {
    "eventId": "ad3c8d01-4a2f-461c-b17d-2ecc51723028",
    "collectionId": "CA510292-E39E-4B28-AB6444CDD2B1C5C0",
    "eventType": "CollectionViewed",
    "dateTime": "2021-11-15T10:07:57.781+00:00",
    "userId": "1A84D758-2B3A-141F-8F07D71AA1F223BD",
    "viewOrigin": "internal",
    "ipAddress": "192.158.1.38",
    "userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/107.0.0.0 Safari/537.36"
  }
]