GET
/
usage-service
/
api
/
v1
/
usage
/
report
curl --request GET \
  --url https://usage-service.vatis.tech/usage-service/api/v1/usage/report \
  --header 'Authorization: Bearer <token>'
{
  "startTimestamp": 123,
  "endTimestamp": 123,
  "granularity": "HOURS",
  "currency": "<string>",
  "totalMeasurements": {
    "credits": "<string>",
    "startTimestamp": 123,
    "endTimestamp": 123,
    "streamsCount": 123,
    "operationType": "BATCH_TRANSCRIPTION",
    "streamConfigurationTemplateId": "<string>",
    "measurements": {
      "executionTime": "<string>",
      "storageSize": "<string>",
      "ingressSize": "<string>",
      "egressSize": "<string>",
      "processedAudioLength": "<string>",
      "processedTokens": "<string>",
      "processedInputTokens": "<string>",
      "processedOutputTokens": "<string>"
    }
  },
  "aggregatedMeasurements": [
    {
      "credits": "<string>",
      "startTimestamp": 123,
      "endTimestamp": 123,
      "streamsCount": 123,
      "operationType": "BATCH_TRANSCRIPTION",
      "streamConfigurationTemplateId": "<string>",
      "measurements": {
        "executionTime": "<string>",
        "storageSize": "<string>",
        "ingressSize": "<string>",
        "egressSize": "<string>",
        "processedAudioLength": "<string>",
        "processedTokens": "<string>",
        "processedInputTokens": "<string>",
        "processedOutputTokens": "<string>"
      }
    }
  ],
  "operationTypeAggregatedMeasurements": [
    {
      "credits": "<string>",
      "startTimestamp": 123,
      "endTimestamp": 123,
      "streamsCount": 123,
      "operationType": "BATCH_TRANSCRIPTION",
      "streamConfigurationTemplateId": "<string>",
      "measurements": {
        "executionTime": "<string>",
        "storageSize": "<string>",
        "ingressSize": "<string>",
        "egressSize": "<string>",
        "processedAudioLength": "<string>",
        "processedTokens": "<string>",
        "processedInputTokens": "<string>",
        "processedOutputTokens": "<string>"
      }
    }
  ],
  "streamConfigurationTemplateIdAggregatedMeasurements": [
    {
      "credits": "<string>",
      "startTimestamp": 123,
      "endTimestamp": 123,
      "streamsCount": 123,
      "operationType": "BATCH_TRANSCRIPTION",
      "streamConfigurationTemplateId": "<string>",
      "measurements": {
        "executionTime": "<string>",
        "storageSize": "<string>",
        "ingressSize": "<string>",
        "egressSize": "<string>",
        "processedAudioLength": "<string>",
        "processedTokens": "<string>",
        "processedInputTokens": "<string>",
        "processedOutputTokens": "<string>"
      }
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
start
string

Start of the interval. If not specified, it will be the 1st of the current month

Example:

"2021-08-01T00:00:00Z"

​
end
string

End of the interval. If not specified, it will be the current date-time

Example:

"2021-08-01T00:00:00Z"

​
granularity
enum<string>

Granularity of the report. Defaults to 'HOURS'

Available options:
HOURS,
DAYS,
MONTHS
​
currency
string

Currency to use for the report. If not specified, the default credits abstraction will be used

Example:

"USD"

Response

200
application/json
Stream canceled successfully
​
startTimestamp
integer
​
endTimestamp
integer
​
granularity
enum<string>
Available options:
HOURS,
DAYS,
MONTHS
​
currency
string
​
totalMeasurements
object
​
aggregatedMeasurements
object[]
​
operationTypeAggregatedMeasurements
object[]
​
streamConfigurationTemplateIdAggregatedMeasurements
object[]