Skip to main content
POST
/
cloud
/
v1
/
usage_report
Get usage statistics report
curl --request POST \
  --url https://api.gcore.com/cloud/v1/usage_report \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "time_from": "2023-11-07T05:31:56Z",
  "time_to": "2023-11-07T05:31:56Z",
  "enable_last_day": false,
  "limit": 10,
  "offset": 0,
  "projects": [
    16,
    17,
    18,
    19,
    20
  ],
  "regions": [
    123
  ],
  "schema_filter": {
    "field": "flavor",
    "type": "instance",
    "values": [
      "g1-standard-1-2"
    ]
  },
  "sorting": [
    {
      "project": "asc"
    }
  ],
  "tags": {
    "conditions": [
      {
        "key": "<string>",
        "strict": true,
        "value": "<string>"
      }
    ],
    "condition_type": "OR"
  },
  "types": [
    "ai_cluster"
  ]
}
'
{
  "count": 1,
  "resources": [
    {
      "billing_metric_name": "<string>",
      "billing_value": 123,
      "billing_value_unit": "<string>",
      "first_seen": "2023-11-07T05:31:56Z",
      "flavor": "<string>",
      "last_name": "<string>",
      "last_seen": "2023-11-07T05:31:56Z",
      "project_id": 123,
      "region": 123,
      "region_id": 123,
      "tags": [
        {
          "os_distro": "ubuntu"
        },
        {
          "os_version": "22.04"
        }
      ],
      "type": "<string>",
      "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "totals": [
    {
      "billing_metric_name": "<string>",
      "billing_value": 123,
      "billing_value_unit": "<string>",
      "flavor": "<string>",
      "region": 123,
      "region_id": 123,
      "type": "<string>"
    }
  ]
}

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.

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.

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

​
projects
integer[] | null

List of project IDs

Example:
[16, 17, 18, 19, 20]
​
regions
integer[]

List of region IDs.

Example:
[1, 2, 3]
​
schema_filter
SchemaFilterSnapshotSerializer · object

Extended filter for field filtering.

Example:
{
  "field": "flavor",
  "type": "instance",
  "values": ["g1-standard-1-2"]
}
​
sorting
UsageReportSortingRequestSerializer · object[]

List of sorting filters (JSON objects) fields: project. directions: asc, desc.

​
tags
TagsFilterSerializer · object

Filter by tags

Example:
{
  "condition_type": "OR",
  "conditions": [
    {
      "key": "os_version",
      "strict": true,
      "value": "22.04"
    },
    {
      "key": "os_version",
      "strict": true,
      "value": "23.04"
    }
  ]
}
​
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:
["egress_traffic", "instance"]

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