368 lines
14 KiB
JSON
368 lines
14 KiB
JSON
{
|
|
"name": "GetEnvironmentInsights",
|
|
"fully_qualified_name": "PosthogApi.GetEnvironmentInsights@0.1.0",
|
|
"description": "Retrieve insights for a specific environment.\n\nUse this tool to get insights for a specified environment within a given project. It logs each view upon retrieval.",
|
|
"toolkit": {
|
|
"name": "ArcadePosthogApi",
|
|
"description": null,
|
|
"version": "0.1.0"
|
|
},
|
|
"input": {
|
|
"parameters": [
|
|
{
|
|
"name": "project_id",
|
|
"required": true,
|
|
"description": "The ID of the project to access. Use /api/projects/ to find the correct ID.",
|
|
"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": "created_by_user_id",
|
|
"required": false,
|
|
"description": "The user ID of who created the insight. Expected as an integer.",
|
|
"value_schema": {
|
|
"val_type": "integer",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": ""
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "created_by"
|
|
},
|
|
{
|
|
"name": "response_format",
|
|
"required": false,
|
|
"description": "Specify the format of the retrieved insights (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": "results_per_page",
|
|
"required": false,
|
|
"description": "Number of results to return per page for pagination.",
|
|
"value_schema": {
|
|
"val_type": "integer",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Number of results to return per page."
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "limit"
|
|
},
|
|
{
|
|
"name": "initial_result_index",
|
|
"required": false,
|
|
"description": "The initial index from which to start returning results.",
|
|
"value_schema": {
|
|
"val_type": "integer",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "The initial index from which to return the results."
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "offset"
|
|
},
|
|
{
|
|
"name": "refresh_method",
|
|
"required": false,
|
|
"description": "Strategy for refreshing insights, with options for cache use and sync/async execution. Choices include: 'force_cache', 'blocking', 'async', 'lazy_async', 'force_blocking', and 'force_async'.",
|
|
"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 retrieved insights, 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"
|
|
},
|
|
{
|
|
"name": "short_identifier",
|
|
"required": false,
|
|
"description": "The short identifier for the environment to retrieve insights for. This is unique per environment.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": ""
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "short_id"
|
|
},
|
|
{
|
|
"name": "return_basic_insight_metadata_only",
|
|
"required": false,
|
|
"description": "Set to true to return only basic metadata without results for faster response.",
|
|
"value_schema": {
|
|
"val_type": "boolean",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Return basic insight metadata only (no results, faster)."
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "basic"
|
|
}
|
|
]
|
|
},
|
|
"output": {
|
|
"description": "Response from the API endpoint 'environments_insights_list'.",
|
|
"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/",
|
|
"http_method": "GET",
|
|
"headers": {},
|
|
"parameters": [
|
|
{
|
|
"name": "basic",
|
|
"tool_parameter_name": "return_basic_insight_metadata_only",
|
|
"description": "Return basic insight metadata only (no results, faster).",
|
|
"value_schema": {
|
|
"val_type": "boolean",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Return basic insight metadata only (no results, faster)."
|
|
},
|
|
"accepted_as": "query",
|
|
"required": false,
|
|
"deprecated": false,
|
|
"default": null,
|
|
"documentation_urls": []
|
|
},
|
|
{
|
|
"name": "created_by",
|
|
"tool_parameter_name": "created_by_user_id",
|
|
"description": "",
|
|
"value_schema": {
|
|
"val_type": "integer",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": ""
|
|
},
|
|
"accepted_as": "query",
|
|
"required": false,
|
|
"deprecated": false,
|
|
"default": null,
|
|
"documentation_urls": []
|
|
},
|
|
{
|
|
"name": "format",
|
|
"tool_parameter_name": "response_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": "limit",
|
|
"tool_parameter_name": "results_per_page",
|
|
"description": "Number of results to return per page.",
|
|
"value_schema": {
|
|
"val_type": "integer",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Number of results to return per page."
|
|
},
|
|
"accepted_as": "query",
|
|
"required": false,
|
|
"deprecated": false,
|
|
"default": null,
|
|
"documentation_urls": []
|
|
},
|
|
{
|
|
"name": "offset",
|
|
"tool_parameter_name": "initial_result_index",
|
|
"description": "The initial index from which to return the results.",
|
|
"value_schema": {
|
|
"val_type": "integer",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "The initial index from which to return the results."
|
|
},
|
|
"accepted_as": "query",
|
|
"required": false,
|
|
"deprecated": false,
|
|
"default": null,
|
|
"documentation_urls": []
|
|
},
|
|
{
|
|
"name": "refresh",
|
|
"tool_parameter_name": "refresh_method",
|
|
"description": "\nWhether to refresh the retrieved insights, 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 retrieved insights, 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": "short_id",
|
|
"tool_parameter_name": "short_identifier",
|
|
"description": "",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": ""
|
|
},
|
|
"accepted_as": "query",
|
|
"required": false,
|
|
"deprecated": false,
|
|
"default": null,
|
|
"documentation_urls": []
|
|
},
|
|
{
|
|
"name": "project_id",
|
|
"tool_parameter_name": "project_id",
|
|
"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
|
|
}
|
|
}
|