UsageAnalyticsByStartDate: DeepL Usage Analytics
read only REST
- Catalog:
DeepL - Schema:
Admin - Label: Usage Analytics
Can only retrieve data.
Summary
The usage of the organisation over a period, in total, per key or per key and day; needs an admin key.
API Source
- Endpoint:
/v2/admin/analytics
Performance Characteristics
| Characteristic | Value |
|---|---|
| Average access latency (ms) | 31 |
Parameters
| Name | Data Type | Required | Default | Documentation |
|---|---|---|---|---|
end_ |
date |
The last day of the period. | ||
group_ |
varchar2 |
Empty for one total, key per key, or key_and_day per key and day. | ||
start_ |
date |
The first day of the period. |
Table Columns
The columns of the table UsageAnalyticsByStartDate are shown below. Each column has an SQL data type. A new non-null value must be provided for every required column at all times during insert and update.
| Name | Data Type | Label | Required | Marks | Documentation |
|---|---|---|---|---|---|
api_ |
varchar2 |
API Key | filters on the platform, writable | The masked key; empty on the total. | |
api_ |
varchar2 |
itgen_dpl_api_key_label | filters on the platform, writable | The label of the key. | |
document_ |
int64 |
itgen_dpl_document_translation_characters | filters on the platform, writable | Characters of document translation. | |
speech_ |
decimal |
itgen_dpl_speech_to_text_minutes | filters on the platform, writable | Minutes of speech to text. | |
text_ |
int64 |
itgen_dpl_text_improvement_characters | filters on the platform, writable | Characters of text improvement. | |
text_ |
int64 |
itgen_dpl_text_translation_characters | filters on the platform, writable | Characters of text translation. | |
total_ |
int64 |
itgen_dpl_total_characters | filters on the platform, writable | Characters over all character-based products. | |
usage_ |
datetime |
itgen_dpl_usage_date | filters on the platform, writable | The day; only when grouped per key and day. |