---
title: "List monthly aggregated data usage"
method: GET
path: "/usage/data/monthly"
tags: ["SIMs (Devices)"]
---

# List monthly aggregated data usage

`GET /usage/data/monthly`

## Request

- Base URL: `https://dashboard.hologram.io/api/1`
- URL: `https://dashboard.hologram.io/api/1/usage/data/monthly`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/hologram/apis/hologram-rest-api-v1/docs/usage/data/monthly/get.ts> (a function with typed inputs; its response is checked against the schema)

## Query parameters

- `limit` integer
- `before` integer
- `after` integer
- `linkid` integer
- `linkids` string
- `tagids` string
- `timestart` integer
- `timeend` integer
- `islive` boolean
- `aggregateall` boolean
- `startat` string
- `tagid` integer
- `tagname` string

## Response `200`

OK

- UsageMonthlyListResponse
  - `success` boolean: Indicates whether the request was successful.
  - `limit` integer: Maximum number of records returned per page
  - `size` integer: Number of records in this response
  - `continues` boolean: True if more records are available
  - `lastid` string: record_id of the last record returned; pass as startat to fetch the next page
  - `links` PaginationLinks
    - `path` string: The API endpoint path
    - `base` string: The API base URL
    - `next` string: URL to retrieve the next page of results
  - `data` UsageMonthlyRecord[]
    - `linkid` integer: Cellular link (SIM) ID
    - `record_id` string: Unique monthly record identifier (linkid concatenated with YYYYMM, e.g. "8676201801")
    - `month` integer: Calendar month (1–12)
    - `year` integer: Calendar year
    - `bytes` integer: Total bytes used in this month
    - `session_count` string: Number of data sessions in this month
    - `reporting_windows_with_usage` string: Number of reporting windows that recorded usage

## Other responses

- `401`: Unauthorized

---

[API](https://skmtc.dev/hologram/apis/hologram-rest-api-v1.md) - [All operations](https://skmtc.dev/hologram/apis/hologram-rest-api-v1/llms.txt) - [OpenAPI document](https://skmtc.dev/hologram/apis/hologram-rest-api-v1/revisions/1bc07dcd1631?raw)