{ "opencollection": "1.0.0", "info": { "name": "PostHog API", "version": "1.0.0" }, "items": [ { "info": { "name": "code-invites", "type": "folder" }, "items": [ { "info": { "name": "Check access", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/code/invites/check-access/" }, "docs": "Check whether the authenticated user has access to PostHog Code." }, { "info": { "name": "Redeem invite code", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/code/invites/redeem/", "body": { "type": "json", "data": "{}" } }, "docs": "Redeem a PostHog Code invite code to enable access." } ] }, { "info": { "name": "alerts", "type": "folder" }, "items": [ { "info": { "name": "environments_alerts_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/alerts/", "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_alerts_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/alerts/", "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_alerts_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/alerts/:id/", "params": [ { "name": "checks_date_from", "value": "", "type": "query", "description": "Relative date string for the start of the check history window (e.g. '-24h', '-7d', '-14d'). Returns checks created after this time. Max retention is 14 days." }, { "name": "checks_date_to", "value": "", "type": "query", "description": "Relative date string for the end of the check history window (e.g. '-1h', '-1d'). Defaults to now if not specified." }, { "name": "checks_limit", "value": "", "type": "query", "description": "Maximum number of check results to return (default 5, max 500). Applied after date filtering." }, { "name": "checks_offset", "value": "", "type": "query", "description": "Number of newest checks to skip (0-based). Use with checks_limit for pagination. Default 0." }, { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this alert configuration." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_alerts_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/environments/:environment_id/alerts/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this alert configuration." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_alerts_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/environments/:environment_id/alerts/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this alert configuration." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_alerts_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/environments/:environment_id/alerts/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this alert configuration." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_alerts_simulate_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/alerts/simulate/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Simulate a detector on an insight's historical data. Read-only — no AlertCheck records are created." }, { "info": { "name": "alerts_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/alerts/", "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": "alerts_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/alerts/", "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": "alerts_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/alerts/:id/", "params": [ { "name": "checks_date_from", "value": "", "type": "query", "description": "Relative date string for the start of the check history window (e.g. '-24h', '-7d', '-14d'). Returns checks created after this time. Max retention is 14 days." }, { "name": "checks_date_to", "value": "", "type": "query", "description": "Relative date string for the end of the check history window (e.g. '-1h', '-1d'). Defaults to now if not specified." }, { "name": "checks_limit", "value": "", "type": "query", "description": "Maximum number of check results to return (default 5, max 500). Applied after date filtering." }, { "name": "checks_offset", "value": "", "type": "query", "description": "Number of newest checks to skip (0-based). Use with checks_limit for pagination. Default 0." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this alert configuration." }, { "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": "alerts_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/projects/:project_id/alerts/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this alert configuration." }, { "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": "alerts_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/projects/:project_id/alerts/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this alert configuration." }, { "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": "alerts_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/projects/:project_id/alerts/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this alert configuration." }, { "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": "alerts_simulate_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/alerts/simulate/", "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}}" } }, "docs": "Simulate a detector on an insight's historical data. Read-only — no AlertCheck records are created." } ] }, { "info": { "name": "batch_exports", "type": "folder" }, "items": [ { "info": { "name": "environments_batch_exports_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/batch_exports/", "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_batch_exports_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/batch_exports/", "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_batch_exports_backfills_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/batch_exports/:batch_export_id/backfills/", "params": [ { "name": "batch_export_id", "value": "", "type": "path" }, { "name": "cursor", "value": "", "type": "query", "description": "The pagination cursor value." }, { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "ordering", "value": "", "type": "query", "description": "Which field to use when ordering the results." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "ViewSet for BatchExportBackfill models.\n\nAllows creating and reading backfills, but not updating or deleting them." }, { "info": { "name": "environments_batch_exports_backfills_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/batch_exports/:batch_export_id/backfills/", "params": [ { "name": "batch_export_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 backfill for a BatchExport." }, { "info": { "name": "environments_batch_exports_backfills_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/batch_exports/:batch_export_id/backfills/:id/", "params": [ { "name": "batch_export_id", "value": "", "type": "path" }, { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this batch export backfill." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "ViewSet for BatchExportBackfill models.\n\nAllows creating and reading backfills, but not updating or deleting them." }, { "info": { "name": "environments_batch_exports_backfills_cancel_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/batch_exports/:batch_export_id/backfills/:id/cancel/", "params": [ { "name": "batch_export_id", "value": "", "type": "path" }, { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this batch export backfill." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Cancel a batch export backfill." }, { "info": { "name": "environments_batch_exports_runs_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/batch_exports/:batch_export_id/runs/", "params": [ { "name": "batch_export_id", "value": "", "type": "path" }, { "name": "cursor", "value": "", "type": "query", "description": "The pagination cursor value." }, { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "ordering", "value": "", "type": "query", "description": "Which field to use when ordering the results." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_batch_exports_runs_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/batch_exports/:batch_export_id/runs/:id/", "params": [ { "name": "batch_export_id", "value": "", "type": "path" }, { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this batch export run." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_batch_exports_runs_cancel_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/batch_exports/:batch_export_id/runs/:id/cancel/", "params": [ { "name": "batch_export_id", "value": "", "type": "path" }, { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this batch export run." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Cancel a batch export run." }, { "info": { "name": "environments_batch_exports_runs_logs_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/batch_exports/:batch_export_id/runs/:id/logs/", "params": [ { "name": "after", "value": "", "type": "query", "description": "Only return entries after this ISO 8601 timestamp." }, { "name": "batch_export_id", "value": "", "type": "path" }, { "name": "before", "value": "", "type": "query", "description": "Only return entries before this ISO 8601 timestamp." }, { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this batch export run." }, { "name": "instance_id", "value": "", "type": "query", "description": "Filter logs to a specific execution instance." }, { "name": "level", "value": "", "type": "query", "description": "Comma-separated log levels to include, e.g. 'WARN,ERROR'. Valid levels: DEBUG, LOG, INFO, WARN, ERROR." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of log entries to return (1-500, default 50)." }, { "name": "search", "value": "", "type": "query", "description": "Case-insensitive substring search across log messages." } ] } }, { "info": { "name": "environments_batch_exports_runs_retry_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/batch_exports/:batch_export_id/runs/:id/retry/", "params": [ { "name": "batch_export_id", "value": "", "type": "path" }, { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this batch export run." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Retry a batch export run.\n\nWe use the same underlying mechanism as when backfilling a batch export, as retrying\na run is the same as backfilling one run." }, { "info": { "name": "environments_batch_exports_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/batch_exports/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this batch export." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_batch_exports_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/environments/:environment_id/batch_exports/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this batch export." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_batch_exports_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/environments/:environment_id/batch_exports/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this batch export." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_batch_exports_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/environments/:environment_id/batch_exports/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this batch export." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_batch_exports_logs_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/batch_exports/:id/logs/", "params": [ { "name": "after", "value": "", "type": "query", "description": "Only return entries after this ISO 8601 timestamp." }, { "name": "before", "value": "", "type": "query", "description": "Only return entries before this ISO 8601 timestamp." }, { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this batch export." }, { "name": "instance_id", "value": "", "type": "query", "description": "Filter logs to a specific execution instance." }, { "name": "level", "value": "", "type": "query", "description": "Comma-separated log levels to include, e.g. 'WARN,ERROR'. Valid levels: DEBUG, LOG, INFO, WARN, ERROR." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of log entries to return (1-500, default 50)." }, { "name": "search", "value": "", "type": "query", "description": "Case-insensitive substring search across log messages." } ] } }, { "info": { "name": "environments_batch_exports_pause_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/batch_exports/:id/pause/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this batch export." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Pause a BatchExport." }, { "info": { "name": "environments_batch_exports_run_test_step_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/batch_exports/:id/run_test_step/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this batch export." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_batch_exports_unpause_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/batch_exports/:id/unpause/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this batch export." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Unpause a BatchExport." }, { "info": { "name": "environments_batch_exports_run_test_step_new_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/batch_exports/run_test_step_new/", "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_batch_exports_test_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/batch_exports/test/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "org_organizations_batch_exports_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/organizations/:organization_id/batch_exports/", "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": "organization_id", "value": "", "type": "path", "description": "ID of the organization you're trying to access. To find the ID of the organization, make a call to /api/organizations/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "org_organizations_batch_exports_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/organizations/:organization_id/batch_exports/", "params": [ { "name": "organization_id", "value": "", "type": "path", "description": "ID of the organization you're trying to access. To find the ID of the organization, make a call to /api/organizations/." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "org_organizations_batch_exports_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/organizations/:organization_id/batch_exports/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this batch export." }, { "name": "organization_id", "value": "", "type": "path", "description": "ID of the organization you're trying to access. To find the ID of the organization, make a call to /api/organizations/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "org_organizations_batch_exports_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/organizations/:organization_id/batch_exports/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this batch export." }, { "name": "organization_id", "value": "", "type": "path", "description": "ID of the organization you're trying to access. To find the ID of the organization, make a call to /api/organizations/." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "org_organizations_batch_exports_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/organizations/:organization_id/batch_exports/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this batch export." }, { "name": "organization_id", "value": "", "type": "path", "description": "ID of the organization you're trying to access. To find the ID of the organization, make a call to /api/organizations/." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "org_organizations_batch_exports_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/organizations/:organization_id/batch_exports/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this batch export." }, { "name": "organization_id", "value": "", "type": "path", "description": "ID of the organization you're trying to access. To find the ID of the organization, make a call to /api/organizations/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "org_organizations_batch_exports_logs_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/organizations/:organization_id/batch_exports/:id/logs/", "params": [ { "name": "after", "value": "", "type": "query", "description": "Only return entries after this ISO 8601 timestamp." }, { "name": "before", "value": "", "type": "query", "description": "Only return entries before this ISO 8601 timestamp." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this batch export." }, { "name": "instance_id", "value": "", "type": "query", "description": "Filter logs to a specific execution instance." }, { "name": "level", "value": "", "type": "query", "description": "Comma-separated log levels to include, e.g. 'WARN,ERROR'. Valid levels: DEBUG, LOG, INFO, WARN, ERROR." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of log entries to return (1-500, default 50)." }, { "name": "organization_id", "value": "", "type": "path", "description": "ID of the organization you're trying to access. To find the ID of the organization, make a call to /api/organizations/." }, { "name": "search", "value": "", "type": "query", "description": "Case-insensitive substring search across log messages." } ] } }, { "info": { "name": "org_organizations_batch_exports_pause_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/organizations/:organization_id/batch_exports/:id/pause/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this batch export." }, { "name": "organization_id", "value": "", "type": "path", "description": "ID of the organization you're trying to access. To find the ID of the organization, make a call to /api/organizations/." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Pause a BatchExport." }, { "info": { "name": "org_organizations_batch_exports_run_test_step_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/organizations/:organization_id/batch_exports/:id/run_test_step/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this batch export." }, { "name": "organization_id", "value": "", "type": "path", "description": "ID of the organization you're trying to access. To find the ID of the organization, make a call to /api/organizations/." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "org_organizations_batch_exports_unpause_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/organizations/:organization_id/batch_exports/:id/unpause/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this batch export." }, { "name": "organization_id", "value": "", "type": "path", "description": "ID of the organization you're trying to access. To find the ID of the organization, make a call to /api/organizations/." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Unpause a BatchExport." }, { "info": { "name": "org_organizations_batch_exports_run_test_step_new_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/organizations/:organization_id/batch_exports/run_test_step_new/", "params": [ { "name": "organization_id", "value": "", "type": "path", "description": "ID of the organization you're trying to access. To find the ID of the organization, make a call to /api/organizations/." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "org_organizations_batch_exports_test_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/organizations/:organization_id/batch_exports/test/", "params": [ { "name": "organization_id", "value": "", "type": "path", "description": "ID of the organization you're trying to access. To find the ID of the organization, make a call to /api/organizations/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "batch_exports_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/batch_exports/", "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": "batch_exports_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/batch_exports/", "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": "batch_exports_backfills_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/batch_exports/:batch_export_id/backfills/", "params": [ { "name": "batch_export_id", "value": "", "type": "path" }, { "name": "cursor", "value": "", "type": "query", "description": "The pagination cursor value." }, { "name": "ordering", "value": "", "type": "query", "description": "Which field to use when ordering 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}}" } }, "docs": "ViewSet for BatchExportBackfill models.\n\nAllows creating and reading backfills, but not updating or deleting them." }, { "info": { "name": "batch_exports_backfills_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/batch_exports/:batch_export_id/backfills/", "params": [ { "name": "batch_export_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 backfill for a BatchExport." }, { "info": { "name": "batch_exports_backfills_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/batch_exports/:batch_export_id/backfills/:id/", "params": [ { "name": "batch_export_id", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this batch export backfill." }, { "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": "ViewSet for BatchExportBackfill models.\n\nAllows creating and reading backfills, but not updating or deleting them." }, { "info": { "name": "batch_exports_backfills_cancel_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/batch_exports/:batch_export_id/backfills/:id/cancel/", "params": [ { "name": "batch_export_id", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this batch export backfill." }, { "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": "Cancel a batch export backfill." }, { "info": { "name": "batch_exports_runs_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/batch_exports/:batch_export_id/runs/", "params": [ { "name": "batch_export_id", "value": "", "type": "path" }, { "name": "cursor", "value": "", "type": "query", "description": "The pagination cursor value." }, { "name": "ordering", "value": "", "type": "query", "description": "Which field to use when ordering 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": "batch_exports_runs_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/batch_exports/:batch_export_id/runs/:id/", "params": [ { "name": "batch_export_id", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this batch export run." }, { "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": "batch_exports_runs_cancel_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/batch_exports/:batch_export_id/runs/:id/cancel/", "params": [ { "name": "batch_export_id", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this batch export run." }, { "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": "Cancel a batch export run." }, { "info": { "name": "batch_exports_runs_logs_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/batch_exports/:batch_export_id/runs/:id/logs/", "params": [ { "name": "after", "value": "", "type": "query", "description": "Only return entries after this ISO 8601 timestamp." }, { "name": "batch_export_id", "value": "", "type": "path" }, { "name": "before", "value": "", "type": "query", "description": "Only return entries before this ISO 8601 timestamp." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this batch export run." }, { "name": "instance_id", "value": "", "type": "query", "description": "Filter logs to a specific execution instance." }, { "name": "level", "value": "", "type": "query", "description": "Comma-separated log levels to include, e.g. 'WARN,ERROR'. Valid levels: DEBUG, LOG, INFO, WARN, ERROR." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of log entries to return (1-500, default 50)." }, { "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": "search", "value": "", "type": "query", "description": "Case-insensitive substring search across log messages." } ] } }, { "info": { "name": "batch_exports_runs_retry_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/batch_exports/:batch_export_id/runs/:id/retry/", "params": [ { "name": "batch_export_id", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this batch export run." }, { "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": "Retry a batch export run.\n\nWe use the same underlying mechanism as when backfilling a batch export, as retrying\na run is the same as backfilling one run." }, { "info": { "name": "batch_exports_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/batch_exports/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this batch export." }, { "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": "batch_exports_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/projects/:project_id/batch_exports/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this batch export." }, { "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": "batch_exports_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/projects/:project_id/batch_exports/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this batch export." }, { "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": "batch_exports_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/projects/:project_id/batch_exports/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this batch export." }, { "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": "batch_exports_logs_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/batch_exports/:id/logs/", "params": [ { "name": "after", "value": "", "type": "query", "description": "Only return entries after this ISO 8601 timestamp." }, { "name": "before", "value": "", "type": "query", "description": "Only return entries before this ISO 8601 timestamp." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this batch export." }, { "name": "instance_id", "value": "", "type": "query", "description": "Filter logs to a specific execution instance." }, { "name": "level", "value": "", "type": "query", "description": "Comma-separated log levels to include, e.g. 'WARN,ERROR'. Valid levels: DEBUG, LOG, INFO, WARN, ERROR." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of log entries to return (1-500, default 50)." }, { "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": "search", "value": "", "type": "query", "description": "Case-insensitive substring search across log messages." } ] } }, { "info": { "name": "batch_exports_pause_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/batch_exports/:id/pause/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this batch export." }, { "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": "Pause a BatchExport." }, { "info": { "name": "batch_exports_run_test_step_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/batch_exports/:id/run_test_step/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this batch export." }, { "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": "batch_exports_unpause_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/batch_exports/:id/unpause/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this batch export." }, { "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": "Unpause a BatchExport." }, { "info": { "name": "batch_exports_run_test_step_new_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/batch_exports/run_test_step_new/", "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": "batch_exports_test_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/batch_exports/test/", "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/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } } ] }, { "info": { "name": "core", "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_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_exports_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/exports/", "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_exports_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/exports/", "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_exports_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/exports/: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 exported asset." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_exports_content_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/exports/:id/content/", "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 exported asset." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_file_system_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/file_system/", "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." }, { "name": "search", "value": "", "type": "query", "description": "A search term." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_file_system_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/file_system/", "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_file_system_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/file_system/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this file system." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_file_system_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/environments/:environment_id/file_system/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this file system." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_file_system_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/environments/:environment_id/file_system/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this file system." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_file_system_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/environments/:environment_id/file_system/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this file system." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_file_system_count_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/file_system/:id/count/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this file system." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Get count of all files in a folder." }, { "info": { "name": "environments_file_system_link_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/file_system/:id/link/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this file system." } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "environments_file_system_move_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/file_system/:id/move/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this file system." } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "environments_file_system_count_by_path_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/file_system/count_by_path/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Get count of all files in a folder." }, { "info": { "name": "environments_file_system_log_view_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/file_system/log_view/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." } ] } }, { "info": { "name": "environments_file_system_log_view_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/file_system/log_view/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "environments_file_system_undo_delete_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/file_system/undo_delete/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "environments_file_system_unfiled_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/file_system/unfiled/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." } ] } }, { "info": { "name": "environments_groups_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/groups/", "params": [ { "name": "cursor", "value": "", "type": "query", "description": "The pagination cursor value." }, { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "group_type_index", "value": "", "type": "query", "description": "Specify the group type to list" }, { "name": "search", "value": "", "type": "query", "description": "Search the group name" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List all groups of a specific group type. You must pass ?group_type_index= in the URL. To get a list of valid group types, call /api/:project_id/groups_types/" }, { "info": { "name": "environments_groups_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/groups/", "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_groups_activity_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/groups/activity/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "group_type_index", "value": "", "type": "query", "description": "Specify the group type to find" }, { "name": "id", "value": "", "type": "query", "description": "Specify the id of the user to find groups for" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_groups_delete_property_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/groups/delete_property/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "group_key", "value": "", "type": "query", "description": "Specify the key of the group to find" }, { "name": "group_type_index", "value": "", "type": "query", "description": "Specify the group type to find" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_groups_find_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/groups/find/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "group_key", "value": "", "type": "query", "description": "Specify the key of the group to find" }, { "name": "group_type_index", "value": "", "type": "query", "description": "Specify the group type to find" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_groups_property_definitions_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/groups/property_definitions/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_groups_property_values_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/groups/property_values/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_groups_related_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/groups/related/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "group_type_index", "value": "", "type": "query", "description": "Specify the group type to find" }, { "name": "id", "value": "", "type": "query", "description": "Specify the id of the user to find groups for" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_groups_update_property_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/groups/update_property/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "group_key", "value": "", "type": "query", "description": "Specify the key of the group to find" }, { "name": "group_type_index", "value": "", "type": "query", "description": "Specify the group type to find" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_insights_sharing_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/insights/:insight_id/sharing/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "insight_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_insights_sharing_passwords_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/insights/:insight_id/sharing/passwords/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "insight_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create a new password for the sharing configuration." }, { "info": { "name": "environments_insights_sharing_passwords_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/environments/:environment_id/insights/:insight_id/sharing/passwords/:password_id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "insight_id", "value": "", "type": "path" }, { "name": "password_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete a password from the sharing configuration." }, { "info": { "name": "environments_insights_sharing_refresh_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/insights/:insight_id/sharing/refresh/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "insight_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_project_secret_api_keys_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/project_secret_api_keys/", "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_project_secret_api_keys_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/project_secret_api_keys/", "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_project_secret_api_keys_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/project_secret_api_keys/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A unique value identifying this project secret api key." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_project_secret_api_keys_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/environments/:environment_id/project_secret_api_keys/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A unique value identifying this project secret api key." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_project_secret_api_keys_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/environments/:environment_id/project_secret_api_keys/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A unique value identifying this project secret api key." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_project_secret_api_keys_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/environments/:environment_id/project_secret_api_keys/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A unique value identifying this project secret api key." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_project_secret_api_keys_roll_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/project_secret_api_keys/:id/roll/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A unique value identifying this project secret api key." } ] }, "docs": "Roll a project secret API key" }, { "info": { "name": "environments_session_recordings_sharing_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/session_recordings/:recording_id/sharing/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "recording_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_session_recordings_sharing_passwords_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/session_recordings/:recording_id/sharing/passwords/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "recording_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create a new password for the sharing configuration." }, { "info": { "name": "environments_session_recordings_sharing_passwords_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/environments/:environment_id/session_recordings/:recording_id/sharing/passwords/:password_id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "password_id", "value": "", "type": "path" }, { "name": "recording_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete a password from the sharing configuration." }, { "info": { "name": "environments_session_recordings_sharing_refresh_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/session_recordings/:recording_id/sharing/refresh/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "recording_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_subscriptions_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/subscriptions/", "params": [ { "name": "created_by", "value": "", "type": "query", "description": "Filter by creator user UUID." }, { "name": "dashboard", "value": "", "type": "query", "description": "Filter by dashboard ID." }, { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "insight", "value": "", "type": "query", "description": "Filter by insight ID." }, { "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": "ordering", "value": "", "type": "query", "description": "Which field to use when ordering the results." }, { "name": "resource_type", "value": "", "type": "query", "description": "Filter by subscription resource: insight vs dashboard export." }, { "name": "search", "value": "", "type": "query", "description": "A search term." }, { "name": "target_type", "value": "", "type": "query", "description": "Filter by delivery channel (email, Slack, or webhook)." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_subscriptions_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/subscriptions/", "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_subscriptions_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/subscriptions/: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 subscription." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_subscriptions_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/environments/:environment_id/subscriptions/: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 subscription." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_subscriptions_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/environments/:environment_id/subscriptions/: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 subscription." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_subscriptions_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/environments/:environment_id/subscriptions/: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 subscription." } ], "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_subscriptions_test_delivery_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/subscriptions/:id/test-delivery/", "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 subscription." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "List subscription deliveries", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:project_id/subscriptions/:subscription_id/deliveries/", "params": [ { "name": "cursor", "value": "", "type": "query", "description": "The pagination cursor value." }, { "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": "status", "value": "", "type": "query", "description": "Return only deliveries in this run status (starting, completed, failed, or skipped)." }, { "name": "subscription_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Paginated delivery history for a subscription. Requires premium subscriptions." }, { "info": { "name": "Retrieve subscription delivery", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:project_id/subscriptions/:subscription_id/deliveries/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this subscription delivery." }, { "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": "subscription_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Fetch one delivery row by id." }, { "info": { "name": "domains_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/organizations/:organization_id/domains/", "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": "organization_id", "value": "", "type": "path", "description": "ID of the organization you're trying to access. To find the ID of the organization, make a call to /api/organizations/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "domains_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/organizations/:organization_id/domains/", "params": [ { "name": "organization_id", "value": "", "type": "path", "description": "ID of the organization you're trying to access. To find the ID of the organization, make a call to /api/organizations/." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "domains_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/organizations/:organization_id/domains/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this domain." }, { "name": "organization_id", "value": "", "type": "path", "description": "ID of the organization you're trying to access. To find the ID of the organization, make a call to /api/organizations/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "domains_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/organizations/:organization_id/domains/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this domain." }, { "name": "organization_id", "value": "", "type": "path", "description": "ID of the organization you're trying to access. To find the ID of the organization, make a call to /api/organizations/." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "domains_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/organizations/:organization_id/domains/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this domain." }, { "name": "organization_id", "value": "", "type": "path", "description": "ID of the organization you're trying to access. To find the ID of the organization, make a call to /api/organizations/." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "domains_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/organizations/:organization_id/domains/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this domain." }, { "name": "organization_id", "value": "", "type": "path", "description": "ID of the organization you're trying to access. To find the ID of the organization, make a call to /api/organizations/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "domains_scim_logs_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/organizations/:organization_id/domains/:id/scim/logs/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this domain." }, { "name": "organization_id", "value": "", "type": "path", "description": "ID of the organization you're trying to access. To find the ID of the organization, make a call to /api/organizations/." } ] } }, { "info": { "name": "domains_scim_token_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/organizations/:organization_id/domains/:id/scim/token/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this domain." }, { "name": "organization_id", "value": "", "type": "path", "description": "ID of the organization you're trying to access. To find the ID of the organization, make a call to /api/organizations/." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Regenerate SCIM bearer token." }, { "info": { "name": "domains_verify_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/organizations/:organization_id/domains/:id/verify/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this domain." }, { "name": "organization_id", "value": "", "type": "path", "description": "ID of the organization you're trying to access. To find the ID of the organization, make a call to /api/organizations/." } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "invites_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/organizations/:organization_id/invites/", "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": "organization_id", "value": "", "type": "path", "description": "ID of the organization you're trying to access. To find the ID of the organization, make a call to /api/organizations/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "invites_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/organizations/:organization_id/invites/", "params": [ { "name": "organization_id", "value": "", "type": "path", "description": "ID of the organization you're trying to access. To find the ID of the organization, make a call to /api/organizations/." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "invites_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/organizations/:organization_id/invites/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this organization invite." }, { "name": "organization_id", "value": "", "type": "path", "description": "ID of the organization you're trying to access. To find the ID of the organization, make a call to /api/organizations/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "invites_bulk_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/organizations/:organization_id/invites/bulk/", "params": [ { "name": "organization_id", "value": "", "type": "path", "description": "ID of the organization you're trying to access. To find the ID of the organization, make a call to /api/organizations/." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "legal_documents_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/organizations/:organization_id/legal_documents/", "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": "organization_id", "value": "", "type": "path", "description": "ID of the organization you're trying to access. To find the ID of the organization, make a call to /api/organizations/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "legal_documents_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/organizations/:organization_id/legal_documents/", "params": [ { "name": "organization_id", "value": "", "type": "path", "description": "ID of the organization you're trying to access. To find the ID of the organization, make a call to /api/organizations/." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "legal_documents_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/organizations/:organization_id/legal_documents/:id/", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "organization_id", "value": "", "type": "path", "description": "ID of the organization you're trying to access. To find the ID of the organization, make a call to /api/organizations/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "legal_documents_download_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/organizations/:organization_id/legal_documents/:id/download/", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "organization_id", "value": "", "type": "path", "description": "ID of the organization you're trying to access. To find the ID of the organization, make a call to /api/organizations/." } ] }, "docs": "Short-lived redirect to the signed PDF in object storage. 404 while the\nenvelope is still out for signature (or if the upload hasn't completed\nyet). The underlying presigned URL expires in ~60s; clients should hit\nthis endpoint each time they want to view the PDF rather than caching." }, { "info": { "name": "members_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/organizations/:organization_id/members/", "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": "order", "value": "", "type": "query", "description": "Sort order. Defaults to `-joined_at`." }, { "name": "organization_id", "value": "", "type": "path", "description": "ID of the organization you're trying to access. To find the ID of the organization, make a call to /api/organizations/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "members_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/organizations/:organization_id/members/:user__uuid/", "params": [ { "name": "organization_id", "value": "", "type": "path", "description": "ID of the organization you're trying to access. To find the ID of the organization, make a call to /api/organizations/." }, { "name": "user__uuid", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "members_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/organizations/:organization_id/members/:user__uuid/", "params": [ { "name": "organization_id", "value": "", "type": "path", "description": "ID of the organization you're trying to access. To find the ID of the organization, make a call to /api/organizations/." }, { "name": "user__uuid", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "members_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/organizations/:organization_id/members/:user__uuid/", "params": [ { "name": "organization_id", "value": "", "type": "path", "description": "ID of the organization you're trying to access. To find the ID of the organization, make a call to /api/organizations/." }, { "name": "user__uuid", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "members_scoped_api_keys_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/organizations/:organization_id/members/:user__uuid/scoped_api_keys/", "params": [ { "name": "organization_id", "value": "", "type": "path", "description": "ID of the organization you're trying to access. To find the ID of the organization, make a call to /api/organizations/." }, { "name": "user__uuid", "value": "", "type": "path" } ] } }, { "info": { "name": "oauth_applications_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/organizations/:organization_id/oauth_applications/", "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": "organization_id", "value": "", "type": "path", "description": "ID of the organization you're trying to access. To find the ID of the organization, make a call to /api/organizations/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "ViewSet for listing OAuth applications at the organization level (read-only)." }, { "info": { "name": "organizations_projects_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/organizations/:organization_id/projects/", "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": "organization_id", "value": "", "type": "path", "description": "ID of the organization you're trying to access. To find the ID of the organization, make a call to /api/organizations/." }, { "name": "search", "value": "", "type": "query", "description": "A search term." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Projects for the current organization." }, { "info": { "name": "organizations_projects_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/organizations/:organization_id/projects/", "params": [ { "name": "organization_id", "value": "", "type": "path", "description": "ID of the organization you're trying to access. To find the ID of the organization, make a call to /api/organizations/." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Projects for the current organization." }, { "info": { "name": "organizations_projects_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/organizations/:organization_id/projects/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique value identifying this project." }, { "name": "organization_id", "value": "", "type": "path", "description": "ID of the organization you're trying to access. To find the ID of the organization, make a call to /api/organizations/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Retrieve a project and its settings." }, { "info": { "name": "organizations_projects_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/organizations/:organization_id/projects/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique value identifying this project." }, { "name": "organization_id", "value": "", "type": "path", "description": "ID of the organization you're trying to access. To find the ID of the organization, make a call to /api/organizations/." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Replace a project and its settings. Prefer the PATCH endpoint for partial updates — PUT requires every writable field to be provided." }, { "info": { "name": "organizations_projects_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/organizations/:organization_id/projects/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique value identifying this project." }, { "name": "organization_id", "value": "", "type": "path", "description": "ID of the organization you're trying to access. To find the ID of the organization, make a call to /api/organizations/." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update one or more of a project's settings. Only the fields included in the request body are changed." }, { "info": { "name": "organizations_projects_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/organizations/:organization_id/projects/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique value identifying this project." }, { "name": "organization_id", "value": "", "type": "path", "description": "ID of the organization you're trying to access. To find the ID of the organization, make a call to /api/organizations/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Projects for the current organization." }, { "info": { "name": "organizations_projects_activity_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/organizations/:organization_id/projects/:id/activity/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique value identifying this project." }, { "name": "organization_id", "value": "", "type": "path", "description": "ID of the organization you're trying to access. To find the ID of the organization, make a call to /api/organizations/." } ] }, "docs": "Projects for the current organization." }, { "info": { "name": "organizations_projects_add_product_intent_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/organizations/:organization_id/projects/:id/add_product_intent/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique value identifying this project." }, { "name": "organization_id", "value": "", "type": "path", "description": "ID of the organization you're trying to access. To find the ID of the organization, make a call to /api/organizations/." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Projects for the current organization." }, { "info": { "name": "organizations_projects_change_organization_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/organizations/:organization_id/projects/:id/change_organization/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique value identifying this project." }, { "name": "organization_id", "value": "", "type": "path", "description": "ID of the organization you're trying to access. To find the ID of the organization, make a call to /api/organizations/." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Projects for the current organization." }, { "info": { "name": "organizations_projects_complete_product_onboarding_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/organizations/:organization_id/projects/:id/complete_product_onboarding/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique value identifying this project." }, { "name": "organization_id", "value": "", "type": "path", "description": "ID of the organization you're trying to access. To find the ID of the organization, make a call to /api/organizations/." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Projects for the current organization." }, { "info": { "name": "organizations_projects_delete_secret_token_backup_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/organizations/:organization_id/projects/:id/delete_secret_token_backup/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique value identifying this project." }, { "name": "organization_id", "value": "", "type": "path", "description": "ID of the organization you're trying to access. To find the ID of the organization, make a call to /api/organizations/." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Projects for the current organization." }, { "info": { "name": "organizations_projects_generate_conversations_public_token_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/organizations/:organization_id/projects/:id/generate_conversations_public_token/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique value identifying this project." }, { "name": "organization_id", "value": "", "type": "path", "description": "ID of the organization you're trying to access. To find the ID of the organization, make a call to /api/organizations/." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Projects for the current organization." }, { "info": { "name": "organizations_projects_is_generating_demo_data_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/organizations/:organization_id/projects/:id/is_generating_demo_data/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique value identifying this project." }, { "name": "organization_id", "value": "", "type": "path", "description": "ID of the organization you're trying to access. To find the ID of the organization, make a call to /api/organizations/." } ] }, "docs": "Projects for the current organization." }, { "info": { "name": "organizations_projects_reset_token_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/organizations/:organization_id/projects/:id/reset_token/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique value identifying this project." }, { "name": "organization_id", "value": "", "type": "path", "description": "ID of the organization you're trying to access. To find the ID of the organization, make a call to /api/organizations/." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Projects for the current organization." }, { "info": { "name": "organizations_projects_rotate_secret_token_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/organizations/:organization_id/projects/:id/rotate_secret_token/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique value identifying this project." }, { "name": "organization_id", "value": "", "type": "path", "description": "ID of the organization you're trying to access. To find the ID of the organization, make a call to /api/organizations/." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Projects for the current organization." }, { "info": { "name": "roles_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/organizations/:organization_id/roles/", "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": "organization_id", "value": "", "type": "path", "description": "ID of the organization you're trying to access. To find the ID of the organization, make a call to /api/organizations/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "roles_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/organizations/:organization_id/roles/", "params": [ { "name": "organization_id", "value": "", "type": "path", "description": "ID of the organization you're trying to access. To find the ID of the organization, make a call to /api/organizations/." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "roles_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/organizations/:organization_id/roles/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this role." }, { "name": "organization_id", "value": "", "type": "path", "description": "ID of the organization you're trying to access. To find the ID of the organization, make a call to /api/organizations/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "roles_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/organizations/:organization_id/roles/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this role." }, { "name": "organization_id", "value": "", "type": "path", "description": "ID of the organization you're trying to access. To find the ID of the organization, make a call to /api/organizations/." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "roles_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/organizations/:organization_id/roles/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this role." }, { "name": "organization_id", "value": "", "type": "path", "description": "ID of the organization you're trying to access. To find the ID of the organization, make a call to /api/organizations/." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "roles_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/organizations/:organization_id/roles/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this role." }, { "name": "organization_id", "value": "", "type": "path", "description": "ID of the organization you're trying to access. To find the ID of the organization, make a call to /api/organizations/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "annotations_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/annotations/", "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/." }, { "name": "search", "value": "", "type": "query", "description": "A search term." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create, Read, Update and Delete annotations. [See docs](https://posthog.com/docs/data/annotations) for more information on annotations." }, { "info": { "name": "annotations_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/annotations/", "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}}" } }, "docs": "Create, Read, Update and Delete annotations. [See docs](https://posthog.com/docs/data/annotations) for more information on annotations." }, { "info": { "name": "annotations_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/annotations/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this annotation." }, { "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": "Create, Read, Update and Delete annotations. [See docs](https://posthog.com/docs/data/annotations) for more information on annotations." }, { "info": { "name": "annotations_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/projects/:project_id/annotations/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this annotation." }, { "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, Read, Update and Delete annotations. [See docs](https://posthog.com/docs/data/annotations) for more information on annotations." }, { "info": { "name": "annotations_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/projects/:project_id/annotations/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this annotation." }, { "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, Read, Update and Delete annotations. [See docs](https://posthog.com/docs/data/annotations) for more information on annotations." }, { "info": { "name": "annotations_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/projects/:project_id/annotations/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this annotation." }, { "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": "cohorts_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/cohorts/", "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": "cohorts_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/cohorts/", "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": "cohorts_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/cohorts/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this cohort." }, { "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": "cohorts_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/projects/:project_id/cohorts/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this cohort." }, { "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": "cohorts_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/projects/:project_id/cohorts/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this cohort." }, { "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": "cohorts_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/projects/:project_id/cohorts/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this cohort." }, { "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": "cohorts_activity_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/cohorts/:id/activity/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this cohort." }, { "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": "cohorts_add_persons_to_static_cohort_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/projects/:project_id/cohorts/:id/add_persons_to_static_cohort/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this cohort." }, { "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": "cohorts_calculation_history_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/cohorts/:id/calculation_history/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this cohort." }, { "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": "cohorts_persons_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/cohorts/:id/persons/", "params": [ { "name": "format", "value": "", "type": "query" }, { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this cohort." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of persons to return per page (defaults to 100)." }, { "name": "offset", "value": "", "type": "query", "description": "Number of persons to skip before starting to return 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": "cohorts_remove_person_from_static_cohort_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/projects/:project_id/cohorts/:id/remove_person_from_static_cohort/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this cohort." }, { "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": "cohorts_all_activity_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/cohorts/activity/", "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/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "comments_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/comments/", "params": [ { "name": "cursor", "value": "", "type": "query", "description": "The pagination cursor value." }, { "name": "item_id", "value": "", "type": "query", "description": "Filter by the ID of the resource being commented on." }, { "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": "scope", "value": "", "type": "query", "description": "Filter by resource type (e.g. Dashboard, FeatureFlag, Insight, Replay)." }, { "name": "search", "value": "", "type": "query", "description": "Full-text search within comment content." }, { "name": "source_comment", "value": "", "type": "query", "description": "Filter replies to a specific parent comment." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "comments_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/comments/", "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": "comments_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/comments/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this comment." }, { "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": "comments_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/projects/:project_id/comments/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this comment." }, { "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": "comments_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/projects/:project_id/comments/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this comment." }, { "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": "comments_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/projects/:project_id/comments/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this comment." }, { "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": "comments_thread_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/comments/:id/thread/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this comment." }, { "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": "comments_count_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/comments/count/", "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/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "dashboard_templates_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/dashboard_templates/", "params": [ { "name": "is_featured", "value": "", "type": "query", "description": "Omit for all templates. When set, filter by featured flag; parsed with str_to_bool (same as other API query booleans)." }, { "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": "ordering", "value": "", "type": "query", "description": "Optional. When not using `search`, results are sorted with featured templates first (`is_featured=true`), then by `template_name` (case-insensitive A–Z; `-template_name` for Z–A) or by `created_at` (`-created_at` for newest first). When `search` is set, order is featured first, then relevance rank, then case-insensitive name for ties." }, { "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": "scope", "value": "", "type": "query", "description": "Optional. `global`: official templates only. `team`: this project's saved templates only (`scope=team` rows for the current project). `feature_flag`: feature-flag dashboard templates only. Omit for both official and this project's templates (default dashboard template picker behavior)." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "dashboard_templates_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/dashboard_templates/", "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": "dashboard_templates_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/dashboard_templates/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this dashboard template." }, { "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": "dashboard_templates_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/projects/:project_id/dashboard_templates/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this dashboard template." }, { "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": "dashboard_templates_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/projects/:project_id/dashboard_templates/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this dashboard template." }, { "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": "dashboard_templates_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/projects/:project_id/dashboard_templates/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this dashboard template." }, { "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": "Copy a team template to this project", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/dashboard_templates/copy_between_projects/", "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": "{}" } }, "docs": "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)`, …" }, { "info": { "name": "dashboard_templates_json_schema_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/dashboard_templates/json_schema/", "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/." } ] } }, { "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_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": "event_definitions_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/event_definitions/", "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": "event_definitions_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/event_definitions/", "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": "event_definitions_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/event_definitions/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this event definition." }, { "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": "event_definitions_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/projects/:project_id/event_definitions/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this event definition." }, { "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": "event_definitions_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/projects/:project_id/event_definitions/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this event definition." }, { "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": "event_definitions_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/projects/:project_id/event_definitions/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this event definition." }, { "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": "event_definitions_metrics_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/event_definitions/:id/metrics/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this event definition." }, { "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/." } ] } }, { "info": { "name": "event_definitions_bulk_update_tags_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/event_definitions/bulk_update_tags/", "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": "{}" } }, "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": "event_definitions_by_name_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/event_definitions/by_name/", "params": [ { "name": "name", "value": "", "type": "query", "description": "The exact event name to look up" }, { "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": "Get event definition by exact name" }, { "info": { "name": "event_definitions_golang_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/event_definitions/golang/", "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/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "event_definitions_promoted_properties_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/event_definitions/promoted_properties/", "params": [ { "name": "names", "value": "", "type": "query", "description": "Optional: restrict the response to these event names. Repeat the parameter for multiple names (e.g. `?names=a&names=b`). When omitted, returns every team-configured promoted property." }, { "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": "Resolve team-configured promoted properties for event definitions.\n\nThe response only contains entries where a non-null promoted_property is set on the\nEventDefinition. Callers should fall back to the core taxonomy defaults client-side\nfor names not present in the response." }, { "info": { "name": "event_definitions_python_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/event_definitions/python/", "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/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "event_definitions_typescript_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/event_definitions/typescript/", "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/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "exports_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/exports/", "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": "exports_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/exports/", "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": "exports_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/exports/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this exported asset." }, { "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": "exports_content_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/exports/:id/content/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this exported asset." }, { "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": "file_system_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/file_system/", "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/." }, { "name": "search", "value": "", "type": "query", "description": "A search term." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "file_system_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/file_system/", "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": "file_system_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/file_system/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this file system." }, { "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": "file_system_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/projects/:project_id/file_system/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this file system." }, { "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": "file_system_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/projects/:project_id/file_system/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this file system." }, { "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": "file_system_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/projects/:project_id/file_system/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this file system." }, { "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": "file_system_count_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/file_system/:id/count/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this file system." }, { "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": "Get count of all files in a folder." }, { "info": { "name": "file_system_link_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/file_system/:id/link/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this file system." }, { "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": "file_system_move_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/file_system/:id/move/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this file system." }, { "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": "file_system_count_by_path_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/file_system/count_by_path/", "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": "{}" } }, "docs": "Get count of all files in a folder." }, { "info": { "name": "file_system_log_view_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/file_system/log_view/", "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/." } ] } }, { "info": { "name": "file_system_log_view_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/file_system/log_view/", "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": "{}" } } }, { "info": { "name": "file_system_undo_delete_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/file_system/undo_delete/", "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": "{}" } } }, { "info": { "name": "file_system_unfiled_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/file_system/unfiled/", "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/." } ] } }, { "info": { "name": "groups_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/groups/", "params": [ { "name": "cursor", "value": "", "type": "query", "description": "The pagination cursor value." }, { "name": "group_type_index", "value": "", "type": "query", "description": "Specify the group type to list" }, { "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": "search", "value": "", "type": "query", "description": "Search the group name" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List all groups of a specific group type. You must pass ?group_type_index= in the URL. To get a list of valid group types, call /api/:project_id/groups_types/" }, { "info": { "name": "groups_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/groups/", "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": "groups_activity_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/groups/activity/", "params": [ { "name": "group_type_index", "value": "", "type": "query", "description": "Specify the group type to find" }, { "name": "id", "value": "", "type": "query", "description": "Specify the id of the user to find groups for" }, { "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": "groups_delete_property_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/groups/delete_property/", "params": [ { "name": "group_key", "value": "", "type": "query", "description": "Specify the key of the group to find" }, { "name": "group_type_index", "value": "", "type": "query", "description": "Specify the group type to find" }, { "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": "groups_find_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/groups/find/", "params": [ { "name": "group_key", "value": "", "type": "query", "description": "Specify the key of the group to find" }, { "name": "group_type_index", "value": "", "type": "query", "description": "Specify the group type to find" }, { "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": "groups_property_definitions_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/groups/property_definitions/", "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/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "groups_property_values_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/groups/property_values/", "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/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "groups_related_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/groups/related/", "params": [ { "name": "group_type_index", "value": "", "type": "query", "description": "Specify the group type to find" }, { "name": "id", "value": "", "type": "query", "description": "Specify the id of the user to find groups for" }, { "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": "groups_update_property_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/groups/update_property/", "params": [ { "name": "group_key", "value": "", "type": "query", "description": "Specify the key of the group to find" }, { "name": "group_type_index", "value": "", "type": "query", "description": "Specify the group type to find" }, { "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": "insights_sharing_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/insights/:insight_id/sharing/", "params": [ { "name": "insight_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": "insights_sharing_passwords_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/insights/:insight_id/sharing/passwords/", "params": [ { "name": "insight_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": "insights_sharing_passwords_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/projects/:project_id/insights/:insight_id/sharing/passwords/:password_id/", "params": [ { "name": "insight_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": "insights_sharing_refresh_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/insights/:insight_id/sharing/refresh/", "params": [ { "name": "insight_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": "project_secret_api_keys_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/project_secret_api_keys/", "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": "project_secret_api_keys_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/project_secret_api_keys/", "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": "project_secret_api_keys_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/project_secret_api_keys/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique value identifying this project secret api key." }, { "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": "project_secret_api_keys_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/projects/:project_id/project_secret_api_keys/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique value identifying this project secret api key." }, { "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": "project_secret_api_keys_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/projects/:project_id/project_secret_api_keys/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique value identifying this project secret api key." }, { "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": "project_secret_api_keys_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/projects/:project_id/project_secret_api_keys/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique value identifying this project secret api key." }, { "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": "project_secret_api_keys_roll_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/project_secret_api_keys/:id/roll/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique value identifying this project secret api key." }, { "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/." } ] }, "docs": "Roll a project secret API key" }, { "info": { "name": "property_definitions_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/property_definitions/", "params": [ { "name": "event_names", "value": "", "type": "query", "description": "If sent, response value will have `is_seen_on_filtered_events` populated. JSON-encoded" }, { "name": "exclude_core_properties", "value": "", "type": "query", "description": "Whether to exclude core properties" }, { "name": "exclude_hidden", "value": "", "type": "query", "description": "Whether to exclude properties marked as hidden" }, { "name": "excluded_properties", "value": "", "type": "query", "description": "JSON-encoded list of excluded properties" }, { "name": "filter_by_event_names", "value": "", "type": "query", "description": "Whether to return only properties for events in `event_names`" }, { "name": "group_type_index", "value": "", "type": "query", "description": "What group type is the property for. Only should be set if `type=group`" }, { "name": "is_feature_flag", "value": "", "type": "query", "description": "Whether to return only (or excluding) feature flag properties" }, { "name": "is_numerical", "value": "", "type": "query", "description": "Whether to return only (or excluding) numerical property definitions" }, { "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/." }, { "name": "properties", "value": "", "type": "query", "description": "Comma-separated list of properties to filter" }, { "name": "search", "value": "", "type": "query", "description": "Searches properties by name" }, { "name": "type", "value": "", "type": "query", "description": "What property definitions to return\n\n* `event` - event\n* `person` - person\n* `group` - group\n* `session` - session" }, { "name": "verified", "value": "", "type": "query", "description": "Filter by verified status. True returns only verified, false returns only unverified." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "property_definitions_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/property_definitions/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this property definition." }, { "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": "property_definitions_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/projects/:project_id/property_definitions/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this property definition." }, { "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": "property_definitions_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/projects/:project_id/property_definitions/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this property definition." }, { "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": "property_definitions_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/projects/:project_id/property_definitions/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this property definition." }, { "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": "property_definitions_bulk_update_tags_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/property_definitions/bulk_update_tags/", "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": "{}" } }, "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": "property_definitions_seen_together_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/property_definitions/seen_together/", "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/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Allows a caller to provide a list of event names and a single property name\nReturns a map of the event names to a boolean representing whether that property has ever been seen with that event_name" }, { "info": { "name": "session_recordings_sharing_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/session_recordings/:recording_id/sharing/", "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/." }, { "name": "recording_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "session_recordings_sharing_passwords_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/session_recordings/:recording_id/sharing/passwords/", "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/." }, { "name": "recording_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create a new password for the sharing configuration." }, { "info": { "name": "session_recordings_sharing_passwords_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/projects/:project_id/session_recordings/:recording_id/sharing/passwords/:password_id/", "params": [ { "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/." }, { "name": "recording_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete a password from the sharing configuration." }, { "info": { "name": "session_recordings_sharing_refresh_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/session_recordings/:recording_id/sharing/refresh/", "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/." }, { "name": "recording_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "subscriptions_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/subscriptions/", "params": [ { "name": "created_by", "value": "", "type": "query", "description": "Filter by creator user UUID." }, { "name": "dashboard", "value": "", "type": "query", "description": "Filter by dashboard ID." }, { "name": "insight", "value": "", "type": "query", "description": "Filter by insight ID." }, { "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": "ordering", "value": "", "type": "query", "description": "Which field to use when ordering 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/." }, { "name": "resource_type", "value": "", "type": "query", "description": "Filter by subscription resource: insight vs dashboard export." }, { "name": "search", "value": "", "type": "query", "description": "A search term." }, { "name": "target_type", "value": "", "type": "query", "description": "Filter by delivery channel (email, Slack, or webhook)." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "subscriptions_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/subscriptions/", "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": "subscriptions_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/subscriptions/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this subscription." }, { "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": "subscriptions_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/projects/:project_id/subscriptions/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this subscription." }, { "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": "subscriptions_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/projects/:project_id/subscriptions/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this subscription." }, { "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": "subscriptions_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/projects/:project_id/subscriptions/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this subscription." }, { "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": "subscriptions_test_delivery_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/subscriptions/:id/test-delivery/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this subscription." }, { "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": "users_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/users/", "params": [ { "name": "email", "value": "", "type": "query" }, { "name": "is_staff", "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": "users_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/users/:uuid/", "params": [ { "name": "uuid", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Retrieve a user's profile and settings. Pass `@me` as the UUID to fetch the authenticated user; non-staff callers may only access their own account." }, { "info": { "name": "users_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/users/:uuid/", "params": [ { "name": "uuid", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Replace the authenticated user's profile and settings. Pass `@me` as the UUID to update the authenticated user. Prefer the PATCH endpoint for partial updates — PUT requires every writable field to be provided." }, { "info": { "name": "users_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/users/:uuid/", "params": [ { "name": "uuid", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update one or more of the authenticated user's profile fields or settings." }, { "info": { "name": "users_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/users/:uuid/", "params": [ { "name": "uuid", "value": "", "type": "path" } ] } }, { "info": { "name": "users_github_login_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/users/:uuid/github_login/", "params": [ { "name": "uuid", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "users_hedgehog_config_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/users/:uuid/hedgehog_config/", "params": [ { "name": "uuid", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "users_hedgehog_config_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/users/:uuid/hedgehog_config/", "params": [ { "name": "uuid", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "List personal GitHub integrations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/users/:uuid/integrations/", "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": "uuid", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "`/api/users/@me/integrations/` — manage the user's personal GitHub integrations." }, { "info": { "name": "Disconnect a personal GitHub integration", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/users/:uuid/integrations/github/:installation_id/", "params": [ { "name": "installation_id", "value": "", "type": "path" }, { "name": "uuid", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Remove a specific GitHub installation by its installation_id." }, { "info": { "name": "List branches for a personal GitHub installation repository", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/users/:uuid/integrations/github/:installation_id/branches/", "params": [ { "name": "installation_id", "value": "", "type": "path" }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of branches to return" }, { "name": "offset", "value": "", "type": "query", "description": "Number of branches to skip" }, { "name": "repo", "value": "", "type": "query", "description": "Repository in owner/repo format" }, { "name": "search", "value": "", "type": "query", "description": "Optional case-insensitive branch name search query." }, { "name": "uuid", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List branches for a repository accessible to a personal GitHub installation." }, { "info": { "name": "List repositories for a personal GitHub installation", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/users/:uuid/integrations/github/:installation_id/repos/", "params": [ { "name": "installation_id", "value": "", "type": "path" }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of repositories to return per request (max 500)." }, { "name": "offset", "value": "", "type": "query", "description": "Number of repositories to skip before returning results." }, { "name": "search", "value": "", "type": "query", "description": "Optional case-insensitive repository name search query." }, { "name": "uuid", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List repositories accessible to a specific GitHub installation (paginated, cached)." }, { "info": { "name": "Refresh repositories for a personal GitHub installation", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/users/:uuid/integrations/github/:installation_id/repos/refresh/", "params": [ { "name": "installation_id", "value": "", "type": "path" }, { "name": "uuid", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Refresh repositories accessible to a specific GitHub installation." }, { "info": { "name": "Start GitHub personal integration linking", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/users/:uuid/integrations/github/start/", "params": [ { "name": "uuid", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Start GitHub linking: either full App install or OAuth-only (user-to-server).\n\n``**_kwargs`` absorbs ``parent_lookup_uuid`` from the nested\n``/api/users/{uuid}/integrations/`` router (same pattern as ``local_evaluation``\nunder projects).\n\nUsually returns ``install_url`` pointing at ``/installations/new`` so the\nuser can pick any GitHub org (new or already connected). GitHub's install\npage handles both cases: orgs where the app is installed show \"Configure\"\n(no admin needed), orgs where it isn't" }, { "info": { "name": "users_scene_personalisation_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/users/:uuid/scene_personalisation/", "params": [ { "name": "uuid", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "users_start_2fa_setup_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/users/:uuid/start_2fa_setup/", "params": [ { "name": "uuid", "value": "", "type": "path" } ] } }, { "info": { "name": "users_two_factor_backup_codes_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/users/:uuid/two_factor_backup_codes/", "params": [ { "name": "uuid", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Generate new backup codes, invalidating any existing ones" }, { "info": { "name": "users_two_factor_disable_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/users/:uuid/two_factor_disable/", "params": [ { "name": "uuid", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Disable 2FA and remove all related devices" }, { "info": { "name": "users_two_factor_start_setup_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/users/:uuid/two_factor_start_setup/", "params": [ { "name": "uuid", "value": "", "type": "path" } ] } }, { "info": { "name": "users_two_factor_status_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/users/:uuid/two_factor_status/", "params": [ { "name": "uuid", "value": "", "type": "path" } ] }, "docs": "Get current 2FA status including backup codes if enabled" }, { "info": { "name": "users_two_factor_validate_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/users/:uuid/two_factor_validate/", "params": [ { "name": "uuid", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "users_validate_2fa_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/users/:uuid/validate_2fa/", "params": [ { "name": "uuid", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "users_cancel_email_change_request_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/users/cancel_email_change_request/", "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "users_request_email_verification_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/users/request_email_verification/", "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "users_verify_email_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/users/verify_email/", "body": { "type": "json", "data": "{}" } } } ] }, { "info": { "name": "dashboards", "type": "folder" }, "items": [ { "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_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_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": "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}}" } } } ] }, { "info": { "name": "data_warehouse", "type": "folder" }, "items": [ { "info": { "name": "environments_data_modeling_jobs_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/data_modeling_jobs/", "params": [ { "name": "cursor", "value": "", "type": "query", "description": "The pagination cursor value." }, { "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": "saved_query_id", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List data modeling jobs which are \"runs\" for our saved queries." }, { "info": { "name": "environments_data_modeling_jobs_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/data_modeling_jobs/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this data modeling job." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List data modeling jobs which are \"runs\" for our saved queries." }, { "info": { "name": "environments_data_modeling_jobs_recent_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/data_modeling_jobs/recent/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." } ] }, "docs": "Get the most recent non-running job for each saved query from the v2 backend." }, { "info": { "name": "environments_data_modeling_jobs_running_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/data_modeling_jobs/running/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." } ] }, "docs": "Get all currently running jobs from the v2 backend." }, { "info": { "name": "environments_data_warehouse_check_database_name_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/data_warehouse/check-database-name/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "name", "value": "", "type": "query", "description": "Database name to check" } ] }, "docs": "Check if a database name is available." }, { "info": { "name": "environments_data_warehouse_completed_activity_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/data_warehouse/completed_activity/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." } ] }, "docs": "Returns completed/non-running activities (jobs with status 'Completed').\nSupports pagination and cutoff time filtering." }, { "info": { "name": "environments_data_warehouse_data_health_issues_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/data_warehouse/data_health_issues/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." } ] }, "docs": "Returns failed/disabled data pipeline items for the Pipeline status side panel.\nIncludes: materializations, syncs, sources, destinations, and transformations." }, { "info": { "name": "environments_data_warehouse_data_ops_dashboard_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/data_warehouse/data_ops_dashboard/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Returns the data ops overview dashboard ID for this team, creating it if it doesn't exist yet." }, { "info": { "name": "environments_data_warehouse_deprovision_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/data_warehouse/deprovision/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Start deprovisioning the managed warehouse for this team." }, { "info": { "name": "environments_data_warehouse_job_stats_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/data_warehouse/job_stats/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." } ] }, "docs": "Returns success and failed job statistics for the last 1, 7, or 30 days.\nQuery parameter 'days' can be 1, 7, or 30 (default: 7)." }, { "info": { "name": "environments_data_warehouse_property_values_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/data_warehouse/property_values/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "API endpoints for data warehouse aggregate statistics and operations." }, { "info": { "name": "environments_data_warehouse_provision_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/data_warehouse/provision/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Start provisioning a managed warehouse for this team." }, { "info": { "name": "environments_data_warehouse_reset_password_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/data_warehouse/reset-password/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Reset the root password for the managed warehouse." }, { "info": { "name": "environments_data_warehouse_running_activity_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/data_warehouse/running_activity/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." } ] }, "docs": "Returns currently running activities (jobs with status 'Running').\nSupports pagination and cutoff time filtering." }, { "info": { "name": "environments_data_warehouse_total_rows_stats_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/data_warehouse/total_rows_stats/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." } ] }, "docs": "Returns aggregated statistics for the data warehouse total rows processed within the current billing period.\nUsed by the frontend data warehouse scene to display usage information." }, { "info": { "name": "environments_data_warehouse_warehouse_status_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/data_warehouse/warehouse_status/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." } ] }, "docs": "Get the current provisioning status of the managed warehouse." }, { "info": { "name": "environments_external_data_schemas_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/external_data_schemas/", "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." }, { "name": "search", "value": "", "type": "query", "description": "A search term." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_external_data_schemas_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/external_data_schemas/", "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_external_data_schemas_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/external_data_schemas/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this external data schema." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_external_data_schemas_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/environments/:environment_id/external_data_schemas/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this external data schema." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_external_data_schemas_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/environments/:environment_id/external_data_schemas/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this external data schema." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_external_data_schemas_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/environments/:environment_id/external_data_schemas/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this external data schema." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_external_data_schemas_cancel_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/external_data_schemas/:id/cancel/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this external data schema." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_external_data_schemas_delete_data_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/environments/:environment_id/external_data_schemas/:id/delete_data/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this external data schema." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_external_data_schemas_incremental_fields_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/external_data_schemas/:id/incremental_fields/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this external data schema." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_external_data_schemas_reload_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/external_data_schemas/:id/reload/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this external data schema." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_external_data_schemas_resync_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/external_data_schemas/:id/resync/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this external data schema." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_external_data_sources_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/external_data_sources/", "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." }, { "name": "search", "value": "", "type": "query", "description": "A search term." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create, Read, Update and Delete External data Sources." }, { "info": { "name": "environments_external_data_sources_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/external_data_sources/", "params": [ { "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, Read, Update and Delete External data Sources." }, { "info": { "name": "environments_external_data_sources_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/external_data_sources/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this external data source." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create, Read, Update and Delete External data Sources." }, { "info": { "name": "environments_external_data_sources_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/environments/:environment_id/external_data_sources/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this external data source." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create, Read, Update and Delete External data Sources." }, { "info": { "name": "environments_external_data_sources_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/environments/:environment_id/external_data_sources/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this external data source." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create, Read, Update and Delete External data Sources." }, { "info": { "name": "environments_external_data_sources_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/environments/:environment_id/external_data_sources/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this external data source." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create, Read, Update and Delete External data Sources." }, { "info": { "name": "environments_external_data_sources_bulk_update_schemas_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/environments/:environment_id/external_data_sources/:id/bulk_update_schemas/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this external data source." }, { "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": "search", "value": "", "type": "query", "description": "A search term." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create, Read, Update and Delete External data Sources." }, { "info": { "name": "environments_external_data_sources_create_webhook_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/external_data_sources/:id/create_webhook/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this external data source." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create, Read, Update and Delete External data Sources." }, { "info": { "name": "environments_external_data_sources_delete_webhook_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/external_data_sources/:id/delete_webhook/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this external data source." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create, Read, Update and Delete External data Sources." }, { "info": { "name": "environments_external_data_sources_jobs_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/external_data_sources/:id/jobs/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this external data source." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create, Read, Update and Delete External data Sources." }, { "info": { "name": "environments_external_data_sources_refresh_schemas_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/external_data_sources/:id/refresh_schemas/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this external data source." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Fetch current schema/table list from the source and create any new ExternalDataSchema rows (no data sync)." }, { "info": { "name": "environments_external_data_sources_reload_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/external_data_sources/:id/reload/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this external data source." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create, Read, Update and Delete External data Sources." }, { "info": { "name": "environments_external_data_sources_revenue_analytics_config_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/environments/:environment_id/external_data_sources/:id/revenue_analytics_config/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this external data source." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update the revenue analytics configuration and return the full external data source." }, { "info": { "name": "environments_external_data_sources_update_webhook_inputs_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/external_data_sources/:id/update_webhook_inputs/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this external data source." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create, Read, Update and Delete External data Sources." }, { "info": { "name": "environments_external_data_sources_webhook_info_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/external_data_sources/:id/webhook_info/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this external data source." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create, Read, Update and Delete External data Sources." }, { "info": { "name": "environments_external_data_sources_check_cdc_prerequisites_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/external_data_sources/check_cdc_prerequisites/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Validate CDC prerequisites against a live Postgres connection.\n\nUsed by the source wizard to surface ✅/❌ checks before source creation,\nand by the self-managed setup popup to verify user-created publications." }, { "info": { "name": "environments_external_data_sources_connections_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/external_data_sources/connections/", "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." }, { "name": "search", "value": "", "type": "query", "description": "A search term." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create, Read, Update and Delete External data Sources." }, { "info": { "name": "environments_external_data_sources_database_schema_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/external_data_sources/database_schema/", "params": [ { "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, Read, Update and Delete External data Sources." }, { "info": { "name": "environments_external_data_sources_source_prefix_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/external_data_sources/source_prefix/", "params": [ { "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, Read, Update and Delete External data Sources." }, { "info": { "name": "environments_external_data_sources_wizard_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/external_data_sources/wizard/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create, Read, Update and Delete External data Sources." }, { "info": { "name": "environments_insight_variables_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/insight_variables/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "page", "value": "", "type": "query", "description": "A page number within the paginated result set." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_insight_variables_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/insight_variables/", "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_insight_variables_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/insight_variables/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this insight variable." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_insight_variables_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/environments/:environment_id/insight_variables/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this insight variable." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_insight_variables_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/environments/:environment_id/insight_variables/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this insight variable." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_insight_variables_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/environments/:environment_id/insight_variables/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this insight variable." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_warehouse_saved_queries_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/warehouse_saved_queries/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "page", "value": "", "type": "query", "description": "A page number within the paginated result set." }, { "name": "search", "value": "", "type": "query", "description": "A search term." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create, Read, Update and Delete Warehouse Tables." }, { "info": { "name": "environments_warehouse_saved_queries_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/warehouse_saved_queries/", "params": [ { "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, Read, Update and Delete Warehouse Tables." }, { "info": { "name": "environments_warehouse_saved_queries_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/warehouse_saved_queries/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this data warehouse saved query." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create, Read, Update and Delete Warehouse Tables." }, { "info": { "name": "environments_warehouse_saved_queries_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/environments/:environment_id/warehouse_saved_queries/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this data warehouse saved query." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create, Read, Update and Delete Warehouse Tables." }, { "info": { "name": "environments_warehouse_saved_queries_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/environments/:environment_id/warehouse_saved_queries/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this data warehouse saved query." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create, Read, Update and Delete Warehouse Tables." }, { "info": { "name": "environments_warehouse_saved_queries_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/environments/:environment_id/warehouse_saved_queries/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this data warehouse saved query." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create, Read, Update and Delete Warehouse Tables." }, { "info": { "name": "environments_warehouse_saved_queries_activity_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/warehouse_saved_queries/:id/activity/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this data warehouse saved query." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create, Read, Update and Delete Warehouse Tables." }, { "info": { "name": "environments_warehouse_saved_queries_ancestors_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/warehouse_saved_queries/:id/ancestors/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this data warehouse saved query." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Return the ancestors of this saved query.\n\nBy default, we return the immediate parents. The `level` parameter can be used to\nlook further back into the ancestor tree. If `level` overshoots (i.e. points to only\nancestors beyond the root), we return an empty list." }, { "info": { "name": "environments_warehouse_saved_queries_cancel_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/warehouse_saved_queries/:id/cancel/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this data warehouse saved query." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Cancel a running saved query workflow." }, { "info": { "name": "environments_warehouse_saved_queries_dependencies_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/warehouse_saved_queries/:id/dependencies/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this data warehouse saved query." } ] }, "docs": "Return the count of immediate upstream and downstream dependencies for this saved query." }, { "info": { "name": "environments_warehouse_saved_queries_descendants_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/warehouse_saved_queries/:id/descendants/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this data warehouse saved query." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Return the descendants of this saved query.\n\nBy default, we return the immediate children. The `level` parameter can be used to\nlook further ahead into the descendants tree. If `level` overshoots (i.e. points to only\ndescendants further than a leaf), we return an empty list." }, { "info": { "name": "environments_warehouse_saved_queries_materialize_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/warehouse_saved_queries/:id/materialize/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this data warehouse saved query." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Enable materialization for this saved query with a 24-hour sync frequency." }, { "info": { "name": "environments_warehouse_saved_queries_revert_materialization_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/warehouse_saved_queries/:id/revert_materialization/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this data warehouse saved query." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Undo materialization, revert back to the original view.\n(i.e. delete the materialized table and the schedule)" }, { "info": { "name": "environments_warehouse_saved_queries_run_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/warehouse_saved_queries/:id/run/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this data warehouse saved query." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Run this saved query." }, { "info": { "name": "environments_warehouse_saved_queries_run_history_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/warehouse_saved_queries/:id/run_history/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this data warehouse saved query." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Return the recent run history (up to 5 most recent) for this materialized view." }, { "info": { "name": "environments_warehouse_saved_queries_resume_schedules_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/warehouse_saved_queries/resume_schedules/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Resume paused materialization schedules for multiple matviews.\n\nAccepts a list of view IDs in the request body: {\"view_ids\": [\"id1\", \"id2\", ...]}\nThis endpoint is idempotent - calling it on already running or non-existent schedules is safe." }, { "info": { "name": "environments_warehouse_saved_query_folders_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/warehouse_saved_query_folders/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_warehouse_saved_query_folders_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/warehouse_saved_query_folders/", "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_warehouse_saved_query_folders_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/warehouse_saved_query_folders/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this data warehouse saved query folder." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_warehouse_saved_query_folders_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/environments/:environment_id/warehouse_saved_query_folders/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this data warehouse saved query folder." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_warehouse_saved_query_folders_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/environments/:environment_id/warehouse_saved_query_folders/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this data warehouse saved query folder." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "data_modeling_jobs_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/data_modeling_jobs/", "params": [ { "name": "cursor", "value": "", "type": "query", "description": "The pagination cursor value." }, { "name": "limit", "value": "", "type": "query", "description": "Number of results to return per page." }, { "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": "saved_query_id", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List data modeling jobs which are \"runs\" for our saved queries." }, { "info": { "name": "data_modeling_jobs_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/data_modeling_jobs/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this data modeling job." }, { "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": "List data modeling jobs which are \"runs\" for our saved queries." }, { "info": { "name": "data_modeling_jobs_recent_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/data_modeling_jobs/recent/", "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/." } ] }, "docs": "Get the most recent non-running job for each saved query from the v2 backend." }, { "info": { "name": "data_modeling_jobs_running_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/data_modeling_jobs/running/", "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/." } ] }, "docs": "Get all currently running jobs from the v2 backend." }, { "info": { "name": "data_warehouse_check_database_name_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/data_warehouse/check-database-name/", "params": [ { "name": "name", "value": "", "type": "query", "description": "Database name to check" }, { "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/." } ] }, "docs": "Check if a database name is available." }, { "info": { "name": "data_warehouse_completed_activity_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/data_warehouse/completed_activity/", "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/." } ] }, "docs": "Returns completed/non-running activities (jobs with status 'Completed').\nSupports pagination and cutoff time filtering." }, { "info": { "name": "data_warehouse_data_health_issues_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/data_warehouse/data_health_issues/", "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/." } ] }, "docs": "Returns failed/disabled data pipeline items for the Pipeline status side panel.\nIncludes: materializations, syncs, sources, destinations, and transformations." }, { "info": { "name": "data_warehouse_data_ops_dashboard_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/data_warehouse/data_ops_dashboard/", "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/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Returns the data ops overview dashboard ID for this team, creating it if it doesn't exist yet." }, { "info": { "name": "data_warehouse_deprovision_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/data_warehouse/deprovision/", "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/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Start deprovisioning the managed warehouse for this team." }, { "info": { "name": "data_warehouse_job_stats_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/data_warehouse/job_stats/", "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/." } ] }, "docs": "Returns success and failed job statistics for the last 1, 7, or 30 days.\nQuery parameter 'days' can be 1, 7, or 30 (default: 7)." }, { "info": { "name": "data_warehouse_property_values_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/data_warehouse/property_values/", "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/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "API endpoints for data warehouse aggregate statistics and operations." }, { "info": { "name": "data_warehouse_provision_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/data_warehouse/provision/", "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}}" } }, "docs": "Start provisioning a managed warehouse for this team." }, { "info": { "name": "data_warehouse_reset_password_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/data_warehouse/reset-password/", "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/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Reset the root password for the managed warehouse." }, { "info": { "name": "data_warehouse_running_activity_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/data_warehouse/running_activity/", "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/." } ] }, "docs": "Returns currently running activities (jobs with status 'Running').\nSupports pagination and cutoff time filtering." }, { "info": { "name": "data_warehouse_total_rows_stats_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/data_warehouse/total_rows_stats/", "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/." } ] }, "docs": "Returns aggregated statistics for the data warehouse total rows processed within the current billing period.\nUsed by the frontend data warehouse scene to display usage information." }, { "info": { "name": "data_warehouse_warehouse_status_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/data_warehouse/warehouse_status/", "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/." } ] }, "docs": "Get the current provisioning status of the managed warehouse." }, { "info": { "name": "external_data_schemas_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/external_data_schemas/", "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/." }, { "name": "search", "value": "", "type": "query", "description": "A search term." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "external_data_schemas_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/external_data_schemas/", "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": "external_data_schemas_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/external_data_schemas/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this external data schema." }, { "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": "external_data_schemas_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/projects/:project_id/external_data_schemas/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this external data schema." }, { "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": "external_data_schemas_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/projects/:project_id/external_data_schemas/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this external data schema." }, { "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": "external_data_schemas_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/projects/:project_id/external_data_schemas/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this external data schema." }, { "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": "external_data_schemas_cancel_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/external_data_schemas/:id/cancel/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this external data schema." }, { "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": "external_data_schemas_delete_data_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/projects/:project_id/external_data_schemas/:id/delete_data/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this external data schema." }, { "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": "external_data_schemas_incremental_fields_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/external_data_schemas/:id/incremental_fields/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this external data schema." }, { "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": "external_data_schemas_reload_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/external_data_schemas/:id/reload/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this external data schema." }, { "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": "external_data_schemas_resync_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/external_data_schemas/:id/resync/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this external data schema." }, { "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": "external_data_sources_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/external_data_sources/", "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/." }, { "name": "search", "value": "", "type": "query", "description": "A search term." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create, Read, Update and Delete External data Sources." }, { "info": { "name": "external_data_sources_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/external_data_sources/", "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}}" } }, "docs": "Create, Read, Update and Delete External data Sources." }, { "info": { "name": "external_data_sources_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/external_data_sources/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this external data source." }, { "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": "Create, Read, Update and Delete External data Sources." }, { "info": { "name": "external_data_sources_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/projects/:project_id/external_data_sources/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this external data source." }, { "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, Read, Update and Delete External data Sources." }, { "info": { "name": "external_data_sources_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/projects/:project_id/external_data_sources/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this external data source." }, { "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, Read, Update and Delete External data Sources." }, { "info": { "name": "external_data_sources_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/projects/:project_id/external_data_sources/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this external data source." }, { "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": "Create, Read, Update and Delete External data Sources." }, { "info": { "name": "external_data_sources_bulk_update_schemas_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/projects/:project_id/external_data_sources/:id/bulk_update_schemas/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this external data source." }, { "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/." }, { "name": "search", "value": "", "type": "query", "description": "A search term." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create, Read, Update and Delete External data Sources." }, { "info": { "name": "external_data_sources_create_webhook_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/external_data_sources/:id/create_webhook/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this external data source." }, { "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, Read, Update and Delete External data Sources." }, { "info": { "name": "external_data_sources_delete_webhook_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/external_data_sources/:id/delete_webhook/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this external data source." }, { "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, Read, Update and Delete External data Sources." }, { "info": { "name": "external_data_sources_jobs_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/external_data_sources/:id/jobs/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this external data source." }, { "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": "Create, Read, Update and Delete External data Sources." }, { "info": { "name": "external_data_sources_refresh_schemas_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/external_data_sources/:id/refresh_schemas/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this external data source." }, { "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": "Fetch current schema/table list from the source and create any new ExternalDataSchema rows (no data sync)." }, { "info": { "name": "external_data_sources_reload_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/external_data_sources/:id/reload/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this external data source." }, { "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, Read, Update and Delete External data Sources." }, { "info": { "name": "external_data_sources_revenue_analytics_config_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/projects/:project_id/external_data_sources/:id/revenue_analytics_config/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this external data source." }, { "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": "Update the revenue analytics configuration and return the full external data source." }, { "info": { "name": "external_data_sources_update_webhook_inputs_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/external_data_sources/:id/update_webhook_inputs/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this external data source." }, { "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, Read, Update and Delete External data Sources." }, { "info": { "name": "external_data_sources_webhook_info_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/external_data_sources/:id/webhook_info/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this external data source." }, { "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": "Create, Read, Update and Delete External data Sources." }, { "info": { "name": "external_data_sources_check_cdc_prerequisites_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/external_data_sources/check_cdc_prerequisites/", "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/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Validate CDC prerequisites against a live Postgres connection.\n\nUsed by the source wizard to surface ✅/❌ checks before source creation,\nand by the self-managed setup popup to verify user-created publications." }, { "info": { "name": "external_data_sources_connections_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/external_data_sources/connections/", "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/." }, { "name": "search", "value": "", "type": "query", "description": "A search term." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create, Read, Update and Delete External data Sources." }, { "info": { "name": "external_data_sources_database_schema_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/external_data_sources/database_schema/", "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}}" } }, "docs": "Create, Read, Update and Delete External data Sources." }, { "info": { "name": "external_data_sources_source_prefix_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/external_data_sources/source_prefix/", "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}}" } }, "docs": "Create, Read, Update and Delete External data Sources." }, { "info": { "name": "external_data_sources_wizard_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/external_data_sources/wizard/", "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/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create, Read, Update and Delete External data Sources." }, { "info": { "name": "insight_variables_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/insight_variables/", "params": [ { "name": "page", "value": "", "type": "query", "description": "A page number within the paginated result set." }, { "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": "insight_variables_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/insight_variables/", "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": "insight_variables_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/insight_variables/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this insight variable." }, { "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": "insight_variables_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/projects/:project_id/insight_variables/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this insight variable." }, { "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": "insight_variables_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/projects/:project_id/insight_variables/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this insight variable." }, { "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": "insight_variables_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/projects/:project_id/insight_variables/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this insight variable." }, { "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": "warehouse_saved_queries_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/warehouse_saved_queries/", "params": [ { "name": "page", "value": "", "type": "query", "description": "A page number within the paginated result set." }, { "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": "search", "value": "", "type": "query", "description": "A search term." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create, Read, Update and Delete Warehouse Tables." }, { "info": { "name": "warehouse_saved_queries_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/warehouse_saved_queries/", "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}}" } }, "docs": "Create, Read, Update and Delete Warehouse Tables." }, { "info": { "name": "warehouse_saved_queries_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/warehouse_saved_queries/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this data warehouse saved 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/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create, Read, Update and Delete Warehouse Tables." }, { "info": { "name": "warehouse_saved_queries_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/projects/:project_id/warehouse_saved_queries/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this data warehouse saved 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}}" } }, "docs": "Create, Read, Update and Delete Warehouse Tables." }, { "info": { "name": "warehouse_saved_queries_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/projects/:project_id/warehouse_saved_queries/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this data warehouse saved 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}}" } }, "docs": "Create, Read, Update and Delete Warehouse Tables." }, { "info": { "name": "warehouse_saved_queries_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/projects/:project_id/warehouse_saved_queries/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this data warehouse saved 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/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create, Read, Update and Delete Warehouse Tables." }, { "info": { "name": "warehouse_saved_queries_activity_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/warehouse_saved_queries/:id/activity/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this data warehouse saved 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/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create, Read, Update and Delete Warehouse Tables." }, { "info": { "name": "warehouse_saved_queries_ancestors_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/warehouse_saved_queries/:id/ancestors/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this data warehouse saved 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": "Return the ancestors of this saved query.\n\nBy default, we return the immediate parents. The `level` parameter can be used to\nlook further back into the ancestor tree. If `level` overshoots (i.e. points to only\nancestors beyond the root), we return an empty list." }, { "info": { "name": "warehouse_saved_queries_cancel_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/warehouse_saved_queries/:id/cancel/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this data warehouse saved 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": "Cancel a running saved query workflow." }, { "info": { "name": "warehouse_saved_queries_dependencies_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/warehouse_saved_queries/:id/dependencies/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this data warehouse saved 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/." } ] }, "docs": "Return the count of immediate upstream and downstream dependencies for this saved query." }, { "info": { "name": "warehouse_saved_queries_descendants_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/warehouse_saved_queries/:id/descendants/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this data warehouse saved 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": "Return the descendants of this saved query.\n\nBy default, we return the immediate children. The `level` parameter can be used to\nlook further ahead into the descendants tree. If `level` overshoots (i.e. points to only\ndescendants further than a leaf), we return an empty list." }, { "info": { "name": "warehouse_saved_queries_materialize_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/warehouse_saved_queries/:id/materialize/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this data warehouse saved 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}}" } }, "docs": "Enable materialization for this saved query with a 24-hour sync frequency." }, { "info": { "name": "warehouse_saved_queries_revert_materialization_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/warehouse_saved_queries/:id/revert_materialization/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this data warehouse saved 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}}" } }, "docs": "Undo materialization, revert back to the original view.\n(i.e. delete the materialized table and the schedule)" }, { "info": { "name": "warehouse_saved_queries_run_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/warehouse_saved_queries/:id/run/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this data warehouse saved 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}}" } }, "docs": "Run this saved query." }, { "info": { "name": "warehouse_saved_queries_run_history_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/warehouse_saved_queries/:id/run_history/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this data warehouse saved 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/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Return the recent run history (up to 5 most recent) for this materialized view." }, { "info": { "name": "warehouse_saved_queries_resume_schedules_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/warehouse_saved_queries/resume_schedules/", "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": "{}" } }, "docs": "Resume paused materialization schedules for multiple matviews.\n\nAccepts a list of view IDs in the request body: {\"view_ids\": [\"id1\", \"id2\", ...]}\nThis endpoint is idempotent - calling it on already running or non-existent schedules is safe." }, { "info": { "name": "warehouse_saved_query_folders_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/warehouse_saved_query_folders/", "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/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "warehouse_saved_query_folders_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/warehouse_saved_query_folders/", "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": "warehouse_saved_query_folders_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/warehouse_saved_query_folders/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this data warehouse saved query folder." }, { "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": "warehouse_saved_query_folders_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/projects/:project_id/warehouse_saved_query_folders/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this data warehouse saved query folder." }, { "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": "warehouse_saved_query_folders_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/projects/:project_id/warehouse_saved_query_folders/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this data warehouse saved query folder." }, { "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": "llm_analytics", "type": "folder" }, "items": [ { "info": { "name": "environments_dataset_items_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/dataset_items/", "params": [ { "name": "dataset", "value": "", "type": "query", "description": "Filter by dataset ID" }, { "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_dataset_items_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/dataset_items/", "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_dataset_items_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/dataset_items/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this dataset item." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_dataset_items_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/environments/:environment_id/dataset_items/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this dataset item." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_dataset_items_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/environments/:environment_id/dataset_items/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this dataset item." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_dataset_items_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/environments/:environment_id/dataset_items/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this dataset item." } ], "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_datasets_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/datasets/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id__in", "value": "", "type": "query", "description": "Multiple values may be separated by commas." }, { "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": "order_by", "value": "", "type": "query", "description": "Ordering\n\n* `created_at` - Created At\n* `-created_at` - Created At (descending)\n* `updated_at` - Updated At\n* `-updated_at` - Updated At (descending)" }, { "name": "search", "value": "", "type": "query", "description": "Search in name, description, or metadata" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_datasets_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/datasets/", "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_datasets_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/datasets/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this dataset." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_datasets_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/environments/:environment_id/datasets/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this dataset." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_datasets_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/environments/:environment_id/datasets/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this dataset." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_datasets_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/environments/:environment_id/datasets/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this dataset." } ], "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": "evaluation_runs_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:project_id/evaluation_runs/", "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}}" } }, "docs": "Create a new evaluation run.\n\nThis endpoint validates the request and enqueues a Temporal workflow\nto asynchronously execute the evaluation." }, { "info": { "name": "evaluations_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:project_id/evaluations/", "params": [ { "name": "enabled", "value": "", "type": "query", "description": "Filter by enabled status" }, { "name": "id__in", "value": "", "type": "query", "description": "Multiple values may be separated by commas." }, { "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": "order_by", "value": "", "type": "query", "description": "Ordering\n\n* `created_at` - Created At\n* `-created_at` - Created At (descending)\n* `updated_at` - Updated At\n* `-updated_at` - Updated At (descending)\n* `name` - Name\n* `-name` - Name (descending)" }, { "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": "search", "value": "", "type": "query", "description": "Search in name or description" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "evaluations_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:project_id/evaluations/", "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": "evaluations_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:project_id/evaluations/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this evaluation." }, { "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": "evaluations_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/environments/:project_id/evaluations/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this evaluation." }, { "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": "evaluations_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/environments/:project_id/evaluations/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this evaluation." }, { "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": "evaluations_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/environments/:project_id/evaluations/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this evaluation." }, { "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": "evaluations_test_hog_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:project_id/evaluations/test_hog/", "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}}" } }, "docs": "Test Hog evaluation code against sample events without saving." }, { "info": { "name": "llm_analytics_clustering_config_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:project_id/llm_analytics/clustering_config/", "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/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Team-level clustering configuration (event filters for automated pipelines)." }, { "info": { "name": "llm_analytics_clustering_config_set_event_filters_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:project_id/llm_analytics/clustering_config/set_event_filters/", "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/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Team-level clustering configuration (event filters for automated pipelines)." }, { "info": { "name": "llm_analytics_clustering_jobs_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:project_id/llm_analytics/clustering_jobs/", "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}}" } }, "docs": "CRUD for clustering job configurations (max 5 per team)." }, { "info": { "name": "llm_analytics_clustering_jobs_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:project_id/llm_analytics/clustering_jobs/", "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}}" } }, "docs": "CRUD for clustering job configurations (max 5 per team)." }, { "info": { "name": "llm_analytics_clustering_jobs_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:project_id/llm_analytics/clustering_jobs/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this clustering job." }, { "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": "CRUD for clustering job configurations (max 5 per team)." }, { "info": { "name": "llm_analytics_clustering_jobs_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/environments/:project_id/llm_analytics/clustering_jobs/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this clustering job." }, { "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": "CRUD for clustering job configurations (max 5 per team)." }, { "info": { "name": "llm_analytics_clustering_jobs_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/environments/:project_id/llm_analytics/clustering_jobs/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this clustering job." }, { "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": "CRUD for clustering job configurations (max 5 per team)." }, { "info": { "name": "llm_analytics_clustering_jobs_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/environments/:project_id/llm_analytics/clustering_jobs/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this clustering job." }, { "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": "CRUD for clustering job configurations (max 5 per team)." }, { "info": { "name": "llm_analytics_evaluation_config_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:project_id/llm_analytics/evaluation_config/", "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/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get the evaluation config for this team" }, { "info": { "name": "llm_analytics_evaluation_config_set_active_key_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:project_id/llm_analytics/evaluation_config/set_active_key/", "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}}" } }, "docs": "Set the active provider key for evaluations" }, { "info": { "name": "llm_analytics_evaluation_reports_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:project_id/llm_analytics/evaluation_reports/", "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}}" } }, "docs": "CRUD for evaluation report configurations + report run history." }, { "info": { "name": "llm_analytics_evaluation_reports_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:project_id/llm_analytics/evaluation_reports/", "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}}" } }, "docs": "CRUD for evaluation report configurations + report run history." }, { "info": { "name": "llm_analytics_evaluation_reports_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:project_id/llm_analytics/evaluation_reports/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this evaluation report." }, { "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": "CRUD for evaluation report configurations + report run history." }, { "info": { "name": "llm_analytics_evaluation_reports_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/environments/:project_id/llm_analytics/evaluation_reports/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this evaluation report." }, { "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": "CRUD for evaluation report configurations + report run history." }, { "info": { "name": "llm_analytics_evaluation_reports_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/environments/:project_id/llm_analytics/evaluation_reports/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this evaluation report." }, { "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": "CRUD for evaluation report configurations + report run history." }, { "info": { "name": "llm_analytics_evaluation_reports_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/environments/:project_id/llm_analytics/evaluation_reports/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this evaluation report." }, { "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": "llm_analytics_evaluation_reports_generate_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:project_id/llm_analytics/evaluation_reports/:id/generate/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this evaluation report." }, { "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": "Trigger immediate report generation." }, { "info": { "name": "llm_analytics_evaluation_reports_runs_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:project_id/llm_analytics/evaluation_reports/:id/runs/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this evaluation report." }, { "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}}" } }, "docs": "List report runs (history) for this report." }, { "info": { "name": "llm_analytics_models_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:project_id/llm_analytics/models/", "params": [ { "name": "key_id", "value": "", "type": "query", "description": "Optional provider key UUID. When supplied, models reachable with that specific key are returned (useful for Azure OpenAI, where the deployment list depends on the configured endpoint). Must belong to the same provider as the `provider` parameter." }, { "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": "provider", "value": "", "type": "query", "description": "LLM provider to list models for. Must be one of the supported providers." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List available models for a provider." }, { "info": { "name": "llm_analytics_provider_key_validations_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:project_id/llm_analytics/provider_key_validations/", "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/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Validate LLM provider API keys without persisting them" }, { "info": { "name": "llm_analytics_provider_keys_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:project_id/llm_analytics/provider_keys/", "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": "llm_analytics_provider_keys_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:project_id/llm_analytics/provider_keys/", "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": "llm_analytics_provider_keys_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:project_id/llm_analytics/provider_keys/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this llm provider key." }, { "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": "llm_analytics_provider_keys_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/environments/:project_id/llm_analytics/provider_keys/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this llm provider key." }, { "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": "llm_analytics_provider_keys_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/environments/:project_id/llm_analytics/provider_keys/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this llm provider key." }, { "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": "llm_analytics_provider_keys_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/environments/:project_id/llm_analytics/provider_keys/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this llm provider key." }, { "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": "llm_analytics_provider_keys_assign_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:project_id/llm_analytics/provider_keys/:id/assign/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this llm provider key." }, { "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": "Assign this key to evaluations and optionally re-enable them." }, { "info": { "name": "llm_analytics_provider_keys_dependent_configs_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:project_id/llm_analytics/provider_keys/:id/dependent_configs/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this llm provider key." }, { "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/." } ] }, "docs": "Get evaluations using this key and alternative keys for replacement." }, { "info": { "name": "llm_analytics_provider_keys_validate_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:project_id/llm_analytics/provider_keys/:id/validate/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this llm provider key." }, { "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": "llm_analytics_provider_keys_trial_evaluations_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:project_id/llm_analytics/provider_keys/trial_evaluations/", "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/." } ] }, "docs": "List enabled evaluations currently using trial credits for a given provider." }, { "info": { "name": "llm_analytics_review_queue_items_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:project_id/llm_analytics/review_queue_items/", "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": "order_by", "value": "", "type": "query", "description": "Order by `created_at` or `updated_at`." }, { "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": "queue_id", "value": "", "type": "query", "description": "Filter by a specific review queue ID." }, { "name": "search", "value": "", "type": "query", "description": "Search pending trace IDs." }, { "name": "trace_id", "value": "", "type": "query", "description": "Filter by an exact trace ID." }, { "name": "trace_id__in", "value": "", "type": "query", "description": "Filter by multiple trace IDs separated by commas." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "llm_analytics_review_queue_items_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:project_id/llm_analytics/review_queue_items/", "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": "llm_analytics_review_queue_items_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:project_id/llm_analytics/review_queue_items/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this review queue item." }, { "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": "llm_analytics_review_queue_items_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/environments/:project_id/llm_analytics/review_queue_items/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this review queue item." }, { "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": "llm_analytics_review_queue_items_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/environments/:project_id/llm_analytics/review_queue_items/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this review queue item." }, { "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": "llm_analytics_review_queues_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:project_id/llm_analytics/review_queues/", "params": [ { "name": "limit", "value": "", "type": "query", "description": "Number of results to return per page." }, { "name": "name", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query", "description": "The initial index from which to return the results." }, { "name": "order_by", "value": "", "type": "query", "description": "Order by `name`, `updated_at`, or `created_at`." }, { "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": "search", "value": "", "type": "query", "description": "Search review queue names." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "llm_analytics_review_queues_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:project_id/llm_analytics/review_queues/", "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": "llm_analytics_review_queues_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:project_id/llm_analytics/review_queues/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this review queue." }, { "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": "llm_analytics_review_queues_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/environments/:project_id/llm_analytics/review_queues/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this review queue." }, { "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": "llm_analytics_review_queues_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/environments/:project_id/llm_analytics/review_queues/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this review queue." }, { "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": "llm_analytics_score_definitions_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:project_id/llm_analytics/score_definitions/", "params": [ { "name": "archived", "value": "", "type": "query", "description": "Filter by archived state." }, { "name": "kind", "value": "", "type": "query", "description": "Filter by scorer kind." }, { "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": "order_by", "value": "", "type": "query", "description": "Sort by name, kind, created_at, updated_at, or current_version." }, { "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": "search", "value": "", "type": "query", "description": "Search scorers by name or description." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "llm_analytics_score_definitions_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:project_id/llm_analytics/score_definitions/", "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": "llm_analytics_score_definitions_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:project_id/llm_analytics/score_definitions/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this score definition." }, { "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": "llm_analytics_score_definitions_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/environments/:project_id/llm_analytics/score_definitions/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this score definition." }, { "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": "llm_analytics_score_definitions_new_version_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:project_id/llm_analytics/score_definitions/:id/new_version/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this score definition." }, { "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": "llm_analytics_trace_reviews_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:project_id/llm_analytics/trace_reviews/", "params": [ { "name": "definition_id", "value": "", "type": "query", "description": "Filter by a stable scorer definition ID." }, { "name": "definition_id__in", "value": "", "type": "query", "description": "Filter by multiple scorer definition IDs separated by commas." }, { "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": "order_by", "value": "", "type": "query", "description": "Order by `updated_at` or `created_at`." }, { "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": "search", "value": "", "type": "query", "description": "Search trace IDs and comments." }, { "name": "trace_id", "value": "", "type": "query", "description": "Filter by an exact trace ID." }, { "name": "trace_id__in", "value": "", "type": "query", "description": "Filter by multiple trace IDs separated by commas." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "llm_analytics_trace_reviews_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:project_id/llm_analytics/trace_reviews/", "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": "llm_analytics_trace_reviews_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:project_id/llm_analytics/trace_reviews/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this trace review." }, { "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": "llm_analytics_trace_reviews_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/environments/:project_id/llm_analytics/trace_reviews/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this trace review." }, { "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": "llm_analytics_trace_reviews_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/environments/:project_id/llm_analytics/trace_reviews/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this trace review." }, { "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": "llm_analytics_translate_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:project_id/llm_analytics/translate/", "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}}" } }, "docs": "Translate text to target language." }, { "info": { "name": "llm_prompts_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:project_id/llm_prompts/", "params": [ { "name": "content", "value": "", "type": "query", "description": "Controls how much prompt content is included in the response. 'full' includes the full prompt, 'preview' includes a short prompt_preview, and 'none' omits prompt content entirely. The outline field is always included.\n\n* `full` - full\n* `preview` - preview\n* `none` - none" }, { "name": "created_by_id", "value": "", "type": "query", "description": "Filter prompts by the ID of the user who created them." }, { "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/." }, { "name": "search", "value": "", "type": "query", "description": "Optional substring filter applied to prompt names and prompt content." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "llm_prompts_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:project_id/llm_prompts/", "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": "llm_prompts_name_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:project_id/llm_prompts/name/:prompt_name/", "params": [ { "name": "content", "value": "", "type": "query", "description": "Controls how much prompt content is included in the response. 'full' includes the full prompt, 'preview' includes a short prompt_preview, and 'none' omits prompt content entirely. The outline field is always included.\n\n* `full` - full\n* `preview` - preview\n* `none` - none" }, { "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": "prompt_name", "value": "", "type": "path" }, { "name": "version", "value": "", "type": "query", "description": "Specific prompt version to fetch. If omitted, the latest version is returned." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "llm_prompts_name_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/environments/:project_id/llm_prompts/name/:prompt_name/", "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/." }, { "name": "prompt_name", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "llm_prompts_name_archive_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:project_id/llm_prompts/name/:prompt_name/archive/", "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/." }, { "name": "prompt_name", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "llm_prompts_name_duplicate_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:project_id/llm_prompts/name/:prompt_name/duplicate/", "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/." }, { "name": "prompt_name", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "llm_prompts_resolve_name_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:project_id/llm_prompts/resolve/name/:prompt_name/", "params": [ { "name": "before_version", "value": "", "type": "query", "description": "Return versions older than this version number. Mutually exclusive with offset." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of versions to return per page (1-100)." }, { "name": "offset", "value": "", "type": "query", "description": "Zero-based offset into version history for pagination. Mutually exclusive with before_version." }, { "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": "prompt_name", "value": "", "type": "path" }, { "name": "version", "value": "", "type": "query", "description": "Specific prompt version to fetch. If omitted, the latest version is returned." }, { "name": "version_id", "value": "", "type": "query", "description": "Exact prompt version UUID to resolve. Can be used together with version for extra safety." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "llm_skills_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:project_id/llm_skills/", "params": [ { "name": "created_by_id", "value": "", "type": "query", "description": "Filter skills by the ID of the user who created them." }, { "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/." }, { "name": "search", "value": "", "type": "query", "description": "Optional substring filter applied to skill names and descriptions." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "llm_skills_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:project_id/llm_skills/", "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": "llm_skills_name_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:project_id/llm_skills/name/:skill_name/", "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/." }, { "name": "skill_name", "value": "", "type": "path" }, { "name": "version", "value": "", "type": "query", "description": "Specific skill version to fetch. If omitted, the latest version is returned." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "llm_skills_name_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/environments/:project_id/llm_skills/name/:skill_name/", "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/." }, { "name": "skill_name", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "llm_skills_name_archive_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:project_id/llm_skills/name/:skill_name/archive/", "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/." }, { "name": "skill_name", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "llm_skills_name_duplicate_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:project_id/llm_skills/name/:skill_name/duplicate/", "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/." }, { "name": "skill_name", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "llm_skills_name_files_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:project_id/llm_skills/name/:skill_name/files/", "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/." }, { "name": "skill_name", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "llm_skills_name_files_rename_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:project_id/llm_skills/name/:skill_name/files-rename/", "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/." }, { "name": "skill_name", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "llm_skills_name_files_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:project_id/llm_skills/name/:skill_name/files/:file_path/", "params": [ { "name": "file_path", "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": "skill_name", "value": "", "type": "path" }, { "name": "version", "value": "", "type": "query", "description": "Specific skill version to fetch. If omitted, the latest version is returned." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "llm_skills_name_files_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/environments/:project_id/llm_skills/name/:skill_name/files/:file_path/", "params": [ { "name": "base_version", "value": "", "type": "query", "description": "Latest version you are editing from. If provided, the request fails with 409 when another write has landed in the meantime." }, { "name": "file_path", "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": "skill_name", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "llm_skills_resolve_name_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:project_id/llm_skills/resolve/name/:skill_name/", "params": [ { "name": "before_version", "value": "", "type": "query", "description": "Return versions older than this version number. Mutually exclusive with offset." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of versions to return per page (1-100)." }, { "name": "offset", "value": "", "type": "query", "description": "Zero-based offset into version history for pagination. Mutually exclusive with before_version." }, { "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": "skill_name", "value": "", "type": "path" }, { "name": "version", "value": "", "type": "query", "description": "Specific skill version to fetch. If omitted, the latest version is returned." }, { "name": "version_id", "value": "", "type": "query", "description": "Exact skill version UUID to resolve." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "dataset_items_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/dataset_items/", "params": [ { "name": "dataset", "value": "", "type": "query", "description": "Filter by dataset ID" }, { "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": "dataset_items_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/dataset_items/", "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": "dataset_items_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/dataset_items/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this dataset item." }, { "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": "dataset_items_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/projects/:project_id/dataset_items/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this dataset item." }, { "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": "dataset_items_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/projects/:project_id/dataset_items/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this dataset item." }, { "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": "dataset_items_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/projects/:project_id/dataset_items/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this dataset item." }, { "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": "datasets_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/datasets/", "params": [ { "name": "id__in", "value": "", "type": "query", "description": "Multiple values may be separated by commas." }, { "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": "order_by", "value": "", "type": "query", "description": "Ordering\n\n* `created_at` - Created At\n* `-created_at` - Created At (descending)\n* `updated_at` - Updated At\n* `-updated_at` - Updated At (descending)" }, { "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": "search", "value": "", "type": "query", "description": "Search in name, description, or metadata" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "datasets_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/datasets/", "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": "datasets_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/datasets/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this dataset." }, { "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": "datasets_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/projects/:project_id/datasets/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this dataset." }, { "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": "datasets_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/projects/:project_id/datasets/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this dataset." }, { "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": "datasets_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/projects/:project_id/datasets/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this dataset." }, { "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": "product_analytics", "type": "folder" }, "items": [ { "info": { "name": "environments_elements_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/elements/", "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_elements_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/elements/", "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_elements_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/elements/: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 element." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_elements_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/environments/:environment_id/elements/: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 element." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_elements_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/environments/:environment_id/elements/: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 element." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_elements_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/environments/:environment_id/elements/: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 element." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_elements_stats_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/elements/stats/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "The original version of this API always and only returned $autocapture elements\nIf no include query parameter is sent this remains true.\nNow, you can pass a combination of include query parameters to get different types of elements\nCurrently only $autocapture and $rageclick and $dead_click are supported" }, { "info": { "name": "environments_elements_values_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/elements/values/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_insights_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/insights/", "params": [ { "name": "basic", "value": "", "type": "query", "description": "Return basic insight metadata only (no results, faster)." }, { "name": "created_by", "value": "", "type": "query", "description": "JSON-encoded array of user IDs. Only returns insights whose `created_by` is in the list, e.g. `[1,42]`." }, { "name": "created_date_from", "value": "", "type": "query", "description": "Filter by `created_at > created_date_from`. Accepts absolute or relative dates." }, { "name": "created_date_to", "value": "", "type": "query", "description": "Filter by `created_at < created_date_to`. Accepts absolute or relative dates." }, { "name": "dashboards", "value": "", "type": "query", "description": "JSON-encoded array of dashboard IDs. Returns insights attached to every listed dashboard (AND)." }, { "name": "date_from", "value": "", "type": "query", "description": "Filter by `last_modified_at > date_from`. Accepts absolute dates (`2025-04-23`) or relative strings (`-7d`, `-1m`)." }, { "name": "date_to", "value": "", "type": "query", "description": "Filter by `last_modified_at < date_to`. Accepts absolute dates or relative strings." }, { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "favorited", "value": "", "type": "query", "description": "Include this parameter (any value) to restrict results to insights marked as favorited." }, { "name": "format", "value": "", "type": "query" }, { "name": "insight", "value": "", "type": "query", "description": "Restrict to a single insight type. `JSON` matches non-wrapper query insights; `SQL` matches HogQL queries." }, { "name": "last_viewed_date_from", "value": "", "type": "query", "description": "Filter by `last_viewed_at > last_viewed_date_from`. Accepts absolute or relative dates." }, { "name": "last_viewed_date_to", "value": "", "type": "query", "description": "Filter by `last_viewed_at < last_viewed_date_to`. Accepts absolute or relative dates." }, { "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": "refresh", "value": "", "type": "query", "description": "\nWhether to refresh the retrieved insights, how aggressively, and if sync or async:\n- `'force_cache'` - return cached data or a cache miss; always completes immediately as it never calculates\n- `'blocking'` - calculate synchronously (returning only when the query is done), UNLESS there are very fresh results in the cache\n- `'async'` - kick off background calculation (returning immediately with a query status), UNLESS there are very fresh results in the cache\n- `'lazy_async'` - kick off background calculation, UNLESS there are somewhat fresh results in the cache\n- `'force_blocking'` - calculate synchronously, even if fresh results are already cached\n- `'force_async'` - kick off background calculation, even if fresh results are already cached\nBackground calculation can be tracked using the `query_status` response field." }, { "name": "saved", "value": "", "type": "query", "description": "When truthy, restricts results to insights that are saved (or attached to a visible dashboard). When falsy, only unsaved insights." }, { "name": "search", "value": "", "type": "query", "description": "Case-insensitive substring match across name, derived_name, description, and tag names." }, { "name": "short_id", "value": "", "type": "query" }, { "name": "tags", "value": "", "type": "query", "description": "JSON-encoded array of tag names. Returns insights with any of the listed tags." }, { "name": "user", "value": "", "type": "query", "description": "Include this parameter (any value) to restrict results to insights created by the authenticated user." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "DRF ViewSet mixin that gates coalesced responses behind permission checks.\n\nThe QueryCoalescingMiddleware attaches cached response data to\nrequest.META[\"_coalesced_response\"] for followers. This mixin runs DRF's\ninitial() (auth + permissions + throttling) before returning the\ncached response, ensuring the request is authorized." }, { "info": { "name": "environments_insights_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/insights/", "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}}" } }, "docs": "DRF ViewSet mixin that gates coalesced responses behind permission checks.\n\nThe QueryCoalescingMiddleware attaches cached response data to\nrequest.META[\"_coalesced_response\"] for followers. This mixin runs DRF's\ninitial() (auth + permissions + throttling) before returning the\ncached response, ensuring the request is authorized." }, { "info": { "name": "environments_insights_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/insights/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "format", "value": "", "type": "query" }, { "name": "from_dashboard", "value": "", "type": "query", "description": "\nOnly if loading an insight in the context of a dashboard: The relevant dashboard's ID.\nWhen set, the specified dashboard's filters and date range override will be applied." }, { "name": "id", "value": "", "type": "path", "description": "Numeric primary key or 8-character `short_id` (for example `AaVQ8Ijw`) identifying the insight." }, { "name": "refresh", "value": "", "type": "query", "description": "\nWhether to refresh the insight, how aggresively, and if sync or async:\n- `'force_cache'` - return cached data or a cache miss; always completes immediately as it never calculates\n- `'blocking'` - calculate synchronously (returning only when the query is done), UNLESS there are very fresh results in the cache\n- `'async'` - kick off background calculation (returning immediately with a query status), UNLESS there are very fresh results in the cache\n- `'lazy_async'` - kick off background calculation, UNLESS there are somewhat fresh results in the cache\n- `'force_blocking'` - calculate synchronously, even if fresh results are already cached\n- `'force_async'` - kick off background calculation, even if fresh results are already cached\nBackground calculation can be tracked using the `query_status` response field." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "DRF ViewSet mixin that gates coalesced responses behind permission checks.\n\nThe QueryCoalescingMiddleware attaches cached response data to\nrequest.META[\"_coalesced_response\"] for followers. This mixin runs DRF's\ninitial() (auth + permissions + throttling) before returning the\ncached response, ensuring the request is authorized." }, { "info": { "name": "environments_insights_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/environments/:environment_id/insights/: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": "Numeric primary key or 8-character `short_id` (for example `AaVQ8Ijw`) identifying the insight." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "DRF ViewSet mixin that gates coalesced responses behind permission checks.\n\nThe QueryCoalescingMiddleware attaches cached response data to\nrequest.META[\"_coalesced_response\"] for followers. This mixin runs DRF's\ninitial() (auth + permissions + throttling) before returning the\ncached response, ensuring the request is authorized." }, { "info": { "name": "environments_insights_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/environments/:environment_id/insights/: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": "Numeric primary key or 8-character `short_id` (for example `AaVQ8Ijw`) identifying the insight." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "DRF ViewSet mixin that gates coalesced responses behind permission checks.\n\nThe QueryCoalescingMiddleware attaches cached response data to\nrequest.META[\"_coalesced_response\"] for followers. This mixin runs DRF's\ninitial() (auth + permissions + throttling) before returning the\ncached response, ensuring the request is authorized." }, { "info": { "name": "environments_insights_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/environments/:environment_id/insights/: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": "Numeric primary key or 8-character `short_id` (for example `AaVQ8Ijw`) identifying the insight." } ], "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_insights_activity_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/insights/:id/activity/", "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 insight." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "DRF ViewSet mixin that gates coalesced responses behind permission checks.\n\nThe QueryCoalescingMiddleware attaches cached response data to\nrequest.META[\"_coalesced_response\"] for followers. This mixin runs DRF's\ninitial() (auth + permissions + throttling) before returning the\ncached response, ensuring the request is authorized." }, { "info": { "name": "environments_insights_analyze_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/insights/:id/analyze/", "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 insight." } ] }, "docs": "DRF ViewSet mixin that gates coalesced responses behind permission checks.\n\nThe QueryCoalescingMiddleware attaches cached response data to\nrequest.META[\"_coalesced_response\"] for followers. This mixin runs DRF's\ninitial() (auth + permissions + throttling) before returning the\ncached response, ensuring the request is authorized." }, { "info": { "name": "environments_insights_suggestions_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/insights/:id/suggestions/", "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 insight." } ] }, "docs": "DRF ViewSet mixin that gates coalesced responses behind permission checks.\n\nThe QueryCoalescingMiddleware attaches cached response data to\nrequest.META[\"_coalesced_response\"] for followers. This mixin runs DRF's\ninitial() (auth + permissions + throttling) before returning the\ncached response, ensuring the request is authorized." }, { "info": { "name": "environments_insights_suggestions_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/insights/:id/suggestions/", "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 insight." } ], "body": { "type": "json", "data": "{}" } }, "docs": "DRF ViewSet mixin that gates coalesced responses behind permission checks.\n\nThe QueryCoalescingMiddleware attaches cached response data to\nrequest.META[\"_coalesced_response\"] for followers. This mixin runs DRF's\ninitial() (auth + permissions + throttling) before returning the\ncached response, ensuring the request is authorized." }, { "info": { "name": "environments_insights_all_activity_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/insights/activity/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "format", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "DRF ViewSet mixin that gates coalesced responses behind permission checks.\n\nThe QueryCoalescingMiddleware attaches cached response data to\nrequest.META[\"_coalesced_response\"] for followers. This mixin runs DRF's\ninitial() (auth + permissions + throttling) before returning the\ncached response, ensuring the request is authorized." }, { "info": { "name": "environments_insights_bulk_update_tags_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/insights/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_insights_cancel_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/insights/cancel/", "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": "DRF ViewSet mixin that gates coalesced responses behind permission checks.\n\nThe QueryCoalescingMiddleware attaches cached response data to\nrequest.META[\"_coalesced_response\"] for followers. This mixin runs DRF's\ninitial() (auth + permissions + throttling) before returning the\ncached response, ensuring the request is authorized." }, { "info": { "name": "environments_insights_generate_metadata_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/insights/generate_metadata/", "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}}" } }, "docs": "Generate an AI-suggested name and description for an insight based on its query configuration." }, { "info": { "name": "environments_insights_my_last_viewed_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/insights/my_last_viewed/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "format", "value": "", "type": "query" } ] }, "docs": "Returns basic details about the last 5 insights viewed by this user. Most recently viewed first." }, { "info": { "name": "environments_insights_trending_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/insights/trending/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "format", "value": "", "type": "query" } ] }, "docs": "Returns trending insights based on view count in the last N days (default 7).\nDefaults to returning top 10 insights." }, { "info": { "name": "environments_insights_viewed_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/insights/viewed/", "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}}" } }, "docs": "Update insight view timestamps.\nExpects: {\"insight_ids\": [1, 2, 3, ...]}" }, { "info": { "name": "elements_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/elements/", "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": "elements_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/elements/", "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": "elements_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/elements/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this element." }, { "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": "elements_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/projects/:project_id/elements/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this element." }, { "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": "elements_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/projects/:project_id/elements/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this element." }, { "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": "elements_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/projects/:project_id/elements/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this element." }, { "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": "elements_stats_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/elements/stats/", "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/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "The original version of this API always and only returned $autocapture elements\nIf no include query parameter is sent this remains true.\nNow, you can pass a combination of include query parameters to get different types of elements\nCurrently only $autocapture and $rageclick and $dead_click are supported" }, { "info": { "name": "elements_values_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/elements/values/", "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/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "insights_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/insights/", "params": [ { "name": "basic", "value": "", "type": "query", "description": "Return basic insight metadata only (no results, faster)." }, { "name": "created_by", "value": "", "type": "query", "description": "JSON-encoded array of user IDs. Only returns insights whose `created_by` is in the list, e.g. `[1,42]`." }, { "name": "created_date_from", "value": "", "type": "query", "description": "Filter by `created_at > created_date_from`. Accepts absolute or relative dates." }, { "name": "created_date_to", "value": "", "type": "query", "description": "Filter by `created_at < created_date_to`. Accepts absolute or relative dates." }, { "name": "dashboards", "value": "", "type": "query", "description": "JSON-encoded array of dashboard IDs. Returns insights attached to every listed dashboard (AND)." }, { "name": "date_from", "value": "", "type": "query", "description": "Filter by `last_modified_at > date_from`. Accepts absolute dates (`2025-04-23`) or relative strings (`-7d`, `-1m`)." }, { "name": "date_to", "value": "", "type": "query", "description": "Filter by `last_modified_at < date_to`. Accepts absolute dates or relative strings." }, { "name": "favorited", "value": "", "type": "query", "description": "Include this parameter (any value) to restrict results to insights marked as favorited." }, { "name": "format", "value": "", "type": "query" }, { "name": "insight", "value": "", "type": "query", "description": "Restrict to a single insight type. `JSON` matches non-wrapper query insights; `SQL` matches HogQL queries." }, { "name": "last_viewed_date_from", "value": "", "type": "query", "description": "Filter by `last_viewed_at > last_viewed_date_from`. Accepts absolute or relative dates." }, { "name": "last_viewed_date_to", "value": "", "type": "query", "description": "Filter by `last_viewed_at < last_viewed_date_to`. Accepts absolute or relative dates." }, { "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/." }, { "name": "refresh", "value": "", "type": "query", "description": "\nWhether to refresh the retrieved insights, how aggressively, and if sync or async:\n- `'force_cache'` - return cached data or a cache miss; always completes immediately as it never calculates\n- `'blocking'` - calculate synchronously (returning only when the query is done), UNLESS there are very fresh results in the cache\n- `'async'` - kick off background calculation (returning immediately with a query status), UNLESS there are very fresh results in the cache\n- `'lazy_async'` - kick off background calculation, UNLESS there are somewhat fresh results in the cache\n- `'force_blocking'` - calculate synchronously, even if fresh results are already cached\n- `'force_async'` - kick off background calculation, even if fresh results are already cached\nBackground calculation can be tracked using the `query_status` response field." }, { "name": "saved", "value": "", "type": "query", "description": "When truthy, restricts results to insights that are saved (or attached to a visible dashboard). When falsy, only unsaved insights." }, { "name": "search", "value": "", "type": "query", "description": "Case-insensitive substring match across name, derived_name, description, and tag names." }, { "name": "short_id", "value": "", "type": "query" }, { "name": "tags", "value": "", "type": "query", "description": "JSON-encoded array of tag names. Returns insights with any of the listed tags." }, { "name": "user", "value": "", "type": "query", "description": "Include this parameter (any value) to restrict results to insights created by the authenticated user." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "DRF ViewSet mixin that gates coalesced responses behind permission checks.\n\nThe QueryCoalescingMiddleware attaches cached response data to\nrequest.META[\"_coalesced_response\"] for followers. This mixin runs DRF's\ninitial() (auth + permissions + throttling) before returning the\ncached response, ensuring the request is authorized." }, { "info": { "name": "insights_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/insights/", "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}}" } }, "docs": "DRF ViewSet mixin that gates coalesced responses behind permission checks.\n\nThe QueryCoalescingMiddleware attaches cached response data to\nrequest.META[\"_coalesced_response\"] for followers. This mixin runs DRF's\ninitial() (auth + permissions + throttling) before returning the\ncached response, ensuring the request is authorized." }, { "info": { "name": "insights_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/insights/:id/", "params": [ { "name": "format", "value": "", "type": "query" }, { "name": "from_dashboard", "value": "", "type": "query", "description": "\nOnly if loading an insight in the context of a dashboard: The relevant dashboard's ID.\nWhen set, the specified dashboard's filters and date range override will be applied." }, { "name": "id", "value": "", "type": "path", "description": "Numeric primary key or 8-character `short_id` (for example `AaVQ8Ijw`) identifying the insight." }, { "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": "\nWhether to refresh the insight, how aggresively, and if sync or async:\n- `'force_cache'` - return cached data or a cache miss; always completes immediately as it never calculates\n- `'blocking'` - calculate synchronously (returning only when the query is done), UNLESS there are very fresh results in the cache\n- `'async'` - kick off background calculation (returning immediately with a query status), UNLESS there are very fresh results in the cache\n- `'lazy_async'` - kick off background calculation, UNLESS there are somewhat fresh results in the cache\n- `'force_blocking'` - calculate synchronously, even if fresh results are already cached\n- `'force_async'` - kick off background calculation, even if fresh results are already cached\nBackground calculation can be tracked using the `query_status` response field." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "DRF ViewSet mixin that gates coalesced responses behind permission checks.\n\nThe QueryCoalescingMiddleware attaches cached response data to\nrequest.META[\"_coalesced_response\"] for followers. This mixin runs DRF's\ninitial() (auth + permissions + throttling) before returning the\ncached response, ensuring the request is authorized." }, { "info": { "name": "insights_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/projects/:project_id/insights/:id/", "params": [ { "name": "format", "value": "", "type": "query" }, { "name": "id", "value": "", "type": "path", "description": "Numeric primary key or 8-character `short_id` (for example `AaVQ8Ijw`) identifying the insight." }, { "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": "DRF ViewSet mixin that gates coalesced responses behind permission checks.\n\nThe QueryCoalescingMiddleware attaches cached response data to\nrequest.META[\"_coalesced_response\"] for followers. This mixin runs DRF's\ninitial() (auth + permissions + throttling) before returning the\ncached response, ensuring the request is authorized." }, { "info": { "name": "insights_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/projects/:project_id/insights/:id/", "params": [ { "name": "format", "value": "", "type": "query" }, { "name": "id", "value": "", "type": "path", "description": "Numeric primary key or 8-character `short_id` (for example `AaVQ8Ijw`) identifying the insight." }, { "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": "DRF ViewSet mixin that gates coalesced responses behind permission checks.\n\nThe QueryCoalescingMiddleware attaches cached response data to\nrequest.META[\"_coalesced_response\"] for followers. This mixin runs DRF's\ninitial() (auth + permissions + throttling) before returning the\ncached response, ensuring the request is authorized." }, { "info": { "name": "insights_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/projects/:project_id/insights/:id/", "params": [ { "name": "format", "value": "", "type": "query" }, { "name": "id", "value": "", "type": "path", "description": "Numeric primary key or 8-character `short_id` (for example `AaVQ8Ijw`) identifying the insight." }, { "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": "insights_activity_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/insights/:id/activity/", "params": [ { "name": "format", "value": "", "type": "query" }, { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this insight." }, { "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": "DRF ViewSet mixin that gates coalesced responses behind permission checks.\n\nThe QueryCoalescingMiddleware attaches cached response data to\nrequest.META[\"_coalesced_response\"] for followers. This mixin runs DRF's\ninitial() (auth + permissions + throttling) before returning the\ncached response, ensuring the request is authorized." }, { "info": { "name": "insights_analyze_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/insights/:id/analyze/", "params": [ { "name": "format", "value": "", "type": "query" }, { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this insight." }, { "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/." } ] }, "docs": "DRF ViewSet mixin that gates coalesced responses behind permission checks.\n\nThe QueryCoalescingMiddleware attaches cached response data to\nrequest.META[\"_coalesced_response\"] for followers. This mixin runs DRF's\ninitial() (auth + permissions + throttling) before returning the\ncached response, ensuring the request is authorized." }, { "info": { "name": "insights_suggestions_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/insights/:id/suggestions/", "params": [ { "name": "format", "value": "", "type": "query" }, { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this insight." }, { "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/." } ] }, "docs": "DRF ViewSet mixin that gates coalesced responses behind permission checks.\n\nThe QueryCoalescingMiddleware attaches cached response data to\nrequest.META[\"_coalesced_response\"] for followers. This mixin runs DRF's\ninitial() (auth + permissions + throttling) before returning the\ncached response, ensuring the request is authorized." }, { "info": { "name": "insights_suggestions_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/insights/:id/suggestions/", "params": [ { "name": "format", "value": "", "type": "query" }, { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this insight." }, { "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": "DRF ViewSet mixin that gates coalesced responses behind permission checks.\n\nThe QueryCoalescingMiddleware attaches cached response data to\nrequest.META[\"_coalesced_response\"] for followers. This mixin runs DRF's\ninitial() (auth + permissions + throttling) before returning the\ncached response, ensuring the request is authorized." }, { "info": { "name": "insights_all_activity_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/insights/activity/", "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/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "DRF ViewSet mixin that gates coalesced responses behind permission checks.\n\nThe QueryCoalescingMiddleware attaches cached response data to\nrequest.META[\"_coalesced_response\"] for followers. This mixin runs DRF's\ninitial() (auth + permissions + throttling) before returning the\ncached response, ensuring the request is authorized." }, { "info": { "name": "insights_bulk_update_tags_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/insights/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": "insights_cancel_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/insights/cancel/", "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": "DRF ViewSet mixin that gates coalesced responses behind permission checks.\n\nThe QueryCoalescingMiddleware attaches cached response data to\nrequest.META[\"_coalesced_response\"] for followers. This mixin runs DRF's\ninitial() (auth + permissions + throttling) before returning the\ncached response, ensuring the request is authorized." }, { "info": { "name": "insights_generate_metadata_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/insights/generate_metadata/", "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}}" } }, "docs": "Generate an AI-suggested name and description for an insight based on its query configuration." }, { "info": { "name": "insights_my_last_viewed_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/insights/my_last_viewed/", "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/." } ] }, "docs": "Returns basic details about the last 5 insights viewed by this user. Most recently viewed first." }, { "info": { "name": "insights_trending_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/insights/trending/", "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/." } ] }, "docs": "Returns trending insights based on view count in the last N days (default 7).\nDefaults to returning top 10 insights." }, { "info": { "name": "insights_viewed_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/insights/viewed/", "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}}" } }, "docs": "Update insight view timestamps.\nExpects: {\"insight_ids\": [1, 2, 3, ...]}" } ] }, { "info": { "name": "endpoints", "type": "folder" }, "items": [ { "info": { "name": "environments_endpoints_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/endpoints/", "params": [ { "name": "created_by", "value": "", "type": "query" }, { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "is_active", "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}}" } }, "docs": "List all endpoints for the team." }, { "info": { "name": "environments_endpoints_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/endpoints/", "params": [ { "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 endpoint." }, { "info": { "name": "environments_endpoints_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/endpoints/:name/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "name", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Retrieve an endpoint, or a specific version via ?version=N." }, { "info": { "name": "environments_endpoints_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/environments/:environment_id/endpoints/:name/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "name", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update an existing endpoint. Parameters are optional. Pass version in body or ?version=N query param to target a specific version." }, { "info": { "name": "environments_endpoints_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/environments/:environment_id/endpoints/:name/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "name", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update an existing endpoint." }, { "info": { "name": "environments_endpoints_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/environments/:environment_id/endpoints/:name/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "name", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete an endpoint and clean up materialized query." }, { "info": { "name": "environments_endpoints_materialization_preview_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/endpoints/:name/materialization_preview/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "name", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Preview the materialization transform for an endpoint. Shows what the query will look like after materialization, including range pair detection and bucket functions." }, { "info": { "name": "environments_endpoints_materialization_status_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/endpoints/:name/materialization_status/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "name", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get materialization status for an endpoint. Supports ?version=N query param." }, { "info": { "name": "environments_endpoints_openapi.json_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/endpoints/:name/openapi.json/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "name", "value": "", "type": "path" }, { "name": "version", "value": "", "type": "query", "description": "Specific endpoint version to generate the spec for. Defaults to latest." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get OpenAPI 3.0 specification for this endpoint. Use this to generate typed SDK clients." }, { "info": { "name": "environments_endpoints_run_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/endpoints/:name/run/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "name", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Execute endpoint with optional materialization. Supports version parameter, runs latest version if not set." }, { "info": { "name": "environments_endpoints_run_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/endpoints/:name/run/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "name", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Execute endpoint with optional materialization. Supports version parameter, runs latest version if not set." }, { "info": { "name": "environments_endpoints_versions_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/endpoints/:name/versions/", "params": [ { "name": "created_by", "value": "", "type": "query" }, { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "is_active", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query", "description": "Number of results to return per page." }, { "name": "name", "value": "", "type": "path" }, { "name": "offset", "value": "", "type": "query", "description": "The initial index from which to return the results." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List all versions for an endpoint." }, { "info": { "name": "environments_endpoints_last_execution_times_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/endpoints/last_execution_times/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Get the last execution times in the past 6 months for multiple endpoints." }, { "info": { "name": "endpoints_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/endpoints/", "params": [ { "name": "created_by", "value": "", "type": "query" }, { "name": "is_active", "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}}" } }, "docs": "List all endpoints for the team." }, { "info": { "name": "endpoints_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/endpoints/", "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}}" } }, "docs": "Create a new endpoint." }, { "info": { "name": "endpoints_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/endpoints/:name/", "params": [ { "name": "name", "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": "Retrieve an endpoint, or a specific version via ?version=N." }, { "info": { "name": "endpoints_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/projects/:project_id/endpoints/:name/", "params": [ { "name": "name", "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": "Update an existing endpoint. Parameters are optional. Pass version in body or ?version=N query param to target a specific version." }, { "info": { "name": "endpoints_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/projects/:project_id/endpoints/:name/", "params": [ { "name": "name", "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": "Update an existing endpoint." }, { "info": { "name": "endpoints_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/projects/:project_id/endpoints/:name/", "params": [ { "name": "name", "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 an endpoint and clean up materialized query." }, { "info": { "name": "endpoints_materialization_preview_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/endpoints/:name/materialization_preview/", "params": [ { "name": "name", "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": "Preview the materialization transform for an endpoint. Shows what the query will look like after materialization, including range pair detection and bucket functions." }, { "info": { "name": "endpoints_materialization_status_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/endpoints/:name/materialization_status/", "params": [ { "name": "name", "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": "Get materialization status for an endpoint. Supports ?version=N query param." }, { "info": { "name": "endpoints_openapi.json_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/endpoints/:name/openapi.json/", "params": [ { "name": "name", "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": "version", "value": "", "type": "query", "description": "Specific endpoint version to generate the spec for. Defaults to latest." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get OpenAPI 3.0 specification for this endpoint. Use this to generate typed SDK clients." }, { "info": { "name": "endpoints_run_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/endpoints/:name/run/", "params": [ { "name": "name", "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": "Execute endpoint with optional materialization. Supports version parameter, runs latest version if not set." }, { "info": { "name": "endpoints_run_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/endpoints/:name/run/", "params": [ { "name": "name", "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": "Execute endpoint with optional materialization. Supports version parameter, runs latest version if not set." }, { "info": { "name": "endpoints_versions_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/endpoints/:name/versions/", "params": [ { "name": "created_by", "value": "", "type": "query" }, { "name": "is_active", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query", "description": "Number of results to return per page." }, { "name": "name", "value": "", "type": "path" }, { "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}}" } }, "docs": "List all versions for an endpoint." }, { "info": { "name": "endpoints_last_execution_times_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/endpoints/last_execution_times/", "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": "{}" } }, "docs": "Get the last execution times in the past 6 months for multiple endpoints." } ] }, { "info": { "name": "error_tracking", "type": "folder" }, "items": [ { "info": { "name": "environments_error_tracking_releases_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/error_tracking/releases/", "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_error_tracking_releases_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/error_tracking/releases/", "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_error_tracking_releases_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/error_tracking/releases/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this error tracking release." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_error_tracking_releases_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/environments/:environment_id/error_tracking/releases/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this error tracking release." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_error_tracking_releases_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/environments/:environment_id/error_tracking/releases/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this error tracking release." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_error_tracking_releases_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/environments/:environment_id/error_tracking/releases/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this error tracking release." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_error_tracking_releases_hash_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/error_tracking/releases/hash/:hash_id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "hash_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_error_tracking_symbol_sets_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/error_tracking/symbol_sets/", "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_error_tracking_symbol_sets_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/error_tracking/symbol_sets/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." } ], "body": { "type": "multipart-form", "data": [] }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_error_tracking_symbol_sets_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/error_tracking/symbol_sets/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this error tracking symbol set." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_error_tracking_symbol_sets_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/environments/:environment_id/error_tracking/symbol_sets/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this error tracking symbol set." } ], "body": { "type": "multipart-form", "data": [] } } }, { "info": { "name": "environments_error_tracking_symbol_sets_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/environments/:environment_id/error_tracking/symbol_sets/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this error tracking symbol set." } ], "body": { "type": "multipart-form", "data": [] } } }, { "info": { "name": "environments_error_tracking_symbol_sets_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/environments/:environment_id/error_tracking/symbol_sets/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this error tracking symbol set." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_error_tracking_symbol_sets_download_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/error_tracking/symbol_sets/:id/download/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this error tracking symbol set." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Return a presigned URL for downloading the symbol set's source map." }, { "info": { "name": "environments_error_tracking_symbol_sets_finish_upload_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/environments/:environment_id/error_tracking/symbol_sets/:id/finish_upload/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this error tracking symbol set." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_error_tracking_symbol_sets_bulk_delete_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/error_tracking/symbol_sets/bulk_delete/", "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_error_tracking_symbol_sets_bulk_finish_upload_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/error_tracking/symbol_sets/bulk_finish_upload/", "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_error_tracking_symbol_sets_bulk_start_upload_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/error_tracking/symbol_sets/bulk_start_upload/", "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_error_tracking_symbol_sets_start_upload_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/error_tracking/symbol_sets/start_upload/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." } ], "body": { "type": "multipart-form", "data": [] }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "error_tracking_assignment_rules_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:project_id/error_tracking/assignment_rules/", "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": "error_tracking_assignment_rules_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:project_id/error_tracking/assignment_rules/", "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": "error_tracking_assignment_rules_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:project_id/error_tracking/assignment_rules/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this error tracking assignment rule." }, { "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": "error_tracking_assignment_rules_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/environments/:project_id/error_tracking/assignment_rules/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this error tracking assignment rule." }, { "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": "error_tracking_assignment_rules_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/environments/:project_id/error_tracking/assignment_rules/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this error tracking assignment rule." }, { "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": "error_tracking_assignment_rules_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/environments/:project_id/error_tracking/assignment_rules/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this error tracking assignment rule." }, { "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": "error_tracking_assignment_rules_reorder_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/environments/:project_id/error_tracking/assignment_rules/reorder/", "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": "{}" } } }, { "info": { "name": "error_tracking_fingerprints_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:project_id/error_tracking/fingerprints/", "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": "error_tracking_fingerprints_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:project_id/error_tracking/fingerprints/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "Fingerprint ID." }, { "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": "error_tracking_fingerprints_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/environments/:project_id/error_tracking/fingerprints/:id/", "params": [ { "name": "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/." } ] }, "docs": "Hard delete of this model is not allowed. Use a patch API call to set \"deleted\" to true" }, { "info": { "name": "error_tracking_git_provider_file_links_resolve_github_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:project_id/error_tracking/git-provider-file-links/resolve_github/", "params": [ { "name": "code_sample", "value": "", "type": "query", "description": "Code snippet to search for in repository files." }, { "name": "file_name", "value": "", "type": "query", "description": "File name to match in search results." }, { "name": "owner", "value": "", "type": "query", "description": "Repository owner or namespace." }, { "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": "repository", "value": "", "type": "query", "description": "Repository name." } ] } }, { "info": { "name": "error_tracking_git_provider_file_links_resolve_gitlab_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:project_id/error_tracking/git-provider-file-links/resolve_gitlab/", "params": [ { "name": "code_sample", "value": "", "type": "query", "description": "Code snippet to search for in repository files." }, { "name": "file_name", "value": "", "type": "query", "description": "File name to match in search results." }, { "name": "owner", "value": "", "type": "query", "description": "Repository owner or namespace." }, { "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": "repository", "value": "", "type": "query", "description": "Repository name." } ] } }, { "info": { "name": "error_tracking_grouping_rules_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:project_id/error_tracking/grouping_rules/", "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/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "error_tracking_grouping_rules_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:project_id/error_tracking/grouping_rules/", "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": "error_tracking_grouping_rules_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:project_id/error_tracking/grouping_rules/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this error tracking grouping rule." }, { "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": "error_tracking_grouping_rules_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/environments/:project_id/error_tracking/grouping_rules/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this error tracking grouping rule." }, { "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": "error_tracking_grouping_rules_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/environments/:project_id/error_tracking/grouping_rules/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this error tracking grouping rule." }, { "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": "error_tracking_grouping_rules_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/environments/:project_id/error_tracking/grouping_rules/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this error tracking grouping rule." }, { "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": "error_tracking_grouping_rules_reorder_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/environments/:project_id/error_tracking/grouping_rules/reorder/", "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": "{}" } } }, { "info": { "name": "error_tracking_issues_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:project_id/error_tracking/issues/", "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": "error_tracking_issues_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:project_id/error_tracking/issues/", "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": "error_tracking_issues_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:project_id/error_tracking/issues/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this error tracking issue." }, { "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": "error_tracking_issues_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/environments/:project_id/error_tracking/issues/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this error tracking issue." }, { "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": "error_tracking_issues_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/environments/:project_id/error_tracking/issues/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this error tracking issue." }, { "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": "error_tracking_issues_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/environments/:project_id/error_tracking/issues/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this error tracking issue." }, { "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": "error_tracking_issues_activity_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:project_id/error_tracking/issues/:id/activity/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this error tracking issue." }, { "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": "error_tracking_issues_assign_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/environments/:project_id/error_tracking/issues/:id/assign/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this error tracking issue." }, { "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": "error_tracking_issues_cohort_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/environments/:project_id/error_tracking/issues/:id/cohort/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this error tracking issue." }, { "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": "error_tracking_issues_merge_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:project_id/error_tracking/issues/:id/merge/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this error tracking issue." }, { "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": "error_tracking_issues_split_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:project_id/error_tracking/issues/:id/split/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this error tracking issue." }, { "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": "error_tracking_issues_all_activity_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:project_id/error_tracking/issues/activity/", "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/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "error_tracking_issues_bulk_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:project_id/error_tracking/issues/bulk/", "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": "error_tracking_issues_exists_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:project_id/error_tracking/issues/exists/", "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/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "error_tracking_issues_values_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:project_id/error_tracking/issues/values/", "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/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "error_tracking_recommendations_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:project_id/error_tracking/recommendations/", "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": "error_tracking_recommendations_dismiss_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:project_id/error_tracking/recommendations/:id/dismiss/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this error tracking recommendation." }, { "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": "error_tracking_recommendations_refresh_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:project_id/error_tracking/recommendations/:id/refresh/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this error tracking recommendation." }, { "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": "error_tracking_recommendations_restore_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:project_id/error_tracking/recommendations/:id/restore/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this error tracking recommendation." }, { "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": "error_tracking_spike_detection_config_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:project_id/error_tracking/spike_detection_config/", "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/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "error_tracking_spike_detection_config_update_config_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/environments/:project_id/error_tracking/spike_detection_config/update_config/", "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": "{}" } } }, { "info": { "name": "error_tracking_spike_events_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:project_id/error_tracking/spike_events/", "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": "error_tracking_stack_frames_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:project_id/error_tracking/stack_frames/", "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": "error_tracking_stack_frames_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:project_id/error_tracking/stack_frames/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this error tracking stack frame." }, { "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": "error_tracking_stack_frames_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/environments/:project_id/error_tracking/stack_frames/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this error tracking stack frame." }, { "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/." } ] }, "docs": "Hard delete of this model is not allowed. Use a patch API call to set \"deleted\" to true" }, { "info": { "name": "error_tracking_stack_frames_batch_get_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:project_id/error_tracking/stack_frames/batch_get/", "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": "error_tracking_suppression_rules_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:project_id/error_tracking/suppression_rules/", "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": "error_tracking_suppression_rules_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:project_id/error_tracking/suppression_rules/", "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": "error_tracking_suppression_rules_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:project_id/error_tracking/suppression_rules/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this error tracking suppression rule." }, { "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": "error_tracking_suppression_rules_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/environments/:project_id/error_tracking/suppression_rules/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this error tracking suppression rule." }, { "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": "error_tracking_suppression_rules_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/environments/:project_id/error_tracking/suppression_rules/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this error tracking suppression rule." }, { "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": "error_tracking_suppression_rules_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/environments/:project_id/error_tracking/suppression_rules/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this error tracking suppression rule." }, { "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": "error_tracking_suppression_rules_reorder_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/environments/:project_id/error_tracking/suppression_rules/reorder/", "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": "{}" } } }, { "info": { "name": "error_tracking_releases_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/error_tracking/releases/", "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": "error_tracking_releases_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/error_tracking/releases/", "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": "error_tracking_releases_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/error_tracking/releases/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this error tracking release." }, { "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": "error_tracking_releases_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/projects/:project_id/error_tracking/releases/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this error tracking release." }, { "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": "error_tracking_releases_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/projects/:project_id/error_tracking/releases/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this error tracking release." }, { "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": "error_tracking_releases_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/projects/:project_id/error_tracking/releases/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this error tracking release." }, { "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": "error_tracking_releases_hash_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/error_tracking/releases/hash/:hash_id/", "params": [ { "name": "hash_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": "error_tracking_symbol_sets_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/error_tracking/symbol_sets/", "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": "error_tracking_symbol_sets_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/error_tracking/symbol_sets/", "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": "multipart-form", "data": [] }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "error_tracking_symbol_sets_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/error_tracking/symbol_sets/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this error tracking symbol set." }, { "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": "error_tracking_symbol_sets_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/projects/:project_id/error_tracking/symbol_sets/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this error tracking symbol set." }, { "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": "multipart-form", "data": [] } } }, { "info": { "name": "error_tracking_symbol_sets_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/projects/:project_id/error_tracking/symbol_sets/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this error tracking symbol set." }, { "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": "multipart-form", "data": [] } } }, { "info": { "name": "error_tracking_symbol_sets_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/projects/:project_id/error_tracking/symbol_sets/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this error tracking symbol set." }, { "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": "error_tracking_symbol_sets_download_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/error_tracking/symbol_sets/:id/download/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this error tracking symbol set." }, { "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": "Return a presigned URL for downloading the symbol set's source map." }, { "info": { "name": "error_tracking_symbol_sets_finish_upload_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/projects/:project_id/error_tracking/symbol_sets/:id/finish_upload/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this error tracking symbol set." }, { "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": "error_tracking_symbol_sets_bulk_delete_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/error_tracking/symbol_sets/bulk_delete/", "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": "error_tracking_symbol_sets_bulk_finish_upload_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/error_tracking/symbol_sets/bulk_finish_upload/", "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": "error_tracking_symbol_sets_bulk_start_upload_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/error_tracking/symbol_sets/bulk_start_upload/", "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": "error_tracking_symbol_sets_start_upload_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/error_tracking/symbol_sets/start_upload/", "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": "multipart-form", "data": [] }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } } ] }, { "info": { "name": "events", "type": "folder" }, "items": [ { "info": { "name": "environments_events_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/events/", "params": [ { "name": "after", "value": "", "type": "query", "description": "Only return events with a timestamp after this time. Default: now() - 24 hours." }, { "name": "before", "value": "", "type": "query", "description": "Only return events with a timestamp before this time. Default: now() + 5 seconds." }, { "name": "distinct_id", "value": "", "type": "query", "description": "Filter list by distinct id." }, { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "event", "value": "", "type": "query", "description": "Filter list by event. For example `user sign up` or `$pageview`." }, { "name": "format", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to return" }, { "name": "offset", "value": "", "type": "query", "description": "Allows to skip first offset rows. Will fail for value larger than 100000. Read about proper way of paginating: https://posthog.com/docs/api/queries#5-use-timestamp-based-pagination-instead-of-offset" }, { "name": "person_id", "value": "", "type": "query", "description": "Filter list by person id." }, { "name": "properties", "value": "", "type": "query", "description": "Filter events by event property, person property, cohort, groups and more." }, { "name": "select", "value": "", "type": "query", "description": "(Experimental) JSON-serialized array of HogQL expressions to return" }, { "name": "where", "value": "", "type": "query", "description": "(Experimental) JSON-serialized array of HogQL expressions that must pass" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "\n This endpoint allows you to list and filter events.\n It is effectively deprecated and is kept only for backwards compatibility.\n If you ever ask about it you will be advised to not use it...\n If you want to ad-hoc list or aggregate events, use the Query endpoint instead.\n If you want to export all events or many pages of events you should use our CDP/Batch Exports products instead.\n " }, { "info": { "name": "environments_events_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/events/: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" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_events_values_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/events/values/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "format", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "events_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/events/", "params": [ { "name": "after", "value": "", "type": "query", "description": "Only return events with a timestamp after this time. Default: now() - 24 hours." }, { "name": "before", "value": "", "type": "query", "description": "Only return events with a timestamp before this time. Default: now() + 5 seconds." }, { "name": "distinct_id", "value": "", "type": "query", "description": "Filter list by distinct id." }, { "name": "event", "value": "", "type": "query", "description": "Filter list by event. For example `user sign up` or `$pageview`." }, { "name": "format", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to return" }, { "name": "offset", "value": "", "type": "query", "description": "Allows to skip first offset rows. Will fail for value larger than 100000. Read about proper way of paginating: https://posthog.com/docs/api/queries#5-use-timestamp-based-pagination-instead-of-offset" }, { "name": "person_id", "value": "", "type": "query", "description": "Filter list by person id." }, { "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": "properties", "value": "", "type": "query", "description": "Filter events by event property, person property, cohort, groups and more." }, { "name": "select", "value": "", "type": "query", "description": "(Experimental) JSON-serialized array of HogQL expressions to return" }, { "name": "where", "value": "", "type": "query", "description": "(Experimental) JSON-serialized array of HogQL expressions that must pass" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "\n This endpoint allows you to list and filter events.\n It is effectively deprecated and is kept only for backwards compatibility.\n If you ever ask about it you will be advised to not use it...\n If you want to ad-hoc list or aggregate events, use the Query endpoint instead.\n If you want to export all events or many pages of events you should use our CDP/Batch Exports products instead.\n " }, { "info": { "name": "events_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/events/:id/", "params": [ { "name": "format", "value": "", "type": "query" }, { "name": "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": "events_values_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/events/values/", "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/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } } ] }, { "info": { "name": "file_system_shortcut", "type": "folder" }, "items": [ { "info": { "name": "environments_file_system_shortcut_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/file_system_shortcut/", "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_file_system_shortcut_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/file_system_shortcut/", "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_file_system_shortcut_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/file_system_shortcut/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this file system shortcut." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_file_system_shortcut_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/environments/:environment_id/file_system_shortcut/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this file system shortcut." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_file_system_shortcut_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/environments/:environment_id/file_system_shortcut/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this file system shortcut." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_file_system_shortcut_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/environments/:environment_id/file_system_shortcut/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this file system shortcut." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_file_system_shortcut_reorder_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/file_system_shortcut/reorder/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Set the display order of the current user's shortcuts. `ordered_ids` becomes the new top-to-bottom order; any unknown IDs are rejected." }, { "info": { "name": "file_system_shortcut_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/file_system_shortcut/", "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": "file_system_shortcut_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/file_system_shortcut/", "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": "file_system_shortcut_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/file_system_shortcut/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this file system shortcut." }, { "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": "file_system_shortcut_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/projects/:project_id/file_system_shortcut/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this file system shortcut." }, { "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": "file_system_shortcut_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/projects/:project_id/file_system_shortcut/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this file system shortcut." }, { "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": "file_system_shortcut_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/projects/:project_id/file_system_shortcut/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this file system shortcut." }, { "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": "file_system_shortcut_reorder_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/file_system_shortcut/reorder/", "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": "{}" } }, "docs": "Set the display order of the current user's shortcuts. `ordered_ids` becomes the new top-to-bottom order; any unknown IDs are rejected." } ] }, { "info": { "name": "heatmap_screenshots", "type": "folder" }, "items": [ { "info": { "name": "environments_heatmap_screenshots_content_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/heatmap_screenshots/:id/content/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this saved heatmap." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "heatmap_screenshots_content_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/heatmap_screenshots/:id/content/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this saved heatmap." }, { "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": "heatmaps", "type": "folder" }, "items": [ { "info": { "name": "environments_heatmaps_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/heatmaps/", "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_heatmaps_events_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/heatmaps/events/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "heatmaps_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/heatmaps/", "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": "heatmaps_events_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/heatmaps/events/", "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/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } } ] }, { "info": { "name": "workflows", "type": "folder" }, "items": [ { "info": { "name": "environments_hog_flows_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/hog_flows/", "params": [ { "name": "created_at", "value": "", "type": "query" }, { "name": "created_by", "value": "", "type": "query" }, { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "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": "updated_at", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_hog_flows_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/hog_flows/", "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_hog_flows_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/hog_flows/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this hog flow." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_hog_flows_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/environments/:environment_id/hog_flows/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this hog flow." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_hog_flows_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/environments/:environment_id/hog_flows/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this hog flow." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_hog_flows_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/environments/:environment_id/hog_flows/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this hog flow." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_hog_flows_batch_jobs_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/hog_flows/:id/batch_jobs/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this hog flow." } ] } }, { "info": { "name": "environments_hog_flows_batch_jobs_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/hog_flows/:id/batch_jobs/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this hog flow." } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "environments_hog_flows_blocked_runs_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/hog_flows/:id/blocked_runs/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this hog flow." } ] }, "docs": "List workflow runs that were blocked by the dedup bug." }, { "info": { "name": "environments_hog_flows_invocations_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/hog_flows/:id/invocations/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this hog flow." } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "environments_hog_flows_logs_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/hog_flows/:id/logs/", "params": [ { "name": "after", "value": "", "type": "query", "description": "Only return entries after this ISO 8601 timestamp." }, { "name": "before", "value": "", "type": "query", "description": "Only return entries before this ISO 8601 timestamp." }, { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this hog flow." }, { "name": "instance_id", "value": "", "type": "query", "description": "Filter logs to a specific execution instance." }, { "name": "level", "value": "", "type": "query", "description": "Comma-separated log levels to include, e.g. 'WARN,ERROR'. Valid levels: DEBUG, LOG, INFO, WARN, ERROR." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of log entries to return (1-500, default 50)." }, { "name": "search", "value": "", "type": "query", "description": "Case-insensitive substring search across log messages." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_hog_flows_metrics_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/hog_flows/:id/metrics/", "params": [ { "name": "after", "value": "", "type": "query", "description": "Start of the time range. Accepts relative formats like '-7d', '-24h' or ISO 8601 timestamps. Defaults to '-7d'." }, { "name": "before", "value": "", "type": "query", "description": "End of the time range. Same format as 'after'. Defaults to now." }, { "name": "breakdown_by", "value": "", "type": "query", "description": "Group the series by metric 'name' or 'kind'. Defaults to 'kind'.\n\n* `name` - name\n* `kind` - kind" }, { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this hog flow." }, { "name": "instance_id", "value": "", "type": "query", "description": "Filter metrics to a specific execution instance." }, { "name": "interval", "value": "", "type": "query", "description": "Time bucket size for the series. One of: hour, day, week. Defaults to 'day'.\n\n* `hour` - hour\n* `day` - day\n* `week` - week" }, { "name": "kind", "value": "", "type": "query", "description": "Comma-separated metric kinds to filter by, e.g. 'success,failure'." }, { "name": "name", "value": "", "type": "query", "description": "Comma-separated metric names to filter by." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_hog_flows_metrics_totals_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/hog_flows/:id/metrics/totals/", "params": [ { "name": "after", "value": "", "type": "query", "description": "Start of the time range. Accepts relative formats like '-7d', '-24h' or ISO 8601 timestamps. Defaults to '-7d'." }, { "name": "before", "value": "", "type": "query", "description": "End of the time range. Same format as 'after'. Defaults to now." }, { "name": "breakdown_by", "value": "", "type": "query", "description": "Group the series by metric 'name' or 'kind'. Defaults to 'kind'.\n\n* `name` - name\n* `kind` - kind" }, { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this hog flow." }, { "name": "instance_id", "value": "", "type": "query", "description": "Filter metrics to a specific execution instance." }, { "name": "interval", "value": "", "type": "query", "description": "Time bucket size for the series. One of: hour, day, week. Defaults to 'day'.\n\n* `hour` - hour\n* `day` - day\n* `week` - week" }, { "name": "kind", "value": "", "type": "query", "description": "Comma-separated metric kinds to filter by, e.g. 'success,failure'." }, { "name": "name", "value": "", "type": "query", "description": "Comma-separated metric names to filter by." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_hog_flows_replay_all_blocked_runs_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/hog_flows/:id/replay_all_blocked_runs/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this hog flow." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Replay all blocked runs in a single bulk call to Node." }, { "info": { "name": "environments_hog_flows_replay_blocked_run_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/hog_flows/:id/replay_blocked_run/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this hog flow." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Replay a single blocked run. Django fetches the event, Node creates the invocation and writes the log." }, { "info": { "name": "environments_hog_flows_schedules_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/hog_flows/:id/schedules/", "params": [ { "name": "created_at", "value": "", "type": "query" }, { "name": "created_by", "value": "", "type": "query" }, { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this hog flow." }, { "name": "id", "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": "updated_at", "value": "", "type": "query" } ] } }, { "info": { "name": "environments_hog_flows_schedules_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/hog_flows/:id/schedules/", "params": [ { "name": "created_at", "value": "", "type": "query" }, { "name": "created_by", "value": "", "type": "query" }, { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this hog flow." }, { "name": "id", "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": "updated_at", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "environments_hog_flows_schedules_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/environments/:environment_id/hog_flows/:id/schedules/:schedule_id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this hog flow." }, { "name": "schedule_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "environments_hog_flows_schedules_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/environments/:environment_id/hog_flows/:id/schedules/:schedule_id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this hog flow." }, { "name": "schedule_id", "value": "", "type": "path" } ] } }, { "info": { "name": "environments_hog_flows_bulk_delete_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/hog_flows/bulk_delete/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "environments_hog_flows_user_blast_radius_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/hog_flows/user_blast_radius/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "hog_flows_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/hog_flows/", "params": [ { "name": "created_at", "value": "", "type": "query" }, { "name": "created_by", "value": "", "type": "query" }, { "name": "id", "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/." }, { "name": "updated_at", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "hog_flows_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/hog_flows/", "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": "hog_flows_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/hog_flows/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this hog flow." }, { "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": "hog_flows_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/projects/:project_id/hog_flows/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this hog flow." }, { "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": "hog_flows_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/projects/:project_id/hog_flows/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this hog flow." }, { "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": "hog_flows_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/projects/:project_id/hog_flows/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this hog flow." }, { "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": "hog_flows_batch_jobs_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/hog_flows/:id/batch_jobs/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this hog flow." }, { "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/." } ] } }, { "info": { "name": "hog_flows_batch_jobs_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/hog_flows/:id/batch_jobs/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this hog flow." }, { "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": "hog_flows_blocked_runs_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/hog_flows/:id/blocked_runs/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this hog flow." }, { "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/." } ] }, "docs": "List workflow runs that were blocked by the dedup bug." }, { "info": { "name": "hog_flows_invocations_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/hog_flows/:id/invocations/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this hog flow." }, { "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": "hog_flows_logs_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/hog_flows/:id/logs/", "params": [ { "name": "after", "value": "", "type": "query", "description": "Only return entries after this ISO 8601 timestamp." }, { "name": "before", "value": "", "type": "query", "description": "Only return entries before this ISO 8601 timestamp." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this hog flow." }, { "name": "instance_id", "value": "", "type": "query", "description": "Filter logs to a specific execution instance." }, { "name": "level", "value": "", "type": "query", "description": "Comma-separated log levels to include, e.g. 'WARN,ERROR'. Valid levels: DEBUG, LOG, INFO, WARN, ERROR." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of log entries to return (1-500, default 50)." }, { "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": "search", "value": "", "type": "query", "description": "Case-insensitive substring search across log messages." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "hog_flows_metrics_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/hog_flows/:id/metrics/", "params": [ { "name": "after", "value": "", "type": "query", "description": "Start of the time range. Accepts relative formats like '-7d', '-24h' or ISO 8601 timestamps. Defaults to '-7d'." }, { "name": "before", "value": "", "type": "query", "description": "End of the time range. Same format as 'after'. Defaults to now." }, { "name": "breakdown_by", "value": "", "type": "query", "description": "Group the series by metric 'name' or 'kind'. Defaults to 'kind'.\n\n* `name` - name\n* `kind` - kind" }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this hog flow." }, { "name": "instance_id", "value": "", "type": "query", "description": "Filter metrics to a specific execution instance." }, { "name": "interval", "value": "", "type": "query", "description": "Time bucket size for the series. One of: hour, day, week. Defaults to 'day'.\n\n* `hour` - hour\n* `day` - day\n* `week` - week" }, { "name": "kind", "value": "", "type": "query", "description": "Comma-separated metric kinds to filter by, e.g. 'success,failure'." }, { "name": "name", "value": "", "type": "query", "description": "Comma-separated metric names to filter by." }, { "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": "hog_flows_metrics_totals_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/hog_flows/:id/metrics/totals/", "params": [ { "name": "after", "value": "", "type": "query", "description": "Start of the time range. Accepts relative formats like '-7d', '-24h' or ISO 8601 timestamps. Defaults to '-7d'." }, { "name": "before", "value": "", "type": "query", "description": "End of the time range. Same format as 'after'. Defaults to now." }, { "name": "breakdown_by", "value": "", "type": "query", "description": "Group the series by metric 'name' or 'kind'. Defaults to 'kind'.\n\n* `name` - name\n* `kind` - kind" }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this hog flow." }, { "name": "instance_id", "value": "", "type": "query", "description": "Filter metrics to a specific execution instance." }, { "name": "interval", "value": "", "type": "query", "description": "Time bucket size for the series. One of: hour, day, week. Defaults to 'day'.\n\n* `hour` - hour\n* `day` - day\n* `week` - week" }, { "name": "kind", "value": "", "type": "query", "description": "Comma-separated metric kinds to filter by, e.g. 'success,failure'." }, { "name": "name", "value": "", "type": "query", "description": "Comma-separated metric names to filter by." }, { "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": "hog_flows_replay_all_blocked_runs_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/hog_flows/:id/replay_all_blocked_runs/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this hog flow." }, { "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": "Replay all blocked runs in a single bulk call to Node." }, { "info": { "name": "hog_flows_replay_blocked_run_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/hog_flows/:id/replay_blocked_run/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this hog flow." }, { "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": "Replay a single blocked run. Django fetches the event, Node creates the invocation and writes the log." }, { "info": { "name": "hog_flows_schedules_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/hog_flows/:id/schedules/", "params": [ { "name": "created_at", "value": "", "type": "query" }, { "name": "created_by", "value": "", "type": "query" }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this hog flow." }, { "name": "id", "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/." }, { "name": "updated_at", "value": "", "type": "query" } ] } }, { "info": { "name": "hog_flows_schedules_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/hog_flows/:id/schedules/", "params": [ { "name": "created_at", "value": "", "type": "query" }, { "name": "created_by", "value": "", "type": "query" }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this hog flow." }, { "name": "id", "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/." }, { "name": "updated_at", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "hog_flows_schedules_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/projects/:project_id/hog_flows/:id/schedules/:schedule_id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this hog flow." }, { "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": "schedule_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "hog_flows_schedules_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/projects/:project_id/hog_flows/:id/schedules/:schedule_id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this hog flow." }, { "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": "schedule_id", "value": "", "type": "path" } ] } }, { "info": { "name": "hog_flows_bulk_delete_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/hog_flows/bulk_delete/", "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": "{}" } } }, { "info": { "name": "hog_flows_user_blast_radius_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/hog_flows/user_blast_radius/", "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": "{}" } } } ] }, { "info": { "name": "hog_functions", "type": "folder" }, "items": [ { "info": { "name": "environments_hog_functions_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/hog_functions/", "params": [ { "name": "created_at", "value": "", "type": "query" }, { "name": "created_by", "value": "", "type": "query" }, { "name": "enabled", "value": "", "type": "query" }, { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "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": "search", "value": "", "type": "query", "description": "A search term." }, { "name": "type", "value": "", "type": "query", "description": "Multiple values may be separated by commas." }, { "name": "updated_at", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_hog_functions_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/hog_functions/", "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_hog_functions_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/hog_functions/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this hog function." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_hog_functions_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/environments/:environment_id/hog_functions/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this hog function." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_hog_functions_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/environments/:environment_id/hog_functions/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this hog function." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_hog_functions_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/environments/:environment_id/hog_functions/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this hog function." } ] }, "docs": "Hard delete of this model is not allowed. Use a patch API call to set \"deleted\" to true" }, { "info": { "name": "environments_hog_functions_enable_backfills_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/hog_functions/:id/enable_backfills/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this hog function." } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "environments_hog_functions_invocations_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/hog_functions/:id/invocations/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this hog function." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_hog_functions_logs_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/hog_functions/:id/logs/", "params": [ { "name": "after", "value": "", "type": "query", "description": "Only return entries after this ISO 8601 timestamp." }, { "name": "before", "value": "", "type": "query", "description": "Only return entries before this ISO 8601 timestamp." }, { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this hog function." }, { "name": "instance_id", "value": "", "type": "query", "description": "Filter logs to a specific execution instance." }, { "name": "level", "value": "", "type": "query", "description": "Comma-separated log levels to include, e.g. 'WARN,ERROR'. Valid levels: DEBUG, LOG, INFO, WARN, ERROR." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of log entries to return (1-500, default 50)." }, { "name": "search", "value": "", "type": "query", "description": "Case-insensitive substring search across log messages." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_hog_functions_metrics_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/hog_functions/:id/metrics/", "params": [ { "name": "after", "value": "", "type": "query", "description": "Start of the time range. Accepts relative formats like '-7d', '-24h' or ISO 8601 timestamps. Defaults to '-7d'." }, { "name": "before", "value": "", "type": "query", "description": "End of the time range. Same format as 'after'. Defaults to now." }, { "name": "breakdown_by", "value": "", "type": "query", "description": "Group the series by metric 'name' or 'kind'. Defaults to 'kind'.\n\n* `name` - name\n* `kind` - kind" }, { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this hog function." }, { "name": "instance_id", "value": "", "type": "query", "description": "Filter metrics to a specific execution instance." }, { "name": "interval", "value": "", "type": "query", "description": "Time bucket size for the series. One of: hour, day, week. Defaults to 'day'.\n\n* `hour` - hour\n* `day` - day\n* `week` - week" }, { "name": "kind", "value": "", "type": "query", "description": "Comma-separated metric kinds to filter by, e.g. 'success,failure'." }, { "name": "name", "value": "", "type": "query", "description": "Comma-separated metric names to filter by." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_hog_functions_metrics_totals_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/hog_functions/:id/metrics/totals/", "params": [ { "name": "after", "value": "", "type": "query", "description": "Start of the time range. Accepts relative formats like '-7d', '-24h' or ISO 8601 timestamps. Defaults to '-7d'." }, { "name": "before", "value": "", "type": "query", "description": "End of the time range. Same format as 'after'. Defaults to now." }, { "name": "breakdown_by", "value": "", "type": "query", "description": "Group the series by metric 'name' or 'kind'. Defaults to 'kind'.\n\n* `name` - name\n* `kind` - kind" }, { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this hog function." }, { "name": "instance_id", "value": "", "type": "query", "description": "Filter metrics to a specific execution instance." }, { "name": "interval", "value": "", "type": "query", "description": "Time bucket size for the series. One of: hour, day, week. Defaults to 'day'.\n\n* `hour` - hour\n* `day` - day\n* `week` - week" }, { "name": "kind", "value": "", "type": "query", "description": "Comma-separated metric kinds to filter by, e.g. 'success,failure'." }, { "name": "name", "value": "", "type": "query", "description": "Comma-separated metric names to filter by." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_hog_functions_icon_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/hog_functions/icon/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." } ] } }, { "info": { "name": "environments_hog_functions_icons_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/hog_functions/icons/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." } ] } }, { "info": { "name": "environments_hog_functions_rearrange_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/environments/:environment_id/hog_functions/rearrange/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update the execution order of multiple HogFunctions." }, { "info": { "name": "hog_functions_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/hog_functions/", "params": [ { "name": "created_at", "value": "", "type": "query" }, { "name": "created_by", "value": "", "type": "query" }, { "name": "enabled", "value": "", "type": "query" }, { "name": "id", "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/." }, { "name": "search", "value": "", "type": "query", "description": "A search term." }, { "name": "type", "value": "", "type": "query", "description": "Multiple values may be separated by commas." }, { "name": "updated_at", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "hog_functions_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/hog_functions/", "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": "hog_functions_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/hog_functions/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this hog function." }, { "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": "hog_functions_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/projects/:project_id/hog_functions/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this hog function." }, { "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": "hog_functions_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/projects/:project_id/hog_functions/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this hog function." }, { "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": "hog_functions_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/projects/:project_id/hog_functions/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this hog function." }, { "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/." } ] }, "docs": "Hard delete of this model is not allowed. Use a patch API call to set \"deleted\" to true" }, { "info": { "name": "hog_functions_enable_backfills_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/hog_functions/:id/enable_backfills/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this hog function." }, { "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": "hog_functions_invocations_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/hog_functions/:id/invocations/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this hog function." }, { "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": "hog_functions_logs_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/hog_functions/:id/logs/", "params": [ { "name": "after", "value": "", "type": "query", "description": "Only return entries after this ISO 8601 timestamp." }, { "name": "before", "value": "", "type": "query", "description": "Only return entries before this ISO 8601 timestamp." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this hog function." }, { "name": "instance_id", "value": "", "type": "query", "description": "Filter logs to a specific execution instance." }, { "name": "level", "value": "", "type": "query", "description": "Comma-separated log levels to include, e.g. 'WARN,ERROR'. Valid levels: DEBUG, LOG, INFO, WARN, ERROR." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of log entries to return (1-500, default 50)." }, { "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": "search", "value": "", "type": "query", "description": "Case-insensitive substring search across log messages." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "hog_functions_metrics_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/hog_functions/:id/metrics/", "params": [ { "name": "after", "value": "", "type": "query", "description": "Start of the time range. Accepts relative formats like '-7d', '-24h' or ISO 8601 timestamps. Defaults to '-7d'." }, { "name": "before", "value": "", "type": "query", "description": "End of the time range. Same format as 'after'. Defaults to now." }, { "name": "breakdown_by", "value": "", "type": "query", "description": "Group the series by metric 'name' or 'kind'. Defaults to 'kind'.\n\n* `name` - name\n* `kind` - kind" }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this hog function." }, { "name": "instance_id", "value": "", "type": "query", "description": "Filter metrics to a specific execution instance." }, { "name": "interval", "value": "", "type": "query", "description": "Time bucket size for the series. One of: hour, day, week. Defaults to 'day'.\n\n* `hour` - hour\n* `day` - day\n* `week` - week" }, { "name": "kind", "value": "", "type": "query", "description": "Comma-separated metric kinds to filter by, e.g. 'success,failure'." }, { "name": "name", "value": "", "type": "query", "description": "Comma-separated metric names to filter by." }, { "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": "hog_functions_metrics_totals_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/hog_functions/:id/metrics/totals/", "params": [ { "name": "after", "value": "", "type": "query", "description": "Start of the time range. Accepts relative formats like '-7d', '-24h' or ISO 8601 timestamps. Defaults to '-7d'." }, { "name": "before", "value": "", "type": "query", "description": "End of the time range. Same format as 'after'. Defaults to now." }, { "name": "breakdown_by", "value": "", "type": "query", "description": "Group the series by metric 'name' or 'kind'. Defaults to 'kind'.\n\n* `name` - name\n* `kind` - kind" }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this hog function." }, { "name": "instance_id", "value": "", "type": "query", "description": "Filter metrics to a specific execution instance." }, { "name": "interval", "value": "", "type": "query", "description": "Time bucket size for the series. One of: hour, day, week. Defaults to 'day'.\n\n* `hour` - hour\n* `day` - day\n* `week` - week" }, { "name": "kind", "value": "", "type": "query", "description": "Comma-separated metric kinds to filter by, e.g. 'success,failure'." }, { "name": "name", "value": "", "type": "query", "description": "Comma-separated metric names to filter by." }, { "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": "hog_functions_icon_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/hog_functions/icon/", "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/." } ] } }, { "info": { "name": "hog_functions_icons_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/hog_functions/icons/", "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/." } ] } }, { "info": { "name": "hog_functions_rearrange_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/projects/:project_id/hog_functions/rearrange/", "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}}" } }, "docs": "Update the execution order of multiple HogFunctions." } ] }, { "info": { "name": "insights", "type": "folder" }, "items": [ { "info": { "name": "environments_insights_thresholds_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/insights/:insight_id/thresholds/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "insight_id", "value": "", "type": "path" }, { "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_insights_thresholds_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/insights/:insight_id/thresholds/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this threshold." }, { "name": "insight_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "insights_thresholds_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/insights/:insight_id/thresholds/", "params": [ { "name": "insight_id", "value": "", "type": "path" }, { "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": "insights_thresholds_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/insights/:insight_id/thresholds/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this threshold." }, { "name": "insight_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": "integrations", "type": "folder" }, "items": [ { "info": { "name": "environments_integrations_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/integrations/", "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_integrations_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/integrations/", "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_integrations_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/integrations/: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 integration." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_integrations_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/environments/:environment_id/integrations/: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 integration." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_integrations_channels_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/integrations/:id/channels/", "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 integration." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_integrations_clickup_lists_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/integrations/:id/clickup_lists/", "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 integration." } ] } }, { "info": { "name": "environments_integrations_clickup_spaces_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/integrations/:id/clickup_spaces/", "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 integration." } ] } }, { "info": { "name": "environments_integrations_clickup_workspaces_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/integrations/:id/clickup_workspaces/", "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 integration." } ] } }, { "info": { "name": "environments_integrations_email_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/environments/:environment_id/integrations/:id/email/", "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 integration." } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "environments_integrations_email_verify_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/integrations/:id/email/verify/", "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 integration." } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "environments_integrations_github_branches_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/integrations/:id/github_branches/", "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 integration." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of branches to return" }, { "name": "offset", "value": "", "type": "query", "description": "Number of branches to skip" }, { "name": "repo", "value": "", "type": "query", "description": "Repository in owner/repo format" }, { "name": "search", "value": "", "type": "query", "description": "Optional case-insensitive branch name search query." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_integrations_github_repos_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/integrations/:id/github_repos/", "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 integration." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of repositories to return per request (max 500)." }, { "name": "offset", "value": "", "type": "query", "description": "Number of repositories to skip before returning results." }, { "name": "search", "value": "", "type": "query", "description": "Optional case-insensitive repository name search query." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_integrations_github_repos_refresh_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/integrations/:id/github_repos/refresh/", "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 integration." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_integrations_google_accessible_accounts_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/integrations/:id/google_accessible_accounts/", "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 integration." } ] } }, { "info": { "name": "environments_integrations_google_conversion_actions_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/integrations/:id/google_conversion_actions/", "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 integration." } ] } }, { "info": { "name": "environments_integrations_jira_projects_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/integrations/:id/jira_projects/", "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 integration." } ] } }, { "info": { "name": "environments_integrations_linear_teams_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/integrations/:id/linear_teams/", "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 integration." } ] } }, { "info": { "name": "environments_integrations_linkedin_ads_accounts_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/integrations/:id/linkedin_ads_accounts/", "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 integration." } ] } }, { "info": { "name": "environments_integrations_linkedin_ads_conversion_rules_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/integrations/:id/linkedin_ads_conversion_rules/", "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 integration." } ] } }, { "info": { "name": "environments_integrations_twilio_phone_numbers_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/integrations/:id/twilio_phone_numbers/", "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 integration." } ] } }, { "info": { "name": "environments_integrations_authorize_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/integrations/authorize/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." } ] } }, { "info": { "name": "environments_integrations_domain_connect_apply_url_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/integrations/domain-connect/apply-url/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Unified endpoint for generating Domain Connect apply URLs.\n\nAccepts a context (\"email\" or \"proxy\") and the relevant resource ID.\nThe backend resolves the domain, template variables, and service ID\nbased on context, then builds the signed apply URL." }, { "info": { "name": "environments_integrations_domain_connect_check_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/integrations/domain-connect/check/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." } ] } }, { "info": { "name": "environments_integrations_github_link_existing_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/integrations/github/link_existing/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Reuse a GitHub installation already linked to a sibling team in the same organization." }, { "info": { "name": "environments_integrations_github_oauth_authorize_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/integrations/github/oauth_authorize/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Mint a User OAuth URL to bootstrap a fresh `code` when the install flow returns without one." }, { "info": { "name": "role_external_references_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/organizations/:organization_id/role_external_references/", "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": "organization_id", "value": "", "type": "path", "description": "ID of the organization you're trying to access. To find the ID of the organization, make a call to /api/organizations/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "role_external_references_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/organizations/:organization_id/role_external_references/", "params": [ { "name": "organization_id", "value": "", "type": "path", "description": "ID of the organization you're trying to access. To find the ID of the organization, make a call to /api/organizations/." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "role_external_references_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/organizations/:organization_id/role_external_references/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this role external reference." }, { "name": "organization_id", "value": "", "type": "path", "description": "ID of the organization you're trying to access. To find the ID of the organization, make a call to /api/organizations/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "role_external_references_lookup_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/organizations/:organization_id/role_external_references/lookup/", "params": [ { "name": "organization_id", "value": "", "type": "path", "description": "ID of the organization you're trying to access. To find the ID of the organization, make a call to /api/organizations/." }, { "name": "provider", "value": "", "type": "query", "description": "Integration kind (e.g., github, linear, jira, slack)." }, { "name": "provider_organization_id", "value": "", "type": "query", "description": "Provider organization/workspace/site identifier." }, { "name": "provider_role_id", "value": "", "type": "query", "description": "Stable provider role identifier." }, { "name": "provider_role_slug", "value": "", "type": "query", "description": "Human-friendly provider role identifier." } ] } }, { "info": { "name": "integrations_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/integrations/", "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": "integrations_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/integrations/", "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": "integrations_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/integrations/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this integration." }, { "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": "integrations_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/projects/:project_id/integrations/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this integration." }, { "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": "integrations_channels_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/integrations/:id/channels/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this integration." }, { "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": "integrations_clickup_lists_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/integrations/:id/clickup_lists/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this integration." }, { "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/." } ] } }, { "info": { "name": "integrations_clickup_spaces_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/integrations/:id/clickup_spaces/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this integration." }, { "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/." } ] } }, { "info": { "name": "integrations_clickup_workspaces_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/integrations/:id/clickup_workspaces/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this integration." }, { "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/." } ] } }, { "info": { "name": "integrations_email_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/projects/:project_id/integrations/:id/email/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this integration." }, { "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": "integrations_email_verify_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/integrations/:id/email/verify/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this integration." }, { "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": "integrations_github_branches_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/integrations/:id/github_branches/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this integration." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of branches to return" }, { "name": "offset", "value": "", "type": "query", "description": "Number of branches to skip" }, { "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": "repo", "value": "", "type": "query", "description": "Repository in owner/repo format" }, { "name": "search", "value": "", "type": "query", "description": "Optional case-insensitive branch name search query." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "integrations_github_repos_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/integrations/:id/github_repos/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this integration." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of repositories to return per request (max 500)." }, { "name": "offset", "value": "", "type": "query", "description": "Number of repositories to skip before returning 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/." }, { "name": "search", "value": "", "type": "query", "description": "Optional case-insensitive repository name search query." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "integrations_github_repos_refresh_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/integrations/:id/github_repos/refresh/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this integration." }, { "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": "integrations_google_accessible_accounts_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/integrations/:id/google_accessible_accounts/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this integration." }, { "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/." } ] } }, { "info": { "name": "integrations_google_conversion_actions_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/integrations/:id/google_conversion_actions/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this integration." }, { "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/." } ] } }, { "info": { "name": "integrations_jira_projects_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/integrations/:id/jira_projects/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this integration." }, { "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/." } ] } }, { "info": { "name": "integrations_linear_teams_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/integrations/:id/linear_teams/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this integration." }, { "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/." } ] } }, { "info": { "name": "integrations_linkedin_ads_accounts_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/integrations/:id/linkedin_ads_accounts/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this integration." }, { "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/." } ] } }, { "info": { "name": "integrations_linkedin_ads_conversion_rules_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/integrations/:id/linkedin_ads_conversion_rules/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this integration." }, { "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/." } ] } }, { "info": { "name": "integrations_twilio_phone_numbers_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/integrations/:id/twilio_phone_numbers/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this integration." }, { "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/." } ] } }, { "info": { "name": "integrations_authorize_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/integrations/authorize/", "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/." } ] } }, { "info": { "name": "integrations_domain_connect_apply_url_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/integrations/domain-connect/apply-url/", "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": "{}" } }, "docs": "Unified endpoint for generating Domain Connect apply URLs.\n\nAccepts a context (\"email\" or \"proxy\") and the relevant resource ID.\nThe backend resolves the domain, template variables, and service ID\nbased on context, then builds the signed apply URL." }, { "info": { "name": "integrations_domain_connect_check_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/integrations/domain-connect/check/", "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/." } ] } }, { "info": { "name": "integrations_github_link_existing_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/integrations/github/link_existing/", "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}}" } }, "docs": "Reuse a GitHub installation already linked to a sibling team in the same organization." }, { "info": { "name": "integrations_github_oauth_authorize_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/integrations/github/oauth_authorize/", "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}}" } }, "docs": "Mint a User OAuth URL to bootstrap a fresh `code` when the install flow returns without one." } ] }, { "info": { "name": "logs", "type": "folder" }, "items": [ { "info": { "name": "environments_logs_alerts_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/logs/alerts/", "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_logs_alerts_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/logs/alerts/", "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_logs_alerts_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/logs/alerts/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this logs alert configuration." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_logs_alerts_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/environments/:environment_id/logs/alerts/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this logs alert configuration." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_logs_alerts_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/environments/:environment_id/logs/alerts/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this logs alert configuration." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_logs_alerts_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/environments/:environment_id/logs/alerts/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this logs alert configuration." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_logs_alerts_destinations_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/logs/alerts/:id/destinations/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this logs alert configuration." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a notification destination for this alert. One HogFunction is created per alert event kind (firing, resolved, ...) atomically." }, { "info": { "name": "environments_logs_alerts_destinations_delete_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/logs/alerts/:id/destinations/delete/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this logs alert configuration." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Delete a notification destination by deleting its HogFunction group atomically." }, { "info": { "name": "environments_logs_alerts_events_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/logs/alerts/:id/events/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this logs alert configuration." }, { "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." } ] }, "docs": "Paginated event history for this alert, newest first. Returns state transitions, errored checks, and user-initiated control-plane rows (reset, enable/disable, snooze/unsnooze, threshold change) — quiet no-op check rows (where state didn't change and there was no error) are filtered out since only the last 10 are kept and they carry no forensic value. Optional `?kind=...` narrows to a single kind." }, { "info": { "name": "environments_logs_alerts_reset_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/logs/alerts/:id/reset/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this logs alert configuration." } ] }, "docs": "Reset a broken alert. Clears the consecutive-failure counter and schedules an immediate recheck." }, { "info": { "name": "environments_logs_alerts_simulate_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/logs/alerts/simulate/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Simulate a logs alert on historical data using the full state machine. Read-only — no alert check records are created." }, { "info": { "name": "environments_logs_attributes_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/logs/attributes/", "params": [ { "name": "attribute_type", "value": "", "type": "query", "description": "Type of attributes: \"log\" for log attributes, \"resource\" for resource attributes. Defaults to \"log\".\n\n* `log` - log\n* `resource` - resource" }, { "name": "dateRange", "value": "", "type": "query", "description": "Date range to search within. Defaults to last hour." }, { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "filterGroup", "value": "", "type": "query", "description": "Property filters to narrow which logs are scanned for attributes." }, { "name": "limit", "value": "", "type": "query", "description": "Max results (default: 100)" }, { "name": "offset", "value": "", "type": "query", "description": "Pagination offset (default: 0)" }, { "name": "search", "value": "", "type": "query", "description": "Search filter for attribute names" }, { "name": "search_values", "value": "", "type": "query", "description": "When true, the search query also matches attribute values (not just keys). Each result indicates whether it matched on key or value." }, { "name": "serviceNames", "value": "", "type": "query", "description": "Filter attributes to those appearing in logs from these services." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_logs_count_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/logs/count/", "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_logs_count_ranges_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/logs/count-ranges/", "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_logs_export_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/logs/export/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_logs_has_logs_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/logs/has_logs/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_logs_query_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/logs/query/", "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_logs_sampling_rules_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/logs/sampling_rules/", "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_logs_sampling_rules_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/logs/sampling_rules/", "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_logs_sampling_rules_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/logs/sampling_rules/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this logs exclusion rule." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_logs_sampling_rules_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/environments/:environment_id/logs/sampling_rules/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this logs exclusion rule." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_logs_sampling_rules_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/environments/:environment_id/logs/sampling_rules/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this logs exclusion rule." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_logs_sampling_rules_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/environments/:environment_id/logs/sampling_rules/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this logs exclusion rule." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_logs_sampling_rules_simulate_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/logs/sampling_rules/:id/simulate/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this logs exclusion rule." } ] }, "docs": "Dry-run estimate for how much volume this rule would remove (placeholder response until CH-backed simulation is wired)." }, { "info": { "name": "environments_logs_sampling_rules_reorder_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/logs/sampling_rules/reorder/", "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Atomically reassign priorities so the given ID order maps to ascending priorities (0..n-1)." }, { "info": { "name": "environments_logs_services_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/logs/services/", "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_logs_sparkline_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/logs/sparkline/", "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_logs_values_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/logs/values/", "params": [ { "name": "attribute_type", "value": "", "type": "query", "description": "Type of attribute: \"log\" or \"resource\". Defaults to \"log\".\n\n* `log` - log\n* `resource` - resource" }, { "name": "dateRange", "value": "", "type": "query", "description": "Date range to search within. Defaults to last hour." }, { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "filterGroup", "value": "", "type": "query", "description": "Property filters to narrow which logs are scanned for values." }, { "name": "key", "value": "", "type": "query", "description": "The attribute key to get values for" }, { "name": "serviceNames", "value": "", "type": "query", "description": "Filter values to those appearing in logs from these services." }, { "name": "value", "value": "", "type": "query", "description": "Search filter for attribute values" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "logs_explainLogWithAI_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:project_id/logs/explainLogWithAI/", "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}}" } }, "docs": "Explain a log entry using AI.\n\nPOST /api/environments/:id/logs/explainLogWithAI/" }, { "info": { "name": "logs_views_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:project_id/logs/views/", "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": "logs_views_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:project_id/logs/views/", "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": "logs_views_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:project_id/logs/views/:short_id/", "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/." }, { "name": "short_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "logs_views_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/environments/:project_id/logs/views/:short_id/", "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/." }, { "name": "short_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "logs_views_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/environments/:project_id/logs/views/:short_id/", "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/." }, { "name": "short_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "logs_views_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/environments/:project_id/logs/views/:short_id/", "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/." }, { "name": "short_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "logs_alerts_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/logs/alerts/", "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": "logs_alerts_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/logs/alerts/", "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": "logs_alerts_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/logs/alerts/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this logs alert configuration." }, { "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": "logs_alerts_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/projects/:project_id/logs/alerts/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this logs alert configuration." }, { "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": "logs_alerts_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/projects/:project_id/logs/alerts/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this logs alert configuration." }, { "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": "logs_alerts_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/projects/:project_id/logs/alerts/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this logs alert configuration." }, { "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": "logs_alerts_destinations_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/logs/alerts/:id/destinations/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this logs alert configuration." }, { "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": "Create a notification destination for this alert. One HogFunction is created per alert event kind (firing, resolved, ...) atomically." }, { "info": { "name": "logs_alerts_destinations_delete_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/logs/alerts/:id/destinations/delete/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this logs alert configuration." }, { "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": "Delete a notification destination by deleting its HogFunction group atomically." }, { "info": { "name": "logs_alerts_events_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/logs/alerts/:id/events/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this logs alert configuration." }, { "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/." } ] }, "docs": "Paginated event history for this alert, newest first. Returns state transitions, errored checks, and user-initiated control-plane rows (reset, enable/disable, snooze/unsnooze, threshold change) — quiet no-op check rows (where state didn't change and there was no error) are filtered out since only the last 10 are kept and they carry no forensic value. Optional `?kind=...` narrows to a single kind." }, { "info": { "name": "logs_alerts_reset_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/logs/alerts/:id/reset/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this logs alert configuration." }, { "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/." } ] }, "docs": "Reset a broken alert. Clears the consecutive-failure counter and schedules an immediate recheck." }, { "info": { "name": "logs_alerts_simulate_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/logs/alerts/simulate/", "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": "{}" } }, "docs": "Simulate a logs alert on historical data using the full state machine. Read-only — no alert check records are created." }, { "info": { "name": "logs_attributes_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/logs/attributes/", "params": [ { "name": "attribute_type", "value": "", "type": "query", "description": "Type of attributes: \"log\" for log attributes, \"resource\" for resource attributes. Defaults to \"log\".\n\n* `log` - log\n* `resource` - resource" }, { "name": "dateRange", "value": "", "type": "query", "description": "Date range to search within. Defaults to last hour." }, { "name": "filterGroup", "value": "", "type": "query", "description": "Property filters to narrow which logs are scanned for attributes." }, { "name": "limit", "value": "", "type": "query", "description": "Max results (default: 100)" }, { "name": "offset", "value": "", "type": "query", "description": "Pagination offset (default: 0)" }, { "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": "search", "value": "", "type": "query", "description": "Search filter for attribute names" }, { "name": "search_values", "value": "", "type": "query", "description": "When true, the search query also matches attribute values (not just keys). Each result indicates whether it matched on key or value." }, { "name": "serviceNames", "value": "", "type": "query", "description": "Filter attributes to those appearing in logs from these services." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "logs_count_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/logs/count/", "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": "logs_count_ranges_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/logs/count-ranges/", "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": "logs_export_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/logs/export/", "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/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "logs_has_logs_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/logs/has_logs/", "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/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "logs_query_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/logs/query/", "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": "logs_sampling_rules_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/logs/sampling_rules/", "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": "logs_sampling_rules_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/logs/sampling_rules/", "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": "logs_sampling_rules_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/logs/sampling_rules/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this logs exclusion rule." }, { "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": "logs_sampling_rules_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/projects/:project_id/logs/sampling_rules/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this logs exclusion rule." }, { "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": "logs_sampling_rules_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/projects/:project_id/logs/sampling_rules/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this logs exclusion rule." }, { "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": "logs_sampling_rules_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/projects/:project_id/logs/sampling_rules/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this logs exclusion rule." }, { "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": "logs_sampling_rules_simulate_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/logs/sampling_rules/:id/simulate/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this logs exclusion rule." }, { "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/." } ] }, "docs": "Dry-run estimate for how much volume this rule would remove (placeholder response until CH-backed simulation is wired)." }, { "info": { "name": "logs_sampling_rules_reorder_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/logs/sampling_rules/reorder/", "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/." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Atomically reassign priorities so the given ID order maps to ascending priorities (0..n-1)." }, { "info": { "name": "logs_services_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/logs/services/", "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": "logs_sparkline_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/logs/sparkline/", "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": "logs_values_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/logs/values/", "params": [ { "name": "attribute_type", "value": "", "type": "query", "description": "Type of attribute: \"log\" or \"resource\". Defaults to \"log\".\n\n* `log` - log\n* `resource` - resource" }, { "name": "dateRange", "value": "", "type": "query", "description": "Date range to search within. Defaults to last hour." }, { "name": "filterGroup", "value": "", "type": "query", "description": "Property filters to narrow which logs are scanned for values." }, { "name": "key", "value": "", "type": "query", "description": "The attribute key to get values for" }, { "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": "serviceNames", "value": "", "type": "query", "description": "Filter values to those appearing in logs from these services." }, { "name": "value", "value": "", "type": "query", "description": "Search filter for attribute values" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } } ] }, { "info": { "name": "persisted_folder", "type": "folder" }, "items": [ { "info": { "name": "environments_persisted_folder_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/persisted_folder/", "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_persisted_folder_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/persisted_folder/", "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_persisted_folder_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/persisted_folder/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this Persisted Folder." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_persisted_folder_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/environments/:environment_id/persisted_folder/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this Persisted Folder." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_persisted_folder_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/environments/:environment_id/persisted_folder/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this Persisted Folder." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_persisted_folder_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/environments/:environment_id/persisted_folder/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this Persisted Folder." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "persisted_folder_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/persisted_folder/", "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": "persisted_folder_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/persisted_folder/", "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": "persisted_folder_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/persisted_folder/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this Persisted Folder." }, { "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": "persisted_folder_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/projects/:project_id/persisted_folder/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this Persisted Folder." }, { "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": "persisted_folder_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/projects/:project_id/persisted_folder/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this Persisted Folder." }, { "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": "persisted_folder_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/projects/:project_id/persisted_folder/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this Persisted Folder." }, { "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": "persons", "type": "folder" }, "items": [ { "info": { "name": "environments_persons_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/persons/", "params": [ { "name": "distinct_id", "value": "", "type": "query", "description": "Filter list by distinct id." }, { "name": "email", "value": "", "type": "query", "description": "Filter persons by email (exact match)" }, { "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." }, { "name": "properties", "value": "", "type": "query", "description": "Filter Persons by person properties." }, { "name": "search", "value": "", "type": "query", "description": "Search persons, either by email (full text search) or distinct_id (exact match)." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs." }, { "info": { "name": "environments_persons_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/persons/: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 value identifying this person. Accepts both numeric ID and UUID." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs." }, { "info": { "name": "environments_persons_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/environments/:environment_id/persons/: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 value identifying this person. Accepts both numeric ID and UUID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Only for setting properties on the person. \"properties\" from the request data will be updated via a \"$set\" event.\nThis means that only the properties listed will be updated, but other properties won't be removed nor updated.\nIf you would like to remove a property use the `delete_property` endpoint." }, { "info": { "name": "environments_persons_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/environments/:environment_id/persons/: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 value identifying this person. Accepts both numeric ID and UUID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs." }, { "info": { "name": "environments_persons_activity_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/persons/:id/activity/", "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 person." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs." }, { "info": { "name": "environments_persons_delete_property_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/persons/:id/delete_property/", "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 value identifying this person. Accepts both numeric ID and UUID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs." }, { "info": { "name": "environments_persons_properties_timeline_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/persons/:id/properties_timeline/", "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 person." } ] }, "docs": "This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs." }, { "info": { "name": "environments_persons_split_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/persons/:id/split/", "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 person." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs." }, { "info": { "name": "environments_persons_update_property_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/persons/:id/update_property/", "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 value identifying this person. Accepts both numeric ID and UUID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs." }, { "info": { "name": "environments_persons_all_activity_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/persons/activity/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "format", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs." }, { "info": { "name": "environments_persons_batch_by_distinct_ids_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/persons/batch_by_distinct_ids/", "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": "This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs." }, { "info": { "name": "environments_persons_batch_by_uuids_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/persons/batch_by_uuids/", "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": "This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs." }, { "info": { "name": "environments_persons_bulk_delete_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/persons/bulk_delete/", "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}}" } }, "docs": "This endpoint allows you to bulk delete persons, either by the PostHog person IDs or by distinct IDs. You can pass in a maximum of 1000 IDs per call. Only events captured before the request will be deleted." }, { "info": { "name": "environments_persons_cohorts_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/persons/cohorts/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "format", "value": "", "type": "query" }, { "name": "person_id", "value": "", "type": "query", "description": "The person ID or UUID to get cohorts for." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs." }, { "info": { "name": "environments_persons_deletion_status_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/persons/deletion_status/", "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." }, { "name": "person_uuid", "value": "", "type": "query", "description": "Filter by a specific person UUID." }, { "name": "status", "value": "", "type": "query", "description": "Filter by deletion status: 'pending', 'completed', or 'all'." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List the status of queued event deletions for persons. When you delete a person with `delete_events=true`, an async deletion is queued. Use this endpoint to check whether those deletions are still pending or have been completed." }, { "info": { "name": "environments_persons_funnel_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/persons/funnel/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "format", "value": "", "type": "query" } ] }, "docs": "This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs." }, { "info": { "name": "environments_persons_funnel_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/persons/funnel/", "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": "This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs." }, { "info": { "name": "environments_persons_funnel_correlation_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/persons/funnel/correlation/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "format", "value": "", "type": "query" } ] }, "docs": "This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs." }, { "info": { "name": "environments_persons_funnel_correlation_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/persons/funnel/correlation/", "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": "This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs." }, { "info": { "name": "environments_persons_lifecycle_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/persons/lifecycle/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "format", "value": "", "type": "query" } ] }, "docs": "This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs." }, { "info": { "name": "environments_persons_properties_at_time_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/persons/properties_at_time/", "params": [ { "name": "debug", "value": "", "type": "query", "description": "Whether to include debug information with raw events (only works when DEBUG=True, default: false)" }, { "name": "distinct_id", "value": "", "type": "query", "description": "The distinct_id of the person (mutually exclusive with person_id)" }, { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "format", "value": "", "type": "query" }, { "name": "include_set_once", "value": "", "type": "query", "description": "Whether to handle $set_once operations (default: false)" }, { "name": "person_id", "value": "", "type": "query", "description": "The person_id (UUID) to build properties for (mutually exclusive with distinct_id)" }, { "name": "timestamp", "value": "", "type": "query", "description": "ISO datetime string for the point in time (e.g., '2023-06-15T14:30:00Z')" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get person properties as they existed at a specific point in time.\n\nThis endpoint reconstructs person properties by querying ClickHouse events\nfor $set and $set_once operations up to the specified timestamp.\n\nQuery parameters:\n- distinct_id: The distinct_id of the person\n- timestamp: ISO datetime string for the point in time (e.g., \"2023-06-15T14:30:00Z\")\n- include_set_once: Whether to handle $set_once operations (default: false)\n- debug: Whether to include debug information with raw events (def" }, { "info": { "name": "environments_persons_reset_person_distinct_id_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/persons/reset_person_distinct_id/", "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}}" } }, "docs": "Reset a distinct_id for a deleted person. This allows the distinct_id to be used again." }, { "info": { "name": "environments_persons_trends_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/persons/trends/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "format", "value": "", "type": "query" } ] }, "docs": "This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs." }, { "info": { "name": "environments_persons_values_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/persons/values/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "format", "value": "", "type": "query" }, { "name": "key", "value": "", "type": "query", "description": "The person property key to get values for (e.g., 'email', 'plan', 'role')." }, { "name": "value", "value": "", "type": "query", "description": "Optional search string to filter values (case-insensitive substring match)." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs." }, { "info": { "name": "persons_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/persons/", "params": [ { "name": "distinct_id", "value": "", "type": "query", "description": "Filter list by distinct id." }, { "name": "email", "value": "", "type": "query", "description": "Filter persons by email (exact match)" }, { "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/." }, { "name": "properties", "value": "", "type": "query", "description": "Filter Persons by person properties." }, { "name": "search", "value": "", "type": "query", "description": "Search persons, either by email (full text search) or distinct_id (exact match)." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs." }, { "info": { "name": "persons_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/persons/:id/", "params": [ { "name": "format", "value": "", "type": "query" }, { "name": "id", "value": "", "type": "path", "description": "A unique value identifying this person. Accepts both numeric ID and UUID." }, { "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": "This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs." }, { "info": { "name": "persons_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/projects/:project_id/persons/:id/", "params": [ { "name": "format", "value": "", "type": "query" }, { "name": "id", "value": "", "type": "path", "description": "A unique value identifying this person. Accepts both numeric ID and UUID." }, { "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": "Only for setting properties on the person. \"properties\" from the request data will be updated via a \"$set\" event.\nThis means that only the properties listed will be updated, but other properties won't be removed nor updated.\nIf you would like to remove a property use the `delete_property` endpoint." }, { "info": { "name": "persons_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/projects/:project_id/persons/:id/", "params": [ { "name": "format", "value": "", "type": "query" }, { "name": "id", "value": "", "type": "path", "description": "A unique value identifying this person. Accepts both numeric ID and UUID." }, { "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": "This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs." }, { "info": { "name": "persons_activity_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/persons/:id/activity/", "params": [ { "name": "format", "value": "", "type": "query" }, { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this person." }, { "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": "This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs." }, { "info": { "name": "persons_delete_property_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/persons/:id/delete_property/", "params": [ { "name": "format", "value": "", "type": "query" }, { "name": "id", "value": "", "type": "path", "description": "A unique value identifying this person. Accepts both numeric ID and UUID." }, { "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": "This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs." }, { "info": { "name": "persons_properties_timeline_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/persons/:id/properties_timeline/", "params": [ { "name": "format", "value": "", "type": "query" }, { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this person." }, { "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/." } ] }, "docs": "This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs." }, { "info": { "name": "persons_split_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/persons/:id/split/", "params": [ { "name": "format", "value": "", "type": "query" }, { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this person." }, { "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": "This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs." }, { "info": { "name": "persons_update_property_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/persons/:id/update_property/", "params": [ { "name": "format", "value": "", "type": "query" }, { "name": "id", "value": "", "type": "path", "description": "A unique value identifying this person. Accepts both numeric ID and UUID." }, { "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": "This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs." }, { "info": { "name": "persons_all_activity_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/persons/activity/", "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/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs." }, { "info": { "name": "persons_batch_by_distinct_ids_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/persons/batch_by_distinct_ids/", "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": "This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs." }, { "info": { "name": "persons_batch_by_uuids_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/persons/batch_by_uuids/", "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": "This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs." }, { "info": { "name": "persons_bulk_delete_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/persons/bulk_delete/", "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}}" } }, "docs": "This endpoint allows you to bulk delete persons, either by the PostHog person IDs or by distinct IDs. You can pass in a maximum of 1000 IDs per call. Only events captured before the request will be deleted." }, { "info": { "name": "persons_cohorts_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/persons/cohorts/", "params": [ { "name": "format", "value": "", "type": "query" }, { "name": "person_id", "value": "", "type": "query", "description": "The person ID or UUID to get cohorts for." }, { "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": "This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs." }, { "info": { "name": "persons_deletion_status_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/persons/deletion_status/", "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": "person_uuid", "value": "", "type": "query", "description": "Filter by a specific person UUID." }, { "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": "status", "value": "", "type": "query", "description": "Filter by deletion status: 'pending', 'completed', or 'all'." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List the status of queued event deletions for persons. When you delete a person with `delete_events=true`, an async deletion is queued. Use this endpoint to check whether those deletions are still pending or have been completed." }, { "info": { "name": "persons_funnel_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/persons/funnel/", "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/." } ] }, "docs": "This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs." }, { "info": { "name": "persons_funnel_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/persons/funnel/", "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": "This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs." }, { "info": { "name": "persons_funnel_correlation_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/persons/funnel/correlation/", "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/." } ] }, "docs": "This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs." }, { "info": { "name": "persons_funnel_correlation_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/persons/funnel/correlation/", "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": "This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs." }, { "info": { "name": "persons_lifecycle_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/persons/lifecycle/", "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/." } ] }, "docs": "This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs." }, { "info": { "name": "persons_properties_at_time_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/persons/properties_at_time/", "params": [ { "name": "debug", "value": "", "type": "query", "description": "Whether to include debug information with raw events (only works when DEBUG=True, default: false)" }, { "name": "distinct_id", "value": "", "type": "query", "description": "The distinct_id of the person (mutually exclusive with person_id)" }, { "name": "format", "value": "", "type": "query" }, { "name": "include_set_once", "value": "", "type": "query", "description": "Whether to handle $set_once operations (default: false)" }, { "name": "person_id", "value": "", "type": "query", "description": "The person_id (UUID) to build properties for (mutually exclusive with distinct_id)" }, { "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": "timestamp", "value": "", "type": "query", "description": "ISO datetime string for the point in time (e.g., '2023-06-15T14:30:00Z')" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get person properties as they existed at a specific point in time.\n\nThis endpoint reconstructs person properties by querying ClickHouse events\nfor $set and $set_once operations up to the specified timestamp.\n\nQuery parameters:\n- distinct_id: The distinct_id of the person\n- timestamp: ISO datetime string for the point in time (e.g., \"2023-06-15T14:30:00Z\")\n- include_set_once: Whether to handle $set_once operations (default: false)\n- debug: Whether to include debug information with raw events (def" }, { "info": { "name": "persons_reset_person_distinct_id_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/persons/reset_person_distinct_id/", "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}}" } }, "docs": "Reset a distinct_id for a deleted person. This allows the distinct_id to be used again." }, { "info": { "name": "persons_trends_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/persons/trends/", "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/." } ] }, "docs": "This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs." }, { "info": { "name": "persons_values_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/persons/values/", "params": [ { "name": "format", "value": "", "type": "query" }, { "name": "key", "value": "", "type": "query", "description": "The person property key to get values for (e.g., 'email', 'plan', 'role')." }, { "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": "value", "value": "", "type": "query", "description": "Optional search string to filter values (case-insensitive substring match)." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "This endpoint is meant for reading and deleting persons. To create or update persons, we recommend using the [capture API](https://posthog.com/docs/api/capture), the `$set` and `$unset` [properties](https://posthog.com/docs/product-analytics/user-properties), or one of our SDKs." } ] }, { "info": { "name": "plugin_configs", "type": "folder" }, "items": [ { "info": { "name": "environments_plugin_configs_logs_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/plugin_configs/:plugin_config_id/logs/", "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." }, { "name": "plugin_config_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "plugin_configs_logs_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/plugin_configs/:plugin_config_id/logs/", "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": "plugin_config_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": "query", "type": "folder" }, "items": [ { "info": { "name": "environments_query_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/query/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "DRF ViewSet mixin that gates coalesced responses behind permission checks.\n\nThe QueryCoalescingMiddleware attaches cached response data to\nrequest.META[\"_coalesced_response\"] for followers. This mixin runs DRF's\ninitial() (auth + permissions + throttling) before returning the\ncached response, ensuring the request is authorized." }, { "info": { "name": "environments_query_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/query/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "(Experimental)" }, { "info": { "name": "environments_query_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/environments/:environment_id/query/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "(Experimental)" }, { "info": { "name": "environments_query_log_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/query/:id/log/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get query log details from query_log_archive table for a specific query_id, the query must have been issued in last 24 hours." }, { "info": { "name": "environments_query_create_with_kind", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/query/:query_kind/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "query_kind", "value": "", "type": "path" } ] }, "docs": "DRF ViewSet mixin that gates coalesced responses behind permission checks.\n\nThe QueryCoalescingMiddleware attaches cached response data to\nrequest.META[\"_coalesced_response\"] for followers. This mixin runs DRF's\ninitial() (auth + permissions + throttling) before returning the\ncached response, ensuring the request is authorized." }, { "info": { "name": "environments_query_check_auth_for_async_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/query/check_auth_for_async/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." } ] }, "docs": "DRF ViewSet mixin that gates coalesced responses behind permission checks.\n\nThe QueryCoalescingMiddleware attaches cached response data to\nrequest.META[\"_coalesced_response\"] for followers. This mixin runs DRF's\ninitial() (auth + permissions + throttling) before returning the\ncached response, ensuring the request is authorized." }, { "info": { "name": "environments_query_draft_sql_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/query/draft_sql/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." } ] }, "docs": "DRF ViewSet mixin that gates coalesced responses behind permission checks.\n\nThe QueryCoalescingMiddleware attaches cached response data to\nrequest.META[\"_coalesced_response\"] for followers. This mixin runs DRF's\ninitial() (auth + permissions + throttling) before returning the\ncached response, ensuring the request is authorized." }, { "info": { "name": "environments_query_upgrade_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/query/upgrade/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Upgrades a query without executing it. Returns a query with all nodes migrated to the latest version." }, { "info": { "name": "query_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/query/", "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}}" } }, "docs": "DRF ViewSet mixin that gates coalesced responses behind permission checks.\n\nThe QueryCoalescingMiddleware attaches cached response data to\nrequest.META[\"_coalesced_response\"] for followers. This mixin runs DRF's\ninitial() (auth + permissions + throttling) before returning the\ncached response, ensuring the request is authorized." }, { "info": { "name": "query_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/query/:id/", "params": [ { "name": "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": "(Experimental)" }, { "info": { "name": "query_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/projects/:project_id/query/:id/", "params": [ { "name": "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": "(Experimental)" }, { "info": { "name": "query_log_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/query/:id/log/", "params": [ { "name": "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/." } ] }, "docs": "Get query log details from query_log_archive table for a specific query_id, the query must have been issued in last 24 hours." }, { "info": { "name": "query_create_with_kind", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/query/:query_kind/", "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/." }, { "name": "query_kind", "value": "", "type": "path" } ] }, "docs": "DRF ViewSet mixin that gates coalesced responses behind permission checks.\n\nThe QueryCoalescingMiddleware attaches cached response data to\nrequest.META[\"_coalesced_response\"] for followers. This mixin runs DRF's\ninitial() (auth + permissions + throttling) before returning the\ncached response, ensuring the request is authorized." }, { "info": { "name": "query_check_auth_for_async_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/query/check_auth_for_async/", "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/." } ] }, "docs": "DRF ViewSet mixin that gates coalesced responses behind permission checks.\n\nThe QueryCoalescingMiddleware attaches cached response data to\nrequest.META[\"_coalesced_response\"] for followers. This mixin runs DRF's\ninitial() (auth + permissions + throttling) before returning the\ncached response, ensuring the request is authorized." }, { "info": { "name": "query_draft_sql_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/query/draft_sql/", "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/." } ] }, "docs": "DRF ViewSet mixin that gates coalesced responses behind permission checks.\n\nThe QueryCoalescingMiddleware attaches cached response data to\nrequest.META[\"_coalesced_response\"] for followers. This mixin runs DRF's\ninitial() (auth + permissions + throttling) before returning the\ncached response, ensuring the request is authorized." }, { "info": { "name": "query_upgrade_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/query/upgrade/", "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": "{}" } }, "docs": "Upgrades a query without executing it. Returns a query with all nodes migrated to the latest version." } ] }, { "info": { "name": "saved", "type": "folder" }, "items": [ { "info": { "name": "environments_saved_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/saved/", "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_saved_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/saved/", "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_saved_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/saved/:short_id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "short_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_saved_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/environments/:environment_id/saved/:short_id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "short_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_saved_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/environments/:environment_id/saved/:short_id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "short_id", "value": "", "type": "path" } ], "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_saved_regenerate_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/saved/:short_id/regenerate/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "short_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "saved_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/saved/", "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": "saved_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/saved/", "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": "saved_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/saved/:short_id/", "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/." }, { "name": "short_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "saved_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/projects/:project_id/saved/:short_id/", "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/." }, { "name": "short_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "saved_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/projects/:project_id/saved/:short_id/", "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/." }, { "name": "short_id", "value": "", "type": "path" } ], "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": "saved_regenerate_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/saved/:short_id/regenerate/", "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/." }, { "name": "short_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } } } ] }, { "info": { "name": "replay", "type": "folder" }, "items": [ { "info": { "name": "environments_session_recording_playlists_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/session_recording_playlists/", "params": [ { "name": "created_by", "value": "", "type": "query" }, { "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." }, { "name": "short_id", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Override list to include synthetic playlists" }, { "info": { "name": "environments_session_recording_playlists_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/session_recording_playlists/", "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_session_recording_playlists_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/session_recording_playlists/:short_id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "short_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_session_recording_playlists_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/environments/:environment_id/session_recording_playlists/:short_id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "short_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_session_recording_playlists_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/environments/:environment_id/session_recording_playlists/:short_id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "short_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_session_recording_playlists_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/environments/:environment_id/session_recording_playlists/:short_id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "short_id", "value": "", "type": "path" } ], "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_session_recording_playlists_recordings_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/session_recording_playlists/:short_id/recordings/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "short_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_session_recording_playlists_recordings_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/session_recording_playlists/:short_id/recordings/:session_recording_id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "session_recording_id", "value": "", "type": "path" }, { "name": "short_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "environments_session_recording_playlists_recordings_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/environments/:environment_id/session_recording_playlists/:short_id/recordings/:session_recording_id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "session_recording_id", "value": "", "type": "path" }, { "name": "short_id", "value": "", "type": "path" } ] } }, { "info": { "name": "environments_session_recordings_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/session_recordings/", "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_session_recordings_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/session_recordings/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this session recording." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_session_recordings_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/environments/:environment_id/session_recordings/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this session recording." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_session_recordings_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/environments/:environment_id/session_recordings/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this session recording." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_session_recordings_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/environments/:environment_id/session_recordings/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this session recording." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "create_session_summaries_individually", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:project_id/session_summaries/create_session_summaries_individually/", "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}}" } }, "docs": "Generate AI individual summary for each session, without grouping." }, { "info": { "name": "session_recording_playlists_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/session_recording_playlists/", "params": [ { "name": "created_by", "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/." }, { "name": "short_id", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Override list to include synthetic playlists" }, { "info": { "name": "session_recording_playlists_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/session_recording_playlists/", "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": "session_recording_playlists_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/session_recording_playlists/:short_id/", "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/." }, { "name": "short_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "session_recording_playlists_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/projects/:project_id/session_recording_playlists/:short_id/", "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/." }, { "name": "short_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "session_recording_playlists_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/projects/:project_id/session_recording_playlists/:short_id/", "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/." }, { "name": "short_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "session_recording_playlists_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/projects/:project_id/session_recording_playlists/:short_id/", "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/." }, { "name": "short_id", "value": "", "type": "path" } ], "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": "session_recording_playlists_recordings_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/session_recording_playlists/:short_id/recordings/", "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/." }, { "name": "short_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "session_recording_playlists_recordings_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/session_recording_playlists/:short_id/recordings/:session_recording_id/", "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/." }, { "name": "session_recording_id", "value": "", "type": "path" }, { "name": "short_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "session_recording_playlists_recordings_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/projects/:project_id/session_recording_playlists/:short_id/recordings/:session_recording_id/", "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/." }, { "name": "session_recording_id", "value": "", "type": "path" }, { "name": "short_id", "value": "", "type": "path" } ] } }, { "info": { "name": "session_recordings_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/session_recordings/", "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": "session_recordings_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/session_recordings/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this session recording." }, { "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": "session_recordings_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/projects/:project_id/session_recordings/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this session recording." }, { "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": "session_recordings_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/projects/:project_id/session_recordings/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this session recording." }, { "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": "session_recordings_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/projects/:project_id/session_recordings/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this session recording." }, { "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": "sessions", "type": "folder" }, "items": [ { "info": { "name": "environments_sessions_property_definitions_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/sessions/property_definitions/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "environments_sessions_values_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/sessions/values/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "sessions_property_definitions_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/sessions/property_definitions/", "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/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "sessions_values_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/sessions/values/", "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/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } } ] }, { "info": { "name": "warehouse_tables", "type": "folder" }, "items": [ { "info": { "name": "environments_warehouse_tables_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/warehouse_tables/", "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." }, { "name": "search", "value": "", "type": "query", "description": "A search term." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create, Read, Update and Delete Warehouse Tables." }, { "info": { "name": "environments_warehouse_tables_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/warehouse_tables/", "params": [ { "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, Read, Update and Delete Warehouse Tables." }, { "info": { "name": "environments_warehouse_tables_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/warehouse_tables/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this data warehouse table." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create, Read, Update and Delete Warehouse Tables." }, { "info": { "name": "environments_warehouse_tables_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/environments/:environment_id/warehouse_tables/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this data warehouse table." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create, Read, Update and Delete Warehouse Tables." }, { "info": { "name": "environments_warehouse_tables_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/environments/:environment_id/warehouse_tables/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this data warehouse table." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create, Read, Update and Delete Warehouse Tables." }, { "info": { "name": "environments_warehouse_tables_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/environments/:environment_id/warehouse_tables/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this data warehouse table." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create, Read, Update and Delete Warehouse Tables." }, { "info": { "name": "environments_warehouse_tables_refresh_schema_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/warehouse_tables/:id/refresh_schema/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this data warehouse table." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create, Read, Update and Delete Warehouse Tables." }, { "info": { "name": "environments_warehouse_tables_update_schema_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/warehouse_tables/:id/update_schema/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this data warehouse table." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create, Read, Update and Delete Warehouse Tables." }, { "info": { "name": "environments_warehouse_tables_file_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/warehouse_tables/file/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." } ], "body": { "type": "form-urlencoded", "data": [] }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create, Read, Update and Delete Warehouse Tables." }, { "info": { "name": "warehouse_tables_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/warehouse_tables/", "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/." }, { "name": "search", "value": "", "type": "query", "description": "A search term." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create, Read, Update and Delete Warehouse Tables." }, { "info": { "name": "warehouse_tables_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/warehouse_tables/", "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}}" } }, "docs": "Create, Read, Update and Delete Warehouse Tables." }, { "info": { "name": "warehouse_tables_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/warehouse_tables/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this data warehouse table." }, { "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": "Create, Read, Update and Delete Warehouse Tables." }, { "info": { "name": "warehouse_tables_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/projects/:project_id/warehouse_tables/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this data warehouse table." }, { "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, Read, Update and Delete Warehouse Tables." }, { "info": { "name": "warehouse_tables_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/projects/:project_id/warehouse_tables/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this data warehouse table." }, { "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, Read, Update and Delete Warehouse Tables." }, { "info": { "name": "warehouse_tables_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/projects/:project_id/warehouse_tables/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this data warehouse table." }, { "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": "Create, Read, Update and Delete Warehouse Tables." }, { "info": { "name": "warehouse_tables_refresh_schema_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/warehouse_tables/:id/refresh_schema/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this data warehouse table." }, { "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": "Create, Read, Update and Delete Warehouse Tables." }, { "info": { "name": "warehouse_tables_update_schema_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/warehouse_tables/:id/update_schema/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this data warehouse table." }, { "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": "Create, Read, Update and Delete Warehouse Tables." }, { "info": { "name": "warehouse_tables_file_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/warehouse_tables/file/", "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": "form-urlencoded", "data": [] }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create, Read, Update and Delete Warehouse Tables." } ] }, { "info": { "name": "warehouse_view_link", "type": "folder" }, "items": [ { "info": { "name": "environments_warehouse_view_link_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/warehouse_view_link/", "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." }, { "name": "search", "value": "", "type": "query", "description": "A search term." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create, Read, Update and Delete View Columns." }, { "info": { "name": "environments_warehouse_view_link_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/warehouse_view_link/", "params": [ { "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, Read, Update and Delete View Columns." }, { "info": { "name": "environments_warehouse_view_link_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/warehouse_view_link/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this data warehouse join." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create, Read, Update and Delete View Columns." }, { "info": { "name": "environments_warehouse_view_link_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/environments/:environment_id/warehouse_view_link/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this data warehouse join." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create, Read, Update and Delete View Columns." }, { "info": { "name": "environments_warehouse_view_link_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/environments/:environment_id/warehouse_view_link/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this data warehouse join." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create, Read, Update and Delete View Columns." }, { "info": { "name": "environments_warehouse_view_link_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/environments/:environment_id/warehouse_view_link/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this data warehouse join." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create, Read, Update and Delete View Columns." }, { "info": { "name": "environments_warehouse_view_link_validate_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/warehouse_view_link/validate/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create, Read, Update and Delete View Columns." }, { "info": { "name": "warehouse_view_link_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/warehouse_view_link/", "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/." }, { "name": "search", "value": "", "type": "query", "description": "A search term." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create, Read, Update and Delete View Columns." }, { "info": { "name": "warehouse_view_link_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/warehouse_view_link/", "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}}" } }, "docs": "Create, Read, Update and Delete View Columns." }, { "info": { "name": "warehouse_view_link_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/warehouse_view_link/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this data warehouse join." }, { "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": "Create, Read, Update and Delete View Columns." }, { "info": { "name": "warehouse_view_link_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/projects/:project_id/warehouse_view_link/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this data warehouse join." }, { "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, Read, Update and Delete View Columns." }, { "info": { "name": "warehouse_view_link_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/projects/:project_id/warehouse_view_link/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this data warehouse join." }, { "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, Read, Update and Delete View Columns." }, { "info": { "name": "warehouse_view_link_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/projects/:project_id/warehouse_view_link/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this data warehouse join." }, { "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": "Create, Read, Update and Delete View Columns." }, { "info": { "name": "warehouse_view_link_validate_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/warehouse_view_link/validate/", "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": "{}" } }, "docs": "Create, Read, Update and Delete View Columns." } ] }, { "info": { "name": "warehouse_view_links", "type": "folder" }, "items": [ { "info": { "name": "environments_warehouse_view_links_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/warehouse_view_links/", "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." }, { "name": "search", "value": "", "type": "query", "description": "A search term." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create, Read, Update and Delete View Columns." }, { "info": { "name": "environments_warehouse_view_links_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/warehouse_view_links/", "params": [ { "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, Read, Update and Delete View Columns." }, { "info": { "name": "environments_warehouse_view_links_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:environment_id/warehouse_view_links/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this data warehouse join." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create, Read, Update and Delete View Columns." }, { "info": { "name": "environments_warehouse_view_links_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/environments/:environment_id/warehouse_view_links/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this data warehouse join." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create, Read, Update and Delete View Columns." }, { "info": { "name": "environments_warehouse_view_links_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/environments/:environment_id/warehouse_view_links/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this data warehouse join." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create, Read, Update and Delete View Columns." }, { "info": { "name": "environments_warehouse_view_links_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/environments/:environment_id/warehouse_view_links/:id/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this data warehouse join." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create, Read, Update and Delete View Columns." }, { "info": { "name": "environments_warehouse_view_links_validate_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:environment_id/warehouse_view_links/validate/", "params": [ { "name": "environment_id", "value": "", "type": "path", "description": "Deprecated. Use /api/projects/{project_id}/ instead." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create, Read, Update and Delete View Columns." }, { "info": { "name": "warehouse_view_links_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/warehouse_view_links/", "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/." }, { "name": "search", "value": "", "type": "query", "description": "A search term." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create, Read, Update and Delete View Columns." }, { "info": { "name": "warehouse_view_links_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/warehouse_view_links/", "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}}" } }, "docs": "Create, Read, Update and Delete View Columns." }, { "info": { "name": "warehouse_view_links_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/warehouse_view_links/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this data warehouse join." }, { "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": "Create, Read, Update and Delete View Columns." }, { "info": { "name": "warehouse_view_links_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/projects/:project_id/warehouse_view_links/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this data warehouse join." }, { "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, Read, Update and Delete View Columns." }, { "info": { "name": "warehouse_view_links_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/projects/:project_id/warehouse_view_links/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this data warehouse join." }, { "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, Read, Update and Delete View Columns." }, { "info": { "name": "warehouse_view_links_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/projects/:project_id/warehouse_view_links/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this data warehouse join." }, { "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": "Create, Read, Update and Delete View Columns." }, { "info": { "name": "warehouse_view_links_validate_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/warehouse_view_links/validate/", "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": "{}" } }, "docs": "Create, Read, Update and Delete View Columns." } ] }, { "info": { "name": "platform_features", "type": "folder" }, "items": [ { "info": { "name": "approval_policies_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:project_id/approval_policies/", "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": "approval_policies_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:project_id/approval_policies/", "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": "approval_policies_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:project_id/approval_policies/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this approval policy." }, { "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": "approval_policies_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/environments/:project_id/approval_policies/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this approval policy." }, { "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": "approval_policies_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/environments/:project_id/approval_policies/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this approval policy." }, { "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": "approval_policies_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/environments/:project_id/approval_policies/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this approval policy." }, { "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": "change_requests_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:project_id/change_requests/", "params": [ { "name": "action_key", "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/." }, { "name": "requester", "value": "", "type": "query" }, { "name": "resource_id", "value": "", "type": "query" }, { "name": "resource_type", "value": "", "type": "query" }, { "name": "state", "value": "", "type": "query", "description": "Multiple values may be separated by commas." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "change_requests_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:project_id/change_requests/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this change request." }, { "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": "change_requests_approve_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:project_id/change_requests/:id/approve/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this change request." }, { "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": "Approve a change request.\nIf quorum is reached, automatically applies the change immediately." }, { "info": { "name": "change_requests_cancel_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:project_id/change_requests/:id/cancel/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this change request." }, { "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": "Cancel a change request.\nOnly the requester can cancel their own pending change request." }, { "info": { "name": "change_requests_reject_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:project_id/change_requests/:id/reject/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this change request." }, { "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": "Reject a change request." }, { "info": { "name": "list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/organizations/", "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." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/organizations/", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/organizations/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this organization." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/organizations/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this organization." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/organizations/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this organization." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/organizations/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this organization." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "roles_role_memberships_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/organizations/:organization_id/roles/:role_id/role_memberships/", "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": "organization_id", "value": "", "type": "path", "description": "ID of the organization you're trying to access. To find the ID of the organization, make a call to /api/organizations/." }, { "name": "role_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "roles_role_memberships_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/organizations/:organization_id/roles/:role_id/role_memberships/", "params": [ { "name": "organization_id", "value": "", "type": "path", "description": "ID of the organization you're trying to access. To find the ID of the organization, make a call to /api/organizations/." }, { "name": "role_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "roles_role_memberships_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/organizations/:organization_id/roles/:role_id/role_memberships/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this role membership." }, { "name": "organization_id", "value": "", "type": "path", "description": "ID of the organization you're trying to access. To find the ID of the organization, make a call to /api/organizations/." }, { "name": "role_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "roles_role_memberships_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/organizations/:organization_id/roles/:role_id/role_memberships/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this role membership." }, { "name": "organization_id", "value": "", "type": "path", "description": "ID of the organization you're trying to access. To find the ID of the organization, make a call to /api/organizations/." }, { "name": "role_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "welcome_current_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/organizations/:organization_id/welcome/current/", "params": [ { "name": "organization_id", "value": "", "type": "path", "description": "ID of the organization you're trying to access. To find the ID of the organization, make a call to /api/organizations/." } ] }, "docs": "Aggregated payload for the invited-user welcome screen." }, { "info": { "name": "advanced_activity_logs_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/advanced_activity_logs/", "params": [ { "name": "activities", "value": "", "type": "query" }, { "name": "clients", "value": "", "type": "query" }, { "name": "detail_filters", "value": "", "type": "query" }, { "name": "end_date", "value": "", "type": "query" }, { "name": "hogql_filter", "value": "", "type": "query" }, { "name": "is_system", "value": "", "type": "query" }, { "name": "item_ids", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query", "description": "Page number for pagination. When provided, uses page-based pagination ordered by most recent first." }, { "name": "page_size", "value": "", "type": "query", "description": "Number of results per page (default: 100, max: 1000). Only used with page-based pagination." }, { "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": "scopes", "value": "", "type": "query" }, { "name": "search_text", "value": "", "type": "query" }, { "name": "start_date", "value": "", "type": "query" }, { "name": "users", "value": "", "type": "query" }, { "name": "was_impersonated", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "advanced_activity_logs_available_filters_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/advanced_activity_logs/available_filters/", "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/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "advanced_activity_logs_export_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/advanced_activity_logs/export/", "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": "{}" } } }, { "info": { "name": "user_home_settings_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/user_home_settings/:uuid/", "params": [ { "name": "uuid", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get the authenticated user's pinned sidebar tabs and configured homepage for the current team. Pass `@me` as the UUID." }, { "info": { "name": "user_home_settings_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/user_home_settings/:uuid/", "params": [ { "name": "uuid", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update the authenticated user's pinned sidebar tabs and/or homepage for the current team. Pass `@me` as the UUID. Send `tabs` to replace the pinned tab list, `homepage` to set the home destination (any PostHog URL — dashboard, insight, search results, scene). Either field may be omitted to leave it unchanged; sending `homepage: null` or `{}` clears the homepage." } ] }, { "info": { "name": "max", "type": "folder" }, "items": [ { "info": { "name": "conversations_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:project_id/conversations/", "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": "conversations_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:project_id/conversations/", "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}}" } }, "docs": "Unified endpoint that handles both conversation creation and streaming.\n\n- If message is provided: Start new conversation processing\n- If no message: Stream from existing conversation" }, { "info": { "name": "conversations_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:project_id/conversations/:conversation/", "params": [ { "name": "conversation", "value": "", "type": "path", "description": "A UUID string identifying this conversation." }, { "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": "conversations_append_message_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:project_id/conversations/:conversation/append_message/", "params": [ { "name": "conversation", "value": "", "type": "path", "description": "A UUID string identifying this conversation." }, { "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": "Appends a message to an existing conversation without triggering AI processing.\nThis is used for client-side generated messages that need to be persisted\n(e.g., support ticket confirmation messages)." }, { "info": { "name": "conversations_cancel_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/environments/:project_id/conversations/:conversation/cancel/", "params": [ { "name": "conversation", "value": "", "type": "path", "description": "A UUID string identifying this conversation." }, { "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": "conversations_queue_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:project_id/conversations/:conversation/queue/", "params": [ { "name": "conversation", "value": "", "type": "path", "description": "A UUID string identifying this conversation." }, { "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/." } ] } }, { "info": { "name": "conversations_queue_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:project_id/conversations/:conversation/queue/", "params": [ { "name": "conversation", "value": "", "type": "path", "description": "A UUID string identifying this conversation." }, { "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": "conversations_queue_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/environments/:project_id/conversations/:conversation/queue/:queue_id/", "params": [ { "name": "conversation", "value": "", "type": "path", "description": "A UUID string identifying this conversation." }, { "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": "queue_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "conversations_queue_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/environments/:project_id/conversations/:conversation/queue/:queue_id/", "params": [ { "name": "conversation", "value": "", "type": "path", "description": "A UUID string identifying this conversation." }, { "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": "queue_id", "value": "", "type": "path" } ] } }, { "info": { "name": "conversations_queue_clear_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:project_id/conversations/:conversation/queue/clear/", "params": [ { "name": "conversation", "value": "", "type": "path", "description": "A UUID string identifying this conversation." }, { "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": "conversations", "type": "folder" }, "items": [ { "info": { "name": "conversations_views_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:project_id/conversations/views/", "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": "conversations_views_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:project_id/conversations/views/", "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": "conversations_views_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:project_id/conversations/views/:short_id/", "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/." }, { "name": "short_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "conversations_views_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/environments/:project_id/conversations/views/:short_id/", "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/." }, { "name": "short_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "conversations_tickets_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/conversations/tickets/", "params": [ { "name": "assignee", "value": "", "type": "query", "description": "Filter by assignee. Use `unassigned` for tickets with no assignee, `user:` for a specific user, or `role:` for a role." }, { "name": "channel_detail", "value": "", "type": "query", "description": "Filter by the channel sub-type (e.g. `widget_embedded`, `slack_bot_mention`)." }, { "name": "channel_source", "value": "", "type": "query", "description": "Filter by the channel the ticket originated from." }, { "name": "date_from", "value": "", "type": "query", "description": "Only include tickets updated on or after this date. Accepts absolute dates (`2026-01-01`) or relative ones (`-7d`, `-1mStart`). Pass `all` to disable the filter." }, { "name": "date_to", "value": "", "type": "query", "description": "Only include tickets updated on or before this date. Same format as `date_from`." }, { "name": "distinct_ids", "value": "", "type": "query", "description": "Comma-separated list of person `distinct_id`s to filter by (max 100)." }, { "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": "order_by", "value": "", "type": "query", "description": "Sort order. Prefix with `-` for descending. Defaults to `-updated_at`." }, { "name": "priority", "value": "", "type": "query", "description": "Filter by priority. Accepts a single value or a comma-separated list (e.g. `medium,high`). Valid values: `low`, `medium`, `high`." }, { "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": "search", "value": "", "type": "query", "description": "Free-text search. A numeric value matches a ticket number exactly; otherwise matches against the customer's name or email (case-insensitive, partial match)." }, { "name": "sla", "value": "", "type": "query", "description": "Filter by SLA state. `breached` = past `sla_due_at`, `at-risk` = due within the next hour, `on-track` = more than an hour remaining." }, { "name": "status", "value": "", "type": "query", "description": "Filter by status. Accepts a single value or a comma-separated list (e.g. `new,open,pending`). Valid values: `new`, `open`, `pending`, `on_hold`, `resolved`." }, { "name": "tags", "value": "", "type": "query", "description": "JSON-encoded array of tag names to filter by, e.g. `[\"billing\",\"urgent\"]`." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List tickets with person data attached." }, { "info": { "name": "conversations_tickets_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/conversations/tickets/", "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": "conversations_tickets_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/conversations/tickets/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this ticket." }, { "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": "Get single ticket and mark as read by team." }, { "info": { "name": "conversations_tickets_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/projects/:project_id/conversations/tickets/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this ticket." }, { "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": "Handle ticket updates including assignee changes." }, { "info": { "name": "conversations_tickets_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/projects/:project_id/conversations/tickets/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this ticket." }, { "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": "conversations_tickets_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/projects/:project_id/conversations/tickets/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this ticket." }, { "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": "conversations_tickets_suggest_reply_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/conversations/tickets/:id/suggest_reply/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this ticket." }, { "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/." } ] } }, { "info": { "name": "conversations_tickets_bulk_update_tags_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/conversations/tickets/bulk_update_tags/", "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": "{}" } }, "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": "conversations_tickets_unread_count_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/conversations/tickets/unread_count/", "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/." } ] }, "docs": "Get total unread ticket count for the team.\n\nReturns the sum of unread_team_count for all non-resolved tickets.\nCached in Redis for 30 seconds, invalidated on changes." } ] }, { "info": { "name": "customer_journeys", "type": "folder" }, "items": [ { "info": { "name": "customer_journeys_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:project_id/customer_journeys/", "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": "customer_journeys_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:project_id/customer_journeys/", "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": "customer_journeys_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:project_id/customer_journeys/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this customer journey." }, { "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": "customer_journeys_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/environments/:project_id/customer_journeys/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this customer journey." }, { "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": "customer_journeys_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/environments/:project_id/customer_journeys/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this customer journey." }, { "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": "customer_journeys_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/environments/:project_id/customer_journeys/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this customer journey." }, { "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": "customer_profile_configs", "type": "folder" }, "items": [ { "info": { "name": "customer_profile_configs_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:project_id/customer_profile_configs/", "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": "customer_profile_configs_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:project_id/customer_profile_configs/", "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": "customer_profile_configs_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:project_id/customer_profile_configs/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this customer profile config." }, { "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": "customer_profile_configs_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/environments/:project_id/customer_profile_configs/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this customer profile config." }, { "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": "customer_profile_configs_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/environments/:project_id/customer_profile_configs/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this customer profile config." }, { "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": "customer_profile_configs_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/environments/:project_id/customer_profile_configs/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this customer profile config." }, { "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": "desktop_recordings", "type": "folder" }, "items": [ { "info": { "name": "desktop_recordings_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:project_id/desktop_recordings/", "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}}" } }, "docs": "RESTful API for managing desktop meeting recordings.\n\nStandard CRUD operations plus transcript management as a subresource." }, { "info": { "name": "desktop_recordings_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:project_id/desktop_recordings/", "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}}" } }, "docs": "Create a new recording and get Recall.ai upload token for the desktop SDK" }, { "info": { "name": "desktop_recordings_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:project_id/desktop_recordings/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this desktop recording." }, { "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": "RESTful API for managing desktop meeting recordings.\n\nStandard CRUD operations plus transcript management as a subresource." }, { "info": { "name": "desktop_recordings_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/environments/:project_id/desktop_recordings/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this desktop recording." }, { "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": "RESTful API for managing desktop meeting recordings.\n\nStandard CRUD operations plus transcript management as a subresource." }, { "info": { "name": "desktop_recordings_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/environments/:project_id/desktop_recordings/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this desktop recording." }, { "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": "RESTful API for managing desktop meeting recordings.\n\nStandard CRUD operations plus transcript management as a subresource." }, { "info": { "name": "desktop_recordings_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/environments/:project_id/desktop_recordings/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this desktop recording." }, { "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": "RESTful API for managing desktop meeting recordings.\n\nStandard CRUD operations plus transcript management as a subresource." }, { "info": { "name": "desktop_recordings_append_segments_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:project_id/desktop_recordings/:id/append_segments/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this desktop recording." }, { "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": "Append transcript segments (supports batched real-time streaming)" } ] }, { "info": { "name": "event_filter", "type": "folder" }, "items": [ { "info": { "name": "event_filter_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:project_id/event_filter/", "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/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Returns the event filter config for the team, or null if not yet created." }, { "info": { "name": "event_filter_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:project_id/event_filter/", "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}}" } }, "docs": "Create or update the event filter config." }, { "info": { "name": "event_filter_metrics_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:project_id/event_filter/metrics/", "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/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Single event filter per team.\nGET /event_filter/ — returns the config (or null if not yet created)\nPOST /event_filter/ — creates or updates the config (upsert)\nGET /event_filter/metrics/ — time-series metrics\nGET /event_filter/metrics/totals/ — aggregate totals" }, { "info": { "name": "event_filter_metrics_totals_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:project_id/event_filter/metrics/totals/", "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/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Single event filter per team.\nGET /event_filter/ — returns the config (or null if not yet created)\nPOST /event_filter/ — creates or updates the config (upsert)\nGET /event_filter/metrics/ — time-series metrics\nGET /event_filter/metrics/totals/ — aggregate totals" } ] }, { "info": { "name": "health_issues", "type": "folder" }, "items": [ { "info": { "name": "health_issues_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:project_id/health_issues/", "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": "health_issues_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:project_id/health_issues/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this health issue." }, { "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": "health_issues_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/environments/:project_id/health_issues/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this health issue." }, { "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": "health_issues_resolve_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:project_id/health_issues/:id/resolve/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this health issue." }, { "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": "health_issues_summary_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:project_id/health_issues/summary/", "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/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } } ] }, { "info": { "name": "lineage", "type": "folder" }, "items": [ { "info": { "name": "lineage_get_upstream_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:project_id/lineage/get_upstream/", "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/." } ] } } ] }, { "info": { "name": "LLM Analytics", "type": "folder" }, "items": [ { "info": { "name": "llm_analytics_evaluation_summary_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:project_id/llm_analytics/evaluation_summary/", "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}}" } }, "docs": "\nGenerate an AI-powered summary of evaluation results.\n\nThis endpoint analyzes evaluation runs and identifies patterns in passing\nand failing evaluations, providing actionable recommendations.\n\nData is fetched server-side by evaluation ID to ensure data integrity.\n\n**Use Cases:**\n- Understand why evaluations are passing or failing\n- Identify systematic issues in LLM responses\n- Get recommendations for improving response quality\n- Review patterns across many evaluation runs at once\n " }, { "info": { "name": "llm_analytics_sentiment_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:project_id/llm_analytics/sentiment/", "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": "llm_analytics_summarization_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:project_id/llm_analytics/summarization/", "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}}" } }, "docs": "\nGenerate an AI-powered summary of an LLM trace or event.\n\nThis endpoint analyzes the provided trace/event, generates a line-numbered text\nrepresentation, and uses an LLM to create a concise summary with line references.\n\n**Two ways to use this endpoint:**\n\n1. **By ID (recommended):** Pass `trace_id` or `generation_id` with an optional `date_from`/`date_to`.\n The backend fetches the data automatically. `summarize_type` is inferred.\n2. **By data:** Pass the full trace/event data blob in `data` " }, { "info": { "name": "llm_analytics_summarization_batch_check_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:project_id/llm_analytics/summarization/batch_check/", "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": "{}" } }, "docs": "\nCheck which traces have cached summaries available.\n\nThis endpoint allows batch checking of multiple trace IDs to see which ones\nhave cached summaries. Returns only the traces that have cached summaries\nwith their titles.\n\n**Use Cases:**\n- Load cached summaries on session view load\n- Avoid unnecessary LLM calls for already-summarized traces\n- Display summary previews without generating new summaries\n " }, { "info": { "name": "llm_analytics_text_repr_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:project_id/llm_analytics/text_repr/", "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}}" } }, "docs": "\nGenerate a human-readable text representation of an LLM trace event.\n\nThis endpoint converts LLM analytics events ($ai_generation, $ai_span, $ai_embedding, or $ai_trace)\ninto formatted text representations suitable for display, logging, or analysis.\n\n**Supported Event Types:**\n- `$ai_generation`: Individual LLM API calls with input/output messages\n- `$ai_span`: Logical spans with state transitions\n- `$ai_embedding`: Embedding generation events (text input → vector)\n- `$ai_trace`: Full traces wi" } ] }, { "info": { "name": "managed_viewsets", "type": "folder" }, "items": [ { "info": { "name": "managed_viewsets_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:project_id/managed_viewsets/:kind/", "params": [ { "name": "kind", "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": "Get all views associated with a specific managed viewset.\nGET /api/environments/{team_id}/managed_viewsets/{kind}/" }, { "info": { "name": "managed_viewsets_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/environments/:project_id/managed_viewsets/:kind/", "params": [ { "name": "kind", "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": "Enable or disable a managed viewset by kind.\nPUT /api/environments/{team_id}/managed_viewsets/{kind}/ with body {\"enabled\": true/false}" } ] }, { "info": { "name": "max_tools", "type": "folder" }, "items": [ { "info": { "name": "max_tools_create_and_query_insight_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:project_id/max_tools/create_and_query_insight/", "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": "mcp_store", "type": "folder" }, "items": [ { "info": { "name": "mcp_server_installations_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:project_id/mcp_server_installations/", "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": "mcp_server_installations_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:project_id/mcp_server_installations/", "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": "mcp_server_installations_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:project_id/mcp_server_installations/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this mcp server installation." }, { "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": "mcp_server_installations_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/environments/:project_id/mcp_server_installations/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this mcp server installation." }, { "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": "mcp_server_installations_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/environments/:project_id/mcp_server_installations/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this mcp server installation." }, { "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": "mcp_server_installations_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/environments/:project_id/mcp_server_installations/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this mcp server installation." }, { "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": "mcp_server_installations_proxy_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:project_id/mcp_server_installations/:id/proxy/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this mcp server installation." }, { "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": "mcp_server_installations_tools_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:project_id/mcp_server_installations/:id/tools/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this mcp server installation." }, { "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": "mcp_server_installations_tools_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/environments/:project_id/mcp_server_installations/:id/tools/:tool_name/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this mcp server installation." }, { "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": "tool_name", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "mcp_server_installations_tools_refresh_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:project_id/mcp_server_installations/:id/tools/refresh/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this mcp server installation." }, { "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": "mcp_server_installations_authorize_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:project_id/mcp_server_installations/authorize/", "params": [ { "name": "install_source", "value": "", "type": "query", "description": "* `posthog` - posthog\n* `posthog-code` - posthog-code" }, { "name": "installation_id", "value": "", "type": "query" }, { "name": "posthog_code_callback_url", "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/." }, { "name": "template_id", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Start (or re-start) an OAuth flow.\n\nPass ``template_id`` to (re)connect a catalog template, or\n``installation_id`` to reconnect an existing custom install using its\ncached metadata and per-user DCR creds." }, { "info": { "name": "mcp_server_installations_install_custom_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:project_id/mcp_server_installations/install_custom/", "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": "mcp_server_installations_install_template_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:project_id/mcp_server_installations/install_template/", "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": "mcp_servers_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:project_id/mcp_servers/", "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}}" } }, "docs": "Lists curated MCP server templates that users can install with one click.\n\nTemplates are seeded by PostHog operators and carry shared, encrypted\nOAuth client credentials. Inactive templates are hidden from the catalog." } ] }, { "info": { "name": "mcp_tools", "type": "folder" }, "items": [ { "info": { "name": "mcp_tools_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:project_id/mcp_tools/:tool_name/", "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/." }, { "name": "tool_name", "value": "", "type": "path" } ] }, "docs": "Invoke an MCP tool by name.\n\nThis endpoint allows MCP callers to invoke Max AI tools directly\nwithout going through the full LangChain conversation flow.\n\nScopes are resolved dynamically per tool via dangerously_get_required_scopes." } ] }, { "info": { "name": "session_summaries", "type": "folder" }, "items": [ { "info": { "name": "retrieve_session_summaries_config", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:project_id/session_summaries/config/", "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/." } ] }, "docs": "Retrieve the team's session summaries configuration (product context used to tailor single-session replay summaries)." }, { "info": { "name": "update_session_summaries_config", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/environments/:project_id/session_summaries/config/", "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": "{}" } }, "docs": "Update the team's session summaries configuration (product context used to tailor single-session replay summaries)." }, { "info": { "name": "create_session_summaries", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:project_id/session_summaries/create_session_summaries/", "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}}" } }, "docs": "Generate AI summary for a group of session recordings to find patterns and generate a notebook." } ] }, { "info": { "name": "taggers", "type": "folder" }, "items": [ { "info": { "name": "taggers_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:project_id/taggers/", "params": [ { "name": "enabled", "value": "", "type": "query", "description": "Filter by enabled status" }, { "name": "id__in", "value": "", "type": "query", "description": "Multiple values may be separated by commas." }, { "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": "order_by", "value": "", "type": "query", "description": "Ordering\n\n* `created_at` - Created At\n* `-created_at` - Created At (descending)\n* `updated_at` - Updated At\n* `-updated_at` - Updated At (descending)\n* `name` - Name\n* `-name` - Name (descending)" }, { "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": "search", "value": "", "type": "query", "description": "Search in name or description" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "taggers_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:project_id/taggers/", "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": "taggers_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:project_id/taggers/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this tagger." }, { "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": "taggers_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/environments/:project_id/taggers/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this tagger." }, { "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": "taggers_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/environments/:project_id/taggers/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this tagger." }, { "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": "taggers_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/environments/:project_id/taggers/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this tagger." }, { "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": "taggers_test_hog_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:project_id/taggers/test_hog/", "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": "{}" } }, "docs": "Test Hog tagger code against sample events without saving." } ] }, { "info": { "name": "user_interviews", "type": "folder" }, "items": [ { "info": { "name": "user_interviews_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:project_id/user_interviews/", "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": "user_interviews_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/environments/:project_id/user_interviews/", "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": "user_interviews_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:project_id/user_interviews/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this user interview." }, { "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": "user_interviews_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/environments/:project_id/user_interviews/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this user interview." }, { "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": "user_interviews_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/environments/:project_id/user_interviews/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this user interview." }, { "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": "user_interviews_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/environments/:project_id/user_interviews/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this user interview." }, { "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": "web_analytics", "type": "folder" }, "items": [ { "info": { "name": "Summarize web analytics", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:project_id/web_analytics/weekly_digest/", "params": [ { "name": "compare", "value": "", "type": "query", "description": "When true (default), include period-over-period change for each metric comparing against the prior equal-length period. Set to false to skip the comparison query (faster)." }, { "name": "days", "value": "", "type": "query", "description": "Lookback window in days (1–90). Defaults to 7." }, { "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": "Summarizes a project's web analytics over a lookback window (default 7 days): unique visitors, pageviews, sessions, bounce rate, and average session duration with period-over-period comparisons, plus the top 5 pages, top 5 traffic sources, and goal conversions." } ] }, { "info": { "name": "web_vitals", "type": "folder" }, "items": [ { "info": { "name": "web_vitals_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/environments/:project_id/web_vitals/", "params": [ { "name": "pathname", "value": "", "type": "query", "description": "Filter web vitals by pathname" }, { "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": "Get web vitals for a specific pathname.\nToolbar accesses this via OAuth (handled by TeamAndOrgViewSetMixin.get_authenticators)." } ] }, { "info": { "name": "organizations", "type": "folder" }, "items": [ { "info": { "name": "org_organizations_integrations_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/organizations/:organization_id/integrations/", "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": "organization_id", "value": "", "type": "path", "description": "ID of the organization you're trying to access. To find the ID of the organization, make a call to /api/organizations/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "ViewSet for organization-level integrations.\n\nProvides access to integrations that are scoped to the entire organization\n(vs. project-level integrations). Examples include Vercel, AWS Marketplace, etc.\n\nCreation is handled by the integration installation flows\n(e.g., Vercel marketplace installation). Users can disconnect integrations\nvia the DELETE endpoint." }, { "info": { "name": "org_organizations_integrations_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/organizations/:organization_id/integrations/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this organization integration." }, { "name": "organization_id", "value": "", "type": "path", "description": "ID of the organization you're trying to access. To find the ID of the organization, make a call to /api/organizations/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "ViewSet for organization-level integrations.\n\nProvides access to integrations that are scoped to the entire organization\n(vs. project-level integrations). Examples include Vercel, AWS Marketplace, etc.\n\nCreation is handled by the integration installation flows\n(e.g., Vercel marketplace installation). Users can disconnect integrations\nvia the DELETE endpoint." }, { "info": { "name": "org_organization_integrations_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/organizations/:organization_id/integrations/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this organization integration." }, { "name": "organization_id", "value": "", "type": "path", "description": "ID of the organization you're trying to access. To find the ID of the organization, make a call to /api/organizations/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "ViewSet for organization-level integrations.\n\nProvides access to integrations that are scoped to the entire organization\n(vs. project-level integrations). Examples include Vercel, AWS Marketplace, etc.\n\nCreation is handled by the integration installation flows\n(e.g., Vercel marketplace installation). Users can disconnect integrations\nvia the DELETE endpoint." }, { "info": { "name": "integrations_environment_mapping_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/organizations/:organization_id/integrations/:id/environment-mapping/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this organization integration." }, { "name": "organization_id", "value": "", "type": "path", "description": "ID of the organization you're trying to access. To find the ID of the organization, make a call to /api/organizations/." } ], "body": { "type": "json", "data": "{}" } }, "docs": "ViewSet for organization-level integrations.\n\nProvides access to integrations that are scoped to the entire organization\n(vs. project-level integrations). Examples include Vercel, AWS Marketplace, etc.\n\nCreation is handled by the integration installation flows\n(e.g., Vercel marketplace installation). Users can disconnect integrations\nvia the DELETE endpoint." } ] }, { "info": { "name": "reverse_proxy", "type": "folder" }, "items": [ { "info": { "name": "proxy_records_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/organizations/:organization_id/proxy_records/", "params": [ { "name": "organization_id", "value": "", "type": "path", "description": "ID of the organization you're trying to access. To find the ID of the organization, make a call to /api/organizations/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List all reverse proxies configured for the organization. Returns proxy records along with the maximum number allowed by the current plan." }, { "info": { "name": "proxy_records_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/organizations/:organization_id/proxy_records/", "params": [ { "name": "organization_id", "value": "", "type": "path", "description": "ID of the organization you're trying to access. To find the ID of the organization, make a call to /api/organizations/." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create a new managed reverse proxy. Provide the domain you want to proxy through. The response includes the CNAME target you need to add as a DNS record. Once the CNAME is configured, the proxy will be automatically verified and provisioned." }, { "info": { "name": "proxy_records_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/organizations/:organization_id/proxy_records/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this proxy record." }, { "name": "organization_id", "value": "", "type": "path", "description": "ID of the organization you're trying to access. To find the ID of the organization, make a call to /api/organizations/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get details of a specific reverse proxy by ID. Returns the full configuration including domain, CNAME target, and current provisioning status." }, { "info": { "name": "proxy_records_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/organizations/:organization_id/proxy_records/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this proxy record." }, { "name": "organization_id", "value": "", "type": "path", "description": "ID of the organization you're trying to access. To find the ID of the organization, make a call to /api/organizations/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete a reverse proxy. For proxies in 'waiting', 'erroring', or 'timed_out' status, the record is deleted immediately. For active proxies, a deletion workflow is started to clean up the provisioned infrastructure." }, { "info": { "name": "proxy_records_retry_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/organizations/:organization_id/proxy_records/:id/retry/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this proxy record." }, { "name": "organization_id", "value": "", "type": "path", "description": "ID of the organization you're trying to access. To find the ID of the organization, make a call to /api/organizations/." } ] }, "docs": "Retry provisioning a failed reverse proxy. Only available for proxies in 'erroring' or 'timed_out' status. Resets the proxy to 'waiting' status and restarts the provisioning workflow." } ] }, { "info": { "name": "actions", "type": "folder" }, "items": [ { "info": { "name": "actions_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/actions/", "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": "actions_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/actions/", "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": "actions_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/actions/:id/", "params": [ { "name": "format", "value": "", "type": "query" }, { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this action." }, { "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": "actions_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/projects/:project_id/actions/:id/", "params": [ { "name": "format", "value": "", "type": "query" }, { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this action." }, { "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": "actions_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/projects/:project_id/actions/:id/", "params": [ { "name": "format", "value": "", "type": "query" }, { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this action." }, { "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": "actions_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/projects/:project_id/actions/:id/", "params": [ { "name": "format", "value": "", "type": "query" }, { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this action." }, { "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": "actions_references_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/actions/:id/references/", "params": [ { "name": "format", "value": "", "type": "query" }, { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this action." }, { "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": "actions_bulk_update_tags_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/actions/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": "activity_logs", "type": "folder" }, "items": [ { "info": { "name": "activity_log_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/activity_log/", "params": [ { "name": "item_id", "value": "", "type": "query", "description": "Filter by the ID of the affected resource." }, { "name": "page", "value": "", "type": "query", "description": "Page number for pagination. When provided, uses page-based pagination ordered by most recent first." }, { "name": "page_size", "value": "", "type": "query", "description": "Number of results per page (default: 100, max: 1000). Only used with page-based pagination." }, { "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": "scope", "value": "", "type": "query", "description": "Filter by a single activity scope, e.g. \"FeatureFlag\", \"Insight\", \"Dashboard\", \"Experiment\".\n\n* `Cohort` - Cohort\n* `FeatureFlag` - FeatureFlag\n* `Person` - Person\n* `Group` - Group\n* `Insight` - Insight\n* `Plugin` - Plugin\n* `PluginConfig` - PluginConfig\n* `HogFunction` - HogFunction\n* `HogFlow` - HogFlow\n* `DataManagement` - DataManagement\n* `EventDefinition` - EventDefinition\n* `PropertyDefinition` - PropertyDefinition\n* `Notebook` - Notebook\n* `Endpoint` - Endpoint\n* `EndpointVersion` - EndpointVersion\n* `Dashboard` - Dashboard\n* `Replay` - Replay\n* `Experiment` - Experiment\n* `ExperimentHoldout` - ExperimentHoldout\n* `ExperimentSavedMetric` - ExperimentSavedMetric\n* `Survey` - Survey\n* `EarlyAccessFeature` - EarlyAccessFeature\n* `SessionRecordingPlaylist` - SessionRecordingPlaylist\n* `Comment` - Comment\n* `Team` - Team\n* `Project` - Project\n* `ErrorTrackingIssue` - ErrorTrackingIssue\n* `DataWarehouseSavedQuery` - DataWarehouseSavedQuery\n* `LegalDocument` - LegalDocument\n* `Organization` - Organization\n* `OrganizationDomain` - OrganizationDomain\n* `OrganizationMembership` - OrganizationMembership\n* `Role` - Role\n* `UserGroup` - UserGroup\n* `BatchExport` - BatchExport\n* `BatchImport` - BatchImport\n* `Integration` - Integration\n* `Annotation` - Annotation\n* `Tag` - Tag\n* `TaggedItem` - TaggedItem\n* `Subscription` - Subscription\n* `PersonalAPIKey` - PersonalAPIKey\n* `ProjectSecretAPIKey` - ProjectSecretAPIKey\n* `User` - User\n* `Action` - Action\n* `AlertConfiguration` - AlertConfiguration\n* `Threshold` - Threshold\n* `AlertSubscription` - AlertSubscription\n* `ExternalDataSource` - ExternalDataSource\n* `ExternalDataSchema` - ExternalDataSchema\n* `LLMTrace` - LLMTrace\n* `WebAnalyticsFilterPreset` - WebAnalyticsFilterPreset\n* `CustomerProfileConfig` - CustomerProfileConfig\n* `Log` - Log\n* `LogsAlertConfiguration` - LogsAlertConfiguration\n* `LogsExclusionRule` - LogsExclusionRule\n* `ProductTour` - ProductTour\n* `Ticket` - Ticket" }, { "name": "scopes", "value": "", "type": "query", "description": "Filter by multiple activity scopes, comma-separated. Values must be valid ActivityScope enum values. E.g. \"FeatureFlag,Insight\"." }, { "name": "user", "value": "", "type": "query", "description": "Filter by user UUID who performed the action." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } } ] }, { "info": { "name": "early_access_features", "type": "folder" }, "items": [ { "info": { "name": "early_access_feature_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/early_access_feature/", "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": "early_access_feature_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/early_access_feature/", "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": "early_access_feature_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/early_access_feature/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this early access feature." }, { "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": "early_access_feature_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/projects/:project_id/early_access_feature/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this early access feature." }, { "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": "early_access_feature_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/projects/:project_id/early_access_feature/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this early access feature." }, { "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": "early_access_feature_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/projects/:project_id/early_access_feature/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this early access feature." }, { "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": "environments", "type": "folder" }, "items": [ { "info": { "name": "environments_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/environments/", "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}}" } }, "docs": "Deprecated: use /api/environments/{id}/ instead." }, { "info": { "name": "environments_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/environments/", "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}}" } }, "docs": "Deprecated: use /api/environments/{id}/ instead." }, { "info": { "name": "environments_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/environments/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this environment (aka team)." }, { "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": "Deprecated: use /api/environments/{id}/ instead." }, { "info": { "name": "environments_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/projects/:project_id/environments/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this environment (aka team)." }, { "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": "Deprecated: use /api/environments/{id}/ instead." }, { "info": { "name": "environments_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/projects/:project_id/environments/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this environment (aka team)." }, { "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": "Deprecated: use /api/environments/{id}/ instead." }, { "info": { "name": "environments_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/projects/:project_id/environments/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this environment (aka team)." }, { "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": "Deprecated: use /api/environments/{id}/ instead." }, { "info": { "name": "environments_activity_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/environments/:id/activity/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this environment (aka team)." }, { "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/." } ] }, "docs": "Deprecated: use /api/environments/{id}/ instead." }, { "info": { "name": "environments_add_product_intent_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/projects/:project_id/environments/:id/add_product_intent/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this environment (aka team)." }, { "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": "Deprecated: use /api/environments/{id}/ instead." }, { "info": { "name": "environments_complete_product_onboarding_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/projects/:project_id/environments/:id/complete_product_onboarding/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this environment (aka team)." }, { "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": "Deprecated: use /api/environments/{id}/ instead." }, { "info": { "name": "environments_default_evaluation_contexts_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/environments/:id/default_evaluation_contexts/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this environment (aka team)." }, { "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/." } ] }, "docs": "Manage default evaluation contexts for a team." }, { "info": { "name": "environments_default_evaluation_contexts_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/environments/:id/default_evaluation_contexts/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this environment (aka team)." }, { "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": "Manage default evaluation contexts for a team." }, { "info": { "name": "environments_default_evaluation_contexts_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/projects/:project_id/environments/:id/default_evaluation_contexts/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this environment (aka team)." }, { "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/." } ] }, "docs": "Manage default evaluation contexts for a team." }, { "info": { "name": "environments_default_release_conditions_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/environments/:id/default_release_conditions/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this environment (aka team)." }, { "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/." } ] }, "docs": "Manage default release conditions for new feature flags in this team." }, { "info": { "name": "environments_default_release_conditions_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/projects/:project_id/environments/:id/default_release_conditions/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this environment (aka team)." }, { "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": "Manage default release conditions for new feature flags in this team." }, { "info": { "name": "environments_delete_secret_token_backup_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/projects/:project_id/environments/:id/delete_secret_token_backup/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this environment (aka team)." }, { "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": "Deprecated: use /api/environments/{id}/ instead." }, { "info": { "name": "environments_event_ingestion_restrictions_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/environments/:id/event_ingestion_restrictions/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this environment (aka team)." }, { "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": "Deprecated: use /api/environments/{id}/ instead." }, { "info": { "name": "environments_experiments_config_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/environments/:id/experiments_config/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this environment (aka team)." }, { "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/." } ] }, "docs": "Manage experiment configuration for this environment." }, { "info": { "name": "environments_experiments_config_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/projects/:project_id/environments/:id/experiments_config/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this environment (aka team)." }, { "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": "Manage experiment configuration for this environment." }, { "info": { "name": "environments_generate_conversations_public_token_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/environments/:id/generate_conversations_public_token/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this environment (aka team)." }, { "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": "Deprecated: use /api/environments/{id}/ instead." }, { "info": { "name": "environments_is_generating_demo_data_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/environments/:id/is_generating_demo_data/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this environment (aka team)." }, { "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/." } ] }, "docs": "Deprecated: use /api/environments/{id}/ instead." }, { "info": { "name": "environments_reset_token_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/projects/:project_id/environments/:id/reset_token/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this environment (aka team)." }, { "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": "Deprecated: use /api/environments/{id}/ instead." }, { "info": { "name": "environments_rotate_secret_token_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/projects/:project_id/environments/:id/rotate_secret_token/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this environment (aka team)." }, { "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": "Deprecated: use /api/environments/{id}/ instead." }, { "info": { "name": "environments_settings_as_of_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/environments/:id/settings_as_of/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this environment (aka team)." }, { "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/." } ] }, "docs": "Return the team settings as of the provided timestamp.\nQuery params:\n- at: ISO8601 datetime (required)\n- scope: optional, one or multiple keys to filter the returned settings" } ] }, { "info": { "name": "event_schemas", "type": "folder" }, "items": [ { "info": { "name": "event_schemas_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/event_schemas/", "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": "event_schemas_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/event_schemas/", "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": "event_schemas_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/projects/:project_id/event_schemas/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this event schema." }, { "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": "event_schemas_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/projects/:project_id/event_schemas/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this event schema." }, { "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": "event_schemas_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/projects/:project_id/event_schemas/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this event schema." }, { "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": "experiment_holdouts", "type": "folder" }, "items": [ { "info": { "name": "experiment_holdouts_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/experiment_holdouts/", "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": "experiment_holdouts_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/experiment_holdouts/", "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": "experiment_holdouts_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/experiment_holdouts/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this experiment holdout." }, { "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": "experiment_holdouts_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/projects/:project_id/experiment_holdouts/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this experiment holdout." }, { "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": "experiment_holdouts_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/projects/:project_id/experiment_holdouts/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this experiment holdout." }, { "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": "experiment_holdouts_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/projects/:project_id/experiment_holdouts/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this experiment holdout." }, { "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": "experiment_saved_metrics", "type": "folder" }, "items": [ { "info": { "name": "experiment_saved_metrics_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/experiment_saved_metrics/", "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": "experiment_saved_metrics_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/experiment_saved_metrics/", "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": "experiment_saved_metrics_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/experiment_saved_metrics/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this experiment saved metric." }, { "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": "experiment_saved_metrics_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/projects/:project_id/experiment_saved_metrics/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this experiment saved metric." }, { "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": "experiment_saved_metrics_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/projects/:project_id/experiment_saved_metrics/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this experiment saved metric." }, { "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": "experiment_saved_metrics_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/projects/:project_id/experiment_saved_metrics/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this experiment saved metric." }, { "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": "experiments", "type": "folder" }, "items": [ { "info": { "name": "experiments_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/experiments/", "params": [ { "name": "archived", "value": "", "type": "query", "description": "Filter by archived state. Defaults to non-archived experiments only." }, { "name": "created_by_id", "value": "", "type": "query", "description": "Filter to experiments created by the given user ID." }, { "name": "feature_flag_id", "value": "", "type": "query", "description": "Filter to experiments linked to the given feature flag ID." }, { "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": "order", "value": "", "type": "query", "description": "Field to order by. Prefix with '-' for descending. Allowlisted fields include name, created_at, updated_at, start_date, end_date, duration, and status." }, { "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": "search", "value": "", "type": "query", "description": "Free-text search applied to the experiment name (case-insensitive)." }, { "name": "status", "value": "", "type": "query", "description": "Filter by experiment status. \"running\" and \"paused\" are mutually exclusive: \"running\" returns launched experiments with an active feature flag, \"paused\" returns launched experiments whose feature flag is deactivated. \"complete\" is an alias for \"stopped\". \"all\" disables status filtering." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List experiments for the current project. Supports filtering by status and archival state." }, { "info": { "name": "experiments_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/experiments/", "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}}" } }, "docs": "Create a new experiment in draft status with optional metrics." }, { "info": { "name": "experiments_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/experiments/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this experiment." }, { "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": "Retrieve a single experiment by ID, including its current status, metrics, feature flag, and results metadata." }, { "info": { "name": "experiments_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/projects/:project_id/experiments/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this experiment." }, { "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": "Mixin for ViewSets to handle ApprovalRequired exceptions from decorated serializers.\n\nThis mixin intercepts ApprovalRequired exceptions raised by the @approval_gate decorator\non serializer methods and converts them into proper HTTP 409 Conflict responses with\nchange request details." }, { "info": { "name": "experiments_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/projects/:project_id/experiments/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this experiment." }, { "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": "Update an experiment. Use this to modify experiment properties such as name, description, metrics, variants, and configuration. Metrics can be added, changed and removed at any time." }, { "info": { "name": "experiments_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/projects/:project_id/experiments/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this experiment." }, { "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": "experiments_archive_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/experiments/:id/archive/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this experiment." }, { "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": "Archive an ended experiment.\n\nHides the experiment from the default list view. The experiment can be\nrestored at any time by updating archived=false. Returns 400 if the\nexperiment is already archived or has not ended yet." }, { "info": { "name": "experiments_copy_to_project_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/experiments/:id/copy_to_project/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this experiment." }, { "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": "Mixin for ViewSets to handle ApprovalRequired exceptions from decorated serializers.\n\nThis mixin intercepts ApprovalRequired exceptions raised by the @approval_gate decorator\non serializer methods and converts them into proper HTTP 409 Conflict responses with\nchange request details." }, { "info": { "name": "experiments_create_exposure_cohort_for_experiment_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/experiments/:id/create_exposure_cohort_for_experiment/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this experiment." }, { "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": "Mixin for ViewSets to handle ApprovalRequired exceptions from decorated serializers.\n\nThis mixin intercepts ApprovalRequired exceptions raised by the @approval_gate decorator\non serializer methods and converts them into proper HTTP 409 Conflict responses with\nchange request details." }, { "info": { "name": "experiments_duplicate_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/experiments/:id/duplicate/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this experiment." }, { "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": "Mixin for ViewSets to handle ApprovalRequired exceptions from decorated serializers.\n\nThis mixin intercepts ApprovalRequired exceptions raised by the @approval_gate decorator\non serializer methods and converts them into proper HTTP 409 Conflict responses with\nchange request details." }, { "info": { "name": "experiments_end_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/experiments/:id/end/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this experiment." }, { "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": "End a running experiment without shipping a variant.\n\nSets end_date to now and marks the experiment as stopped. The feature\nflag is NOT modified — users continue to see their assigned variants\nand exposure events ($feature_flag_called) continue to be recorded.\nHowever, only data up to end_date is included in experiment results.\n\nUse this when:\n\n- You want to freeze the results window without changing which variant\n users see.\n- A variant was already shipped manually via the feature flag UI and\n" }, { "info": { "name": "experiments_launch_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/experiments/:id/launch/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this experiment." }, { "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": "Launch a draft experiment.\n\nValidates the experiment is in draft state, activates its linked feature flag,\nsets start_date to the current server time, and transitions the experiment to running.\nReturns 400 if the experiment has already been launched or if the feature flag\nconfiguration is invalid (e.g. missing \"control\" variant or fewer than 2 variants)." }, { "info": { "name": "experiments_pause_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/experiments/:id/pause/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this experiment." }, { "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": "Pause a running experiment.\n\nDeactivates the linked feature flag so it is no longer returned by the\n/decide endpoint. Users fall back to the application default (typically\nthe control experience), and no new exposure events are recorded (i.e.\n$feature_flag_called is not fired).\nReturns 400 if the experiment is not running or is already paused." }, { "info": { "name": "experiments_recalculate_timeseries_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/experiments/:id/recalculate_timeseries/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this experiment." }, { "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": "Mixin for ViewSets to handle ApprovalRequired exceptions from decorated serializers.\n\nThis mixin intercepts ApprovalRequired exceptions raised by the @approval_gate decorator\non serializer methods and converts them into proper HTTP 409 Conflict responses with\nchange request details." }, { "info": { "name": "experiments_reset_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/experiments/:id/reset/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this experiment." }, { "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": "Reset an experiment back to draft state.\n\nClears start/end dates, conclusion, and archived flag. The feature\nflag is left unchanged — users continue to see their assigned variants.\n\nPreviously collected events still exist but won't be included in\nresults unless the start date is manually adjusted after re-launch.\n\nReturns 400 if the experiment is already in draft state." }, { "info": { "name": "experiments_resume_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/experiments/:id/resume/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this experiment." }, { "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": "Resume a paused experiment.\n\nReactivates the linked feature flag so it is returned by /decide again.\nUsers are re-bucketed deterministically into the same variants they had\nbefore the pause, and exposure tracking resumes.\nReturns 400 if the experiment is not running or is not paused." }, { "info": { "name": "experiments_ship_variant_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/experiments/:id/ship_variant/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this experiment." }, { "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": "Ship a variant to 100% of users and (optionally) end the experiment.\n\nRewrites the feature flag so that the selected variant is served to everyone.\nExisting release conditions (flag groups) are preserved so the change can be\nrolled back by deleting the auto-added release condition in the feature flag UI.\n\nCan be called on both running and stopped experiments. If the experiment is\nstill running, it will also be ended (end_date set and status marked as stopped).\nIf the experiment has already ended" }, { "info": { "name": "experiments_timeseries_results_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/experiments/:id/timeseries_results/", "params": [ { "name": "fingerprint", "value": "", "type": "query", "description": "Fingerprint of the metric configuration. Available alongside metric_uuid on each metric in the experiment's metrics array." }, { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this experiment." }, { "name": "metric_uuid", "value": "", "type": "query", "description": "UUID of the metric to fetch timeseries for. Available on each metric in the experiment's metrics array." }, { "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": "Mixin for ViewSets to handle ApprovalRequired exceptions from decorated serializers.\n\nThis mixin intercepts ApprovalRequired exceptions raised by the @approval_gate decorator\non serializer methods and converts them into proper HTTP 409 Conflict responses with\nchange request details." }, { "info": { "name": "experiments_unarchive_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/experiments/:id/unarchive/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this experiment." }, { "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": "Unarchive an archived experiment.\n\nRestores the experiment to the default list view. Returns 400 if the\nexperiment is not currently archived." }, { "info": { "name": "experiments_eligible_feature_flags_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/experiments/eligible_feature_flags/", "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/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Returns a paginated list of feature flags eligible for use in experiments.\n\nEligible flags must:\n- Be multivariate with at least 2 variants\n- Have \"control\" as the first variant key\n\nQuery parameters:\n- search: Filter by flag key or name (case insensitive)\n- limit: Number of results per page (default: 20)\n- offset: Pagination offset (default: 0)\n- active: Filter by active status (\"true\" or \"false\")\n- created_by_id: Filter by creator user ID\n- order: Sort order field\n- evaluation_runtime: Filter " }, { "info": { "name": "experiments_requires_flag_implementation_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/experiments/requires_flag_implementation/", "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/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Mixin for ViewSets to handle ApprovalRequired exceptions from decorated serializers.\n\nThis mixin intercepts ApprovalRequired exceptions raised by the @approval_gate decorator\non serializer methods and converts them into proper HTTP 409 Conflict responses with\nchange request details." }, { "info": { "name": "experiments_stats_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/experiments/stats/", "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/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Mixin for ViewSets to handle ApprovalRequired exceptions from decorated serializers.\n\nThis mixin intercepts ApprovalRequired exceptions raised by the @approval_gate decorator\non serializer methods and converts them into proper HTTP 409 Conflict responses with\nchange request details." } ] }, { "info": { "name": "feature_flags", "type": "folder" }, "items": [ { "info": { "name": "feature_flags_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/feature_flags/", "params": [ { "name": "active", "value": "", "type": "query" }, { "name": "created_by_id", "value": "", "type": "query", "description": "The User ID which initially created the feature flag." }, { "name": "evaluation_runtime", "value": "", "type": "query", "description": "Filter feature flags by their evaluation runtime." }, { "name": "excluded_properties", "value": "", "type": "query", "description": "JSON-encoded list of feature flag keys to exclude from the results." }, { "name": "has_evaluation_contexts", "value": "", "type": "query", "description": "Filter feature flags by presence of evaluation contexts. 'true' returns only flags with at least one evaluation context, 'false' returns only flags without." }, { "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/." }, { "name": "search", "value": "", "type": "query", "description": "Search by feature flag key or name. Case insensitive." }, { "name": "tags", "value": "", "type": "query", "description": "JSON-encoded list of tag names to filter feature flags by." }, { "name": "type", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create, read, update and delete feature flags. [See docs](https://posthog.com/docs/feature-flags) for more information on feature flags.\n\nIf you're looking to use feature flags on your application, you can either use our JavaScript Library or our dedicated endpoint to check if feature flags are enabled for a given user." }, { "info": { "name": "feature_flags_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/feature_flags/", "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}}" } }, "docs": "Create, read, update and delete feature flags. [See docs](https://posthog.com/docs/feature-flags) for more information on feature flags.\n\nIf you're looking to use feature flags on your application, you can either use our JavaScript Library or our dedicated endpoint to check if feature flags are enabled for a given user." }, { "info": { "name": "feature_flags_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/feature_flags/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this feature flag." }, { "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": "Create, read, update and delete feature flags. [See docs](https://posthog.com/docs/feature-flags) for more information on feature flags.\n\nIf you're looking to use feature flags on your application, you can either use our JavaScript Library or our dedicated endpoint to check if feature flags are enabled for a given user." }, { "info": { "name": "feature_flags_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/projects/:project_id/feature_flags/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this feature flag." }, { "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, read, update and delete feature flags. [See docs](https://posthog.com/docs/feature-flags) for more information on feature flags.\n\nIf you're looking to use feature flags on your application, you can either use our JavaScript Library or our dedicated endpoint to check if feature flags are enabled for a given user." }, { "info": { "name": "feature_flags_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/projects/:project_id/feature_flags/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this feature flag." }, { "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, read, update and delete feature flags. [See docs](https://posthog.com/docs/feature-flags) for more information on feature flags.\n\nIf you're looking to use feature flags on your application, you can either use our JavaScript Library or our dedicated endpoint to check if feature flags are enabled for a given user." }, { "info": { "name": "feature_flags_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/projects/:project_id/feature_flags/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this feature flag." }, { "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": "feature_flags_activity_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/feature_flags/:id/activity/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this feature flag." }, { "name": "limit", "value": "", "type": "query", "description": "Number of items per page" }, { "name": "page", "value": "", "type": "query", "description": "Page number" }, { "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": "Create, read, update and delete feature flags. [See docs](https://posthog.com/docs/feature-flags) for more information on feature flags.\n\nIf you're looking to use feature flags on your application, you can either use our JavaScript Library or our dedicated endpoint to check if feature flags are enabled for a given user." }, { "info": { "name": "feature_flags_create_static_cohort_for_flag_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/feature_flags/:id/create_static_cohort_for_flag/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this feature flag." }, { "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": "Create, read, update and delete feature flags. [See docs](https://posthog.com/docs/feature-flags) for more information on feature flags.\n\nIf you're looking to use feature flags on your application, you can either use our JavaScript Library or our dedicated endpoint to check if feature flags are enabled for a given user." }, { "info": { "name": "feature_flags_dashboard_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/feature_flags/:id/dashboard/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this feature flag." }, { "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": "Create, read, update and delete feature flags. [See docs](https://posthog.com/docs/feature-flags) for more information on feature flags.\n\nIf you're looking to use feature flags on your application, you can either use our JavaScript Library or our dedicated endpoint to check if feature flags are enabled for a given user." }, { "info": { "name": "feature_flags_dependent_flags_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/feature_flags/:id/dependent_flags/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this feature flag." }, { "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": "Get other active flags that depend on this flag." }, { "info": { "name": "feature_flags_enrich_usage_dashboard_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/feature_flags/:id/enrich_usage_dashboard/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this feature flag." }, { "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": "Create, read, update and delete feature flags. [See docs](https://posthog.com/docs/feature-flags) for more information on feature flags.\n\nIf you're looking to use feature flags on your application, you can either use our JavaScript Library or our dedicated endpoint to check if feature flags are enabled for a given user." }, { "info": { "name": "feature_flags_remote_config_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/feature_flags/:id/remote_config/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this feature flag." }, { "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": "Create, read, update and delete feature flags. [See docs](https://posthog.com/docs/feature-flags) for more information on feature flags.\n\nIf you're looking to use feature flags on your application, you can either use our JavaScript Library or our dedicated endpoint to check if feature flags are enabled for a given user." }, { "info": { "name": "feature_flags_status_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/feature_flags/:id/status/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this feature flag." }, { "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": "Create, read, update and delete feature flags. [See docs](https://posthog.com/docs/feature-flags) for more information on feature flags.\n\nIf you're looking to use feature flags on your application, you can either use our JavaScript Library or our dedicated endpoint to check if feature flags are enabled for a given user." }, { "info": { "name": "feature_flags_versions_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/feature_flags/:id/versions/:version_number/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this feature flag." }, { "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": "version_number", "value": "", "type": "path", "description": "The version number to reconstruct." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create, read, update and delete feature flags. [See docs](https://posthog.com/docs/feature-flags) for more information on feature flags.\n\nIf you're looking to use feature flags on your application, you can either use our JavaScript Library or our dedicated endpoint to check if feature flags are enabled for a given user." }, { "info": { "name": "feature_flags_all_activity_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/feature_flags/activity/", "params": [ { "name": "limit", "value": "", "type": "query", "description": "Number of items per page" }, { "name": "page", "value": "", "type": "query", "description": "Page number" }, { "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": "Create, read, update and delete feature flags. [See docs](https://posthog.com/docs/feature-flags) for more information on feature flags.\n\nIf you're looking to use feature flags on your application, you can either use our JavaScript Library or our dedicated endpoint to check if feature flags are enabled for a given user." }, { "info": { "name": "feature_flags_bulk_delete_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/feature_flags/bulk_delete/", "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}}" } }, "docs": "Bulk delete feature flags by filter criteria or explicit IDs.\n\nAccepts either:\n- {\"filters\": {...}} - Same filter params as list endpoint (search, active, type, etc.)\n- {\"ids\": [...]} - Explicit list of flag IDs (no limit)\n\nReturns same format as bulk_delete for UI compatibility.\n\nUses bulk operations for efficiency: database updates are batched and cache\ninvalidation happens once at the end rather than per-flag." }, { "info": { "name": "feature_flags_bulk_keys_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/feature_flags/bulk_keys/", "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": "{}" } }, "docs": "Get feature flag keys by IDs.\nAccepts a list of feature flag IDs and returns a mapping of ID to key." }, { "info": { "name": "feature_flags_bulk_update_tags_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/feature_flags/bulk_update_tags/", "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": "{}" } }, "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": "feature_flags_evaluation_reasons_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/feature_flags/evaluation_reasons/", "params": [ { "name": "distinct_id", "value": "", "type": "query", "description": "User distinct ID" }, { "name": "groups", "value": "", "type": "query", "description": "Groups for feature flag evaluation (JSON object string)" }, { "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": "Create, read, update and delete feature flags. [See docs](https://posthog.com/docs/feature-flags) for more information on feature flags.\n\nIf you're looking to use feature flags on your application, you can either use our JavaScript Library or our dedicated endpoint to check if feature flags are enabled for a given user." }, { "info": { "name": "feature_flags_local_evaluation_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/feature_flags/local_evaluation/", "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/." }, { "name": "send_cohorts", "value": "", "type": "query", "description": "Include cohorts in response" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create, read, update and delete feature flags. [See docs](https://posthog.com/docs/feature-flags) for more information on feature flags.\n\nIf you're looking to use feature flags on your application, you can either use our JavaScript Library or our dedicated endpoint to check if feature flags are enabled for a given user." }, { "info": { "name": "feature_flags_matching_ids_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/feature_flags/matching_ids/", "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/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get IDs of all feature flags matching the current filters.\nUses the same filtering logic as the list endpoint.\nReturns only IDs that the user has permission to edit." }, { "info": { "name": "feature_flags_my_flags_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/feature_flags/my_flags/", "params": [ { "name": "groups", "value": "", "type": "query", "description": "Groups for feature flag evaluation (JSON object string)" }, { "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": "Create, read, update and delete feature flags. [See docs](https://posthog.com/docs/feature-flags) for more information on feature flags.\n\nIf you're looking to use feature flags on your application, you can either use our JavaScript Library or our dedicated endpoint to check if feature flags are enabled for a given user." }, { "info": { "name": "feature_flags_user_blast_radius_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/feature_flags/user_blast_radius/", "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}}" } }, "docs": "Create, read, update and delete feature flags. [See docs](https://posthog.com/docs/feature-flags) for more information on feature flags.\n\nIf you're looking to use feature flags on your application, you can either use our JavaScript Library or our dedicated endpoint to check if feature flags are enabled for a given user." } ] }, { "info": { "name": "flag_value", "type": "folder" }, "items": [ { "info": { "name": "flag_value_values_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/flag_value/values/", "params": [ { "name": "key", "value": "", "type": "query", "description": "The flag ID" }, { "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/." } ] }, "docs": "Get possible values for a feature flag.\n\nQuery parameters:\n- key: The flag ID (required)\nReturns:\n\n- Array of objects with 'name' field containing possible values" } ] }, { "info": { "name": "groups_types", "type": "folder" }, "items": [ { "info": { "name": "groups_types_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/groups_types/", "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/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "groups_types_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/projects/:project_id/groups_types/:group_type_index/", "params": [ { "name": "group_type_index", "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": "groups_types_create_detail_dashboard_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/projects/:project_id/groups_types/create_detail_dashboard/", "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": "{}" } } }, { "info": { "name": "groups_types_set_default_columns_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/projects/:project_id/groups_types/set_default_columns/", "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": "{}" } } }, { "info": { "name": "groups_types_update_metadata_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/projects/:project_id/groups_types/update_metadata/", "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": "{}" } } } ] }, { "info": { "name": "customer_analytics", "type": "folder" }, "items": [ { "info": { "name": "groups_types_metrics_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/groups_types/:group_type_index/metrics/", "params": [ { "name": "group_type_index", "value": "", "type": "path" }, { "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": "groups_types_metrics_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/groups_types/:group_type_index/metrics/", "params": [ { "name": "group_type_index", "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": "groups_types_metrics_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/groups_types/:group_type_index/metrics/:id/", "params": [ { "name": "group_type_index", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this group usage metric." }, { "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": "groups_types_metrics_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/projects/:project_id/groups_types/:group_type_index/metrics/:id/", "params": [ { "name": "group_type_index", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this group usage metric." }, { "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": "groups_types_metrics_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/projects/:project_id/groups_types/:group_type_index/metrics/:id/", "params": [ { "name": "group_type_index", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this group usage metric." }, { "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": "groups_types_metrics_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/projects/:project_id/groups_types/:group_type_index/metrics/:id/", "params": [ { "name": "group_type_index", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this group usage metric." }, { "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": "hog_function_templates", "type": "folder" }, "items": [ { "info": { "name": "hog_function_templates_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/hog_function_templates/", "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/." }, { "name": "template_id", "value": "", "type": "query", "description": "Filter to a specific template by its template_id. Deprecated templates are excluded from list results; use the retrieve endpoint to look up a template by ID regardless of status." }, { "name": "type", "value": "", "type": "query", "description": "Filter by template type (e.g. destination, email, sms_provider, broadcast). Defaults to destination if neither type nor types is provided." }, { "name": "types", "value": "", "type": "query", "description": "Comma-separated list of template types to include (e.g. destination,email,sms_provider)." } ] } }, { "info": { "name": "hog_function_templates_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/hog_function_templates/:template_id/", "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/." }, { "name": "template_id", "value": "", "type": "path" } ] } }, { "info": { "name": "public_hog_function_templates_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/public_hog_function_templates/", "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": "template_id", "value": "", "type": "query", "description": "Filter to a specific template by its template_id. Deprecated templates are excluded from list results; use the retrieve endpoint to look up a template by ID regardless of status." }, { "name": "type", "value": "", "type": "query", "description": "Filter by template type (e.g. destination, email, sms_provider, broadcast). Defaults to destination if neither type nor types is provided." }, { "name": "types", "value": "", "type": "query", "description": "Comma-separated list of template types to include (e.g. destination,email,sms_provider)." } ] } } ] }, { "info": { "name": "js-snippet", "type": "folder" }, "items": [ { "info": { "name": "js_snippet_resolve_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/js-snippet/resolve/", "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/." } ] }, "docs": "Preview what a given pin would resolve to, without saving it." }, { "info": { "name": "js_snippet_version_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/js-snippet/version/", "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/." } ] }, "docs": "Return the team's current version pin and resolved version." }, { "info": { "name": "js_snippet_version_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/projects/:project_id/js-snippet/version/", "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": "{}" } }, "docs": "Update the team's version pin." } ] }, { "info": { "name": "live_debugger_breakpoints", "type": "folder" }, "items": [ { "info": { "name": "live_debugger_breakpoints_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/live_debugger_breakpoints/", "params": [ { "name": "filename", "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/." }, { "name": "repository", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create, Read, Update and Delete breakpoints for live debugging." }, { "info": { "name": "live_debugger_breakpoints_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/live_debugger_breakpoints/", "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}}" } }, "docs": "Create, Read, Update and Delete breakpoints for live debugging." }, { "info": { "name": "live_debugger_breakpoints_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/live_debugger_breakpoints/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this live debugger breakpoint." }, { "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": "Create, Read, Update and Delete breakpoints for live debugging." }, { "info": { "name": "live_debugger_breakpoints_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/projects/:project_id/live_debugger_breakpoints/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this live debugger breakpoint." }, { "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, Read, Update and Delete breakpoints for live debugging." }, { "info": { "name": "live_debugger_breakpoints_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/projects/:project_id/live_debugger_breakpoints/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this live debugger breakpoint." }, { "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, Read, Update and Delete breakpoints for live debugging." }, { "info": { "name": "live_debugger_breakpoints_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/projects/:project_id/live_debugger_breakpoints/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this live debugger breakpoint." }, { "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": "Create, Read, Update and Delete breakpoints for live debugging." }, { "info": { "name": "Get active breakpoints (External API)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/live_debugger_breakpoints/active/", "params": [ { "name": "enabled", "value": "", "type": "query", "description": "Only return enabled breakpoints" }, { "name": "filename", "value": "", "type": "query", "description": "Filter breakpoints for a specific file" }, { "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": "repository", "value": "", "type": "query", "description": "Filter breakpoints for a specific repository (e.g., 'PostHog/posthog')" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "External API endpoint for client applications to fetch active breakpoints using Project API key. This endpoint allows external client applications (like Python scripts, Node.js apps, etc.) to fetch the list of active breakpoints so they can instrument their code accordingly. \n\nAuthentication: Requires a Project API Key in the Authorization header: `Authorization: Bearer phs_`. You can find your Project API Key in PostHog at: Settings → Project → Project API Key" }, { "info": { "name": "Get breakpoint hits", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/live_debugger_breakpoints/breakpoint_hits/", "params": [ { "name": "breakpoint_ids", "value": "", "type": "query", "description": "Filter hits for specific breakpoints (repeat parameter for multiple IDs, e.g., ?breakpoint_ids=uuid1&breakpoint_ids=uuid2)" }, { "name": "limit", "value": "", "type": "query", "description": "Number of hits to return (default: 100, max: 1000)" }, { "name": "offset", "value": "", "type": "query", "description": "Pagination offset for retrieving additional results (default: 0)" }, { "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": "Retrieve breakpoint hit events from ClickHouse with optional filtering and pagination. Returns hit events containing stack traces, local variables, and execution context from your application's runtime. \n\nSecurity: Breakpoint IDs are filtered to only include those belonging to the current team." } ] }, { "info": { "name": "notebooks", "type": "folder" }, "items": [ { "info": { "name": "notebooks_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/notebooks/", "params": [ { "name": "contains", "value": "", "type": "query", "description": "Filter for notebooks that match a provided filter.\n Each match pair is separated by a colon,\n multiple match pairs can be sent separated by a space or a comma" }, { "name": "created_by", "value": "", "type": "query", "description": "The UUID of the Notebook's creator" }, { "name": "date_from", "value": "", "type": "query", "description": "Filter for notebooks created after this date & time" }, { "name": "date_to", "value": "", "type": "query", "description": "Filter for notebooks created before this date & time" }, { "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/." }, { "name": "user", "value": "", "type": "query", "description": "If any value is provided for this parameter, return notebooks created by the logged in user." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement." }, { "info": { "name": "notebooks_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/notebooks/", "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}}" } }, "docs": "The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement." }, { "info": { "name": "notebooks_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/notebooks/:short_id/", "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/." }, { "name": "short_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement." }, { "info": { "name": "notebooks_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/projects/:project_id/notebooks/:short_id/", "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/." }, { "name": "short_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement." }, { "info": { "name": "notebooks_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/projects/:project_id/notebooks/:short_id/", "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/." }, { "name": "short_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement." }, { "info": { "name": "notebooks_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/projects/:project_id/notebooks/:short_id/", "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/." }, { "name": "short_id", "value": "", "type": "path" } ], "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": "notebooks_activity_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/notebooks/:short_id/activity/", "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/." }, { "name": "short_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement." }, { "info": { "name": "notebooks_collab_save_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/notebooks/:short_id/collab/save/", "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/." }, { "name": "short_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement." }, { "info": { "name": "notebooks_collab_stream_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/notebooks/:short_id/collab/stream/", "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/." }, { "name": "short_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement." }, { "info": { "name": "notebooks_hogql_execute_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/notebooks/:short_id/hogql/execute/", "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/." }, { "name": "short_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement." }, { "info": { "name": "notebooks_kernel_config_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/notebooks/:short_id/kernel/config/", "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/." }, { "name": "short_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement." }, { "info": { "name": "notebooks_kernel_dataframe_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/notebooks/:short_id/kernel/dataframe/", "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/." }, { "name": "short_id", "value": "", "type": "path" } ] }, "docs": "The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement." }, { "info": { "name": "notebooks_kernel_execute_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/notebooks/:short_id/kernel/execute/", "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/." }, { "name": "short_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement." }, { "info": { "name": "notebooks_kernel_execute_stream_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/notebooks/:short_id/kernel/execute/stream/", "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/." }, { "name": "short_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement." }, { "info": { "name": "notebooks_kernel_restart_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/notebooks/:short_id/kernel/restart/", "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/." }, { "name": "short_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement." }, { "info": { "name": "notebooks_kernel_start_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/notebooks/:short_id/kernel/start/", "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/." }, { "name": "short_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement." }, { "info": { "name": "notebooks_kernel_status_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/notebooks/:short_id/kernel/status/", "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/." }, { "name": "short_id", "value": "", "type": "path" } ] }, "docs": "The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement." }, { "info": { "name": "notebooks_kernel_stop_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/notebooks/:short_id/kernel/stop/", "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/." }, { "name": "short_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement." }, { "info": { "name": "notebooks_all_activity_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/notebooks/activity/", "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/." } ] }, "docs": "The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement." }, { "info": { "name": "notebooks_recording_comments_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/notebooks/recording_comments/", "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/." } ] }, "docs": "The API for interacting with Notebooks. This feature is in early access and the API can have breaking changes without announcement." } ] }, { "info": { "name": "object_media_previews", "type": "folder" }, "items": [ { "info": { "name": "object_media_previews_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/object_media_previews/", "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": "object_media_previews_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/object_media_previews/", "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": "object_media_previews_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/object_media_previews/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this object media preview." }, { "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": "object_media_previews_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/projects/:project_id/object_media_previews/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this object media preview." }, { "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": "object_media_previews_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/projects/:project_id/object_media_previews/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this object media preview." }, { "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": "object_media_previews_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/projects/:project_id/object_media_previews/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this object media preview." }, { "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": "object_media_previews_preferred_for_event_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/object_media_previews/preferred_for_event/", "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/." } ] }, "docs": "Get the preferred media preview for an event definition.\nMost recent user-uploaded, then most recent exported asset.\nRequires event_definition (query param)." } ] }, { "info": { "name": "product_tours", "type": "folder" }, "items": [ { "info": { "name": "product_tours_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/product_tours/", "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/." }, { "name": "search", "value": "", "type": "query", "description": "A search term." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "product_tours_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/product_tours/", "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": "product_tours_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/product_tours/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this product tour." }, { "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": "product_tours_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/projects/:project_id/product_tours/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this product tour." }, { "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": "product_tours_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/projects/:project_id/product_tours/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this product tour." }, { "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": "product_tours_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/projects/:project_id/product_tours/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this product tour." }, { "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": "product_tours_discard_draft_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/projects/:project_id/product_tours/:id/discard_draft/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this product tour." }, { "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": "Discard draft content." }, { "info": { "name": "product_tours_draft_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/projects/:project_id/product_tours/:id/draft/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this product tour." }, { "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": "Save draft content (server-side merge). No side effects triggered." }, { "info": { "name": "product_tours_draft_status_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/product_tours/:id/draft_status/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this product tour." }, { "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": "Lightweight polling endpoint for draft change detection." }, { "info": { "name": "product_tours_generate_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/product_tours/:id/generate/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this product tour." }, { "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": "Generate tour step content using AI." }, { "info": { "name": "product_tours_publish_draft_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/product_tours/:id/publish_draft/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this product tour." }, { "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": "Commit draft to live tour. Runs full validation and triggers side effects.\n\nAccepts an optional body payload. If provided, merges it into the draft\nbefore publishing so the caller can save + publish in a single request." } ] }, { "info": { "name": "sandbox-environments", "type": "folder" }, "items": [ { "info": { "name": "sandbox_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/sandbox_environments/", "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}}" } }, "docs": "API for managing sandbox environments that control network access for task runs." }, { "info": { "name": "sandbox_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/sandbox_environments/", "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}}" } }, "docs": "API for managing sandbox environments that control network access for task runs." }, { "info": { "name": "sandbox_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/sandbox_environments/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this sandbox environment." }, { "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": "API for managing sandbox environments that control network access for task runs." }, { "info": { "name": "sandbox_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/projects/:project_id/sandbox_environments/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this sandbox environment." }, { "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": "API for managing sandbox environments that control network access for task runs." }, { "info": { "name": "sandbox_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/projects/:project_id/sandbox_environments/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this sandbox environment." }, { "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": "API for managing sandbox environments that control network access for task runs." } ] }, { "info": { "name": "schema_property_groups", "type": "folder" }, "items": [ { "info": { "name": "schema_property_groups_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/schema_property_groups/", "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": "schema_property_groups_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/schema_property_groups/", "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": "schema_property_groups_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/schema_property_groups/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this schema property group." }, { "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": "schema_property_groups_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/projects/:project_id/schema_property_groups/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this schema property group." }, { "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": "schema_property_groups_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/projects/:project_id/schema_property_groups/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this schema property group." }, { "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": "schema_property_groups_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/projects/:project_id/schema_property_groups/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this schema property group." }, { "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": "sdk_doctor", "type": "folder" }, "items": [ { "info": { "name": "Get SDK health report for a project", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/sdk_doctor/report/", "params": [ { "name": "force_refresh", "value": "", "type": "query", "description": "When true, bypasses the Redis cache and re-queries ClickHouse for SDK usage. Use sparingly — data is refreshed every 12 hours by a background job." }, { "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": "Returns a pre-digested health assessment of the PostHog SDKs the project is using. Covers which SDKs are current vs outdated (smart-semver rules with grace periods and traffic-percentage thresholds), per-version breakdown, and a human-readable reason for each assessment. Use this to diagnose SDK version issues, surface upgrade recommendations, or check overall SDK health." } ] }, { "info": { "name": "session_group_summaries", "type": "folder" }, "items": [ { "info": { "name": "session_group_summaries_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/session_group_summaries/", "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}}" } }, "docs": "API for retrieving and managing stored group session summaries." }, { "info": { "name": "session_group_summaries_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/session_group_summaries/", "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}}" } }, "docs": "API for retrieving and managing stored group session summaries." }, { "info": { "name": "session_group_summaries_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/session_group_summaries/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this session group summary." }, { "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": "API for retrieving and managing stored group session summaries." }, { "info": { "name": "session_group_summaries_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/projects/:project_id/session_group_summaries/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this session group summary." }, { "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": "API for retrieving and managing stored group session summaries." }, { "info": { "name": "session_group_summaries_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/projects/:project_id/session_group_summaries/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this session group summary." }, { "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": "API for retrieving and managing stored group session summaries." }, { "info": { "name": "session_group_summaries_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/projects/:project_id/session_group_summaries/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this session group summary." }, { "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": "API for retrieving and managing stored group session summaries." } ] }, { "info": { "name": "signals", "type": "folder" }, "items": [ { "info": { "name": "signals_processing_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/signals/processing/", "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}}" } }, "docs": "Return current processing state including pause status." }, { "info": { "name": "signals_processing_pause_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/projects/:project_id/signals/processing/pause/", "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}}" } }, "docs": "View and control signal processing pipeline state for a team." }, { "info": { "name": "signals_processing_pause_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/projects/:project_id/signals/processing/pause/", "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/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "View and control signal processing pipeline state for a team." }, { "info": { "name": "signals_reports_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/signals/reports/", "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": "ordering", "value": "", "type": "query", "description": "Comma-separated ordering clauses. Each clause is a field name optionally prefixed with '-' for descending. Allowed fields: status, is_suggested_reviewer, signal_count, total_weight, priority, created_at, updated_at, id. Defaults to '-is_suggested_reviewer,status,-updated_at'." }, { "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": "search", "value": "", "type": "query", "description": "Case-insensitive substring match against report title and summary." }, { "name": "source_product", "value": "", "type": "query", "description": "Comma-separated list of source products to include. Reports are kept if at least one of their contributing signals comes from one of these products (e.g. error_tracking, session_replay)." }, { "name": "status", "value": "", "type": "query", "description": "Comma-separated list of statuses to include. Valid values: potential, candidate, in_progress, pending_input, ready, failed, suppressed. Defaults to all statuses except suppressed." }, { "name": "suggested_reviewers", "value": "", "type": "query", "description": "Comma-separated list of PostHog user UUIDs. Reports are kept if their suggested reviewers include any of the given users." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "signals_reports_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/signals/reports/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this signal report." }, { "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": "signals_source_configs_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/signals/source_configs/", "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": "signals_source_configs_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/signals/source_configs/", "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": "signals_source_configs_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/signals/source_configs/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this signal source config." }, { "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": "signals_source_configs_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/projects/:project_id/signals/source_configs/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this signal source config." }, { "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": "signals_source_configs_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/projects/:project_id/signals/source_configs/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this signal source config." }, { "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": "signals_source_configs_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/projects/:project_id/signals/source_configs/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this signal source config." }, { "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": "surveys", "type": "folder" }, "items": [ { "info": { "name": "surveys_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/surveys/", "params": [ { "name": "archived", "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/." }, { "name": "search", "value": "", "type": "query", "description": "A search term." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "surveys_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/surveys/", "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": "surveys_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/surveys/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this survey." }, { "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": "surveys_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/projects/:project_id/surveys/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this survey." }, { "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": "surveys_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/projects/:project_id/surveys/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this survey." }, { "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": "surveys_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/projects/:project_id/surveys/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this survey." }, { "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": "surveys_activity_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/surveys/:id/activity/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this survey." }, { "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": "surveys_archived_response_uuids_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/surveys/:id/archived-response-uuids/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this survey." }, { "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": "Get list of archived response UUIDs for HogQL filtering.\n\nReturns list of UUIDs that the frontend can use to filter out archived responses\nin HogQL queries." }, { "info": { "name": "surveys_duplicate_to_projects_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/surveys/:id/duplicate_to_projects/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this survey." }, { "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": "Duplicate a survey to multiple projects in a single transaction.\n\nAccepts a list of target team IDs and creates a copy of the survey in each project.\nUses an all-or-nothing approach - if any duplication fails, all changes are rolled back." }, { "info": { "name": "surveys_generate_translations_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/surveys/:id/generate_translations/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this survey." }, { "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": "surveys_responses_archive_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/surveys/:id/responses/:response_uuid/archive/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this survey." }, { "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": "response_uuid", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Archive a single survey response." }, { "info": { "name": "surveys_responses_unarchive_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/surveys/:id/responses/:response_uuid/unarchive/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this survey." }, { "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": "response_uuid", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Unarchive a single survey response." }, { "info": { "name": "surveys_stats_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/surveys/:id/stats/", "params": [ { "name": "date_from", "value": "", "type": "query", "description": "Optional ISO timestamp for start date (e.g. 2024-01-01T00:00:00Z)" }, { "name": "date_to", "value": "", "type": "query", "description": "Optional ISO timestamp for end date (e.g. 2024-01-31T23:59:59Z)" }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this survey." }, { "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": "Get survey response statistics for a specific survey.\n\nArgs:\n date_from: Optional ISO timestamp for start date (e.g. 2024-01-01T00:00:00Z)\n date_to: Optional ISO timestamp for end date (e.g. 2024-01-31T23:59:59Z)\n exclude_archived: Optional boolean to exclude archived responses (default: false, includes archived)\n\nReturns:\n Survey statistics including event counts, unique respondents, and conversion rates" }, { "info": { "name": "surveys_summarize_responses_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/surveys/:id/summarize_responses/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this survey." }, { "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": "surveys_summary_headline_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/surveys/:id/summary_headline/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this survey." }, { "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": "surveys_all_activity_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/surveys/activity/", "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/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } } }, { "info": { "name": "surveys_responses_count_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/surveys/responses_count/", "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/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get response counts for all surveys.\n\nArgs:\n exclude_archived: Optional boolean to exclude archived responses (default: false, includes archived)\n survey_ids: Optional comma-separated list of survey IDs to filter by\n\nReturns:\n Dictionary mapping survey IDs to response counts" }, { "info": { "name": "surveys_global_stats_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/surveys/stats/", "params": [ { "name": "date_from", "value": "", "type": "query", "description": "Optional ISO timestamp for start date (e.g. 2024-01-01T00:00:00Z)" }, { "name": "date_to", "value": "", "type": "query", "description": "Optional ISO timestamp for end date (e.g. 2024-01-31T23:59:59Z)" }, { "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": "Get aggregated response statistics across all surveys.\n\nArgs:\n date_from: Optional ISO timestamp for start date (e.g. 2024-01-01T00:00:00Z)\n date_to: Optional ISO timestamp for end date (e.g. 2024-01-31T23:59:59Z)\n\nReturns:\n Aggregated statistics across all surveys including total counts and rates" } ] }, { "info": { "name": "task-automations", "type": "folder" }, "items": [ { "info": { "name": "task_automations_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/task_automations/", "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": "task_automations_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/task_automations/", "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": "task_automations_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/task_automations/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this task automation." }, { "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": "task_automations_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/projects/:project_id/task_automations/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this task automation." }, { "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": "task_automations_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/projects/:project_id/task_automations/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this task automation." }, { "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": "task_automations_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/projects/:project_id/task_automations/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this task automation." }, { "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": "task_automations_run_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/task_automations/:id/run/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this task automation." }, { "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": "tasks", "type": "folder" }, "items": [ { "info": { "name": "List tasks", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/tasks/", "params": [ { "name": "created_by", "value": "", "type": "query", "description": "Filter by creator user ID" }, { "name": "internal", "value": "", "type": "query", "description": "When true, list internal tasks instead of user-facing ones. Honored only in debug environments; ignored in production. Defaults to excluding internal tasks." }, { "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": "organization", "value": "", "type": "query", "description": "Filter by repository organization" }, { "name": "origin_product", "value": "", "type": "query", "description": "Filter by origin product" }, { "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": "repository", "value": "", "type": "query", "description": "Filter by repository name (can include org/repo format)" }, { "name": "search", "value": "", "type": "query", "description": "Case-insensitive substring search over task title and description. A numeric value also matches the task number. An empty value disables the filter." }, { "name": "stage", "value": "", "type": "query", "description": "Filter by task run stage" }, { "name": "status", "value": "", "type": "query", "description": "Filter tasks by the status of their most recent run.\n\n* `not_started` - not_started\n* `queued` - queued\n* `in_progress` - in_progress\n* `completed` - completed\n* `failed` - failed\n* `cancelled` - cancelled" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get a list of tasks for the current project, with optional filtering by origin product, stage, organization, repository, and created_by." }, { "info": { "name": "tasks_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/tasks/", "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}}" } }, "docs": "API for managing tasks within a project. Tasks represent units of work to be performed by an agent." }, { "info": { "name": "tasks_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/tasks/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this task." }, { "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": "API for managing tasks within a project. Tasks represent units of work to be performed by an agent." }, { "info": { "name": "tasks_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/projects/:project_id/tasks/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this task." }, { "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": "API for managing tasks within a project. Tasks represent units of work to be performed by an agent." }, { "info": { "name": "tasks_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/projects/:project_id/tasks/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this task." }, { "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": "API for managing tasks within a project. Tasks represent units of work to be performed by an agent." }, { "info": { "name": "tasks_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/projects/:project_id/tasks/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this task." }, { "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": "API for managing tasks within a project. Tasks represent units of work to be performed by an agent." }, { "info": { "name": "Run task", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/tasks/:id/run/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this task." }, { "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 task run and kick off the workflow." }, { "info": { "name": "Finalize staged direct uploads for task attachments", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/tasks/:id/staged_artifacts/finalize_upload/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this task." }, { "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": "Verify staged S3 uploads and cache their metadata so they can be attached to the next run created for this task." }, { "info": { "name": "Prepare staged direct uploads for task attachments", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/tasks/:id/staged_artifacts/prepare_upload/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this task." }, { "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": "Reserve S3 object keys for task attachments before creating a new run and return presigned POST forms for direct uploads." }, { "info": { "name": "List distinct task repositories", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/tasks/repositories/", "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/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Return the set of repositories referenced by non-deleted, non-internal tasks in the current project. Used to populate repository filter pickers without being constrained by task list pagination." }, { "info": { "name": "Get repository readiness", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/tasks/repository_readiness/", "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/." }, { "name": "refresh", "value": "", "type": "query" }, { "name": "repository", "value": "", "type": "query", "description": "Repository in org/repo format" }, { "name": "window_days", "value": "", "type": "query" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get autonomy readiness details for a specific repository in the current project." } ] }, { "info": { "name": "task-runs", "type": "folder" }, "items": [ { "info": { "name": "List task runs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/tasks/:task_id/runs/", "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/." }, { "name": "task_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get a list of runs for a specific task." }, { "info": { "name": "Create task run", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/tasks/:task_id/runs/", "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/." }, { "name": "task_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Create a new run for a specific task without starting execution." }, { "info": { "name": "tasks_runs_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/tasks/:task_id/runs/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this task run." }, { "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": "task_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "API for managing task runs. Each run represents an execution of a task." }, { "info": { "name": "Update task run", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/projects/:project_id/tasks/:task_id/runs/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this task run." }, { "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": "task_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "API for managing task runs. Each run represents an execution of a task." }, { "info": { "name": "Append log entries", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/tasks/:task_id/runs/:id/append_log/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this task run." }, { "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": "task_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Append one or more log entries to the task run log array" }, { "info": { "name": "Upload artifacts for a task run", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/tasks/:task_id/runs/:id/artifacts/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this task run." }, { "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": "task_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Persist task artifacts to S3 and attach them to the run manifest." }, { "info": { "name": "Download an artifact through the backend", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/tasks/:task_id/runs/:id/artifacts/download/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this task run." }, { "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": "task_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Streams artifact content for a task run artifact after validating that it belongs to the run." }, { "info": { "name": "Finalize direct uploads for task run artifacts", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/tasks/:task_id/runs/:id/artifacts/finalize_upload/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this task run." }, { "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": "task_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Verify directly uploaded S3 objects and attach them to the run artifact manifest." }, { "info": { "name": "Prepare direct uploads for task run artifacts", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/tasks/:task_id/runs/:id/artifacts/prepare_upload/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this task run." }, { "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": "task_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Reserve S3 object keys for task artifacts and return presigned POST forms for direct uploads." }, { "info": { "name": "Generate presigned URL for an artifact", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/tasks/:task_id/runs/:id/artifacts/presign/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this task run." }, { "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": "task_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Returns a temporary, signed URL that can be used to download a specific artifact." }, { "info": { "name": "Send command to agent server", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/tasks/:task_id/runs/:id/command/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this task run." }, { "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": "task_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Forward a JSON-RPC command to the agent server running in the sandbox. Supports user_message, cancel, close, permission_response, and set_config_option commands." }, { "info": { "name": "Get sandbox connection token", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/tasks/:task_id/runs/:id/connection_token/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this task run." }, { "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": "task_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Generate a JWT token for direct connection to the sandbox. Valid for 24 hours." }, { "info": { "name": "Get task run logs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/tasks/:task_id/runs/:id/logs/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this task run." }, { "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": "task_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Fetch the logs for a task run as JSONL. If the run resumes from another (state.resume_from_run_id), each ancestor's log is concatenated first (oldest ancestor → ... → this run) so resume consumers see a single continuous history and can find the most recent git_checkpoint event regardless of which run emitted it." }, { "info": { "name": "Relay run message to Slack", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/tasks/:task_id/runs/:id/relay_message/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this task run." }, { "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": "task_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Queue a Slack relay workflow to post a run message into the mapped Slack thread." }, { "info": { "name": "Resume task run in cloud", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/tasks/:task_id/runs/:id/resume_in_cloud/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this task run." }, { "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": "task_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Resume an existing task run in a cloud sandbox. Terminates any existing workflow and starts a new one." }, { "info": { "name": "Get filtered task run session logs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/tasks/:task_id/runs/:id/session_logs/", "params": [ { "name": "after", "value": "", "type": "query", "description": "Only return events after this ISO8601 timestamp" }, { "name": "event_types", "value": "", "type": "query", "description": "Comma-separated list of event types to include" }, { "name": "exclude_types", "value": "", "type": "query", "description": "Comma-separated list of event types to exclude" }, { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this task run." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of entries to return (default 1000, max 5000)" }, { "name": "offset", "value": "", "type": "query", "description": "Zero-based offset into the filtered log entries" }, { "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": "task_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Fetch session log entries for a task run with optional filtering by timestamp, event type, and limit." }, { "info": { "name": "Set run output", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/projects/:project_id/tasks/:task_id/runs/:id/set_output/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this task run." }, { "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": "task_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update the output field for a task run (e.g., PR URL, commit SHA, etc.)" }, { "info": { "name": "Start task run", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/tasks/:task_id/runs/:id/start/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this task run." }, { "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": "task_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Start an existing cloud run after any initial run-scoped attachments have been uploaded." }, { "info": { "name": "tasks_runs_stream_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/tasks/:task_id/runs/:id/stream/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this task run." }, { "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": "task_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "API for managing task runs. Each run represents an execution of a task." } ] }, { "info": { "name": "uploaded_media", "type": "folder" }, "items": [ { "info": { "name": "uploaded_media_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/uploaded_media/", "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/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "\n When object storage is available this API allows upload of media which can be used, for example, in text cards on dashboards.\n\n Uploaded media must have a content type beginning with 'image/' and be less than 4MB.\n " } ] }, { "info": { "name": "visual_review", "type": "folder" }, "items": [ { "info": { "name": "visual_review_repos_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/visual_review/repos/", "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}}" } }, "docs": "List all projects for the team." }, { "info": { "name": "visual_review_repos_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/visual_review/repos/", "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}}" } }, "docs": "Create a new repo." }, { "info": { "name": "visual_review_repos_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/visual_review/repos/:id/", "params": [ { "name": "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": "Get a repo by ID." }, { "info": { "name": "visual_review_repos_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/projects/:project_id/visual_review/repos/:id/", "params": [ { "name": "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": "Update a repo's settings." }, { "info": { "name": "visual_review_repos_baselines_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/visual_review/repos/:id/baselines/", "params": [ { "name": "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": "Snapshots overview for a repo: every identifier with a current baseline (latest non-superseded master/main run per run_type), plus tolerate counts, active quarantine state, and a 30-day stability sparkline. Capped at 5000 entries — sets `truncated` and returns the most recently active when exceeded. Filtering / faceting / search are all done client-side; this endpoint takes no filter query params." }, { "info": { "name": "visual_review_repos_quarantine_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/visual_review/repos/:id/quarantine/", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "identifier", "value": "", "type": "query", "description": "Filter by identifier (returns full history)" }, { "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/." }, { "name": "run_type", "value": "", "type": "query", "description": "Filter by run type" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List quarantined identifiers. Without filter: active only. With identifier: full history." }, { "info": { "name": "visual_review_repos_quarantine_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/visual_review/repos/:id/quarantine/:run_type/", "params": [ { "name": "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": "run_type", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Quarantine a snapshot identifier for a specific run type." }, { "info": { "name": "visual_review_repos_quarantine_expire_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/visual_review/repos/:id/quarantine/:run_type/expire/", "params": [ { "name": "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": "run_type", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Expire all active quarantine entries for an identifier." }, { "info": { "name": "visual_review_repos_thumbnails_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/visual_review/repos/:id/thumbnails/:identifier/", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "identifier", "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": "Serve a snapshot thumbnail by identifier. Returns WebP with ETag caching." }, { "info": { "name": "visual_review_repos_runs_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/visual_review/repos/:repo_id/runs/", "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/." }, { "name": "repo_id", "value": "", "type": "path" }, { "name": "review_state", "value": "", "type": "query", "description": "Filter by review state" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List runs in this repo, optionally filtered by review state." }, { "info": { "name": "visual_review_repos_runs_counts_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/visual_review/repos/:repo_id/runs/counts/", "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/." }, { "name": "repo_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Review state counts for runs in this repo." }, { "info": { "name": "visual_review_repos_snapshots_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/visual_review/repos/:repo_id/snapshots/:run_type/:identifier/", "params": [ { "name": "identifier", "value": "", "type": "path", "description": "Snapshot identifier; clients must percent-encode before sending" }, { "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/." }, { "name": "repo_id", "value": "", "type": "path" }, { "name": "run_type", "value": "", "type": "path", "description": "Run type (storybook, playwright)" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Deduped baseline timeline for a snapshot identity. Newest first." }, { "info": { "name": "visual_review_runs_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/visual_review/runs/", "params": [ { "name": "branch", "value": "", "type": "query", "description": "Filter by branch name" }, { "name": "commit_sha", "value": "", "type": "query", "description": "Filter by full commit SHA" }, { "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": "pr_number", "value": "", "type": "query", "description": "Filter by GitHub PR number" }, { "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": "review_state", "value": "", "type": "query", "description": "Filter by review state" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "List runs for the team, optionally filtered by review state, PR number, commit SHA, or branch." }, { "info": { "name": "visual_review_runs_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/visual_review/runs/", "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}}" } }, "docs": "Create a new run from a CI manifest." }, { "info": { "name": "visual_review_runs_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/visual_review/runs/:id/", "params": [ { "name": "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": "Get run status and summary." }, { "info": { "name": "visual_review_runs_add_snapshots_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/visual_review/runs/:id/add-snapshots/", "params": [ { "name": "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": "Add a batch of snapshots to a pending run (shard-based flow)." }, { "info": { "name": "visual_review_runs_approve_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/visual_review/runs/:id/approve/", "params": [ { "name": "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": "Approve visual changes for snapshots in this run.\n\nWith approve_all=true, approves all changed+new snapshots and returns\nsigned baseline YAML. With specific snapshots, approves only those." }, { "info": { "name": "visual_review_runs_auto_approve_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/visual_review/runs/:id/auto-approve/", "params": [ { "name": "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": "CLI auto-approve: approve all and return baseline YAML for local write." }, { "info": { "name": "visual_review_runs_complete_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/visual_review/runs/:id/complete/", "params": [ { "name": "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": "Complete a run: detect removals, verify uploads, trigger diff processing." }, { "info": { "name": "visual_review_runs_recompute_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/visual_review/runs/:id/recompute/", "params": [ { "name": "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": "Re-evaluate quarantine and counts, update commit status, and optionally rerun the CI job." }, { "info": { "name": "visual_review_runs_snapshot_history_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/visual_review/runs/:id/snapshot-history/", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "identifier", "value": "", "type": "query", "description": "Snapshot identifier" }, { "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}}" } }, "docs": "Recent change history for a snapshot identifier across runs." }, { "info": { "name": "visual_review_runs_snapshots_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/visual_review/runs/:id/snapshots/", "params": [ { "name": "id", "value": "", "type": "path" }, { "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}}" } }, "docs": "Get all snapshots for a run with diff results." }, { "info": { "name": "visual_review_runs_tolerate_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/visual_review/runs/:id/tolerate/", "params": [ { "name": "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": "{}" } }, "docs": "Mark a changed snapshot as a known tolerated alternate." }, { "info": { "name": "visual_review_runs_tolerated_hashes_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/visual_review/runs/:id/tolerated-hashes/", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "identifier", "value": "", "type": "query", "description": "Snapshot identifier" }, { "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}}" } }, "docs": "List known tolerated hashes for a snapshot identifier." }, { "info": { "name": "visual_review_runs_counts_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/visual_review/runs/counts/", "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/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Review state counts for the runs list." } ] }, { "info": { "name": "warehouse_dag", "type": "folder" }, "items": [ { "info": { "name": "warehouse_dag_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/warehouse_dag/", "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/." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Return this team's DAG as a set of edges and nodes" } ] }, { "info": { "name": "warehouse_model_paths", "type": "folder" }, "items": [ { "info": { "name": "warehouse_model_paths_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/warehouse_model_paths/", "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": "warehouse_model_paths_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/warehouse_model_paths/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A UUID string identifying this data warehouse model 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": "web_experiments", "type": "folder" }, "items": [ { "info": { "name": "web_experiments_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/web_experiments/", "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": "web_experiments_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/projects/:project_id/web_experiments/", "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": "web_experiments_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/projects/:project_id/web_experiments/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this web experiment." }, { "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": "web_experiments_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/projects/:project_id/web_experiments/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this web experiment." }, { "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": "web_experiments_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/projects/:project_id/web_experiments/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this web experiment." }, { "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": "web_experiments_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/projects/:project_id/web_experiments/:id/", "params": [ { "name": "id", "value": "", "type": "path", "description": "A unique integer value identifying this web experiment." }, { "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": "users", "type": "folder" }, "items": [ { "info": { "name": "users_signal_autonomy_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/users/:user_id/signal_autonomy/", "params": [ { "name": "user_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Per-user signal autonomy config (singleton keyed by user).\n\nGET /api/users//signal_autonomy/ → current config (or 404)\nPOST /api/users//signal_autonomy/ → create or update\nDELETE /api/users//signal_autonomy/ → remove (opt out)" }, { "info": { "name": "users_signal_autonomy_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/users/:user_id/signal_autonomy/", "params": [ { "name": "user_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Per-user signal autonomy config (singleton keyed by user).\n\nGET /api/users//signal_autonomy/ → current config (or 404)\nPOST /api/users//signal_autonomy/ → create or update\nDELETE /api/users//signal_autonomy/ → remove (opt out)" }, { "info": { "name": "users_signal_autonomy_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/users/:user_id/signal_autonomy/", "params": [ { "name": "user_id", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Per-user signal autonomy config (singleton keyed by user).\n\nGET /api/users//signal_autonomy/ → current config (or 404)\nPOST /api/users//signal_autonomy/ → create or update\nDELETE /api/users//signal_autonomy/ → remove (opt out)" } ] } ], "bundled": true }