v1

latestOpenAPI 3.0.02026-07-243339471.1 MB

Client Onboarding

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.

get/network-monitoring/v1/client-onboarding-score

Query parameters

start-atstring const

Example:2026-04-27T14:30:00Z

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.

end-atstring const

Example:2026-04-29T14:30:00Z

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.

site-idstring const

Example:6985764272

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

stagestring const

Example:assoc

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

versionstring const

Example:1

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

view-type'DEFAULT' | 'BY_CLIENT' | 'BY_ATTEMPTS'

Example:BY_CLIENT

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.

Response

Onboarding score details.

idstring required

A unique identifier for this onboarding score response.

typestring required

The resource type for onboarding score response.

overallScorestring

Overall score as average of valid stage scores; -1 when no valid stage score is available.

countinteger required

The number of stages returned in items.

Example response

{
  "id": "onboarding-score",
  "type": "onboarding-score",
  "overallScore": "51.62",
  "items": [
    {
      "stage": "assoc",
      "score": "77.90",
      "scorePercentage": "77.90%"
    }
  ],
  "count": 4
}