teams
Get a summary of usage for the specified time range.
get/teams/{team_name}/usage-summary
Path parameters
team_namestring required
The unique name for the team.
Example:cloudquery
Query parameters
metricsstring[]
A list of metrics to include in the response. Each metric must be one of the predefined valid values. If not provided, only paid-rows will be included.
startstring date-time
A valid ISO-8601-formatted date and time, indicating the inclusive start of the query time range. Defaults to 30 days ago.
endstring date-time
A valid ISO-8601-formatted date and time, indicating the exclusive end of the query time range. Defaults to the current time.
aggregation_period'day' | 'month'
An aggregation period to sum data over. In other words, data will be returned at this granularity. Currently only supports day and month.
Response
A summary of usage for the specified time range.
Example response
{
"groups": [
{
"name": "plugin",
"value": "cloudquery/source/aws"
},
{
"name": "plugin",
"value": "cloudquery/source/gcp"
}
],
"values": [
{
"timestamp": "2021-01-01T00:00:00Z",
"paid_rows": [
100,
200
]
},
{
"timestamp": "2021-01-02T00:00:00Z",
"paid_rows": [
150,
300
]
}
]
}