arcade-mcp/toolkits/posthog_api/arcade_posthog_api/wrapper_tools/BulkDeletePersonsInEnvironment.json
jottakka b7bb2c8d03
[MOAR][PostHog] Adding PostHog starter toolkit (+722) (#654)
Co-authored-by: Francisco Liberal <francisco@arcade.dev>
2025-10-27 12:22:18 -03:00

384 lines
14 KiB
JSON

{
"name": "BulkDeletePersonsInEnvironment",
"fully_qualified_name": "PosthogApi.BulkDeletePersonsInEnvironment@0.1.0",
"description": "Bulk delete persons by IDs in a Datadog environment.\n\nUse this tool to remove multiple persons from a Datadog environment by providing up to 1000 PostHog person IDs or distinct IDs. Useful for managing large datasets efficiently.",
"toolkit": {
"name": "ArcadePosthogApi",
"description": null,
"version": "0.1.0"
},
"input": {
"parameters": [
{
"name": "target_project_id",
"required": true,
"description": "The ID of the project you wish to access for this operation. Retrieve it using the /api/projects/ endpoint.",
"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": "distinct_ids_to_delete",
"required": false,
"description": "Provide a list of up to 1000 distinct IDs to delete all associated persons.",
"value_schema": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "A list of distinct IDs, up to 1000 of them. We'll delete all persons associated with those distinct IDs."
},
"inferrable": true,
"http_endpoint_parameter_name": "distinct_ids"
},
{
"name": "response_format",
"required": false,
"description": "Specify the format of the API response, either '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": "posthog_person_ids",
"required": false,
"description": "A list of up to 1000 PostHog person IDs to delete from the environment.",
"value_schema": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "A list of PostHog person IDs, up to 1000 of them. We'll delete all the persons listed."
},
"inferrable": true,
"http_endpoint_parameter_name": "ids"
},
{
"name": "delete_request_body",
"required": false,
"description": "JSON object containing person deletion details such as person IDs, distinct IDs, and additional properties.",
"value_schema": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": {
"id": {
"val_type": "integer",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": null
},
"name": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": null
},
"distinct_ids": {
"val_type": "array",
"inner_val_type": "string",
"enum": null,
"properties": null,
"inner_properties": null,
"description": null
},
"properties": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": null
},
"created_at": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": null
},
"uuid": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": null
}
},
"inner_properties": null,
"description": ""
},
"inferrable": true,
"http_endpoint_parameter_name": "requestBody"
},
{
"name": "delete_events",
"required": false,
"description": "If true, a task to delete all events related to this person will be created and queued, executing at 5AM UTC every Sunday.",
"value_schema": {
"val_type": "boolean",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "If true, a task to delete all events associated with this person will be created and queued. The task does not run immediately and instead is batched together and at 5AM UTC every Sunday"
},
"inferrable": true,
"http_endpoint_parameter_name": "delete_events"
}
]
},
"output": {
"description": "Response from the API endpoint 'environments_persons_bulk_delete_create'.",
"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}/persons/bulk_delete/",
"http_method": "POST",
"headers": {},
"parameters": [
{
"name": "delete_events",
"tool_parameter_name": "delete_events",
"description": "If true, a task to delete all events associated with this person will be created and queued. The task does not run immediately and instead is batched together and at 5AM UTC every Sunday",
"value_schema": {
"val_type": "boolean",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "If true, a task to delete all events associated with this person will be created and queued. The task does not run immediately and instead is batched together and at 5AM UTC every Sunday"
},
"accepted_as": "query",
"required": false,
"deprecated": false,
"default": false,
"documentation_urls": []
},
{
"name": "distinct_ids",
"tool_parameter_name": "distinct_ids_to_delete",
"description": "A list of distinct IDs, up to 1000 of them. We'll delete all persons associated with those distinct IDs.",
"value_schema": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "A list of distinct IDs, up to 1000 of them. We'll delete all persons associated with those distinct IDs."
},
"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": "ids",
"tool_parameter_name": "posthog_person_ids",
"description": "A list of PostHog person IDs, up to 1000 of them. We'll delete all the persons listed.",
"value_schema": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "A list of PostHog person IDs, up to 1000 of them. We'll delete all the persons listed."
},
"accepted_as": "query",
"required": false,
"deprecated": false,
"default": null,
"documentation_urls": []
},
{
"name": "project_id",
"tool_parameter_name": "target_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": []
},
{
"name": "requestBody",
"tool_parameter_name": "delete_request_body",
"description": "",
"value_schema": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": {
"id": {
"val_type": "integer",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": null
},
"name": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": null
},
"distinct_ids": {
"val_type": "array",
"inner_val_type": "string",
"enum": null,
"properties": null,
"inner_properties": null,
"description": null
},
"properties": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": null
},
"created_at": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": null
},
"uuid": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": null
}
},
"inner_properties": null,
"description": ""
},
"accepted_as": "body",
"required": false,
"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": "{\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"integer\",\n \"readOnly\": true\n },\n \"name\": {\n \"type\": \"string\",\n \"readOnly\": true\n },\n \"distinct_ids\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n },\n \"readOnly\": true\n },\n \"properties\": {},\n \"created_at\": {\n \"type\": \"string\",\n \"format\": \"date-time\",\n \"readOnly\": true\n },\n \"uuid\": {\n \"type\": \"string\",\n \"format\": \"uuid\",\n \"readOnly\": true\n }\n },\n \"required\": [\n \"created_at\",\n \"distinct_ids\",\n \"id\",\n \"name\",\n \"uuid\"\n ]\n }\n }\n }\n}",
"use_request_body_schema_mode": true,
"validate_request_body_schema": true
}
}