Get usage analytics

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

Get usage statistics as an admin

cURL

curl --request GET \
  --url https://api.deepl.com/v2/admin/analytics \
  --header 'Authorization: <api-key>'

200

withGrouping

{
  "usage_report": {
    "total_usage": {
      "total_characters": 9619,
      "text_translation_characters": 4892,
      "document_translation_characters": 0,
      "text_improvement_characters": 4727,
      "speech_to_text_minutes": 107.46
    },
    "group_by": "key_and_day",
    "start_date": "2025-09-29T00:00:00",
    "end_date": "2025-10-01T00:00:00",
    "key_and_day_usages": [
      {
        "api_key": "dc88****3a2c",
        "api_key_label": "Staging API Key",
        "usage_date": "2025-09-29T00:00:00Z",
        "usage": {
          "total_characters": 315,
          "text_translation_characters": 159,
          "document_translation_characters": 0,
          "text_improvement_characters": 156,
          "speech_to_text_minutes": 11.94
        }
      }
    ]
  }
}

Date range

Specify the reporting window using the required start_date and end_date parameters. Both support the following formats (all in UTC):

Format	Example
YYYY-MM-DD	2025-09-29
YYYY-MM-DDTHH:MM:SS	2025-09-29T14:30:00

The maximum date range is 366 days.

Grouping

The optional group_by parameter controls how results are organized:

Value	Description
(default)	Returns total usage for the entire date range across all API keys
key	Groups usage by individual API key, showing totals for each key over the date range
key_and_day	Groups usage by both API key and day, providing daily breakdowns per key

Response structure

All responses include a breakdown of usage by service type:

Field	Description
total_characters	Combined character usage across all services
text_translation_characters	Characters used for text translation
document_translation_characters	Characters used for document translation
text_improvement_characters	Characters used for text improvement (rephrasing)
speech_to_text_minutes	Duration of speech-to-text usage in minutes

Authorizations

Authorization · string · header · default: DeepL-Auth-Key · required

Authentication with Authorization header and DeepL-Auth-Key authentication scheme. Example: DeepL-Auth-Key <api-key>

Query Parameters

start_date · string<date> · required

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

end_date · string<date> · required

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

group_by · enum<string>

Optional parameter to group usage statistics. Possible values:

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

Available options: key, key_and_day

Response

200

application/json

The usage statistics for the specified date range.

The response for admin usage statistics.

usage_report · object

Contains the detailed usage statistics for the specified date range.

Show child attributes