{ "opencollection": "1.0.0", "info": { "name": "PostHog actions core API", "version": "1.0.0" }, "items": [ { "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": "{}" } } } ] } ], "bundled": true }