API Endpoint Index
The full list of public API endpoints on one page, for discovering everything the API can do without hopping between reference categories.
Every endpoint the public API exposes, on one page. Each resource still has its own guide with the full request/response detail — this page exists so you (or an agent) can see the complete surface area in a single fetch instead of walking the API Reference tab's per-category structure.
Every request needs an API key; the Scope column is which one — see Getting Started for the auth header and scope rules (GET/HEAD need api:read, everything else needs api:write).
| Method | Path | Scope | Guide |
|---|---|---|---|
| GET | /dashboards | api:read | Dashboards |
| GET | /dashboards/:dashboardId | api:read | Dashboards |
| POST | /dashboards/:dashboardId/export | api:write | Dashboards |
| GET | /data_feed_connections | api:read | Data Feed Connections |
| GET | /data_feed_connections/:connectionId | api:read | Data Feed Connections |
| GET | /data_feeds | api:read | Data Feeds |
| DELETE | /data_feeds/:feedId | api:write | Data Feeds |
| GET | /data_feeds/:feedId | api:read | Data Feeds |
| PUT | /data_feeds/:feedId | api:write | Data Feeds |
| GET | /data_feeds/:feedId/data | api:read | Data Feeds |
| GET | /data_feeds/:feedId/raw_data | api:read | Data Feeds |
| POST | /data_feeds/:feedId/raw_data | api:write | Data Feeds |
| POST | /data_feeds/:feedId/refresh | api:write | Data Feeds |
| GET | /data_feeds/creation_url | api:read | Data Feeds |
| POST | /data_feeds/generate | api:write | Data Feeds |
| GET | /direct_connections | api:read | Direct Connections |
| POST | /direct_connections | api:write | Direct Connections |
| DELETE | /direct_connections/:connectionId | api:write | Direct Connections |
| GET | /direct_connections/:connectionId | api:read | Direct Connections |
| PUT | /direct_connections/:connectionId | api:write | Direct Connections |
| GET | /direct_connections/:connectionId/metrics | api:read | Direct Connections |
| GET | /direct_connections/:connectionId/tables | api:read | Direct Connections |
| GET | /direct_connections/:connectionId/tables/:tableName/fields | api:read | Direct Connections |
| GET | /direct_connections/get_connection_fields/:dataBaseType | api:read | Direct Connections |
| GET | /events/subscriptions | api:read | Events (Webhook Subscriptions) |
| POST | /events/subscriptions | api:write | Events (Webhook Subscriptions) |
| DELETE | /events/subscriptions/:subscriptionId | api:write | Events (Webhook Subscriptions) |
| GET | /events/subscriptions/:subscriptionId | api:read | Events (Webhook Subscriptions) |
| GET | /goals | api:read | Goals |
| POST | /goals | api:write | Goals |
| DELETE | /goals/:goalId | api:write | Goals |
| GET | /goals/:goalId | api:read | Goals |
| PUT | /goals/:goalId | api:write | Goals |
| GET | /metrics | api:read | Metrics |
| POST | /metrics | api:write | Metrics |
| DELETE | /metrics/:metricId | api:write | Metrics |
| GET | /metrics/:metricId | api:read | Metrics |
| PUT | /metrics/:metricId | api:write | Metrics |
| POST | /metrics/:metricId/query | api:write | Metrics |
| GET | /query_builder/services | api:read | Query Builder |
| GET | /query_builder/services/:serviceName/views | api:read | Query Builder |
| GET | /query_builder/services/:serviceName/views/:viewName/fields | api:read | Query Builder |
| GET | /service_providers | api:read | Service Providers |
| GET | /tags | api:read | Tags |
| POST | /tags | api:write | Tags |
| DELETE | /tags/:tagId | api:write | Tags |
| GET | /tags/:tagId | api:read | Tags |
| PUT | /tags/:tagId | api:write | Tags |
The table above is generated from lib/spec-schemas/public-api-v1/openapi-document.mjs by npm run export-endpoint-index — the same CI step that exports and publishes openapi.json regenerates this file too, so it can't drift from the real endpoint list. Don't hand-edit the rows between the markers; add a new resource to GUIDE_BY_PREFIX in scripts/export-endpoint-index.mjs instead. For field-level request/response shape, use the API Reference tab, or fetch the live OpenAPI document directly — see Getting Started for the URL.
Updated 6 days ago