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

Get onboarding score

get
https://de1.api.central.arubanetworks.com/network-monitoring/v1/client-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

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

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 score is returned.

string

Optional onboarding stage. Supported values: assoc, auth, dhcp, dns. Omit to get all supported stages.

string

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

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

Updated 15 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 15 days ago