ibl-data-manager (4.84.1-ai-plus)

Copy

• Copy for LLM

  Copy page as Markdown for LLMs
• View as Markdown

  Open this page as Markdown
• Open in ChatGPT

  Get insights from ChatGPT
• Open in Claude

  Get insights from Claude
• Connect to Cursor

  Install MCP server on Cursor
• Connect to VS Code

  Install MCP server on VS Code

Flexible Invoice Report API – Billing summary with username and platform filtering.

This endpoint generates invoice reports with flexible filtering options:

• Platform admins can view their platform's data and filter by username within their platform
• Super admins can view any combination of username/platform or global summaries

Key Features:

• Flexible filtering by username and/or platform_key
• Essential metrics: total cost, sessions, usage period
• Provider breakdown (OpenAI, Anthropic, etc.)
• Top mentors/actions by cost
• Clean, invoice-ready format

Query Parameters:

• username: Filter by specific username (optional)
• platform_key: Filter by platform (optional, but required for platform admins)
• start_date, end_date: billing period (defaults to last 30 days)
• include_breakdown: show provider/mentor details (default: true)

Permission Logic:

• Platform admins: Must include platform_key matching their permission scope
• Super admins: Can use any combination of filters or none (global summary)

Examples:

# Platform admin viewing their platform
GET /api/analytics/financial/invoice?platform_key=web-app

# Platform admin viewing specific user in their platform
GET /api/analytics/financial/invoice?platform_key=web-app&username=john.doe

# Super admin viewing specific user across all platforms
GET /api/analytics/financial/invoice?username=john.doe

# Super admin viewing global summary
GET /api/analytics/financial/invoice

Response Structure:

{
  "entity": {
    "type": "user|platform|global",
    "username": "john.doe",
    "platform_key": "web-app",
    "platform_name": "Web Application",
    "display_name": "John Doe on Web Application"
  },
  "billing_period": {
    "start_date": "2025-01-01",
    "end_date": "2025-01-31",
    "days": 31
  },
  "summary": {
    "total_cost": 245.750,
    "total_sessions": 1250,
    "active_users": 85,
    "cost_per_session": 0.196
  },
  "breakdown": {
    "by_provider": [...],
    "by_mentor": [...],
    "by_action": [...]
  }
}

Retrieve a holistic snapshot of a learner across catalog enrollments, mentor engagement, skills, credentials, and time spent data. The metrics query parameter controls which sections are returned and defaults to courses when omitted.

Unified API endpoint for learner analytics.

This endpoint provides either:

1. Cross-platform summary (when only username is provided)
2. Platform-specific detailed data (when username + platform_key are provided)

Query params:

• username (required): Username of the learner
• platform_key (optional): Platform key for platform-specific data
• page (optional): Page number (default: 1)
• limit (optional): Records per page (default: 20, max: 100)

Returns:

• If platform_key provided: Detailed platform metrics
• If no platform_key: Cross-platform summary with pagination