Session
4 endpoints
POST /api/v5/artifacts/session/get
Get Session
Get session detail with groups and timeline.
Parameters:
| Name | In | Required | Description |
|---|---|---|---|
X-Api-Key | header | No | — |
authorization | header | No | — |
X-MCP | header | No | — |
Request body:
{
session_id: `string`
}Response:
{
actor_name?: `string` | `null`
session_exists?: `boolean`
session_id?: `string` | `null`
profile_id?: `string` | `null`
profile_name?: `string` | `null`
session_created_at?: `string` | `null`
active?: `boolean`
groups?: `ArtifactSessionGroup`[]
timeline?: `SessionTimelineItem`[]
}POST /api/v5/artifacts/session/refresh
Session Refresh
Refresh session materialized views and invalidate caches.
Parameters:
| Name | In | Required | Description |
|---|---|---|---|
X-Api-Key | header | No | — |
authorization | header | No | — |
X-MCP | header | No | — |
Response:
{
success: `boolean`
refreshed_views: `string`[]
invalidated_tags: `string`[]
}POST /api/v5/artifacts/session/docs
Get Session Docs Endpoint
Get composed documentation for the session analytics.
Parameters:
| Name | In | Required | Description |
|---|---|---|---|
X-Api-Key | header | No | — |
authorization | header | No | — |
X-MCP | header | No | — |
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`
}POST /api/v5/artifacts/session/export
Export Session
Export session data as a clean, denormalized ZIP.
Parameters:
| Name | In | Required | Description |
|---|---|---|---|
X-Api-Key | header | No | — |
authorization | header | No | — |
X-MCP | header | No | — |
Request body:
{
target_session_id: `string`
}Response:
{
upload_id: `string`
file_name: `string`
row_count: `integer`
}Last updated on