---
title: "Get paginated usage data grouped over time."
method: GET
path: "/v1/usage/series"
tags: ["Usage"]
deprecated: true
---

# Get paginated usage data grouped over time.

`GET /v1/usage/series`

## Request

- Base URL: `https://api.checklyhq.com`
- URL: `https://api.checklyhq.com/v1/usage/series`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/checklyhq/apis/checkly-public-api/docs/v1/usage/series/get.ts> (a function with typed inputs; its response is checked against the schema)

> **Deprecated.**

Deprecated. Use GET /v2/usage/series for usage across terms and pricing rules.

## Query parameters

- `to` string, date: Date used to resolve usage terms. Defaults to today.
- `from` string, date: Start date, inclusive. Defaults to the resolved usage start date.
- `accountIds` string[], nullable: Account IDs included in the resolved usage terms. Repeat or comma-separate values.
- `checkTypes` string[], nullable: Check types to include. Repeat or comma-separate values.
- `interval` 'total' | 'day' | 'week' | 'month': Aggregation interval for response rows.
- `groupBy` 'account' | 'checkType' | 'account,checkType': Dimensions to group response rows by.
- `limit` integer: Maximum number of rows to return.
- `nextId` string: Opaque cursor returned by the previous page.

## Headers

- `x-checkly-account` string, uuid: Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general

## Response `200`

Successful

- UsageV1SeriesResponse
  - `usageTermsId` string, uuid, nullable, required
  - `period` UsageV1SeriesPeriod, required
    - `from` string, date, required
    - `to` string, date, required
    - `interval` 'total' | 'day' | 'week' | 'month', required
    - `groupBy` 'account' | 'checkType' | 'account,checkType', required
  - `data` UsageV1Row[], required
    - `credits` UsageV1Credits, required
      - `used` number, nullable, required
      - `percentOfBudget` number, nullable, required
    - `meters` UsageV1Meter[], required
      - union
        - UsageV1CheckRunMeter
          - `meterType` 'CHECK_RUN', required
          - `measures` object, required
            - `totalRuns` integer, required
            - `finalRuns` integer, required
            - `retryRuns` integer, required
            - `cancelledRuns` integer, required
            - `multiStepRequests` integer, required
            - `playwrightBillableDurationMs` integer, required
            - `degradedRuns` integer, required
            - `failedRuns` integer, required
            - `errorRuns` integer, required
            - `abortedRuns` integer, required
            - `overMaxResponseTimeRuns` integer, required
            - `standardBillableUnits` integer, required
            - `premiumBillableUnits` integer, required
        - UsageV1AiInvocationMeter: AI usage is metered against its own invocation budget and is not priced into `credits` or the credit projections.
          - `meterType` 'AI_INVOCATION', required
          - `measures` object, required
            - `invocations` integer, required: AI invocations consumed in the period: RCA analyses, weighted Automatic Check Repair invocations, and one charge for the first run of each customer-facing AI conversation. These share one account-wide allowance. Check-type series include an untyped row for account-wide conversation charges unless a check-type filter is applied.
            - `durationMs` integer, required: Total recorded execution duration for AI invocations; currently completed RCA analyses.
    - `periodStart` string, date, required
    - `periodEnd` string, date, required
    - `accountId` string
    - `checkType` 'AGENTIC' | 'API' | 'BROWSER' | 'HEARTBEAT' | 'ICMP' | 'MULTI_STEP' | 'TCP' | 'PLAYWRIGHT' | 'URL' | 'DNS' | 'SSL' | 'GRPC' | 'TRACEROUTE': Present for check-attributed usage. Account-wide AI invocation usage has no check type, even when grouped by check type.
  - `length` integer, required
  - `nextId` string, nullable, required

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found

## Changes

- **2026-10-31** `bc90d1bfa738`: 4 info
  - added the optional property `errorCode` to the response with the `400` status
  - added the optional property `errorCode` to the response with the `401` status
  - added the optional property `errorCode` to the response with the `403` status
  - added the optional property `errorCode` to the response with the `404` status
- **2026-10-17** `4698655f7ecd`: 1 info
  - endpoint deprecated
- **2026-10-07** `aba5d34c749b`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/checklyhq/apis/checkly-public-api/changes/v1/usage/series/get.md)

---

[API](https://skmtc.dev/checklyhq/apis/checkly-public-api.md) - [All operations](https://skmtc.dev/checklyhq/apis/checkly-public-api/llms.txt) - [OpenAPI document](https://skmtc.dev/checklyhq/apis/checkly-public-api/revisions/bc90d1bfa738?raw)