Skip to main content
GET
/report/health-check

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

uid
string

One or more publisher IDs, comma-separated. Defaults to all publishers in your organisation

range
enum<string>
default:thirty_days

Date range of health check reports to list. Ranges run up to and including today. custom requires start and end (YYYY-MM-DD). Other values return a 400 error.

Available options:
custom,
all_time,
seven_days,
fourteen_days,
thirty_days,
three_months,
six_months,
week_to_date,
month_to_date,
quarter_to_date,
year_to_date,
last_week,
last_month,
last_quarter,
last_year,
yesterday
start
string<date>

Start date when range=custom

end
string<date>

End date when range=custom

Response

200 - application/json
results
object[]
required

Health checks dated within the range, oldest first. For internal users, checks still being generated follow at the end

success
boolean
required