STstarlink
Account

Query data usage

Required permission: Service plan, View.<br/>Retrieve the real-time data tracking info for this account's data usage. For detailed instructions, please refer to the API documentation: https://starlink.readme.io/docs/data-usage-api

For a service line on a data pool, each data block's serviceLineUsage and monthlyUsage only include that service line. Use the data pool usage endpoint for every service line's usage of a pool.

post/public/v2/data-usage/query

Request

  • Base URL
    https://starlink.com/api
  • URL
    https://starlink.com/api/public/v2/data-usage/query
  • Auth
    HTTP bearer

Query parameters

pageinteger

Index of page to get.

limitinteger

Amount of service lines to retrieve per page. Defaults to 50, can request up to 250.

Request body

serviceLineNumbersstring[] nullable

Service line numbers to filter by. Queries for all service lines on account if omitted

previousBillingCyclesinteger nullable

Number of previous billing cycles to include in addition to the current one. Defaults to 1

activeServiceLinesOnlyboolean

Whether to filter by only active service lines. Defaults to true

queryStartDatestring date-time nullable

Override the first cycle's start date with the provided query start date

Response

Successfully retrieved data usage

informationstring[] nullable
isValidboolean

Changes

No recorded changes to this operation across all 2 revisions of this API.