---
title: "Usage Summary"
method: GET
path: "/usage/summary"
tags: ["usage"]
---

# Usage Summary

`GET /usage/summary`

## Request

- Base URL: `https://api.os3robotics.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.os3robotics.com/usage/summary`
- Auth: one of:
  - HTTP bearer
  - HTTP bearer

Lines and summed quantity per meter (the portal's usage total) of the lines that ended
in [since, until), every line by default; `by_day=1`: per meter and UTC day (`day`).

## Query parameters

- `workspace_id` string, uuid, nullable
- `since` string, date-time, nullable
- `until` string, date-time, nullable
- `by_day` boolean

## Response `200`

Successful Response

- UsageTotal[]
  - `meter` string, required
  - `unit` string, required
  - `lines` integer, required
  - `quantity` string, required
  - `normalised_h100_seconds` string, nullable, required
  - `day` string, date, nullable

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/os3robotics/apis/os3-api.md) - [All operations](https://skmtc.dev/os3robotics/apis/os3-api/llms.txt) - [OpenAPI document](https://skmtc.dev/os3robotics/apis/os3-api/revisions/af32cd4f14bb?raw)
