Core-8
For instructions on how to authenticate to use this endpoint, see API overview.
Endpoints
GET | |
POST | |
GET | |
PATCH | |
DELETE | |
POST | |
GET | |
GET | |
POST | |
GET | |
POST | |
DELETE | |
POST | |
GET | |
PATCH | |
DELETE | |
POST | |
POST |
List all dashboard templates
Required API key scopes
dashboard_template:readPath parameters
- project_idstring
Query parameters
- is_featuredboolean
- limitinteger
- offsetinteger
- orderingstringOne of:
"-created_at""-template_name""created_at""template_name" - scopestringOne of:
"feature_flag""global""team"
Response
Example request
GET /api /projects /:project_id /dashboard_templatesExample response
Status 200
Create dashboard templates
Required API key scopes
dashboard_template:writePath parameters
- project_idstring
Request parameters
- template_namestring
- dashboard_descriptionstring
- dashboard_filters
- tagsarray
- tiles
- variables
- deletedboolean
- image_urlstring
- scope
- availability_contextsarray
- is_featuredboolean
Response
Example request
POST /api /projects /:project_id /dashboard_templatesExample response
Status 201
Retrieve dashboard templates
Required API key scopes
dashboard_template:readPath parameters
- idstring
- project_idstring
Response
Example request
GET /api /projects /:project_id /dashboard_templates /:idExample response
Status 200
Update dashboard templates
Required API key scopes
dashboard_template:writePath parameters
- idstring
- project_idstring
Request parameters
- template_namestring
- dashboard_descriptionstring
- dashboard_filters
- tagsarray
- tiles
- variables
- deletedboolean
- image_urlstring
- scope
- availability_contextsarray
- is_featuredboolean
Response
Example request
PATCH /api /projects /:project_id /dashboard_templates /:idExample response
Status 200
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
Create dashboard templates copy between projects
Creates a new team-scoped template in the target project (URL) from a team-scoped source template in the same organization. Global and feature-flag templates return 400. Cross-organization or inaccessible sources return 404. Source and destination projects must differ (400 if equal). Conflicting template_name values on the destination are auto-suffixed with (copy), (copy 2), …
Path parameters
- project_idstring
Request parameters
- source_template_idstring
Response
Example request
POST /api /projects /:project_id /dashboard_templates /copy_between_projectsExample response
Status 201
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
- quick_filter_idsarray
- 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
- quick_filter_idsarray
- 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
- quick_filter_idsarray
- 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
Create dashboards copy tile
Copy an existing dashboard tile to another dashboard (insight or text card; new tile row).
Required API key scopes
dashboard:writePath parameters
- idinteger
- project_idstring
Query parameters
- formatstringOne of:
"json""txt"
Request parameters
- fromDashboardIdinteger
- tileIdinteger
Response
Example request
POST /api /projects /:project_id /dashboards /:id /copy_tile