Request path and method
Path | Method | Description |
---|---|---|
/api/suggest | POST | Queries the Metric, TagKey, and TagValue. |
Request parameters
Name | Type | Required | Description | Default value | Example |
---|---|---|---|---|---|
type | String | Yes | Type to be queried. Options: metrics, TagKey, and TagValue | None | metrics |
q | String | No | Prefix filtering | None | my_ |
max | Integer | No | Maximum number of returned results | 25 | 4 |
Request JSON example
Job: Query four indexes prefixed by “my”.
Request: POST/api/suggest
Body:
{
"type": "metrics",
"q": "my_",
"max": 4
}
Response description
The response is the queried string array:
[ "my_metric1", "my_metric2", "my_metric3", "my_metric4" ]