---
name: analytics-routes
description: Handle 9 OpenAPI operation(s) under /api/v1/analytics for the analytics route group.
---

# analytics API Routes

Handle 9 OpenAPI operation(s) under /api/v1/analytics for the analytics route group.

Use the generated operation tools to make real API calls. Do not invent API responses.
If a tool reports missing setup, return the exact setup field name to the caller.
For write, update, or delete operations, state the intended action before calling the tool.

## Operations

### analytics_status_api_v1_analytics_status_get

- Operation ID: `analytics_status_api_v1_analytics_status_get`
- Route: `GET /api/v1/analytics/status`
- Mode: READ
- Summary: Check analytics configuration

### ingest_frontend_event_api_v1_analytics_events_post

- Operation ID: `ingest_frontend_event_api_v1_analytics_events_post`
- Route: `POST /api/v1/analytics/events`
- Mode: WRITE
- Summary: Ingest a frontend analytics event
- Body: JSON request body accepted.

### query_dashboard_detail_api_v1_analytics_dashboard_detail_query_name_get

- Operation ID: `query_dashboard_detail_api_v1_analytics_dashboard_detail_query_name_get`
- Route: `GET /api/v1/analytics/dashboard/detail/{query_name}`
- Mode: READ
- Summary: Run a detail dashboard query
- Parameters:
  - `query_name` in `path` required
  - `org_id` in `query` required

### query_dashboard_api_v1_analytics_dashboard_query_name_get

- Operation ID: `query_dashboard_api_v1_analytics_dashboard_query_name_get`
- Route: `GET /api/v1/analytics/dashboard/{query_name}`
- Mode: READ
- Summary: Run a dashboard analytics query
- Parameters:
  - `query_name` in `path` required
  - `org_id` in `query` required

### query_dashboard_db_api_v1_analytics_dashboard_db_query_name_get

- Operation ID: `query_dashboard_db_api_v1_analytics_dashboard_db_query_name_get`
- Route: `GET /api/v1/analytics/dashboard/db/{query_name}`
- Mode: READ
- Summary: Run a PostgreSQL-backed dashboard query
- Parameters:
  - `query_name` in `path` required
  - `org_id` in `query` required

### query_course_dashboard_detail_api_v1_analytics_dashboard_course_detail_query_nam

- Operation ID: `query_course_dashboard_detail_api_v1_analytics_dashboard_course_detail_query_nam`
- Route: `GET /api/v1/analytics/dashboard/course/detail/{query_name}`
- Mode: READ
- Summary: Run a course-level detail analytics query
- Parameters:
  - `query_name` in `path` required
  - `org_id` in `query` required
  - `course_uuid` in `query` required

### query_course_dashboard_api_v1_analytics_dashboard_course_query_name_get

- Operation ID: `query_course_dashboard_api_v1_analytics_dashboard_course_query_name_get`
- Route: `GET /api/v1/analytics/dashboard/course/{query_name}`
- Mode: READ
- Summary: Run a course-level analytics query
- Parameters:
  - `query_name` in `path` required
  - `org_id` in `query` required
  - `course_uuid` in `query` required

### export_analytics_api_v1_analytics_export_get

- Operation ID: `export_analytics_api_v1_analytics_export_get`
- Route: `GET /api/v1/analytics/export`
- Mode: READ
- Summary: Export analytics data
- Parameters:
  - `org_id` in `query` required

### get_plan_info_api_v1_analytics_plan_info_get

- Operation ID: `get_plan_info_api_v1_analytics_plan_info_get`
- Route: `GET /api/v1/analytics/plan-info`
- Mode: READ
- Summary: Get analytics plan tier for an organization
- Parameters:
  - `org_id` in `query` required