---
title: "GET /teams/{team_name}/usage-summary"
method: GET
path: "/teams/{team_name}/usage-summary"
tags: ["teams"]
---

# GET /teams/{team_name}/usage-summary

`GET /teams/{team_name}/usage-summary`

Get a summary of usage for the specified time range.

## Path parameters

- `team_name` string, required — The unique name for the team.

## Query parameters

- `metrics` string[] — 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.
- `start` string, date-time — A valid ISO-8601-formatted date and time, indicating the inclusive start of the query time range. Defaults to 30 days ago.
- `end` string, 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'

## Response `200`

A summary of usage for the specified time range.

- UsageSummary — A usage summary for a team, summarizing the paid rows synced and/or cloud resource usage over a given time range. Note that empty or all-zero values are not included in the response.
  - `groups` UsageSummaryGroup[], required — The groups of the usage summary. Every group will have a corresponding value at the same index in the values array.
    - `name` string, required — The name of the group.
    - `value` string, required — The value of the group at this index.
  - `values` UsageSummaryValue[], required
    - `timestamp` string, date-time, required — The timestamp marking the start of a period.
    - `paid_rows` integer[] — The paid rows that were synced in this period, one per group.
    - `cloud_vcpu_seconds` integer[] — vCPU/seconds consumed in this period, one per group.
    - `cloud_vram_byte_seconds` integer[] — vRAM/byte-seconds consumed in this period, one per group.
    - `cloud_egress_bytes` integer[] — Egress bytes consumed in this period, one per group.
  - `metadata` object, required — Additional metadata about the usage summary. This may include information about the time range, the aggregation period, or other details.
    - `start` string, date-time, required — The inclusive start of the query time range.
    - `end` string, date-time, required — The exclusive end of the query time range.
    - `aggregation_period` 'day' | 'month', required — The aggregation period to sum data over. In other words, data will be returned at this granularity.
    - `metrics` string[], required — List of metrics included in the response.

## Other responses

- `400` — Bad request
- `401` — Requires authentication
- `403` — Forbidden
- `404` — Resource not found
- `422` — UnprocessableEntity
- `500` — Internal Error

---

[API](https://skmtc.net/cloudquery/apis/cloudquery-openapi-spec.md) · [All operations](https://skmtc.net/cloudquery/apis/cloudquery-openapi-spec/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cloudquery/cloudquery-openapi-spec/versions/4af580f9023b/schema)