Skip to Content

Leaderboard

5 endpoints

POST /api/v5/artifacts/leaderboard/get

Get Leaderboard

Parameters:

NameInRequiredDescription
X-Api-KeyheaderNo
authorizationheaderNo
X-MCPheaderNo

Request body:

{ start_date?: `string` | `null` end_date?: `string` | `null` cohort_ids?: `string`[] | `null` department_ids?: `string`[] | `null` simulation_filters?: `string`[] | `null` target_profile_id?: `string` | `null` cohort_id?: `string` | `null` }

Response:

{ sections?: `LeaderboardSections` resources?: `LeaderboardResources` analytics?: `AnalyticsFacets` | `null` }

POST /api/v5/artifacts/leaderboard/search

Search Leaderboard

Get leaderboard profile rows (bottom table, paginated).

Parameters:

NameInRequiredDescription
X-Api-KeyheaderNo
authorizationheaderNo
X-MCPheaderNo

Request body:

{ start_date?: `string` | `null` end_date?: `string` | `null` cohort_ids?: `string`[] | `null` simulation_ids?: `string`[] | `null` department_ids?: `string`[] | `null` simulation_filters?: `string`[] | `null` target_profile_id?: `string` | `null` cohort_id?: `string` | `null` simulation_id?: `string` | `null` scenario_ids?: `string`[] | `null` search?: `string` | `null` sort_by?: `string` sort_order?: `string` page_limit?: `integer` page_offset?: `integer` }

Response:

{ data?: `LeaderboardDataRow`[] resources?: `LeaderboardResources` total_count?: `integer` simulation_options?: `FilterOption`[] profile_options?: `FilterOption`[] }

POST /api/v5/artifacts/leaderboard/refresh

Leaderboard Refresh

Refresh leaderboard caches.

Parameters:

NameInRequiredDescription
X-Api-KeyheaderNo
authorizationheaderNo
X-MCPheaderNo

Response:

{ success: `boolean` refreshed_views: `string`[] invalidated_tags: `string`[] }

POST /api/v5/artifacts/leaderboard/export

Export Leaderboard

Export all leaderboard data as a clean, denormalized ZIP.

Parameters:

NameInRequiredDescription
X-Api-KeyheaderNo
authorizationheaderNo
X-MCPheaderNo

Response:

{ upload_id: `string` file_name: `string` row_count: `integer` }

POST /api/v5/artifacts/leaderboard/docs

Get Leaderboard Docs Endpoint

Get composed documentation for the leaderboard analytics.

Parameters:

NameInRequiredDescription
X-Api-KeyheaderNo
authorizationheaderNo
X-MCPheaderNo

Request body:

{ entity_id?: `string` | `null` }

Response:

{ name: `string` type: `string` description: `string` artifact?: `DocsResponse` | `null` entries: `DocsResponse`[] resources: `DocsResponse`[] permissions: `OperationInfo`[] api_operations: `OperationInfo`[] page_metadata?: `DocsApiResponse` | `null` }

Last updated on