HomeGuidesAPI ReferenceGuidesMRT APIConfiguration API
GitHubAirheads Developer Community
API Reference

Get onboarding score

Retrieves an onboarding score by stage and overall score for a given time range. If stage is not provided, scores are returned for default stages: assoc, auth, dhcp, and dns. If site-id is omitted tenant-level score is returned.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required

Start timestamp (epoch milliseconds or date-time string). Must be earlier than end-at.

string
required

End timestamp (epoch milliseconds or date-time string). Must be later than start-at.

string

Optional site identifier. If omitted, tenant-level score is returned.

string

Optional onboarding stage. Supported values: assoc, auth, dhcp, dns.

string

Optional onboarding events version. If not provided or non-numeric, the service uses a default version.

Responses

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json