HomeGuidesAPI ReferenceGuidesMRT APIConfiguration API
GitHubAirheads Developer Community
API Reference

Get top onboarding counts by stage and status for a specific field

Retrieves top grouped counts for onboarding by stage and status. Query params supports kebab-case

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

Start timestamp (ISO date format). Must be earlier than end-at. If start-at and end-at are not provided, the default time range is 3 hours.

string
required

End timestamp (ISO date format). Must be later than start-at. If start-at and end-at are not provided, the default time range is 3 hours.

string

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

string
enum

Grouping field key. Supported values and meanings: topclients (client MAC), topaccessdevices (AP MAC), band (radio band), topwlans (ESSID), topreasons (onboarding failure reason), topservers (auth server if stage is auth, dhcp server if stage is dhcp, dns server if stage is dns). Defaults to topclients in resolver when omitted.

Allowed:
string
enum

Optional status selector. Supported values: FAILED (stage failed), DELAY (successful with latency above threshold), SUCCESS (successful onboarding). Defaults to FAILED.

Allowed:
string
enum

Optional onboarding stage selector. Omit to get all supported stages.

Allowed:
string

Optional onboarding events version. If missing or non-numeric, default version is used.

string
enum

view-type supports DEFAULT, BY_CLIENT and BY_ATTEMPTS view. DEFAULT view gives consolidated metrics based on every single client onboarding attempt in given time period. BY_CLIENT gives consolidated metrics for all distinct client based on the single connection attempt made most recently or latest connection attempt in the given time period. BY_ATTEMPTS view gives the consolidated metrics by extracting latest or most recent connection attempt made per session from the client.

Allowed:
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