Skip to main content
GET
Read one area's history

Authorizations

Authorization
string
header
required

A company admin credential for your company. Droplet installation tokens are refused.

Path Parameters

area
enum<string>
required

The area key. An area key.

Available options:
droplets,
connect,
payments,
checkout,
tax,
shipping,
fulfillment,
subscriptions,
mist_apps,
themes,
auth,
fairshare

Query Parameters

since
string<date-time>

The earliest check to return. Defaults to the start of the hour 7 days ago; no earlier than 90 days ago. Send the same since with every page of a cursor; a cursor from a different since answers 422.

page[cursor]
string

A cursor from meta.pagination.

page[limit]
integer

Checks per page, 1 to 100. Defaults to 25.

Required range: 1 <= x <= 100

Response

The area's checks.

company_health_checks
object[]
required
status
integer
required
meta
object
required

Response metadata included on every response body. A refused droplet installation token's 403 names the request request_id rather than request_uuid.