Skip to content

Retrieve group uptime value

Request

Returns uptime for a group which is based on uptime of all services in that group for a given date range.
Group is considered up if all of its services are not down. Every time frame when at least one of group services is down, is considered as downtime for this group.
Maximum length of date range is 18 months.

Security
ApiKeyAuth
Path
subdomainstringrequired

Unique subdomain of requested Hub.

group_idinteger, >= 1required

id of the group

Query
start_datestring, (date)

Start date for uptime calculations.
start_date and end_date range can't be bigger than 18 months.

Example:start_date=2025-01-01
end_datestring, (date)

End date for uptime calculations.
start_date and end_date range can't be bigger than 18 months.

Example:end_date=2025-01-01
api_versionstring

Api version

Value:"V3-R1"
curl -i -X GET \
  'https://subdomain-of-your-account.app.statushub.io/api/v3/hubs/{subdomain}/uptime/groups/{group_id}?start_date=2025-01-01&end_date=2025-01-01&api_version=V3-R1' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
uptimenumber, [ 0 .. 1 ]

Uptime value for the requested period. Value is between 0.0 and 1.0, where 0 means no uptime and 1 means 100% uptime.
Uptime value is always rounded down.

Example:0.9995
Response
{ "uptime": 0.9995 }