Skip to content
Relay Port

API reference

Usage

The workspace's meters against its plan.

GET/usage

Get the workspace's meters for the current billing period

  • Scope usage:read

Each meter of the response against the plan's limit (null means no limit; posts count one per target), and the billing block state.

Request
curl https://api.relayport.dev/usage \
  -H "Authorization: Bearer $RELAYPORT_API_KEY"

Parameters

  • X-Api-Versionstringheader

    The API version. API keys answer in the version they were created with unless this header asks for another; the current version is 2026-12-01.

    One of 2026-12-01

  • X-Workspace-Idstring (uuid)header

    The workspace of the request. Required with a session; with an API key it may be left out and must match the key's workspace when sent.

Responses

200OK
  • dataUsagerequired

  • periodstringrequired

    The billing period the meters count, as YYYY-MM

  • accountsobjectrequired

  • usednumberrequired

  • limitnumber | nullrequired

    null means no limit

  • postsobjectrequired

  • usednumberrequired

  • limitnumber | nullrequired

    null means no limit

  • storageBytesobjectrequired

  • usednumberrequired

  • limitnumber | nullrequired

    null means no limit

  • planKeystringrequired

    One of free pro business enterprise

  • billingBlockstringrequired

    One of none grace blocked

  • graceUntilstring (date-time) | nullrequired

400WorkspaceRequired
401InvalidApiKeyUnauthenticated
403ForbiddenWorkspaceSuspended
404NotFound
422ValidationError
429RateLimited
503RateLimiterUnavailable

GET/usage/daily

Count posts per UTC day

  • Scope usage:read

Targets created, published and failed per day from from to to (default the last 30 days, at most 90).

Request
curl https://api.relayport.dev/usage/daily \
  -H "Authorization: Bearer $RELAYPORT_API_KEY"

Parameters

  • X-Api-Versionstringheader

    The API version. API keys answer in the version they were created with unless this header asks for another; the current version is 2026-12-01.

    One of 2026-12-01

  • X-Workspace-Idstring (uuid)header

    The workspace of the request. Required with a session; with an API key it may be left out and must match the key's workspace when sent.

  • fromstring (date-time)query

  • tostring (date-time)query

Responses

200OK
  • dataUsageDay[]required

  • datestringrequired

    YYYY-MM-DD (UTC)

  • postsintegerrequired

  • publishedintegerrequired

  • failedintegerrequired

400WorkspaceRequired
401InvalidApiKeyUnauthenticated
403ForbiddenWorkspaceSuspended
404NotFound
422ValidationError
429RateLimited
503RateLimiterUnavailable