Skip to main content
GET
/
waap
/
v1
/
prebilling
/
total
/
{metric}
Get aggregated billable consumption by metric
curl --request GET \
  --url https://api.gcore.com/waap/v1/prebilling/total/{metric} \
  --header 'Authorization: <api-key>'
{
  "limit": 123,
  "offset": 123,
  "count": 123,
  "results": [
    {
      "date": "<string>",
      "amount": 123
    }
  ]
}

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

Path Parameters

​
metric
enum<string>
required

The metric to get billable consumption for

Available options:
domains,
volume,
requests

Query Parameters

​
client_ids
integer[] | null

List of client IDs to filter the billable consumption by, if specified

Example:
[1, 2, 3]
​
from
string<date>
required

The report start date (inclusive) in ISO 8601 format

​
to
string<date>
required

The report end date (exclusive) in ISO 8601 format

​
limit
integer
default:100

Number of items to return

Required range: 0 <= x <= 100
​
offset
integer
default:0

Number of items to skip

Required range: 0 <= x <= 100000

Response

Successful Response

​
limit
integer
required

Number of items requested in the response

​
offset
integer
required

Items response offset used

​
count
integer
required

Number of items contain in the response

​
results
BillingReportItem · object[]
required

List of items returned in the response following given criteria