{ "name": "FetchEnvironmentInsights", "fully_qualified_name": "PosthogApi.FetchEnvironmentInsights@0.1.0", "description": "Retrieve insights for a specific environment.\n\nThis tool is used to retrieve insights data for a specified environment within a project. It should be called when detailed information about an environment's insights is needed.", "toolkit": { "name": "ArcadePosthogApi", "description": null, "version": "0.1.0" }, "input": { "parameters": [ { "name": "insight_identifier", "required": true, "description": "A unique integer identifying the specific insight to retrieve.", "value_schema": { "val_type": "integer", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "A unique integer value identifying this insight." }, "inferrable": true, "http_endpoint_parameter_name": "id" }, { "name": "project_identifier", "required": true, "description": "The ID of the project to access. Retrieve it by calling /api/projects/.", "value_schema": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." }, "inferrable": true, "http_endpoint_parameter_name": "project_id" }, { "name": "output_format", "required": false, "description": "Specify the format for the output data. Options are 'csv' or 'json'.", "value_schema": { "val_type": "string", "inner_val_type": null, "enum": [ "csv", "json" ], "properties": null, "inner_properties": null, "description": "" }, "inferrable": true, "http_endpoint_parameter_name": "format" }, { "name": "dashboard_id_context", "required": false, "description": "The ID of the dashboard to apply its filters and date range if loading insight in the context of a dashboard.", "value_schema": { "val_type": "integer", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "\nOnly if loading an insight in the context of a dashboard: The relevant dashboard's ID.\nWhen set, the specified dashboard's filters and date range override will be applied." }, "inferrable": true, "http_endpoint_parameter_name": "from_dashboard" }, { "name": "insight_refresh_strategy", "required": false, "description": "Determines how to refresh the insight: choose from 'force_cache', 'blocking', 'async', 'lazy_async', 'force_blocking', or 'force_async'. Dictates calculation synchronization and use of cache.", "value_schema": { "val_type": "string", "inner_val_type": null, "enum": [ "async", "async_except_on_cache_miss", "blocking", "force_async", "force_blocking", "force_cache", "lazy_async" ], "properties": null, "inner_properties": null, "description": "\nWhether to refresh the insight, how aggresively, and if sync or async:\n- `'force_cache'` - return cached data or a cache miss; always completes immediately as it never calculates\n- `'blocking'` - calculate synchronously (returning only when the query is done), UNLESS there are very fresh results in the cache\n- `'async'` - kick off background calculation (returning immediately with a query status), UNLESS there are very fresh results in the cache\n- `'lazy_async'` - kick off background calculation, UNLESS there are somewhat fresh results in the cache\n- `'force_blocking'` - calculate synchronously, even if fresh results are already cached\n- `'force_async'` - kick off background calculation, even if fresh results are already cached\nBackground calculation can be tracked using the `query_status` response field." }, "inferrable": true, "http_endpoint_parameter_name": "refresh" } ] }, "output": { "description": "Response from the API endpoint 'environments_insights_retrieve'.", "available_modes": [ "value", "error", "null" ], "value_schema": { "val_type": "json", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": null } }, "requirements": { "authorization": null, "secrets": [ { "key": "POSTHOG_SERVER_URL" }, { "key": "POSTHOG_PERSONAL_API_KEY" } ], "metadata": null }, "deprecation_message": null, "metadata": { "object_type": "api_wrapper_tool", "version": "1.1.0", "description": "Tools that enable LLMs to interact directly with the Datadog API." }, "http_endpoint": { "metadata": { "object_type": "http_endpoint", "version": "1.2.0", "description": "" }, "url": "{posthog_server_url}/api/environments/{project_id}/insights/{id}/", "http_method": "GET", "headers": {}, "parameters": [ { "name": "format", "tool_parameter_name": "output_format", "description": "", "value_schema": { "val_type": "string", "inner_val_type": null, "enum": [ "csv", "json" ], "properties": null, "inner_properties": null, "description": "" }, "accepted_as": "query", "required": false, "deprecated": false, "default": null, "documentation_urls": [] }, { "name": "from_dashboard", "tool_parameter_name": "dashboard_id_context", "description": "\nOnly if loading an insight in the context of a dashboard: The relevant dashboard's ID.\nWhen set, the specified dashboard's filters and date range override will be applied.", "value_schema": { "val_type": "integer", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "\nOnly if loading an insight in the context of a dashboard: The relevant dashboard's ID.\nWhen set, the specified dashboard's filters and date range override will be applied." }, "accepted_as": "query", "required": false, "deprecated": false, "default": null, "documentation_urls": [] }, { "name": "refresh", "tool_parameter_name": "insight_refresh_strategy", "description": "\nWhether to refresh the insight, how aggresively, and if sync or async:\n- `'force_cache'` - return cached data or a cache miss; always completes immediately as it never calculates\n- `'blocking'` - calculate synchronously (returning only when the query is done), UNLESS there are very fresh results in the cache\n- `'async'` - kick off background calculation (returning immediately with a query status), UNLESS there are very fresh results in the cache\n- `'lazy_async'` - kick off background calculation, UNLESS there are somewhat fresh results in the cache\n- `'force_blocking'` - calculate synchronously, even if fresh results are already cached\n- `'force_async'` - kick off background calculation, even if fresh results are already cached\nBackground calculation can be tracked using the `query_status` response field.", "value_schema": { "val_type": "string", "inner_val_type": null, "enum": [ "async", "async_except_on_cache_miss", "blocking", "force_async", "force_blocking", "force_cache", "lazy_async" ], "properties": null, "inner_properties": null, "description": "\nWhether to refresh the insight, how aggresively, and if sync or async:\n- `'force_cache'` - return cached data or a cache miss; always completes immediately as it never calculates\n- `'blocking'` - calculate synchronously (returning only when the query is done), UNLESS there are very fresh results in the cache\n- `'async'` - kick off background calculation (returning immediately with a query status), UNLESS there are very fresh results in the cache\n- `'lazy_async'` - kick off background calculation, UNLESS there are somewhat fresh results in the cache\n- `'force_blocking'` - calculate synchronously, even if fresh results are already cached\n- `'force_async'` - kick off background calculation, even if fresh results are already cached\nBackground calculation can be tracked using the `query_status` response field." }, "accepted_as": "query", "required": false, "deprecated": false, "default": "force_cache", "documentation_urls": [] }, { "name": "id", "tool_parameter_name": "insight_identifier", "description": "A unique integer value identifying this insight.", "value_schema": { "val_type": "integer", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "A unique integer value identifying this insight." }, "accepted_as": "path", "required": true, "deprecated": false, "default": null, "documentation_urls": [] }, { "name": "project_id", "tool_parameter_name": "project_identifier", "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.", "value_schema": { "val_type": "string", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/." }, "accepted_as": "path", "required": true, "deprecated": false, "default": null, "documentation_urls": [] } ], "documentation_urls": [], "secrets": [ { "arcade_key": "POSTHOG_SERVER_URL", "parameter_name": "posthog_server_url", "accepted_as": "path", "formatted_value": null, "description": "", "is_auth_token": false }, { "arcade_key": "POSTHOG_PERSONAL_API_KEY", "parameter_name": "Authorization", "accepted_as": "header", "formatted_value": "Bearer {authorization}", "description": "", "is_auth_token": false } ], "request_body_spec": null, "use_request_body_schema_mode": false, "validate_request_body_schema": false } }