Get usage summary · DeutschlandGPT

Returns aggregated usage statistics for the workspace. Requires an API key with the admin:export_usage scope. Defaults to last 30 days if no date range specified.

GEThttps://api.deutschlandgpt.de/v2/admin/usage/summary

Example request

curl https://api.deutschlandgpt.de/v2/admin/usage/summary \
  -X GET \
  -H "Authorization: Bearer $DGPT_API_KEY"

curl https://api.deutschlandgpt.de/v2/admin/usage/summary \
  -X GET \
  -H "Authorization: Bearer $DGPT_API_KEY"

import os, requests

response = requests.get(
    "https://api.deutschlandgpt.de/v2/admin/usage/summary",
    headers={"Authorization": f"Bearer {os.environ['DGPT_API_KEY']}"},
)

print(response.json())

import os, requests

response = requests.get(
    "https://api.deutschlandgpt.de/v2/admin/usage/summary",
    headers={"Authorization": f"Bearer {os.environ['DGPT_API_KEY']}"},
)

print(response.json())

const response = await fetch('https://api.deutschlandgpt.de/v2/admin/usage/summary', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.DGPT_API_KEY}`,
  },
});

console.log(await response.json());

const response = await fetch('https://api.deutschlandgpt.de/v2/admin/usage/summary', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.DGPT_API_KEY}`,
  },
});

console.log(await response.json());

Parameters

start_datestring<date>optional

Start date (ISO 8601). Defaults to 30 days ago.

end_datestring<date>optional

End date (ISO 8601). Defaults to today.

Response

200application/json

{
  "totalCost": 0,
  "totalRequests": 0,
  "activeApiKeys": 0,
  "totalTokens": 0
}

{
  "totalCost": 0,
  "totalRequests": 0,
  "activeApiKeys": 0,
  "totalTokens": 0
}

Usage summary

totalCostnumber

Total cost. Value in micro-cents (divide by 100,000,000 for EUR).

totalRequestsinteger

activeApiKeysinteger

totalTokensinteger

Response codes

200

Usage summary

UsageSummary

401

Unauthorized

403

Requires admin API key