Xentree Docs
StatusMy Xentree
StatusMy Xentree
  1. Admin Stats & Members
  • Documentation
    • Introduction
    • Quickstart
    • Authentication
    • Conversations
    • Knowledge Base
    • Organizations
    • Admin Stats and Members
    • Profile & Analytics
    • Xentree English
    • Xentree Live
    • Skills Connector
    • Integration Tokens
    • API Keys
    • Errors and Limits
  • API Reference
    • Authentication
      • Register a new user
      • Log in and get an access token
      • Refresh an access token
      • Log out the current user
      • Get the current authenticated user
      • Update the current authenticated user
    • Conversations
      • List available AI providers
      • Generate an AI response
      • List conversations for the current user
      • Create a conversation
      • Delete a conversation
      • Get messages for a conversation
      • Start a conversation session
      • Update session activity
      • End a conversation session
      • Get current session status
      • Search indexed user content
      • Search infrastructure status
      • Rebuild search index
      • List notes
      • Create a note
      • Update a note
      • Delete a note
    • Knowledge Base
      • Search the knowledge base
      • List documents
      • Upload document
      • Query knowledge
    • Organizations
      • List organizations for the current user
      • Create an organization
      • Get organization details
      • Update organization details
      • Delete an organization
      • List organization members
      • Add a member to an organization
      • Update a member's role
      • Comprehensive member update (role, organization, team)
      • Remove a member from an organization
    • Admin Stats & Members
      • Engagement dashboard
        GET
      • Engagement member detail
        GET
      • Progress KPI cards
        GET
      • List learning objectives
        GET
      • Create learning objective
        POST
      • Archive learning objective
        DELETE
      • Suggest learning objectives (with draft)
        POST
      • Progress members table
        GET
      • Impact KPI cards
        GET
      • List learning targets
        GET
      • Create or update learning target
        POST
      • Suggest learning targets
        POST
    • Profile & Analytics
      • Get my XP profile
      • Get a user's public profile
      • Get streak status
      • Get weekly XP activity
      • Get learning pulse (365-day heatmap)
      • Get daily quests
      • Get learning time analytics
    • Xentree English
      • List XEL modules with user progress
      • Get XEL module details
      • Start an XEL module
      • Complete an XEL module
      • Regenerate a task variant
      • Get current XPI breakdown
      • Get XPI history
      • Start a learning session
      • End a learning session
      • Save a transcript entry
      • Get transcripts for a session
      • Submit a learning task response
      • Run AI evaluation for speaking or writing
      • Get the XEL dashboard overview
    • Xentree Live
      • Get remaining Xentree Live quota
      • Start a live session
      • Update an active live session heartbeat
      • End a live session
      • Update the user nickname used in Xentree Live
      • List live transcripts for the current user
      • Save live session transcripts
      • Get a single live transcript
    • Skills Connector
      • List active integrations for the current user
      • Start the Google Calendar OAuth flow
    • Integration Tokens
      • Issue tenant-scoped RS256 integration grant token
      • Verify tenant integration token signature and claims
      • Revoke integration token by token or jti
      • Rotate integration grant and optionally revoke previous token
      • Get tenant active JWKS material for verification
      • Get tenant active integration key fingerprints
      • Admin observability for integration token revocations
    • API Keys
      • List tenants
      • List API keys
      • Create an API key
      • Delete an API key
    • Health
      • Health check
      • Detailed health check
  • Schemas
    • Error
    • SimpleDetailResponse
    • HealthLivenessResponse
    • HealthDetailedResponse
    • HealthDetailedServices
    • DatabaseHealthStatus
    • DatabasePoolStatus
    • DatabaseConnectionStats
    • SimpleMessageResponse
    • LogoutResponse
    • TokenResponse
    • UserProfile
    • ChatRequest
    • ChatResponse
    • ConversationCreateRequest
    • ConversationResponse
    • CoreSearchConversationResult
    • CoreSearchMessageResult
    • CoreSearchResponse
    • TypesenseReindexRequest
    • TypesenseStatusResponse
    • NoteCreate
    • NoteUpdate
    • NoteResponse
    • CoreConversationSessionStartResponse
    • CoreConversationSessionActivityResponse
    • CoreConversationSessionEndResponse
    • CoreConversationSessionStatusResponse
    • AdminStatsProgressMemberRow
    • TenantResponse
    • AdminStatsProgressMembersResponse
    • AdminStatsOrganizationSummary
    • AdminStatsDateRangeSummary
    • AdminStatsKPIStat
    • AdminStatsPulseDay
    • AdminStatsPulseSummary
    • AdminStatsTeamPulse
    • AdminStatsTrendPoint
    • AdminStatsDistributionBucket
    • AdminStatsCohortRetentionCell
    • AdminStatsCohortRetentionRow
    • AdminStatsCohortAnalyticsRow
    • AdminStatsCohortRetentionAnalytics
    • AdminStatsCohortRetentionResponse
    • AdminStatsMemberActivityRow
    • AdminStatsAffiliation
    • AdminStatsMemberDirectoryRow
    • AdminStatsDashboardResponse
    • AdminStatsUserDetailResponse
    • AdminStatsMutationResponse
    • ProgressKPIItem
    • ProgressKPIResponse
    • ProgressKeyResultPayload
    • ProgressObjectiveCreateRequest
    • ProgressObjectiveSuggestRequest
    • ProgressObjectiveKeyResult
    • ProgressObjectiveResponse
    • ProgressObjectiveSuggestedItem
    • ProgressObjectiveSuggestResponse
    • ProgressTrendResponse
    • ProgressMemberAttempt
    • ProgressMemberSession
    • ProgressMemberRow
    • ProgressMembersResponse
    • ProgressDistributionBucket
    • ProgressDistributionResponse
    • ImpactKPIItem
    • ImpactKPIResponse
    • ImpactTrendResponse
    • ImpactLevelItem
    • ImpactLevelProgressionResponse
    • ImpactTeamBreakdownItem
    • ImpactTeamBreakdownResponse
    • ImpactTopPerformerItem
    • ImpactTopPerformersResponse
    • LearningTargetCreateRequest
    • LearningTargetResponse
    • LearningTargetListResponse
    • LearningTargetSuggestResponse
    • LVIWeightResponse
    • LVIWeightUpdateRequest
    • IntegrationOut
    • KnowledgeSearchRequest
    • KnowledgeSearchResultItem
    • KnowledgeSearchResponse
    • RagDocument
    • RagUploadResponse
    • RagQueryRequest
    • RagQueryResponse
    • LiveStartSessionRequest
    • LiveSessionResponse
    • LiveQuotaResponse
    • TranscriptTurn
    • SaveLiveTranscriptsRequest
    • OrganizationCreateRequest
    • OrganizationResponse
    • MemberResponse
    • XELModuleSummary
    • XELTaskSubmissionRequest
    • XELModuleDetail
    • XELTaskSubmissionResponse
    • XELEvaluationResponse
    • XELDashboardResponse
    • XELModuleStartResponse
    • XELModuleCompleteResponse
    • XELTaskRegenerateRequest
    • XELTaskRegenerateResponse
    • XELXpiResponse
    • XELXpiHistoryItem
    • XELSessionStartRequest
    • XELSessionStartResponse
    • XELSessionEndRequest
    • XELSessionEndResponse
    • XELTranscriptSaveRequest
    • XELTranscriptSaveResponse
    • XELTranscriptItem
    • LiveSessionEndResponse
    • LiveSessionHeartbeatResponse
    • LiveNicknameResponse
    • LiveTranscriptSaveResponse
    • LiveTranscriptListItem
    • LiveTranscriptListResponse
    • LiveTranscriptDetailResponse
    • XPProfileResponse
    • PublicXPProfileResponse
    • StreakStatusResponse
    • WeeklyActivityResponse
    • LearningPulseDayEntry
    • LearningPulseResponse
    • QuestItem
    • QuestsResponse
    • LearningTimeAnalyticsResponse
    • APIKeyCreateRequest
    • APIKeyResponse
    • IntegrationGrantRequest
    • IntegrationGrantResponse
    • IntegrationVerifyRequest
    • IntegrationVerifyResponse
    • IntegrationRevokeRequest
    • IntegrationRevokeResponse
    • IntegrationRotateRequest
    • IntegrationRotateResponse
    • IntegrationJWKSResponse
    • IntegrationFingerprintResponse
    • IntegrationTokenRevocationItem
  1. Admin Stats & Members

Engagement dashboard

GET
/api/v1/admin/stats/
Returns Engagement tab payload:
KPI cards, pulse heatmap, member breakdown, member directory, and retention cohort matrix/analytics.
Date query values are date-only (YYYY-MM-DD).

Request

Authorization
JWT Bearer
Add the parameter
Authorization
to Headers
Example:
Authorization: ********************
or
Query Params

Responses

🟢200
application/json
Dashboard returned.
Bodyapplication/json

Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://my.xentree.ai/api/v1/admin/stats/?organization_id=&team_id=&start_date=&end_date=' \
--header 'Authorization: Bearer <token>'
Response Response Example
{
    "organization": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string",
        "slug": "string",
        "member_count": 0
    },
    "date_range": {
        "start_date": "2019-08-24",
        "end_date": "2019-08-24",
        "previous_start_date": "2019-08-24",
        "previous_end_date": "2019-08-24",
        "days": 0
    },
    "kpis": [
        {
            "key": "string",
            "label": "string",
            "value": 0,
            "previous_value": 0,
            "delta": 0,
            "delta_pct": 0,
            "unit": "string",
            "direction": "string"
        }
    ],
    "pulse": {
        "activity_data": [
            {
                "date": "2019-08-24",
                "learning_time": 0,
                "sessions": 0,
                "level": 0
            }
        ],
        "summary": {
            "total_learning_time": 0,
            "total_sessions": 0,
            "active_days": 0,
            "period_start": "2019-08-24",
            "period_end": "2019-08-24"
        }
    },
    "trend": [
        {
            "date": "2019-08-24",
            "total_learning_hours": 0,
            "avg_learning_hours_per_member": 0
        }
    ],
    "activity_distribution": [
        {
            "bucket": "string",
            "member_count": 0
        }
    ],
    "retention": {
        "periods": [
            "string"
        ],
        "cohorts": [
            {
                "cohort": "string",
                "cohort_start_date": "2019-08-24",
                "cohort_size": 0,
                "periods": [
                    {
                        "period": 0,
                        "label": "string",
                        "retained_users": 0,
                        "retention_rate": 0
                    }
                ]
            }
        ],
        "analytics": {
            "metrics": [
                {
                    "key": "string",
                    "label": "string",
                    "value": 0,
                    "previous_value": 0,
                    "delta": 0,
                    "delta_pct": 0,
                    "unit": "string",
                    "direction": "string"
                }
            ],
            "top_cohorts": [
                {
                    "cohort": "string",
                    "cohort_start_date": "2019-08-24",
                    "cohort_size": 0,
                    "week_1_retention": 0,
                    "latest_retention": 0,
                    "retained_users_latest": 0
                }
            ]
        }
    },
    "member_activity": [
        {
            "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
            "username": "string",
            "full_name": "string",
            "email": "string",
            "avatar_url": "string",
            "learning_time": 0,
            "sessions": 0,
            "active_days": 0,
            "last_active": "2019-08-24T14:15:22.123Z",
            "status": "string"
        }
    ],
    "member_directory": [
        {
            "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
            "username": "string",
            "full_name": "string",
            "email": "string",
            "avatar_url": "string",
            "join_date": "2019-08-24T14:15:22.123Z",
            "subscription_plan": "string",
            "account_status": "string",
            "status": "string",
            "last_active": "2019-08-24T14:15:22.123Z",
            "organizations": [
                "string"
            ],
            "teams": [
                "string"
            ],
            "affiliations": [
                {
                    "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
                    "organization_name": "string",
                    "team_id": "810007d0-bec5-486c-b5d1-28fcd8a079ba",
                    "team_name": "string"
                }
            ]
        }
    ]
}
Modified at 2026-06-30 10:13:57
Previous
Remove a member from an organization
Next
Engagement member detail
Built with