{ "opencollection": "1.0.0", "info": { "name": "PostHog actions dashboards API", "version": "1.0.0" }, "items": [ { "info": { "name": "dashboards", "type": "folder" }, "items": [ { "info": { "name": "environments_dashboards_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/dashboards/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "format", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query", "description": "Number of results to return per page." }, { "name": "offset", "value": "", "type": "query", "description": "The initial index from which to return the results." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_dashboards_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/dashboards/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "format", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_dashboards_collaborators_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/dashboards/:dashboard_id/collaborators/", "params": [ { "name": "dashboard_id", "value": "", "type": "path" }, { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_dashboards_collaborators_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/dashboards/:dashboard_id/collaborators/", "params": [ { "name": "dashboard_id", "value": "", "type": "path" }, { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_dashboards_collaborators_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/environments/:environment_id/dashboards/:dashboard_id/collaborators/:user__uuid/", "params": [ { "name": "dashboard_id", "value": "", "type": "path" }, { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "user__uuid", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_dashboards_sharing_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/dashboards/:dashboard_id/sharing/", "params": [ { "name": "dashboard_id", "value": "", "type": "path" }, { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_dashboards_sharing_passwords_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/dashboards/:dashboard_id/sharing/passwords/", "params": [ { "name": "dashboard_id", "value": "", "type": "path" }, { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create a new password for the sharing configuration." }, { "info": { "name": "environments_dashboards_sharing_passwords_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/environments/:environment_id/dashboards/:dashboard_id/sharing/passwords/:password_id/", "params": [ { "name": "dashboard_id", "value": "", "type": "path" }, { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "password_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete a password from the sharing configuration." }, { "info": { "name": "environments_dashboards_sharing_refresh_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/dashboards/:dashboard_id/sharing/refresh/", "params": [ { "name": "dashboard_id", "value": "", "type": "path" }, { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_dashboards_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/dashboards/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "filters_override", "value": "", "type": "query", "description": "JSON object to override dashboard filters for this request only (not persisted). Top-level keys replace; nested values are not deep-merged — pass the complete value for any key you override. See the dashboard filters schema for available keys (e.g., `date_from`, `date_to`, `properties`). Ignored when accessed via a dashboard sharing token." }, { "name": "format", "value": "", "type": "query" }, { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this dashboard." }, { "name": "variables_override", "value": "", "type": "query", "description": "JSON object to override dashboard variables for this request only (not persisted). Format: {\"\": {\"code_name\": \"\", \"variableId\": \"\", \"value\": }}. Each entry must include `code_name` — partial entries are silently dropped. The simplest workflow is to call `dashboard-get` first, copy the matching entry from the response's `variables` field, and mutate `value`. Top-level keys replace; nested values are not deep-merged. Ignored when accessed via a dashboard sharing token." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_dashboards_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/environments/:environment_id/dashboards/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "format", "value": "", "type": "query" }, { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this dashboard." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_dashboards_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/environments/:environment_id/dashboards/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "format", "value": "", "type": "query" }, { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this dashboard." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_dashboards_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/environments/:environment_id/dashboards/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "format", "value": "", "type": "query" }, { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this dashboard." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Hard delete of this model is not allowed. Use a patch API call to set \"deleted\" to true" }, { "info": { "name": "environments_dashboards_analyze_refresh_result_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/dashboards/:id/analyze_refresh_result/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "format", "value": "", "type": "query" }, { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this dashboard." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Generate AI analysis comparing before/after dashboard refresh.\nExpects cache_key in request body pointing to the stored 'before' state." }, { "info": { "name": "environments_dashboards_copy_tile_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/dashboards/:id/copy_tile/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "format", "value": "", "type": "query" }, { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this dashboard." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Copy an existing dashboard tile to another dashboard (insight or text card; new tile row)." }, { "info": { "name": "environments_dashboards_move_tile_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/environments/:environment_id/dashboards/:id/move_tile/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "format", "value": "", "type": "query" }, { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this dashboard." } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "environments_dashboards_reorder_tiles_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/dashboards/:id/reorder_tiles/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "format", "value": "", "type": "query" }, { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this dashboard." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_dashboards_run_insights_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/dashboards/:id/run_insights/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "filters_override", "value": "", "type": "query", "description": "JSON object to override dashboard filters for this request only (not persisted). Top-level keys replace; nested values are not deep-merged — pass the complete value for any key you override. See the dashboard filters schema for available keys (e.g., `date_from`, `date_to`, `properties`). Ignored when accessed via a dashboard sharing token." }, { "name": "format", "value": "", "type": "query" }, { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this dashboard." }, { "name": "output_format", "value": "", "type": "query", "description": "'optimized' (default) returns LLM-friendly formatted text per insight. 'json' returns the raw query result objects." }, { "name": "refresh", "value": "", "type": "query", "description": "Cache behavior. 'force_cache' (default) serves from cache even if stale. 'blocking' uses cache if fresh, otherwise recalculates. 'force_blocking' always recalculates." }, { "name": "variables_override", "value": "", "type": "query", "description": "JSON object to override dashboard variables for this request only (not persisted). Format: {\"\": {\"code_name\": \"\", \"variableId\": \"\", \"value\": }}. Each entry must include `code_name` — partial entries are silently dropped. The simplest workflow is to call `dashboard-get` first, copy the matching entry from the response's `variables` field, and mutate `value`. Top-level keys replace; nested values are not deep-merged. Ignored when accessed via a dashboard sharing token." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Run all insights on a dashboard and return their results." }, { "info": { "name": "environments_dashboards_snapshot_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/dashboards/:id/snapshot/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "format", "value": "", "type": "query" }, { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this dashboard." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Snapshot the current dashboard state (from cache) for AI analysis.\nReturns a cache_key representing the 'before' state, to be used with analyze_refresh_result." }, { "info": { "name": "environments_dashboards_stream_tiles_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/dashboards/:id/stream_tiles/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "filters_override", "value": "", "type": "query", "description": "JSON object to override dashboard filters for this request only (not persisted). Top-level keys replace; nested values are not deep-merged — pass the complete value for any key you override. See the dashboard filters schema for available keys (e.g., `date_from`, `date_to`, `properties`). Ignored when accessed via a dashboard sharing token." }, { "name": "format", "value": "", "type": "query" }, { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this dashboard." }, { "name": "layoutSize", "value": "", "type": "query", "description": "Layout size for tile positioning. 'sm' (default) for standard, 'xs' for mobile. The snake_case alias `layout_size` is also accepted for backward compatibility." }, { "name": "variables_override", "value": "", "type": "query", "description": "JSON object to override dashboard variables for this request only (not persisted). Format: {\"\": {\"code_name\": \"\", \"variableId\": \"\", \"value\": }}. Each entry must include `code_name` — partial entries are silently dropped. The simplest workflow is to call `dashboard-get` first, copy the matching entry from the response's `variables` field, and mutate `value`. Top-level keys replace; nested values are not deep-merged. Ignored when accessed via a dashboard sharing token." } ] }, "docs": "Stream dashboard metadata and tiles via Server-Sent Events. Sends metadata first, then tiles as they are rendered." }, { "info": { "name": "environments_dashboards_bulk_update_tags_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/dashboards/bulk_update_tags/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "format", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Bulk update tags on multiple objects.\n\nAccepts:\n- {\"ids\": [...], \"action\": \"add\"|\"remove\"|\"set\", \"tags\": [\"tag1\", \"tag2\"]}\n\nActions:\n- \"add\": Add tags to existing tags on each object\n- \"remove\": Remove specific tags from each object\n- \"set\": Replace all tags on each object with the provided list" }, { "info": { "name": "environments_dashboards_create_from_template_json_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/dashboards/create_from_template_json/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "format", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "environments_dashboards_create_unlisted_dashboard_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/dashboards/create_unlisted_dashboard/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "format", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates an unlisted dashboard from template by tag.\nEnforces uniqueness (one per tag per team).\nReturns 409 if unlisted dashboard with this tag already exists." }, { "info": { "name": "environments_data_color_themes_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/data_color_themes/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "limit", "value": "", "type": "query", "description": "Number of results to return per page." }, { "name": "offset", "value": "", "type": "query", "description": "The initial index from which to return the results." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_data_color_themes_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/data_color_themes/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_data_color_themes_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/data_color_themes/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this data color theme." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_data_color_themes_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/environments/:environment_id/data_color_themes/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this data color theme." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_data_color_themes_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/environments/:environment_id/data_color_themes/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this data color theme." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_data_color_themes_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/environments/:environment_id/data_color_themes/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this data color theme." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "dashboards_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/dashboards/", "params": [ { "name": "format", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query", "description": "Number of results to return per page." }, { "name": "offset", "value": "", "type": "query", "description": "The initial index from which to return the results." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "dashboards_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/dashboards/", "params": [ { "name": "format", "value": "", "type": "query" }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "dashboards_collaborators_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/dashboards/:dashboard_id/collaborators/", "params": [ { "name": "dashboard_id", "value": "", "type": "path" }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "dashboards_collaborators_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/dashboards/:dashboard_id/collaborators/", "params": [ { "name": "dashboard_id", "value": "", "type": "path" }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "dashboards_collaborators_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/projects/:project_id/dashboards/:dashboard_id/collaborators/:user__uuid/", "params": [ { "name": "dashboard_id", "value": "", "type": "path" }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." }, { "name": "user__uuid", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "dashboards_sharing_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/dashboards/:dashboard_id/sharing/", "params": [ { "name": "dashboard_id", "value": "", "type": "path" }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "dashboards_sharing_passwords_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/dashboards/:dashboard_id/sharing/passwords/", "params": [ { "name": "dashboard_id", "value": "", "type": "path" }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create a new password for the sharing configuration." }, { "info": { "name": "dashboards_sharing_passwords_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/projects/:project_id/dashboards/:dashboard_id/sharing/passwords/:password_id/", "params": [ { "name": "dashboard_id", "value": "", "type": "path" }, { "name": "password_id", "value": "", "type": "path" }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete a password from the sharing configuration." }, { "info": { "name": "dashboards_sharing_refresh_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/dashboards/:dashboard_id/sharing/refresh/", "params": [ { "name": "dashboard_id", "value": "", "type": "path" }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "dashboards_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/dashboards/:id/", "params": [ { "name": "filters_override", "value": "", "type": "query", "description": "JSON object to override dashboard filters for this request only (not persisted). Top-level keys replace; nested values are not deep-merged — pass the complete value for any key you override. See the dashboard filters schema for available keys (e.g., `date_from`, `date_to`, `properties`). Ignored when accessed via a dashboard sharing token." }, { "name": "format", "value": "", "type": "query" }, { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this dashboard." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." }, { "name": "variables_override", "value": "", "type": "query", "description": "JSON object to override dashboard variables for this request only (not persisted). Format: {\"\": {\"code_name\": \"\", \"variableId\": \"\", \"value\": }}. Each entry must include `code_name` — partial entries are silently dropped. The simplest workflow is to call `dashboard-get` first, copy the matching entry from the response's `variables` field, and mutate `value`. Top-level keys replace; nested values are not deep-merged. Ignored when accessed via a dashboard sharing token." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "dashboards_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/projects/:project_id/dashboards/:id/", "params": [ { "name": "format", "value": "", "type": "query" }, { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this dashboard." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "dashboards_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/projects/:project_id/dashboards/:id/", "params": [ { "name": "format", "value": "", "type": "query" }, { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this dashboard." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "dashboards_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/projects/:project_id/dashboards/:id/", "params": [ { "name": "format", "value": "", "type": "query" }, { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this dashboard." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Hard delete of this model is not allowed. Use a patch API call to set \"deleted\" to true" }, { "info": { "name": "dashboards_analyze_refresh_result_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/dashboards/:id/analyze_refresh_result/", "params": [ { "name": "format", "value": "", "type": "query" }, { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this dashboard." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Generate AI analysis comparing before/after dashboard refresh.\nExpects cache_key in request body pointing to the stored 'before' state." }, { "info": { "name": "dashboards_copy_tile_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/dashboards/:id/copy_tile/", "params": [ { "name": "format", "value": "", "type": "query" }, { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this dashboard." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Copy an existing dashboard tile to another dashboard (insight or text card; new tile row)." }, { "info": { "name": "dashboards_move_tile_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/projects/:project_id/dashboards/:id/move_tile/", "params": [ { "name": "format", "value": "", "type": "query" }, { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this dashboard." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "dashboards_reorder_tiles_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/dashboards/:id/reorder_tiles/", "params": [ { "name": "format", "value": "", "type": "query" }, { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this dashboard." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "dashboards_run_insights_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/dashboards/:id/run_insights/", "params": [ { "name": "filters_override", "value": "", "type": "query", "description": "JSON object to override dashboard filters for this request only (not persisted). Top-level keys replace; nested values are not deep-merged — pass the complete value for any key you override. See the dashboard filters schema for available keys (e.g., `date_from`, `date_to`, `properties`). Ignored when accessed via a dashboard sharing token." }, { "name": "format", "value": "", "type": "query" }, { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this dashboard." }, { "name": "output_format", "value": "", "type": "query", "description": "'optimized' (default) returns LLM-friendly formatted text per insight. 'json' returns the raw query result objects." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." }, { "name": "refresh", "value": "", "type": "query", "description": "Cache behavior. 'force_cache' (default) serves from cache even if stale. 'blocking' uses cache if fresh, otherwise recalculates. 'force_blocking' always recalculates." }, { "name": "variables_override", "value": "", "type": "query", "description": "JSON object to override dashboard variables for this request only (not persisted). Format: {\"\": {\"code_name\": \"\", \"variableId\": \"\", \"value\": }}. Each entry must include `code_name` — partial entries are silently dropped. The simplest workflow is to call `dashboard-get` first, copy the matching entry from the response's `variables` field, and mutate `value`. Top-level keys replace; nested values are not deep-merged. Ignored when accessed via a dashboard sharing token." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Run all insights on a dashboard and return their results." }, { "info": { "name": "dashboards_snapshot_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/dashboards/:id/snapshot/", "params": [ { "name": "format", "value": "", "type": "query" }, { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this dashboard." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Snapshot the current dashboard state (from cache) for AI analysis.\nReturns a cache_key representing the 'before' state, to be used with analyze_refresh_result." }, { "info": { "name": "dashboards_stream_tiles_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/dashboards/:id/stream_tiles/", "params": [ { "name": "filters_override", "value": "", "type": "query", "description": "JSON object to override dashboard filters for this request only (not persisted). Top-level keys replace; nested values are not deep-merged — pass the complete value for any key you override. See the dashboard filters schema for available keys (e.g., `date_from`, `date_to`, `properties`). Ignored when accessed via a dashboard sharing token." }, { "name": "format", "value": "", "type": "query" }, { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this dashboard." }, { "name": "layoutSize", "value": "", "type": "query", "description": "Layout size for tile positioning. 'sm' (default) for standard, 'xs' for mobile. The snake_case alias `layout_size` is also accepted for backward compatibility." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." }, { "name": "variables_override", "value": "", "type": "query", "description": "JSON object to override dashboard variables for this request only (not persisted). Format: {\"\": {\"code_name\": \"\", \"variableId\": \"\", \"value\": }}. Each entry must include `code_name` — partial entries are silently dropped. The simplest workflow is to call `dashboard-get` first, copy the matching entry from the response's `variables` field, and mutate `value`. Top-level keys replace; nested values are not deep-merged. Ignored when accessed via a dashboard sharing token." } ] }, "docs": "Stream dashboard metadata and tiles via Server-Sent Events. Sends metadata first, then tiles as they are rendered." }, { "info": { "name": "dashboards_bulk_update_tags_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/dashboards/bulk_update_tags/", "params": [ { "name": "format", "value": "", "type": "query" }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Bulk update tags on multiple objects.\n\nAccepts:\n- {\"ids\": [...], \"action\": \"add\"|\"remove\"|\"set\", \"tags\": [\"tag1\", \"tag2\"]}\n\nActions:\n- \"add\": Add tags to existing tags on each object\n- \"remove\": Remove specific tags from each object\n- \"set\": Replace all tags on each object with the provided list" }, { "info": { "name": "dashboards_create_from_template_json_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/dashboards/create_from_template_json/", "params": [ { "name": "format", "value": "", "type": "query" }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "dashboards_create_unlisted_dashboard_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/dashboards/create_unlisted_dashboard/", "params": [ { "name": "format", "value": "", "type": "query" }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates an unlisted dashboard from template by tag.\nEnforces uniqueness (one per tag per team).\nReturns 409 if unlisted dashboard with this tag already exists." }, { "info": { "name": "data_color_themes_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/data_color_themes/", "params": [ { "name": "limit", "value": "", "type": "query", "description": "Number of results to return per page." }, { "name": "offset", "value": "", "type": "query", "description": "The initial index from which to return the results." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "data_color_themes_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/data_color_themes/", "params": [ { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "data_color_themes_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/data_color_themes/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this data color theme." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "data_color_themes_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/projects/:project_id/data_color_themes/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this data color theme." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "data_color_themes_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/projects/:project_id/data_color_themes/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this data color theme." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "data_color_themes_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/projects/:project_id/data_color_themes/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this data color theme." }, { "name": "project_id", "value": "", "type": "path", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } } ] } ], "bundled": true }