Skip to main content
GET
Get admin dashboard data

Authorizations

X-HYS-API-Key
string
header
required

Gratona API key sent with the compatibility header X-HYS-API-Key.

Response

Dashboard payload for the authenticated client. Shape depends on cache state — fields outside data.org, stripe_msg, and status are only present once the cached stats are fully built.

data
object
stripe_msg
string

Stripe gateway health for the client. Empty string when Stripe is configured and reachable; otherwise a human-readable diagnostic such as 'No Payment Gateway Setup', 'No Stripe Publishable Key Setup', or the Stripe API error message. Omitted while the dashboard is in the initial 'reloading' state.

Example:

"No Payment Gateway Setup"

status
string
Example:

"success"