Skip to content
SarvexDocs
Esc
↑↓navigate↵open⌘Jpreview

Endpoint-health timeline — probe outcomes and status-check transitions

GET/stores/{store_id}/health/history
Authorization
AuthorizationBearer token (JWT) · headerrequired

JWT issued by the external IdP via the OAuth 2.0 authorization-code flow (Kinde in production; a simulator in test). The client obtains it and sends it as a Bearer token on every authenticated call. Sarvex's services verify it — issuer, audience, signature (IdP JWKS), expiry — and read identity and tenant from its claims. Sarvex does not issue or revoke these tokens. merchant_id/store_id are read from the verified claims (and the merchant→store mapping), never from the URL. The operator scope is required for /operator/*. Operators acting on a specific merchant pass the X-Operate-As header, which is recorded in the audit log.

Path parameters
store_idstringrequired

A store the caller's merchant owns. Authorized server-side against the principal; not a free-form tenant selector.

Query parameters
fromstring<date-time>
tostring<date-time>
Responses
200

History entries, newest first. Range (to - from) is capped at 30 days; defaults to the last 24 hours if from/to are omitted.

datahealth_history_entry[]required
Show properties
Array of health_history_entry
kindstring
Allowed:probe_completedthreshold_breachedrecovered
probe_typestring
Allowed:profile_reachablesignature_roundtripnegotiation_handshakecatalog_lookup
check_typestring
outcomestring
Allowed:passfaildegradedtimeout
severitystring
Allowed:healthydegradedcritical
detailstring
atstring<date-time>
pagepagerequired
Show properties
cursorstring | nullrequired
has_morebooleanrequired
404

Resource not found within the caller's tenant.

errorobjectrequired
Show properties
codestringrequired
messagestringrequired
detailsobject | null
422

Request body failed validation.

errorobjectrequired
Show properties
codestringrequired
messagestringrequired
detailsobject | null
Try it
Server
Authorization
Parameters
Request
curl -X GET "https://api.sarvex.example.com/v1/stores/string/health/history" \
  -H "Authorization: Bearer YOUR_TOKEN"
Response
{
  "data": [
    {
      "kind": "probe_completed",
      "probe_type": "profile_reachable",
      "check_type": "string",
      "outcome": "pass",
      "severity": "healthy",
      "detail": "string",
      "at": "2019-08-24T14:15:22Z"
    }
  ],
  "page": {
    "cursor": "string",
    "has_more": true
  }
}