Get workspace onboarding progress

Report setup milestones and the first-message activation state, plus chart-ready progress data.

GET/api/v2/analytics/onboarding

Authorization

AuthorizationBearer token (Anlyon API key) · headerrequired

Workspace API key sent as Authorization: Bearer <key>.

better-auth.session_tokenAPI key · cookierequired

Browser session used by dashboard-only operations.

Header parameters

X-Request-Idstring

Optional caller correlation ID. Unsafe or oversized values are replaced.

max length 128

Responses

200

Workspace onboarding status and progress projections returned.

successbooleanrequired

Allowed:true

dataOnboardingStatusrequired

Show properties

isOnboardedbooleanrequired

True after the workspace has invoked its first action, whatever the outcome.

hasApiKeybooleanrequired

hasInvocationsbooleanrequired

totalInvocationsintegerrequired

Action invocations recorded for the workspace.

min 0

stepsOnboardingStep[]required

Show properties

Array of OnboardingStep

idstringrequired

Allowed:api_keyfirst_invocation

completedbooleanrequired

labelstringrequired

completedStepsintegerrequired

min 0

totalStepsintegerrequired

min 0

completionPercentageintegerrequired

min 0 · max 100

chartsAnalyticsChartsrequired

Chart-library-ready projections of the canonical data payload.

401

Unauthorized - Invalid or missing API key

successbooleanrequired

requestIdstringrequired

Correlation ID matching the X-Request-Id response header.

errorobjectrequired

Show properties

codestring

messagestring

detailsobject

403

Authenticated credential lacks the required scope or workspace access.

successbooleanrequired

requestIdstringrequired

Correlation ID matching the X-Request-Id response header.

errorobjectrequired

Show properties

codestring

messagestring

detailsobject

429

Too Many Requests - Rate limit exceeded

successbooleanrequired

requestIdstringrequired

Correlation ID matching the X-Request-Id response header.

errorobjectrequired

Show properties

codestring

messagestring

detailsobject

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (Anlyon API key)Remember on this deviceInclude my values in samples

Parameters

X-Request-IdheaderOptional caller correlation ID. Unsafe or oversized values are replaced.

Request

curl -X GET 'https://api.anlyon.com/api/v2/analytics/onboarding' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch("https://api.anlyon.com/api/v2/analytics/onboarding", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.get(
    "https://api.anlyon.com/api/v2/analytics/onboarding",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

{
  "success": true,
  "data": {
    "isOnboarded": true,
    "hasApiKey": true,
    "hasInvocations": true,
    "totalInvocations": 0,
    "steps": [
      {
        "id": "api_key",
        "completed": true,
        "label": "string"
      }
    ],
    "completedSteps": 0,
    "totalSteps": 0,
    "completionPercentage": 0
  },
  "charts": {}
}

{
  "success": false,
  "error": {
    "code": "AUTHENTICATION_ERROR",
    "message": "Invalid or missing API key"
  }
}

{
  "success": false,
  "requestId": "req_0123456789abcdef0123456789abcdef",
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request data",
    "details": {}
  }
}

{
  "success": false,
  "error": {
    "code": "RATE_LIMIT_EXCEEDED",
    "message": "Rate limit exceeded. Please try again later."
  }
}