Skip to main content
POST
Get usage statistics report

Authorizations

Authorization
string
header
required

API key for authentication. Make sure to include the word apikey, followed by a single space and then your token. Example: apikey 1234$abcdef

Body

application/json
time_from
string<date-time>
required

The start date of the report period (ISO 8601). The report starts from the beginning of this day in UTC.

Example:

"2023-01-01T00:00:00Z"

time_to
string<date-time>
required

The end date of the report period (ISO 8601). The report ends just before the beginning of this day in UTC.

Example:

"2023-02-01T00:00:00Z"

enable_last_day
boolean
default:false

Expenses for the last specified day are taken into account. As the default, False.

Example:

false

limit
integer
default:10

The response resources limit. Defaults to 10.

Example:

10

offset
integer
default:0

The response resources offset.

Required range: x >= 0
Example:

0

order_by
enum<string>[]

List of sorting criteria in 'field.direction' format.

Available options:
billing_value.asc,
billing_value.desc,
first_seen.asc,
first_seen.desc,
last_name.asc,
last_name.desc,
last_seen.asc,
last_seen.desc,
project.asc,
project.desc,
region.asc,
region.desc,
type.asc,
type.desc
Example:
projects
integer[] | null

List of project IDs

Example:
regions
integer[]

List of region IDs.

Example:
schema_filter
SchemaFilterSnapshotSerializer · object

Extended filter for field filtering.

Example:
sorting
UsageReportSortingRequestSerializer · object[]
deprecated

(DEPRECATED Use 'order_by' instead) List of sorting filters (JSON objects) fields: project. directions: asc, desc.

tags
TagsFilterSerializer · object

Filter by tags

Example:
types
enum<string>[]

List of resource types to be filtered in the report.

Resource types for prebilling report

Available options:
ai_cluster,
ai_virtual_cluster,
backup,
baremetal,
basic_vm,
containers,
dbaas_postgresql_connection_pooler,
dbaas_postgresql_cpu,
dbaas_postgresql_memory,
dbaas_postgresql_public_network,
dbaas_postgresql_volume,
egress_traffic,
external_ip,
file_share,
floatingip,
functions,
functions_calls,
functions_traffic,
image,
inference,
instance,
load_balancer,
log_index,
snapshot,
volume
Example:

Response

200 - application/json

OK

count
integer
required

Total count of the resources

Required range: x >= 0
Example:

1

resources
(ResourceAiClusterSerializer · object | ResourceAiVirtualClusterSerializer · object | ResourceBaremetalSerializer · object | ResourceBasicVmSerializer · object | ResourceBackupSerializer · object | ResourceContainerSerializer · object | ResourceEgressTrafficSerializer · object | ResourceExternalIpSerializer · object | ResourceFileShareSerializer · object | ResourceFloatingIpSerializer · object | ResourceFunctionsSerializer · object | ResourceFunctionCallsSerializer · object | ResourceFunctionEgressTrafficSerializer · object | ResourceImagesSerializer · object | ResourceInferenceSerializer · object | ResourceInstanceSerializer · object | ResourceLoadBalancerSerializer · object | ResourceLogIndexSerializer · object | ResourceSnapshotSerializer · object | ResourceVolumeSerializer · object | ResourceDBAASPostgreSQLPoolerSerializer · object | ResourceDBAASPostgreSQLMemorySerializer · object | ResourceDBAASPostgreSQLPublicNetworkSerializer · object | ResourceDBAASPostgreSQLCPUSerializer · object | ResourceDBAASPostgreSQLVolumeSerializer · object)[]
required

These properties are common for all individual AI clusters in all cost and usage reports results (but not in totals)

totals
(TotalAiClusterReportItemSerializer · object | TotalAiVirtualClusterReportItemSerializer · object | TotalBaremetalReportItemSerializer · object | TotalBasicVmReportItemSerializer · object | TotalContainerReportItemSerializer · object | TotalEgressTrafficReportItemSerializer · object | TotalExternalIpReportItemSerializer · object | TotalFileShareReportItemSerializer · object | TotalFloatingIpReportItemSerializer · object | TotalFunctionsReportItemSerializer · object | TotalFunctionCallsReportItemSerializer · object | TotalFunctionEgressTrafficReportItemSerializer · object | TotalImagesReportItemSerializer · object | TotalInferenceReportItemSerializer · object | TotalInstanceReportItemSerializer · object | TotalLoadBalancerReportItemSerializer · object | TotalLogIndexReportItemSerializer · object | TotalSnapshotReportItemSerializer · object | TotalVolumeReportItemSerializer · object | TotalDBAASPostgreSQLPoolerReportItemSerializer · object | TotalDBAASPostgreSQLMemoryReportItemSerializer · object | TotalDBAASPostgreSQLPublicNetworkReportItemSerializer · object | TotalDBAASPostgreSQLCPUReportItemSerializer · object | TotalDBAASPostgreSQLVolumeReportItemSerializer · object)[]
required