/usages

get

https://api.cloud.scenario.com/v1/usages

Provide usage data for the given filters. Such as consumed compute units, number of assets generated, etc. Maximum time range with custom startDate and endDate is 120 days. Granularity is calculated based on the time range.

Query Params

userId

string

The unique identifier of the user for the usage. If not provided, returns all usages for the team.

activityOffset

string

The offset for the activity data. Default is 0. If bad offset or empty, 0 will be returned. Must be a positive integer.

userIds

string

The unique identifiers of the users for filtering the usage data. If not provided, use all users. Can be one or more comma separated values.

type

string

The type of the usage data. Can be one or more comma separated values. Default is all types. If bad type or empty, all types will be returned.

endDate

string

The end date of the usage in ISO 8601 format. If not provided, use default timeRange. If provided, startDate is required.

projectIds

string

The project ids for filtering the usage data. If not provided, use all projects. Can be one or more comma separated values.

timeRange

string

The time range of the usage. If not provided, use default timeRange. If startDate and endDate provided, timeRange is ignored.

startDate

string

The start date of the usage in ISO 8601 format. If not provided, use default timeRange. If provided, endDate is required.

Response

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200 response