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 string

  Optional parameter to group usage statistics. Possible values:

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

  Values are key or key_and_day.

Responses

• 200 application/json

  The usage statistics for the specified date range.

  Hide headers attribute Show headers attribute

  • X-Trace-ID

    A unique identifier for the request that can be included in bug reports to DeepL support.

  Hide response attribute Show response attribute object

  • usage_report object

    Contains the detailed usage statistics for the specified date range.

    Hide usage_report attributes Show usage_report attributes object

    • total_usage object

      Breakdown of character usage by category.

      Hide total_usage attributes Show total_usage attributes object

      • total_characters integer

        Total number of characters used.

      • text_translation_characters integer

        Number of characters used for text translation.

      • document_translation_characters integer

        Number of characters used for document translation.

      • text_improvement_characters integer

        Number of characters used for text improvement.

      • speech_to_text_milliseconds integer

        Duration of speech-to-text usage in milliseconds.

    • start_date string(date-time)

      Start date of the usage report period.

    • end_date string(date-time)

      End date of the usage report period.

    • group_by string

      The grouping method used, if any.

      Values are key or key_and_day.

    • key_usages array[object]

      Usage statistics grouped by key. Present when group_by='key'.

      Hide key_usages attributes Show key_usages attributes object

      Usage statistics for a specific API key (without date grouping).

      • api_key string

        Masked API key identifier.

      • api_key_label string

        Label associated with the API key.

      • usage object

        Breakdown of character usage by category.

        Hide usage attributes Show usage attributes object

        • total_characters integer

          Total number of characters used.

        • text_translation_characters integer

          Number of characters used for text translation.

        • document_translation_characters integer

          Number of characters used for document translation.

        • text_improvement_characters integer

          Number of characters used for text improvement.

        • speech_to_text_milliseconds integer

          Duration of speech-to-text usage in milliseconds.

    • key_and_day_usages array[object]

      Usage statistics grouped by key and day. Present when group_by='key_and_day'.

      Hide key_and_day_usages attributes Show key_and_day_usages attributes object

      Usage statistics for a specific API key and specific date.

      • api_key string

        Masked API key identifier.

      • api_key_label string

        Label associated with the API key.

      • usage_date string(date-time)

        The usage date when group_by is "key_and_day".

      • usage object

        Breakdown of character usage by category.

        Hide usage attributes Show usage attributes object

        • total_characters integer

          Total number of characters used.

        • text_translation_characters integer

          Number of characters used for text translation.

        • document_translation_characters integer

          Number of characters used for document translation.

        • text_improvement_characters integer

          Number of characters used for text improvement.

        • speech_to_text_milliseconds integer

          Duration of speech-to-text usage in milliseconds.

• 400 application/json

  Bad request. Please check error message and your parameters.

  Hide headers attribute Show headers attribute

  • X-Trace-ID

    A unique identifier for the request that can be included in bug reports to DeepL support.

  Hide response attribute Show response attribute object

  • message string

    Error message describing the issue.

• 403

  Authorization failed. Please supply a valid DeepL-Auth-Key via the Authorization header.

  Hide headers attribute Show headers attribute

  • X-Trace-ID

    A unique identifier for the request that can be included in bug reports to DeepL support.

• 404

  The requested resource could not be found.

  Hide headers attribute Show headers attribute

  • X-Trace-ID

    A unique identifier for the request that can be included in bug reports to DeepL support.

• 500

  Internal error.

  Hide headers attribute Show headers attribute

  • X-Trace-ID

    A unique identifier for the request that can be included in bug reports to DeepL support.