HomeGuidesAPI ReferenceGuidesMRT APIConfiguration API
GitHubAirheads Developer Community
API Reference
GitHubAirheads Developer Community

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

get
https://de1.api.central.arubanetworks.com/network-monitoring/v1/client-onboarding-stage/count

Retrieves top grouped counts for onboarding by stage and status. Query params are kebab-case and the gateway route uses uri_args_type_conversion: true.

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 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 client_mac 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. Use all (or omit) for all supported stages.

Allowed:
string

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

Responses

Updated 7 days ago

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

Updated 7 days ago