List all usages

GET/compute/{connection_id}/usage

Parameters

limitnumber default=100
offsetnumber default=0
updated_gtedate-time
Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
sort enum
order enum
querystring
Query string to search. eg. email address or name
instance_idstring
The ComputeInstance ID to filter by
start_gtestring
The start date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
end_ltstring
The end date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
fieldsstring array
Fields to return
rawstring
Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar
connection_idstring required
ID of the connection

Returns

idstring
Unique identifier for the usage record
created_atdate-time
When the usage record was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atdate-time
When the usage record was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
start_atdate-time
Start of the usage period (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
end_atdate-time
End of the usage period (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
instance_idstring
The instance the usage belongs to, when per-instance
category enum
Valid values:
"GPU"
"CPU"
"MEMORY"
"STORAGE"
"NETWORK"
What was consumed
quantitynumber
Amount consumed, in unit
unit enum
Valid values:
"GPU_HOUR"
"VCPU_SECOND"
"GB_SECOND"
"GB_MONTH"
"BYTE"
Unit of quantity
cost_amountnumber
Cost of the usage, when the vendor reports it
currencystring
Currency of cost_amount (ISO 4217)

Errors

Errors return the HTTP status code and a JSON body with statusCode, error (the short label) and message (a human-readable detail).

{
  "statusCode": 429,
  "error": "Too Many Requests",
  "message": "Too many requests to unified.to API; max requests per minute: N"
}
StatusErrorMeaning
400Bad RequestThe request was malformed or failed validation.
401UnauthorizedThe connection is likely broken; re-authorize it.
403ForbiddenThe connection is missing permissions or scopes.
404Not FoundThe requested resource does not exist.
429Too Many RequestsRate limit exceeded (see the two sources below).
500Internal Server ErrorAn unexpected error occurred.
501Not ImplementedNot supported by this integration.

Errors from the underlying integration pass through: the integration's status comes back as ours (429, 401, 403, 404 or 5xx), usually with its message. When the integration's error body is unclear, Unified extracts what it can and returns a clearer message.

429 Too Many Requests

A 429 has two possible sources:

  • The integration's own rate limit, passed through.
  • Unified's workspace limit: a rolling 60 seconds, set by plan, with the message Too many requests to unified.to API; max requests per minute: N.
const options = {
  method: 'GET',
  url: 'https://api.unified.to/compute/5de520f96e439b002043d8dc/usage',
  headers: {
    authorization: 'bearer .....'
  },
  params: {
    limit: 50,
    offset: 0,
    updated_gte: '2026-10-11T18:29:33.421Z',
    sort: 'updated_at',
    order: 'asc',
    query: '',
    instance_id: '',
    start_gte: '',
    end_lt: '',
    fields: '',
    raw: '',
  }
};

const results = await axios.request(options);
Are we missing anything? Let us know
Was this page helpful?