Core-8
For instructions on how to authenticate to use this endpoint, see API overview.
Endpoints
DELETE | |
GET | |
GET | |
POST | |
GET | |
POST | |
DELETE | |
POST | |
GET | |
PATCH | |
DELETE | |
POST | |
PATCH | |
POST | |
GET | |
POST | |
POST | |
GET | |
POST |
Delete dashboard templates
Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true
Required API key scopes
dashboard_template:writePath parameters
- idstring
- project_idstring
Example request
DELETE /api /projects /:project_id /dashboard_templates /:idExample response
Status 405 No response body
Retrieve dashboard templates json schema
Path parameters
- project_idstring
Example request
GET /api /projects /:project_id /dashboard_templates /json_schemaExample response
Status 200 No response body
List all dashboards
Required API key scopes
dashboard:readPath parameters
- project_idstring
Query parameters
- formatstringOne of:
"json""txt" - limitinteger
- offsetinteger
Response
Example request
GET /api /projects /:project_id /dashboardsExample response
Status 200
Create dashboards
Required API key scopes
dashboard:writePath parameters
- project_idstring
Query parameters
- formatstringOne of:
"json""txt"
Request parameters
- namestring
- descriptionstring
- pinnedboolean
- last_accessed_atstring
- deletedboolean
- breakdown_colors
- data_color_theme_idinteger
- tagsarray
- restriction_level
- last_refreshstring
- use_templatestring
- use_dashboardinteger
- delete_insightsbooleanDefault:
false - _create_in_folderstring
Response
Example request
POST /api /projects /:project_id /dashboardsExample response
Status 201
List all dashboards sharing
Required API key scopes
sharing_configuration:readPath parameters
- dashboard_idinteger
- project_idstring
Example request
GET /api /projects /:project_id /dashboards /:dashboard_id /sharingExample response
Status 200
Create dashboards sharing passwords
Create a new password for the sharing configuration.
Required API key scopes
sharing_configuration:writePath parameters
- dashboard_idinteger
- project_idstring
Request parameters
- enabledboolean
- settings
- password_requiredboolean
Response
Example request
POST /api /projects /:project_id /dashboards /:dashboard_id /sharing /passwordsExample response
Status 200
Delete dashboards sharing passwords
Delete a password from the sharing configuration.
Required API key scopes
sharing_configuration:writePath parameters
- dashboard_idinteger
- password_idstring
- project_idstring
Example request
DELETE /api /projects /:project_id /dashboards /:dashboard_id /sharing /passwords /:password_idExample response
Status 204 No response body
Create dashboards sharing refresh
Required API key scopes
sharing_configuration:writePath parameters
- dashboard_idinteger
- project_idstring
Request parameters
- enabledboolean
- settings
- password_requiredboolean
Response
Example request
POST /api /projects /:project_id /dashboards /:dashboard_id /sharing /refreshExample response
Status 200
Retrieve dashboards
Required API key scopes
dashboard:readPath parameters
- idinteger
- project_idstring
Query parameters
- formatstringOne of:
"json""txt"
Response
Example request
GET /api /projects /:project_id /dashboards /:idExample response
Status 200
Update dashboards
Required API key scopes
dashboard:writePath parameters
- idinteger
- project_idstring
Query parameters
- formatstringOne of:
"json""txt"
Request parameters
- namestring
- descriptionstring
- pinnedboolean
- last_accessed_atstring
- deletedboolean
- breakdown_colors
- data_color_theme_idinteger
- tagsarray
- restriction_level
- last_refreshstring
- use_templatestring
- use_dashboardinteger
- delete_insightsbooleanDefault:
false - _create_in_folderstring
Response
Example request
PATCH /api /projects /:project_id /dashboards /:idExample response
Status 200
Delete dashboards
Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true
Required API key scopes
dashboard:writePath parameters
- idinteger
- project_idstring
Query parameters
- formatstringOne of:
"json""txt"
Example request
DELETE /api /projects /:project_id /dashboards /:idExample response
Status 405 No response body
Create dashboards analyze refresh result
Generate AI analysis comparing before/after dashboard refresh. Expects cache_key in request body pointing to the stored 'before' state.
Path parameters
- idinteger
- project_idstring
Query parameters
- formatstringOne of:
"json""txt"
Request parameters
- namestring
- descriptionstring
- pinnedboolean
- last_accessed_atstring
- deletedboolean
- breakdown_colors
- data_color_theme_idinteger
- tagsarray
- restriction_level
- last_refreshstring
- use_templatestring
- use_dashboardinteger
- delete_insightsbooleanDefault:
false - _create_in_folderstring
Example request
POST /api /projects /:project_id /dashboards /:id /analyze_refresh_resultExample response
Status 200 No response body
Update dashboards move tile
Path parameters
- idinteger
- project_idstring
Query parameters
- formatstringOne of:
"json""txt"
Request parameters
- namestring
- descriptionstring
- pinnedboolean
- last_accessed_atstring
- deletedboolean
- breakdown_colors
- data_color_theme_idinteger
- tagsarray
- restriction_level
- last_refreshstring
- use_templatestring
- use_dashboardinteger
- delete_insightsbooleanDefault:
false - _create_in_folderstring
Example request
PATCH /api /projects /:project_id /dashboards /:id /move_tileExample response
Status 200 No response body
Create dashboards snapshot
Snapshot the current dashboard state (from cache) for AI analysis. Returns a cache_key representing the 'before' state, to be used with analyze_refresh_result.
Path parameters
- idinteger
- project_idstring
Query parameters
- formatstringOne of:
"json""txt"
Request parameters
- namestring
- descriptionstring
- pinnedboolean
- last_accessed_atstring
- deletedboolean
- breakdown_colors
- data_color_theme_idinteger
- tagsarray
- restriction_level
- last_refreshstring
- use_templatestring
- use_dashboardinteger
- delete_insightsbooleanDefault:
false - _create_in_folderstring
Example request
POST /api /projects /:project_id /dashboards /:id /snapshotExample response
Status 200 No response body
Retrieve dashboards stream tiles
Stream dashboard metadata and tiles via Server-Sent Events. Sends metadata first, then tiles as they are rendered.
Path parameters
- idinteger
- project_idstring
Query parameters
- formatstringOne of:
"json""txt"
Example request
GET /api /projects /:project_id /dashboards /:id /stream_tilesExample response
Status 200 No response body
Create dashboards create from template json
Path parameters
- project_idstring
Query parameters
- formatstringOne of:
"json""txt"
Request parameters
- namestring
- descriptionstring
- pinnedboolean
- last_accessed_atstring
- deletedboolean
- breakdown_colors
- data_color_theme_idinteger
- tagsarray
- restriction_level
- last_refreshstring
- use_templatestring
- use_dashboardinteger
- delete_insightsbooleanDefault:
false - _create_in_folderstring
Example request
POST /api /projects /:project_id /dashboards /create_from_template_jsonExample response
Status 200 No response body
Create dashboards create unlisted dashboard
Creates an unlisted dashboard from template by tag. Enforces uniqueness (one per tag per team). Returns 409 if unlisted dashboard with this tag already exists.
Path parameters
- project_idstring
Query parameters
- formatstringOne of:
"json""txt"
Request parameters
- namestring
- descriptionstring
- pinnedboolean
- last_accessed_atstring
- deletedboolean
- breakdown_colors
- data_color_theme_idinteger
- tagsarray
- restriction_level
- last_refreshstring
- use_templatestring
- use_dashboardinteger
- delete_insightsbooleanDefault:
false - _create_in_folderstring
Example request
POST /api /projects /:project_id /dashboards /create_unlisted_dashboardExample response
Status 200 No response body
List all event definitions
Required API key scopes
event_definition:readPath parameters
- project_idstring
Query parameters
- limitinteger
- offsetinteger
Response
Example request
GET /api /projects /:project_id /event_definitionsExample response
Status 200
Create event definitions
Required API key scopes
event_definition:writePath parameters
- project_idstring
Request parameters
- namestring
- ownerinteger
- descriptionstring
- tagsarray
- verifiedboolean
- hiddenboolean
- enforcement_mode
- post_to_slackbooleanDefault:
false - default_columnsarray
Response
Example request
POST /api /projects /:project_id /event_definitions