---
title: "Pre-Release: Query data pool usage with service line and monthly breakdowns."
method: GET
path: "/public/v2/data-pools/usage"
tags: ["Data Pools"]
---

# Pre-Release: Query data pool usage with service line and monthly breakdowns.

`GET /public/v2/data-pools/usage`

Required permission: Service plan, View.<br/>This endpoint is available for select audiences only.

## Query parameters

- `dataPoolIds` string[]
- `asOfTimestamp` string, date-time
- `page` integer
- `limit` integer

## Response `200`

OK

- DataPoolUsageResponseV2PaginatedServiceResponse
  - `errors` ValidationResult[], nullable
    - `memberNames` string[], nullable
    - `errorMessage` string, nullable
  - `warnings` ValidationResult[], nullable
    - `memberNames` string[], nullable
    - `errorMessage` string, nullable
  - `information` string[], nullable
  - `isValid` boolean
  - `content` DataPoolUsageResponseV2Paginated
    - `pageIndex` integer
    - `limit` integer
    - `isLastPage` boolean
    - `results` DataPoolUsageResponseV2[], nullable
      - `dataPoolId` string — Data pool ID.
      - `dataBlocks` DataBlockUsageResponseV2[] — Usage by data blocks in the pool.
        - `startDate` string, date-time — UTC start date of the data block.
        - `endDate` string, date-time — UTC end date of the data block.
        - `totalAmountGB` number, double — Total GB capacity, calculated by multiplying BlocksCount and PerBlockAmountGB.
        - `consumedAmountGB` number, double — How much data has been used on the block.
        - `perBlockAmountGB` number, double — GB capacity per individual block.
        - `dataBlockType` 'IncludedWithBaseSubscription' | 'RecurringPerBillingCycle' | 'Overage' | 'OneTimePurchase'
        - `productId` string — Product ID of the data block.
        - `blocksCount` integer — Number of data blocks.
        - `serviceLineUsage` DataBlockServiceLineUsagePublicResponseV2[] — Usage breakdown by service lines.
          - `serviceLineNumber` string — Service line number.
          - `consumedAmountGB` number, double — GB amount that the service line consumed from the block.
        - `monthlyUsage` DataBlockMonthlyResponseV2[] — Usage breakdown by month.
          - `startDate` string, date-time — Start date of the respective month.
          - `endDate` string, date-time — End date of the respective month.
          - `serviceLineUsage` DataBlockServiceLineUsagePublicResponseV2[] — Montly usage breakdown by service lines.
            - `serviceLineNumber` string — Service line number.
            - `consumedAmountGB` number, double — GB amount that the service line consumed from the block.
    - `totalCount` integer

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden
- `422` — Unprocessable Content

---

[API](https://skmtc.net/starlink/apis/starlink-management-api.md) · [All operations](https://skmtc.net/starlink/apis/starlink-management-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/starlink/starlink-management-api/versions/a730bd0ddb42/schema)