invantive documentation
Invantive Support ForumsLog In / Sign Up

CustomTagUsageAnalyticsByStartDate: DeepL Custom Tag Usage Analytics

read only REST

  • Catalog: DeepL
  • Schema: Admin
  • Label: Custom Tag Usage Analytics

Can only retrieve data.

Summary

The usage per custom reporting tag over a period; needs an admin key.

API Source

  • Endpoint: /v2/admin/analytics/custom-tags

Performance Characteristics

Characteristic Value
Average access latency (ms) 31

Parameters

Name Data Type Required Default Documentation
aggregate_by varchar2 period (default) or day.
end_date date The last day of the period.
start_date date The first day of the period.

Table Columns

The columns of the table CustomTagUsageAnalyticsByStartDate 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
custom_tag varchar2 itgen_dpl_custom_tag filters on the platform, writable The custom reporting tag.
speech_to_speech_minutes decimal itgen_dpl_speech_to_speech_minutes filters on the platform, writable Minutes of speech to speech.
speech_to_text_minutes decimal itgen_dpl_speech_to_text_minutes filters on the platform, writable Minutes of speech to text.
text_improvement_characters int64 itgen_dpl_text_improvement_characters filters on the platform, writable Characters of text improvement.
text_translation_characters int64 itgen_dpl_text_translation_characters filters on the platform, writable Characters of text translation.
total_characters int64 itgen_dpl_total_characters filters on the platform, writable Characters over all character-based products; voice is in minutes.
usage_date datetime itgen_dpl_usage_date filters on the platform, writable The day; only when aggregated per day.