Solace DocsDeveloper HubSolace Community
API Reference

Get usage aggregates for your organization

get
https://api.solace.cloud/api/v2/billing/usages/usageAggregates

Get aggregate usage by service, environment, or environment type between two points in time for the current organization.

This API is available to customers subscribed to a drawdown billing plan and reports usage for a single account (organization). If you have multiple accounts, you must run the API separately in each account.

The time query results include the timestamp specified in 'startTime' to the time before the specified 'endTime'. For example, if you specify the 'startTime' of 2023-01-01T00:00:00Z and the 'endTime' of 2023-02-01T00:00:00Z, the results include all of January 2023 and exclude any results from February.

Your token must have one of the permissions listed in the Token Permissions.


Token Permissions: [ billing_usage_summary:get ]

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
1 to 1000
Defaults to 100

The number of usage aggregates to return on each page.

integer
≥ 1
Defaults to 1

The page number to retrieve.

string
enum
required

Which attribute to aggregate usage by. One of service, environment, environmentType.

Allowed:
string

The ID of the resource of aggregateBy type (ex. aggregateBy=service&aggregateById=abc gets the usage for the broker service abc).

date-time
required

The timestamp of the start time of the query, in ISO 8601 date/time format.

date-time
required

The timestamp of the end time of the query, in ISO 8601 date/time format.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 12 months ago

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
*/*
application/json

Updated 12 months ago