313 lines
15 KiB
JSON
313 lines
15 KiB
JSON
{
|
|
"name": "UpdateWebExperimentStatus",
|
|
"fully_qualified_name": "PosthogApi.UpdateWebExperimentStatus@0.1.0",
|
|
"description": "Update the status of a web experiment.\n\nUse this tool to update the status or data of an existing web experiment within a specific project by providing the relevant identifiers.",
|
|
"toolkit": {
|
|
"name": "ArcadePosthogApi",
|
|
"description": null,
|
|
"version": "0.1.0"
|
|
},
|
|
"input": {
|
|
"parameters": [
|
|
{
|
|
"name": "project_id_for_access",
|
|
"required": true,
|
|
"description": "Project ID to access the specific project. Obtain it via /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": "web_experiment_id",
|
|
"required": false,
|
|
"description": "A unique integer identifying the web experiment.",
|
|
"value_schema": {
|
|
"val_type": "integer",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": ""
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "id"
|
|
},
|
|
{
|
|
"name": "experiment_identifier",
|
|
"required": false,
|
|
"description": "The unique identifier for the web experiment that needs to be updated.",
|
|
"value_schema": {
|
|
"val_type": "integer",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": ""
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "id"
|
|
},
|
|
{
|
|
"name": "experiment_name",
|
|
"required": false,
|
|
"description": "The name of the web experiment to be updated. This should be a descriptive string identifying the specific experiment within the project.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": ""
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "name"
|
|
},
|
|
{
|
|
"name": "creation_timestamp",
|
|
"required": false,
|
|
"description": "The timestamp when the web experiment was created. Must be in ISO 8601 format (e.g., '2023-10-05T14:48:00.000Z').",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": ""
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "created_at"
|
|
},
|
|
{
|
|
"name": "feature_flag_key",
|
|
"required": false,
|
|
"description": "A string representing the feature flag key associated with the web experiment. It uniquely identifies the feature toggle you want to update.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": ""
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "feature_flag_key"
|
|
},
|
|
{
|
|
"name": "web_experiment_variants",
|
|
"required": false,
|
|
"description": "JSON string defining the variants for the web experiment. Include text, HTML, selector, conditions, and rollout percentage for each variant. Example: { \"control\": { \"transforms\": [ { \"text\": \"Here comes Superman!\", \"html\": \"\", \"selector\": \"#page > #body > .header h1\" } ], \"conditions\": \"None\", \"rollout_percentage\": 50 } }",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Variants for the web experiment. Example:\n\n {\n \"control\": {\n \"transforms\": [\n {\n \"text\": \"Here comes Superman!\",\n \"html\": \"\",\n \"selector\": \"#page > #body > .header h1\"\n }\n ],\n \"conditions\": \"None\",\n \"rollout_percentage\": 50\n },\n }"
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "variants"
|
|
}
|
|
]
|
|
},
|
|
"output": {
|
|
"description": "Response from the API endpoint 'web_experiments_partial_update'.",
|
|
"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/projects/{project_id}/web_experiments/{id}/",
|
|
"http_method": "PATCH",
|
|
"headers": {},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"tool_parameter_name": "experiment_identifier",
|
|
"description": "A unique integer value identifying this web experiment.",
|
|
"value_schema": {
|
|
"val_type": "integer",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "A unique integer value identifying this web experiment."
|
|
},
|
|
"accepted_as": "path",
|
|
"required": true,
|
|
"deprecated": false,
|
|
"default": null,
|
|
"documentation_urls": []
|
|
},
|
|
{
|
|
"name": "project_id",
|
|
"tool_parameter_name": "project_id_for_access",
|
|
"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": "id",
|
|
"tool_parameter_name": "experiment_identifier",
|
|
"description": "",
|
|
"value_schema": {
|
|
"val_type": "integer",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": ""
|
|
},
|
|
"accepted_as": "body",
|
|
"required": false,
|
|
"deprecated": false,
|
|
"default": null,
|
|
"documentation_urls": []
|
|
},
|
|
{
|
|
"name": "name",
|
|
"tool_parameter_name": "experiment_name",
|
|
"description": "",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": ""
|
|
},
|
|
"accepted_as": "body",
|
|
"required": false,
|
|
"deprecated": false,
|
|
"default": null,
|
|
"documentation_urls": []
|
|
},
|
|
{
|
|
"name": "created_at",
|
|
"tool_parameter_name": "creation_timestamp",
|
|
"description": "",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": ""
|
|
},
|
|
"accepted_as": "body",
|
|
"required": false,
|
|
"deprecated": false,
|
|
"default": null,
|
|
"documentation_urls": []
|
|
},
|
|
{
|
|
"name": "feature_flag_key",
|
|
"tool_parameter_name": "feature_flag_key",
|
|
"description": "",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": ""
|
|
},
|
|
"accepted_as": "body",
|
|
"required": false,
|
|
"deprecated": false,
|
|
"default": null,
|
|
"documentation_urls": []
|
|
},
|
|
{
|
|
"name": "variants",
|
|
"tool_parameter_name": "web_experiment_variants",
|
|
"description": "Variants for the web experiment. Example:\n\n {\n \"control\": {\n \"transforms\": [\n {\n \"text\": \"Here comes Superman!\",\n \"html\": \"\",\n \"selector\": \"#page > #body > .header h1\"\n }\n ],\n \"conditions\": \"None\",\n \"rollout_percentage\": 50\n },\n }",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Variants for the web experiment. Example:\n\n {\n \"control\": {\n \"transforms\": [\n {\n \"text\": \"Here comes Superman!\",\n \"html\": \"\",\n \"selector\": \"#page > #body > .header h1\"\n }\n ],\n \"conditions\": \"None\",\n \"rollout_percentage\": 50\n },\n }"
|
|
},
|
|
"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 \"description\": \"Serializer for the exposed /api/web_experiments endpoint, to be used in posthog-js and for headless APIs.\",\n \"properties\": {\n \"id\": {\n \"type\": \"integer\",\n \"readOnly\": true\n },\n \"name\": {\n \"type\": \"string\",\n \"maxLength\": 400\n },\n \"created_at\": {\n \"type\": \"string\",\n \"format\": \"date-time\"\n },\n \"feature_flag_key\": {\n \"type\": \"string\",\n \"readOnly\": true\n },\n \"variants\": {\n \"description\": \"Variants for the web experiment. Example:\\n\\n {\\n \\\"control\\\": {\\n \\\"transforms\\\": [\\n {\\n \\\"text\\\": \\\"Here comes Superman!\\\",\\n \\\"html\\\": \\\"\\\",\\n \\\"selector\\\": \\\"#page > #body > .header h1\\\"\\n }\\n ],\\n \\\"conditions\\\": \\\"None\\\",\\n \\\"rollout_percentage\\\": 50\\n },\\n }\"\n }\n }\n }\n },\n \"application/x-www-form-urlencoded\": {\n \"schema\": {\n \"type\": \"object\",\n \"description\": \"Serializer for the exposed /api/web_experiments endpoint, to be used in posthog-js and for headless APIs.\",\n \"properties\": {\n \"id\": {\n \"type\": \"integer\",\n \"readOnly\": true\n },\n \"name\": {\n \"type\": \"string\",\n \"maxLength\": 400\n },\n \"created_at\": {\n \"type\": \"string\",\n \"format\": \"date-time\"\n },\n \"feature_flag_key\": {\n \"type\": \"string\",\n \"readOnly\": true\n },\n \"variants\": {\n \"description\": \"Variants for the web experiment. Example:\\n\\n {\\n \\\"control\\\": {\\n \\\"transforms\\\": [\\n {\\n \\\"text\\\": \\\"Here comes Superman!\\\",\\n \\\"html\\\": \\\"\\\",\\n \\\"selector\\\": \\\"#page > #body > .header h1\\\"\\n }\\n ],\\n \\\"conditions\\\": \\\"None\\\",\\n \\\"rollout_percentage\\\": 50\\n },\\n }\"\n }\n }\n }\n },\n \"multipart/form-data\": {\n \"schema\": {\n \"type\": \"object\",\n \"description\": \"Serializer for the exposed /api/web_experiments endpoint, to be used in posthog-js and for headless APIs.\",\n \"properties\": {\n \"id\": {\n \"type\": \"integer\",\n \"readOnly\": true\n },\n \"name\": {\n \"type\": \"string\",\n \"maxLength\": 400\n },\n \"created_at\": {\n \"type\": \"string\",\n \"format\": \"date-time\"\n },\n \"feature_flag_key\": {\n \"type\": \"string\",\n \"readOnly\": true\n },\n \"variants\": {\n \"description\": \"Variants for the web experiment. Example:\\n\\n {\\n \\\"control\\\": {\\n \\\"transforms\\\": [\\n {\\n \\\"text\\\": \\\"Here comes Superman!\\\",\\n \\\"html\\\": \\\"\\\",\\n \\\"selector\\\": \\\"#page > #body > .header h1\\\"\\n }\\n ],\\n \\\"conditions\\\": \\\"None\\\",\\n \\\"rollout_percentage\\\": 50\\n },\\n }\"\n }\n }\n }\n }\n }\n}",
|
|
"use_request_body_schema_mode": false,
|
|
"validate_request_body_schema": false
|
|
}
|
|
}
|