Usage Analyst

Get all events based on filters

GET · Usage Analyst

GET/api/v1/usage-analyst/events

Authentication

x-api-key

Request

curl --globoff --request GET \
  --url 'https://api.example.com/api/v1/usage-analyst/events?eventType=material_created&startDate=%3CstartDate%3E&endDate=%3CendDate%3E' \
  --header 'x-api-key: <API_KEY>'

Replace credential and <field> placeholders with your own values. URL placeholders appear as %3Cfield%3E. Review the example values before sending your request.

Replace https://api.example.com with the API server URL.

Parameters

eventTypequery · string · required

Type of usage event to filter

startDatequery · string · required

Start date for filtering (ISO 8601)

endDatequery · string · required

End date for filtering (ISO 8601)

userIdsquery · array

Array of user IDs to filter

groupIdsquery · array

Array of group IDs to filter

Responses

200Events retrieved successfully