Skip to main content

Documentation Index

Fetch the complete documentation index at: https://deepl-c950b784-add-custom-tags-cookbook.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

The Admin API provides two endpoints for monitoring usage across your organization:

​
Organization usage

The Get usage analytics endpoint returns usage statistics for a specified date range with flexible grouping options. It covers all services: text translation, document translation, text improvement, and speech-to-text.

​
Custom tag usage

Custom tags are an optional dimension for breaking down usage. If your organization wants to track consumption by team, project, or any other category, you can attach a single tag to individual API requests using the X-DeepL-Reporting-Tag header. Each request accepts one tag. The Get custom tag usage analytics endpoint only returns usage from tagged requests. Untagged requests are not included, so the results will reflect a subset of your organization’s total usage unless all API requests are tagged. 
curl --request POST \
  --url https://api.deepl.com/v2/translate \
  --header 'Authorization: DeepL-Auth-Key YOUR_AUTH_KEY' \
  --header 'X-DeepL-Reporting-Tag: your-custom-tag' \
  --header 'Content-Type: application/json' \
  --data '{
    "text": ["Hello, world!"],
    "target_lang": "DE"
  }'
Custom tag data is currently supported for text translation. Support for additional request types will be added in a future update.
For a fuller walkthrough including naming guidance and current limitations, see How to Use Custom Reporting Tags. Once tags are in place, query Get custom tag usage analytics to retrieve usage broken down by tag.