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

Financial Details Analytics API – paginated cost tables with flexible grouping.

This endpoint returns tabular cost metrics aggregated by the dimension specified via the group_by query parameter. One or more KPI columns can be requested through the comma-separated metrics list while typical filters (date range, provider, platform_key, user, etc.) narrow the dataset. Results are paginated with page / limit.

Required query parameters

• group_by – provider | llm_model | username | mentor | platform
• metrics – csv list of KPI names, e.g. total_cost, sessions

Shared optional filters

• start_date, end_date – ISO yyyy-mm-dd (ignored when all_time=true)
• platform_key – tenant isolation
• mentor_unique_id – filter to one mentor
• username – filter to a learner
• provider / llm_model – filter to LLM provider / model
• all_time – true → lifetime totals
• page (default 1), limit (default 50)

Examples

1. Cost by provider for the last week

   GET /api/v2/analytics/financial/details?
       group_by=provider&
       metrics=total_cost&
       start_date=2025-01-01&
       end_date=2025-01-07&
       page=1&limit=10

2. Lifetime cost per user with extra KPIs
   GET /api/v2/analytics/financial/details?
       group_by=username&
       metrics=total_cost,sessions&
       all_time=true&page=1&limit=50

3. Cost by LLM model with tenant filter

   GET /api/v2/analytics/financial/details?
       group_by=llm_model&
       metrics=total_cost&
       platform_key=web-app&
       start_date=2025-01-01&end_date=2025-01-31

Response structure

{
  "page": 1,
  "limit": 10,
  "total_pages": 1,
  "total_records": 3,
  "rows": [
    {"provider": "openai", "total_cost": "2.50000"},
    {"provider": "anthropic", "total_cost": "1.00000"},
    {"provider": "azure",    "total_cost": "0.50000"}
  ],
  "metrics": [
    {
      "name": "total_cost",
      "unit": "$",
      "description": "Cost for this entity in period"
    }
  ],
  "total_cost": "4.00000"   // optional grand-total when available
}
``

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.