Usage

The team's usage and cost: CPU, memory, bandwidth, storage and build minutes per day, the plan's limits with their use, the estimated cost of the billing period on paid plans, what each project used, and the warnings at 80 % and 100 % that are on now

get/usage/report

Request

  • Base URL: https://hostingsurge.com/api/v1
  • URL: https://hostingsurge.com/api/v1/usage/report
  • Auth: one of:
    • HTTP bearer
    • API key in cookie __Host-hs_session

Query parameters

orgIdstring
range'7d' | '30d'
lang'en' | 'sv'

Response

Usage

organizationIdstring uuid required
range'7d' | '30d' required
fromstring required

UTC day, YYYY-MM-DD

tostring required

UTC day, YYYY-MM-DD

generatedAtstring required

ISO-8601 timestamp

planId'free' | 'pro' | 'business' required
costVisibleboolean required

the caller has billing:read: owners, admins and billing members see the cost, others do not

canUpgradeboolean required

the caller can change the plan (billing:write) and the team has limits to raise

unlimitedboolean required

a team without plan limits (the platform's own): no warnings and nothing to upgrade

hiddenProjectsinteger required

projects the caller cannot see: counted in the team figures only

Changes

No recorded changes to this operation across all 1 revision of this API.