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));

curl --request GET \
  --url https://studyfetchapi.com/api/v1/usage/summary \
  --header 'x-api-key: <api-key>'

import requests

url = "https://studyfetchapi.com/api/v1/usage/summary"

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

GET

api

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));

curl --request GET \
  --url https://studyfetchapi.com/api/v1/usage/summary \
  --header 'x-api-key: <api-key>'

import requests

url = "https://studyfetchapi.com/api/v1/usage/summary"

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

Authorizations

x-api-key

string

header

required

API Key for server-to-server authentication. Resolves to the owning organization.

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

Get usage events Get usage statistics

Component API

REST API

Get usage summary

Authorizations

Query Parameters

Response