Skip to main content
GET
/
api
/
v1
/
usage
/
summary
Get usage summary
const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://studyfetchapi.com/api/v1/usage/summary', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

Authorizations

​
x-api-key
string
header
required

API Key for authentication

Query Parameters

​
period
enum<string>
required

Summary period

Available options:
hourly,
daily,
monthly
​
startDate
string
required

Start date for summary (ISO 8601)

​
endDate
string
required

End date for summary (ISO 8601)

​
groupBy
enum<string>

Group results by

Available options:
user,
group,
model,
endpoint

Response

200

Usage summary retrieved