Skip to navigation

Onboarding analytics

Active users, engine sessions, a funnel per guide with step drop-off, announcement reach, top pages and missing targets.

Needs the experts:read scope. A key without it gets 403 insufficient_scope. Routes not in this reference cannot be called with a key at all (403 not_available_to_api_keys).

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idstringRequired
The expert id.

Query parameters

daysenumOptional

7, 30 (default) or 90.

Allowed values:

Response

OK
daysintegerOptional
fromdatetimeOptional
todatetimeOptional
usersobjectOptional
sessionsobjectOptional
guideslist of objectsOptional
announcementslist of objectsOptional
topPageslist of objectsOptional
missingTargetslist of objectsOptional

Errors

401
Unauthorized Error
403
Forbidden Error
429
Too Many Requests Error