v1

latestOpenAPI 3.0.32026-07-265278189.1 KB

AdminApi

Get usage statistics as an admin

Retrieve usage statistics for the organization within a specified date range. Optionally group the results by API key or by API key and day.

get/v2/admin/analytics

Query parameters

start_datestring date required

Start date for the usage report (ISO 8601 date format).

end_datestring date required

End date for the usage report (ISO 8601 date format).

group_by'key' | 'key_and_day'

Optional parameter to group usage statistics. Possible values:

key - Group by API key
key_and_day - Group by API key and usage date

Response

The usage statistics for the specified date range.

Example response

{
  "usage_report": {
    "total_usage": {
      "total_characters": 9619,
      "text_translation_characters": 4892,
      "text_improvement_characters": 4727,
      "speech_to_text_minutes": 107.46
    },
    "start_date": "2025-09-29T00:00:00",
    "end_date": "2025-10-01T00:00:00",
    "group_by": "key_and_day",
    "key_usages": [
      {
        "api_key": "db96****cb2c",
        "api_key_label": "DeepL API Key Prod",
        "usage": {
          "total_characters": 9619,
          "text_translation_characters": 4892,
          "text_improvement_characters": 4727,
          "speech_to_text_minutes": 107.46
        }
      }
    ],
    "key_and_day_usages": [
      {
        "api_key": "db96****cb2c",
        "api_key_label": "DeepL API Key Prod",
        "usage_date": "2025-09-29T00:00:00Z",
        "usage": {
          "total_characters": 9619,
          "text_translation_characters": 4892,
          "text_improvement_characters": 4727,
          "speech_to_text_minutes": 107.46
        }
      }
    ]
  }
}