322 lines
31 KiB
JSON
322 lines
31 KiB
JSON
{
|
|
"name": "QueryScalarData",
|
|
"fully_qualified_name": "DatadogApi.QueryScalarData@0.1.0",
|
|
"description": "Query scalar values from diverse data sources.\n\nUse this tool to query scalar values from various data sources, with options to apply formulas and functions, ideal for insights in widgets like Query Value, Table, and Toplist.",
|
|
"toolkit": {
|
|
"name": "ArcadeDatadogApi",
|
|
"description": null,
|
|
"version": "0.1.0"
|
|
},
|
|
"input": {
|
|
"parameters": [
|
|
{
|
|
"name": "scalar_query_request",
|
|
"required": true,
|
|
"description": "A JSON object describing the details of a scalar formula request, including formulas, queries, and the date range.",
|
|
"value_schema": {
|
|
"val_type": "json",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": {
|
|
"data": {
|
|
"val_type": "json",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": {
|
|
"attributes": {
|
|
"val_type": "json",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": {
|
|
"formulas": {
|
|
"val_type": "array",
|
|
"inner_val_type": "json",
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": {
|
|
"formula": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Formula string, referencing one or more queries with their name property."
|
|
},
|
|
"limit": {
|
|
"val_type": "json",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": {
|
|
"count": {
|
|
"val_type": "integer",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "The number of results to which to limit."
|
|
},
|
|
"order": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
],
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Direction of sort."
|
|
}
|
|
},
|
|
"inner_properties": null,
|
|
"description": "Message for specifying limits to the number of values returned by a query.\nThis limit is only for scalar queries and has no effect on timeseries queries."
|
|
}
|
|
},
|
|
"description": "List of formulas to be calculated and returned as responses."
|
|
},
|
|
"from": {
|
|
"val_type": "integer",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Start date (inclusive) of the query in milliseconds since the Unix epoch."
|
|
},
|
|
"queries": {
|
|
"val_type": "array",
|
|
"inner_val_type": "json",
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": {},
|
|
"description": "List of queries to be run and used as inputs to the formulas."
|
|
},
|
|
"to": {
|
|
"val_type": "integer",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "End date (exclusive) of the query in milliseconds since the Unix epoch."
|
|
}
|
|
},
|
|
"inner_properties": null,
|
|
"description": "The object describing a scalar formula request."
|
|
},
|
|
"type": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": [
|
|
"scalar_request"
|
|
],
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "The type of the resource. The value should always be scalar_request."
|
|
}
|
|
},
|
|
"inner_properties": null,
|
|
"description": "A single scalar query to be executed."
|
|
}
|
|
},
|
|
"inner_properties": null,
|
|
"description": ""
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "requestBody"
|
|
}
|
|
]
|
|
},
|
|
"output": {
|
|
"description": "Response from the API endpoint 'QueryScalarData'.",
|
|
"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": "DATADOG_API_KEY"
|
|
},
|
|
{
|
|
"key": "DATADOG_APPLICATION_KEY"
|
|
},
|
|
{
|
|
"key": "DATADOG_BASE_URL"
|
|
}
|
|
],
|
|
"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": "https://{datadog_base_url}/api/v2/query/scalar",
|
|
"http_method": "POST",
|
|
"headers": {},
|
|
"parameters": [
|
|
{
|
|
"name": "requestBody",
|
|
"tool_parameter_name": "scalar_query_request",
|
|
"description": "",
|
|
"value_schema": {
|
|
"val_type": "json",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": {
|
|
"data": {
|
|
"val_type": "json",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": {
|
|
"attributes": {
|
|
"val_type": "json",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": {
|
|
"formulas": {
|
|
"val_type": "array",
|
|
"inner_val_type": "json",
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": {
|
|
"formula": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Formula string, referencing one or more queries with their name property."
|
|
},
|
|
"limit": {
|
|
"val_type": "json",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": {
|
|
"count": {
|
|
"val_type": "integer",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "The number of results to which to limit."
|
|
},
|
|
"order": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
],
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Direction of sort."
|
|
}
|
|
},
|
|
"inner_properties": null,
|
|
"description": "Message for specifying limits to the number of values returned by a query.\nThis limit is only for scalar queries and has no effect on timeseries queries."
|
|
}
|
|
},
|
|
"description": "List of formulas to be calculated and returned as responses."
|
|
},
|
|
"from": {
|
|
"val_type": "integer",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Start date (inclusive) of the query in milliseconds since the Unix epoch."
|
|
},
|
|
"queries": {
|
|
"val_type": "array",
|
|
"inner_val_type": "json",
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": {},
|
|
"description": "List of queries to be run and used as inputs to the formulas."
|
|
},
|
|
"to": {
|
|
"val_type": "integer",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "End date (exclusive) of the query in milliseconds since the Unix epoch."
|
|
}
|
|
},
|
|
"inner_properties": null,
|
|
"description": "The object describing a scalar formula request."
|
|
},
|
|
"type": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": [
|
|
"scalar_request"
|
|
],
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "The type of the resource. The value should always be scalar_request."
|
|
}
|
|
},
|
|
"inner_properties": null,
|
|
"description": "A single scalar query to be executed."
|
|
}
|
|
},
|
|
"inner_properties": null,
|
|
"description": ""
|
|
},
|
|
"accepted_as": "body",
|
|
"required": true,
|
|
"deprecated": false,
|
|
"default": null,
|
|
"documentation_urls": []
|
|
}
|
|
],
|
|
"documentation_urls": [],
|
|
"secrets": [
|
|
{
|
|
"arcade_key": "DATADOG_API_KEY",
|
|
"parameter_name": "DD-API-KEY",
|
|
"accepted_as": "header",
|
|
"formatted_value": null,
|
|
"description": "",
|
|
"is_auth_token": false
|
|
},
|
|
{
|
|
"arcade_key": "DATADOG_APPLICATION_KEY",
|
|
"parameter_name": "DD-APPLICATION-KEY",
|
|
"accepted_as": "header",
|
|
"formatted_value": null,
|
|
"description": "",
|
|
"is_auth_token": false
|
|
},
|
|
{
|
|
"arcade_key": "DATADOG_BASE_URL",
|
|
"parameter_name": "datadog_base_url",
|
|
"accepted_as": "path",
|
|
"formatted_value": null,
|
|
"description": "",
|
|
"is_auth_token": false
|
|
}
|
|
],
|
|
"request_body_spec": "{\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"description\": \"A wrapper request around one scalar query to be executed.\",\n \"properties\": {\n \"data\": {\n \"description\": \"A single scalar query to be executed.\",\n \"properties\": {\n \"attributes\": {\n \"description\": \"The object describing a scalar formula request.\",\n \"properties\": {\n \"formulas\": {\n \"description\": \"List of formulas to be calculated and returned as responses.\",\n \"items\": {\n \"description\": \"A formula for calculation based on one or more queries.\",\n \"properties\": {\n \"formula\": {\n \"description\": \"Formula string, referencing one or more queries with their name property.\",\n \"example\": \"a+b\",\n \"type\": \"string\"\n },\n \"limit\": {\n \"description\": \"Message for specifying limits to the number of values returned by a query.\\nThis limit is only for scalar queries and has no effect on timeseries queries.\",\n \"properties\": {\n \"count\": {\n \"description\": \"The number of results to which to limit.\",\n \"example\": 10,\n \"format\": \"int32\",\n \"maximum\": 2147483647,\n \"type\": \"integer\"\n },\n \"order\": {\n \"default\": \"desc\",\n \"description\": \"Direction of sort.\",\n \"enum\": [\n \"asc\",\n \"desc\"\n ],\n \"type\": \"string\",\n \"x-enum-varnames\": [\n \"ASC\",\n \"DESC\"\n ]\n }\n },\n \"type\": \"object\"\n }\n },\n \"required\": [\n \"formula\"\n ],\n \"type\": \"object\"\n },\n \"type\": \"array\"\n },\n \"from\": {\n \"description\": \"Start date (inclusive) of the query in milliseconds since the Unix epoch.\",\n \"example\": 1568899800000,\n \"format\": \"int64\",\n \"type\": \"integer\"\n },\n \"queries\": {\n \"description\": \"List of queries to be run and used as inputs to the formulas.\",\n \"example\": [\n {\n \"aggregator\": \"avg\",\n \"data_source\": \"metrics\",\n \"query\": \"avg:system.cpu.user{*} by {env}\"\n }\n ],\n \"items\": {\n \"description\": \"An individual scalar query to one of the basic Datadog data sources.\",\n \"example\": {\n \"aggregator\": \"avg\",\n \"data_source\": \"metrics\",\n \"query\": \"avg:system.cpu.user{*} by {env}\"\n },\n \"oneOf\": [\n {\n \"description\": \"An individual scalar metrics query.\",\n \"properties\": {\n \"aggregator\": {\n \"default\": \"avg\",\n \"description\": \"The type of aggregation that can be performed on metrics-based queries.\",\n \"enum\": [\n \"avg\",\n \"min\",\n \"max\",\n \"sum\",\n \"last\",\n \"percentile\",\n \"mean\",\n \"l2norm\",\n \"area\"\n ],\n \"example\": \"avg\",\n \"type\": \"string\",\n \"x-enum-varnames\": [\n \"AVG\",\n \"MIN\",\n \"MAX\",\n \"SUM\",\n \"LAST\",\n \"PERCENTILE\",\n \"MEAN\",\n \"L2NORM\",\n \"AREA\"\n ]\n },\n \"data_source\": {\n \"default\": \"metrics\",\n \"description\": \"A data source that is powered by the Metrics platform.\",\n \"enum\": [\n \"metrics\",\n \"cloud_cost\"\n ],\n \"example\": \"metrics\",\n \"type\": \"string\",\n \"x-enum-varnames\": [\n \"METRICS\",\n \"CLOUD_COST\"\n ]\n },\n \"name\": {\n \"description\": \"The variable name for use in formulas.\",\n \"type\": \"string\"\n },\n \"query\": {\n \"description\": \"A classic metrics query string.\",\n \"example\": \"avg:system.cpu.user{*} by {env}\",\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"data_source\",\n \"query\",\n \"aggregator\"\n ],\n \"type\": \"object\"\n },\n {\n \"description\": \"An individual scalar events query.\",\n \"properties\": {\n \"compute\": {\n \"description\": \"The instructions for what to compute for this query.\",\n \"properties\": {\n \"aggregation\": {\n \"default\": \"count\",\n \"description\": \"The type of aggregation that can be performed on events-based queries.\",\n \"enum\": [\n \"count\",\n \"cardinality\",\n \"pc75\",\n \"pc90\",\n \"pc95\",\n \"pc98\",\n \"pc99\",\n \"sum\",\n \"min\",\n \"max\",\n \"avg\"\n ],\n \"example\": \"count\",\n \"type\": \"string\",\n \"x-enum-varnames\": [\n \"COUNT\",\n \"CARDINALITY\",\n \"PC75\",\n \"PC90\",\n \"PC95\",\n \"PC98\",\n \"PC99\",\n \"SUM\",\n \"MIN\",\n \"MAX\",\n \"AVG\"\n ]\n },\n \"interval\": {\n \"description\": \"Interval for compute in milliseconds.\",\n \"example\": 60000,\n \"format\": \"int64\",\n \"type\": \"integer\"\n },\n \"metric\": {\n \"description\": \"The \\\"measure\\\" attribute on which to perform the computation.\",\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"aggregation\"\n ],\n \"type\": \"object\"\n },\n \"data_source\": {\n \"default\": \"logs\",\n \"description\": \"A data source that is powered by the Events Platform.\",\n \"enum\": [\n \"logs\",\n \"rum\",\n \"dora\"\n ],\n \"example\": \"logs\",\n \"type\": \"string\",\n \"x-enum-varnames\": [\n \"LOGS\",\n \"RUM\",\n \"DORA\"\n ]\n },\n \"group_by\": {\n \"description\": \"The list of facets on which to split results.\",\n \"items\": {\n \"description\": \"A dimension on which to split a query's results.\",\n \"properties\": {\n \"facet\": {\n \"description\": \"The facet by which to split groups.\",\n \"example\": \"@error.type\",\n \"type\": \"string\"\n },\n \"limit\": {\n \"default\": 10,\n \"description\": \"The maximum buckets to return for this group by. Note: at most 10000 buckets are allowed.\\nIf grouping by multiple facets, the product of limits must not exceed 10000.\",\n \"example\": 10,\n \"format\": \"int32\",\n \"maximum\": 10000,\n \"type\": \"integer\"\n },\n \"sort\": {\n \"description\": \"The dimension by which to sort a query's results.\",\n \"properties\": {\n \"aggregation\": {\n \"default\": \"count\",\n \"description\": \"The type of aggregation that can be performed on events-based queries.\",\n \"enum\": [\n \"count\",\n \"cardinality\",\n \"pc75\",\n \"pc90\",\n \"pc95\",\n \"pc98\",\n \"pc99\",\n \"sum\",\n \"min\",\n \"max\",\n \"avg\"\n ],\n \"example\": \"count\",\n \"type\": \"string\",\n \"x-enum-varnames\": [\n \"COUNT\",\n \"CARDINALITY\",\n \"PC75\",\n \"PC90\",\n \"PC95\",\n \"PC98\",\n \"PC99\",\n \"SUM\",\n \"MIN\",\n \"MAX\",\n \"AVG\"\n ]\n },\n \"metric\": {\n \"description\": \"The metric's calculated value which should be used to define the sort order of a query's results.\",\n \"example\": \"@duration\",\n \"type\": \"string\"\n },\n \"order\": {\n \"default\": \"desc\",\n \"description\": \"Direction of sort.\",\n \"enum\": [\n \"asc\",\n \"desc\"\n ],\n \"type\": \"string\",\n \"x-enum-varnames\": [\n \"ASC\",\n \"DESC\"\n ]\n },\n \"type\": {\n \"description\": \"The type of sort to use on the calculated value.\",\n \"enum\": [\n \"alphabetical\",\n \"measure\"\n ],\n \"type\": \"string\",\n \"x-enum-varnames\": [\n \"ALPHABETICAL\",\n \"MEASURE\"\n ]\n }\n },\n \"required\": [\n \"aggregation\"\n ],\n \"type\": \"object\"\n }\n },\n \"required\": [\n \"facet\"\n ],\n \"type\": \"object\"\n },\n \"type\": \"array\"\n },\n \"indexes\": {\n \"description\": \"The indexes in which to search.\",\n \"example\": [\n \"main\"\n ],\n \"items\": {\n \"description\": \"The unique index name.\",\n \"example\": \"main\",\n \"type\": \"string\"\n },\n \"type\": \"array\"\n },\n \"name\": {\n \"description\": \"The variable name for use in formulas.\",\n \"type\": \"string\"\n },\n \"search\": {\n \"description\": \"Configuration of the search/filter for an events query.\",\n \"properties\": {\n \"query\": {\n \"description\": \"The search/filter string for an events query.\",\n \"example\": \"status:warn service:foo\",\n \"type\": \"string\"\n }\n },\n \"type\": \"object\"\n }\n },\n \"required\": [\n \"data_source\",\n \"compute\"\n ],\n \"type\": \"object\"\n }\n ]\n },\n \"type\": \"array\"\n },\n \"to\": {\n \"description\": \"End date (exclusive) of the query in milliseconds since the Unix epoch.\",\n \"example\": 1568923200000,\n \"format\": \"int64\",\n \"type\": \"integer\"\n }\n },\n \"required\": [\n \"to\",\n \"from\",\n \"queries\"\n ],\n \"type\": \"object\"\n },\n \"type\": {\n \"default\": \"scalar_request\",\n \"description\": \"The type of the resource. The value should always be scalar_request.\",\n \"enum\": [\n \"scalar_request\"\n ],\n \"example\": \"scalar_request\",\n \"type\": \"string\",\n \"x-enum-varnames\": [\n \"SCALAR_REQUEST\"\n ]\n }\n },\n \"required\": [\n \"type\",\n \"attributes\"\n ],\n \"type\": \"object\"\n }\n },\n \"required\": [\n \"data\"\n ],\n \"type\": \"object\"\n }\n }\n },\n \"required\": true\n}",
|
|
"use_request_body_schema_mode": true,
|
|
"validate_request_body_schema": true
|
|
}
|
|
}
|