Sign in

v1

latestOpenAPI 3.1.02026-07-2419782400.4 KB
Asset Usage V1

Retrieve asset download events

This endpoint only offers data from 2023-11-01. Use the Asset Download endpoint for previous data.

get/v7/analytics/api/v1/asset/v2/download

Query parameters

limitinteger
Example:100

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

cursorstring
Example:MTAwMA

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

fromDateTimestring date-time
Example:2022-01-01T01:00

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

toDateTimestring date-time
Example:2022-06-01T01:00

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

Response

Successful response

eventIdstring

Id of the event

eventTypestring

Type of event

dateTimestring date-time

Date and time when the event occurred

userIdstring

Id of the user that generated the event

assetIdstring

Id of the asset

downloadReasonsstring[]

Reasons given on why the asset was downloaded

Example response

[
  {
    "eventId": "1408aec2-3114-43dd-be20-ffb1246a5231",
    "eventType": "AssetDownloadRequested",
    "dateTime": "2021-11-15T10:07:57.781Z",
    "userId": "1A84D758-2B3A-141F-8F07D71AA1F223BD",
    "assetId": "CA510292-E39E-4B28-AB6444CDD2B1C5C0",
    "downloadReasons": [
      "reason1",
      "reason2"
    ]
  }
]