Skip to content
StudyFetch API

Usage Tracking

Get usage summary

OpenAPI specification
GET/api/v1/usage/summary

Authentication

x-api-key

Request

curl --globoff --request GET \
  --url 'https://api.example.com/api/v1/usage/summary?period=hourly&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

periodquery · string · required

Summary period

startDatequery · string · required

Start date for summary (ISO 8601)

endDatequery · string · required

End date for summary (ISO 8601)

groupByquery · string

Group results by

Responses

200Usage summary retrieved