---
title: "Get your usage"
method: GET
path: "/v1/usage"
tags: ["usage"]
---

# Get your usage

`GET /v1/usage`

## Request

- Base URL: `https://api.pomerado.ai`
- URL: `https://api.pomerado.ai/v1/usage`
- Auth: HTTP bearer

Returns your account's charged tool calls and successful builds in a time range, optionally per integration, per member or as a series.

- A charged call is a tool call that finished with a result, or that refused your input itself, counted when Pomerado accepted it. A call that failed because the tool or the website broke is free, and so is one a repair finished. A build counts when it published a tool.
- With interval, the range also comes as a series of UTC hours, days or months.
- With group_by member, an Owner or Admin sees every member, including those who have left; a Member sees only their own row.
- coverage.complete says whether the whole range lies within recorded history.

## Query parameters

- `from` string
- `to` string
- `group_by` 'integration' | 'member'
- `interval` 'hour' | 'day' | 'month'

## Response `200`

Your usage in the range

- UsageReport
  - `from` string, nullable, required
  - `to` string, required
  - `as_of` string, required
  - `calls` integer, required: Charged tool calls in the range
  - `last_used_at` string, nullable, required
  - `unattributed_calls` integer, required: Calls in the range recorded before calls named their integration
  - `integrations_created` integer, required: Successful builds in the range: each build that published a tool, including one that added a tool to an existing integration
  - `coverage` object, required
    - `started_at` string, required: When usage recording began
    - `complete` boolean, required: The whole range lies within recorded history
    - `attribution_complete` boolean, required
  - `groups` object[]
    - `integration_id` string, required: an integration ID: int_ and 32 lowercase hex digits
    - `name` string, required: The integration's name, such as its site's
    - `calls` integer, required: a non-negative number
    - `last_used_at` string, nullable, required
    - `integrations_created` integer, required: Successful builds in the range that published a tool still in this integration
  - `series` object[]: Every bucket of the range in order, empty ones included. The first and last bucket count only their part inside the range
    - `start` string, required: The bucket's start, a UTC hour, day or month
    - `calls` integer, required: Charged tool calls in the bucket
    - `integrations_created` integer, required: Successful builds in the bucket
  - `members` object[]
    - `member_id` string, required: The member's user ID
    - `name` string, nullable, required
    - `email` string, nullable, required
    - `role` 'owner' | 'admin' | 'member', nullable, required: The member's current role; null once they have left the team
    - `calls` integer, required: Their charged tool calls in the range
    - `integrations_created` integer, required: Their successful builds in the range, including builds that added a tool to an existing integration
    - `last_used_at` string, nullable, required: Their last charged call in the range

## Other responses

- `400`: invalid_request
- `401`: unauthorized, reauthentication_required
- `403`: forbidden
- `500`: internal_error
- `503`: temporarily_unavailable

---

[API](https://skmtc.dev/pomerado/apis/pomerado-api.md) · [All operations](https://skmtc.dev/pomerado/apis/pomerado-api/llms.txt) · [OpenAPI document](https://skmtc.dev/pomerado/apis/pomerado-api/revisions/48dac2a3143e?raw)