Skip to main content
GET
Check calculation status for wrapped statistics

Authorizations

X-HYS-API-Key
string
header
required

API key generated from Developer Settings. Format: hys_...

Path Parameters

year
integer
required

Year to check status for

Example:

2024

Response

Status check successful

status
enum<string>
Available options:
calculating,
completed,
failed,
unknown
Example:

"calculating"

lastCalculated
string<date-time> | null
error
string | null
progress
integer

Calculation progress percentage (0-100)

Example:

75