Skip to content

List Usage

Endpoint

http
GET /unified/usage-metering/usage
Integrations supported
  • Confluent
  • Datadog

Query parameters

Refer Specifying query parameters in Truto APIs

integrated_account_id
string · uuid
REQUIRED · 

The ID of the integrated account to use for the request.

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_format
string

The format of the response.

  • unified will return the response with unified mappings applied.
  • raw will return the raw response from the remote API.
  • normalized will apply the unified mappings and return the data in a normalized format.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
Example: unified
truto_key_by
string

By default the result attribute is an array of objects. This parameter allows you to specify a field in each result objects to use as key, which transforms the result array into an object with the array items keyed by the field. This is useful for when you want to use the result as a lookup table.

Example: id
truto_ignore_limit
boolean

Ignores the limit query parameter.

truto_ignore_remote_data
boolean

Excludes the remote_data attribute from the response.

truto_exclude_fields
array

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_query
object

Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.

Example: remote_query[foo]=bar
start_date
string · date-time

The start date for the usage data.

Integration specific notes
  • DatadogIf not specified, it defaults to the start of the current month. Only supports maximum resolution of a month.
  • ConfluentIf not specified, it defaults to the start of the current month.
Supported in
  • Confluent
  • Datadog
end_date
string · date-time

The end date for the usage data.

Integration specific notes
  • DatadogIf not specified, it defaults to the end of the current month or the end of the month specified in the start date. Only supports maximum resolution of a month.
  • ConfluentIf not specified, it defaults to the end of the current month or the end of the month specified in the start date.
Supported in
  • Confluent
  • Datadog

Response Body

result
object[]

List of Usage

id
string
REQUIRED · 

Unique identifier for the usage.

Supported in
  • Confluent
  • Datadog
product
object

The product associated with the usage.

Supported in
  • Confluent
  • Datadog
id
string
REQUIRED · 

Unique identifier for the product.

name
string

Name of the product.

metric_name
string

Name of the metric being charged for

Supported in
  • Confluent
  • Datadog
resources
object[]
Supported in
  • Confluent
id
string

Unique identifier for the resource.

name
string

Name of the resource.

workspace
object

The resource is present in this workspace.

id
string

Unique identifier for the workspace.

name
string

Name of the workspace.

organization
object

The organization associated with the usage.

Supported in
  • Datadog
id
string
REQUIRED · 

Unique identifier for the organization.

name
string

Name of the organization.

charges
object[]

The amounts charged for the usage.

Supported in
  • Confluent
  • Datadog
amount
number

The amount charged for the usage.

currency
string

The currency in which the charge is made.

type
string

The type of charge.

All possible enum values:
  • total
  • on_demand
  • committed
usage
object

The usage data for the product.

Supported in
  • Confluent
start_date
string · date-time

The start date for the usage data.

Supported in
  • Confluent
  • Datadog
end_date
string · date-time

The end date for the usage data.

Supported in
  • Confluent
  • Datadog
created_at
string · date-time

Date and time when the usage data metric was created.

updated_at
string · date-time

Date and time when the usage data metric was last updated.

remote_data
object

Raw data returned from the remote API call.

next_cursor
string

The cursor to use for the next page of results. Pass this value as next_cursor in the query parameter in the next request to get the next page of results.