iblai-api-analytics

iblai-api-analytics

Read ibl.ai analytics from the platform API. One /api/analytics/ family serves every scope; the query params decide what you get:

• Agent (chat) analytics — add mentor_unique_id to scope any chat metric (topics, sessions, conversations, ratings, costs, transcripts) to one agent.
• Content analytics — /api/analytics/content/, keyed by metric=courses | programs | pathways | skills, for catalog engagement and time spent.
• Organization-wide analytics — omit mentor_unique_id for org totals.
• Per-user analytics — a single user's enrollments, grades, time spent, engagement, and cross-platform snapshot.

Reads are read-only; the only writes are Data Reports and a time-spent event.

The schema is the contract

These endpoints live on the Data Manager service and its live OpenAPI schema is the single source of truth — the URLs and params below exist for orientation and can drift between releases. Validate against the schema before building requests:

• Schema (raw): https://api.iblai.app/dm/api/docs/schema/
• Swagger UI: https://api.iblai.app/dm/api/docs/

# Confirm the analytics paths you're about to call exist verbatim:
curl -sS "https://api.iblai.app/dm/api/docs/schema/" -o /tmp/iblai_schema.yaml
grep -nE "^  /api/analytics/" /tmp/iblai_schema.yaml

Treat any mismatch between this skill and the schema as a bug in the skill — the deployed schema wins.

Auth & conventions

• dm_url = https://api.iblai.app/dm — analytics are Data Manager endpoints reached through the gateway's /dm prefix. Every URL below is written as {dm_url}/api/analytics/<path>; set dm_url=https://api.iblai.app/dm and use it as the prefix.
• Header: Authorization: Api-Token $IBLAI_API_KEY on every request.
• Placeholders:
  • {platform} = your workspace key = $IBLAI_ORG. On the wire it is the platform_key query param and the orgs/{platform} / platforms/{platform} path segment — same value everywhere.
  • {username} = $IBLAI_USERNAME.
  • {mentor} = an agent's unique id — optional: include mentor_unique_id={mentor} for agent scope, omit for org-wide.
• Shared query params (available on most endpoints):
  • platform_key={platform} — the workspace key (required on most reads).
  • date_filter — today | 7d | 30d | 90d | all_time | custom. custom requires start_date and end_date (both yyyy-MM-dd).
  • mentor_unique_id={mentor} — narrows any chat metric to one agent.
  • granularity — hour | day | week | month (time-series endpoints).
  • usergroup_ids — repeat to narrow results to specific user groups.
  • page / limit — pagination on list/details endpoints.
• Each endpoint below lists its own params; required ones are marked and enum values are given inline. [&param=value] means optional.
• Not connected yet? Run /iblai-api-login first.