Skip to content
StudyFetch API

Usage Tracking

Export usage events matching the given filters as CSV

OpenAPI specification
GET/api/v1/usage/events/export

Authentication

x-api-key

Request

curl --globoff --request GET \
  --url 'https://api.example.com/api/v1/usage/events/export' \
  --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

startDatequery · string

Start date for filtering (ISO 8601)

endDatequery · string

End date for filtering (ISO 8601)

eventTypequery · string

Filter by event type

userIdquery · string

Filter by user ID

groupIdquery · string

Filter by group ID

resourceIdquery · string

Filter by resource ID

componentTypequery · string

Filter by component type

limitquery · number

Restrict the export to a single page of results

offsetquery · number

Offset of the page to export, used with limit

Responses

200CSV export of usage events
{
  "type": "string",
  "format": "binary"
}
400Result set exceeds the export row limit