---
title: "Usage Detailed"
method: GET
path: "/usage/detailed"
tags: ["Metadata"]
---

# Usage Detailed

`GET /usage/detailed`

## Request

- Base URL: `https://app.regrid.com/api/v2`
- URL: `https://app.regrid.com/api/v2/usage/detailed`
- Auth: one of:
  - API key in header `x-regrid-token`
  - API key in query parameter `token`

Detailed usage breakdown grouped by country and service. Same date range and history parameters as /usage.

## Query parameters

- `return_full_history` boolean
- `begin_date` string
- `end_date` string
- `return_by_token` boolean
- `return_by_this_token` boolean

## Response `200`

OK Usage Detailed response body

- object
  - `usage` object
    - `cycle_dates` CycleDates
      - `begin` number
      - `end` number
    - `cycle_usage` UsageDetailedRow[]
      - `country` string
      - `service` string
      - `requests` integer
      - `buildings` integer
      - `addresses` integer
      - `ownership` integer
      - `zoning` integer
      - `area` object
        - `sq_meters` number
        - `acres` number
        - `sq_miles` number
      - `parcels` integer
    - `date_range` DateRangeDetailedData
      - `begin_ts` number
      - `begin` string, date
      - `end` string, date
      - `total` UsageDetailedRow[]
        - `country` string
        - `service` string
        - `requests` integer
        - `buildings` integer
        - `addresses` integer
        - `ownership` integer
        - `zoning` integer
        - `area` object
          - `sq_meters` number
          - `acres` number
          - `sq_miles` number
        - `parcels` integer
    - `full_history` object[]
      - `begin_ts` number
      - `begin` string, date
      - `end` string, date
      - `total` UsageDetailedRow[]
        - `country` string
        - `service` string
        - `requests` integer
        - `buildings` integer
        - `addresses` integer
        - `ownership` integer
        - `zoning` integer
        - `area` object
          - `sq_meters` number
          - `acres` number
          - `sq_miles` number
        - `parcels` integer
      - `counts` object[]
        - `country` string
        - `service` string
        - `requests` integer
        - `buildings` integer
        - `addresses` integer
        - `ownership` integer
        - `zoning` integer
        - `area` object
          - `sq_meters` number
          - `acres` number
          - `sq_miles` number
        - `parcels` integer
        - `date` string, date

## Other responses

- `401`: Unauthorized

## Changes

- **2026-11-03** `b7a7c93d7494`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/regrid/apis/regrid-openapi-specification/changes/usage/detailed/get.md)

---

[API](https://skmtc.dev/regrid/apis/regrid-openapi-specification.md) - [All operations](https://skmtc.dev/regrid/apis/regrid-openapi-specification/llms.txt) - [OpenAPI document](https://skmtc.dev/regrid/apis/regrid-openapi-specification/revisions/b7a7c93d7494?raw)