> ## Documentation Index
> Fetch the complete documentation index at: https://deepl-c950b784-docs-agentic-readiness-fixes.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Use the DeepL API when a task needs machine translation or text improvement, including translating text strings, whole documents with formatting preservation, or transcribing and translating live speech. Preferred terminology and phrasing may be enforced using customizations (glossaries, style rules, and translation memories). Retrieve supported languages for each product from the `/v3/languages` endpoints.
> Read the machine-readable API surface instead of inferring request shapes from prose: the REST spec is at https://developers.deepl.com/api-reference/openapi.yaml (also served as openapi.json) and the Voice WebSocket protocol is at https://developers.deepl.com/api-reference/voice/voice.asyncapi.yaml. These docs also expose an MCP server at https://developers.deepl.com/mcp (Streamable HTTP, no authentication).
> Use https://api.deepl.com for Pro plans and https://api-free.deepl.com for the Free plan. Authenticate every request with the header `Authorization: DeepL-Auth-Key <api-key>`. Never fabricate an API key: ask the user for one, or point them at https://developers.deepl.com/docs/getting-started/quickstart.
> Errors use standard HTTP status codes with a JSON body containing a `message` field, plus a `code` field where available, and an `X-Trace-ID` response header that identifies the request in DeepL's logs. Log `X-Trace-ID` by default. Retry 429 and 5xx with exponential backoff. Do not retry 456, which means the account quota is exhausted, or 400, which means the request itself is invalid.

# Usage Analytics Dashboard

> A demo dashboard for visualizing DeepL API key usage across an entire account using the Admin API.

<Card title="GitHub - DeepL/usage-analytics-demo-dashboard" icon="github" horizontal href="https://github.com/DeepL/usage-analytics-demo-dashboard">
  Usage Analytics Demo Dashboard on GitHub
</Card>

This open-source demo dashboard shows how to visualize DeepL API key usage across your entire account, powered by a single API call to the `/v2/admin/analytics` endpoint. It provides interactive charts, flexible date ranges, and per-API-key breakdowns to help you monitor and analyze your API usage.

The dashboard is designed to be lightweight and easy to set up, with zero NPM dependencies and sample data included for testing. It can be used as-is, or as an example of how similar data can be incorporated into your own internal workflows and dashboards.

For more information about the DeepL Admin API endpoint, check out the [Admin API documentation](/api-reference/admin-api/get-usage-analytics).

If you need per-request logging instead of account-wide views, see the [API Usage Logger](/docs/learning-how-tos/cookbook/api-usage-logger) cookbook.

## Features

* **Interactive charts and visualizations** - View your usage data through multiple chart types
* **Flexible date ranges** - Analyze usage over rolling periods or fixed date ranges
* **Per-API-key breakdown** - See usage broken down by individual API keys
* **Basic trends and forecasting** - Identify patterns in your API usage
* **Secure local configuration** - All configuration stays on your machine
* **Zero NPM dependencies** - Chart.js loaded from CDN for simplicity
* **Sample data included** - Test and demo without connecting to your account

## Screenshots

<Frame>
  <img src="https://mintcdn.com/deepl-c950b784-docs-agentic-readiness-fixes/A7qtSjBxGPa9Sib6/docs/learning-how-tos/cookbook/images/dashboard-overview.png?fit=max&auto=format&n=A7qtSjBxGPa9Sib6&q=85&s=2aa55e913f9a0e936f5eaa6188356efd" alt="Dashboard Overview showing character usage and usage by feature type" width="718" height="474" data-path="docs/learning-how-tos/cookbook/images/dashboard-overview.png" />
</Frame>

<Frame>
  <img src="https://mintcdn.com/deepl-c950b784-docs-agentic-readiness-fixes/A7qtSjBxGPa9Sib6/docs/learning-how-tos/cookbook/images/usage-by-api-key.png?fit=max&auto=format&n=A7qtSjBxGPa9Sib6&q=85&s=1bafd9215238821e6e0eb265347ca35b" alt="Usage by API Key comparison chart showing top 5 keys" width="718" height="474" data-path="docs/learning-how-tos/cookbook/images/usage-by-api-key.png" />
</Frame>

<Frame>
  <img src="https://mintcdn.com/deepl-c950b784-docs-agentic-readiness-fixes/A7qtSjBxGPa9Sib6/docs/learning-how-tos/cookbook/images/usage-trends.png?fit=max&auto=format&n=A7qtSjBxGPa9Sib6&q=85&s=fd361167e86f83665e8bb86f93cfa738" alt="Daily usage trends across all API keys" width="718" height="474" data-path="docs/learning-how-tos/cookbook/images/usage-trends.png" />
</Frame>
