/api/search

    Note

    If the plugin is not configured or enabled, endpoints other than /api/search/lookup will return an exception.

    Verbs

    • GET

    • POST

    Requests

    Parameters used by the search endpoint include:

    Query String:

    POST:

    1. {
    2.     "query": "name:*",
    3.     "limit": 4,
    4.     "startIndex": 5
    5. }

    Depending on the endpoint called, the output will change slightly. However common fields include:

    Name

    Data Type

    Description

    Example

    type

    String

    The type of query submitted, i.e. the endpoint called. Will be one of the endpoints listed above.

    TSMETA

    query

    String

    name:sys.cpu.*

    limit

    Integer

    The maximum number of items returned in the result set. Note that the actual number returned may be less than the limit.

    25

    startIndex

    Integer

    The starting index for the current result set as provided in the query

    0

    metric

    String

    The metric used for the lookup

    tags

    Array

    The list of tag pairs used for lookup queries. May be an empty list.

    [ ]

    time

    Integer

    The amount of time it took, in milliseconds, to complete the query

    120

    totalResults

    Integer

    The total number of results matched by the query

    1024

    results

    Array

    The result set. The format depends on the endpoint requested.

    See Below

    This endpoint will almost always return a 200 with content body. If the query doesn’t match any results, the results field will be an empty array and totalResults will be 0. If an error occurs, such as the plugin being disabled or not configured, an exception will be returned.

    TSMETA Response

    The TSMeta endpoint returns a list of matching TSMeta objects.

    TSMETA_SUMMARY Response

    The TSMeta Summary endpoint returns just the basic information associated with a timeseries including the TSUID, the metric name and tags. The search is run against the same index as the TSMeta query but returns a subset of the data.

    1. {
    2.     "type": "TSMETA_SUMMARY",
    3.     "query": "name:*",
    4.     "metric": "*",
    5.     "tags": [],
    6.     "limit": 3,
    7.     "time": 565,
    8.     "results": [
    9.             "tags": {
    10.                 "fqdn": "web01.mysite.com"
    11.             },
    12.             "metric": "app.apache.connections",
    13.             "tsuid": "0000150000070010D0"
    14.         },
    15.         {
    16.             "tags": {
    18.             },
    19.             "metric": "app.apache.connections",
    20.             "tsuid": "0000150000070010D5"
    21.         },
    22.         {
    23.             "tags": {
    24.                 "fqdn": "web03.mysite.com"
    25.             },
    26.             "metric": "app.apache.connections",
    27.             "tsuid": "0000150000070010D6"
    28.         }
    29.     ],
    30.     "startIndex": 0,
    31.     "totalResults": 9688066
    32. }

    The TSUIDs endpoint returns a list of TSUIDS that match the query. The search is run against the same index as the TSMeta query but returns a subset of the data.

    UIDMETA Response

    1. {
    2.     "type": "UIDMETA",
    3.     "query": "name:*",
    4.     "metric": "*",
    5.     "tags": [],
    6.     "limit": 3,
    7.     "time": 517,
    8.     "results": [
    9.             "uid": "000007",
    10.             "type": "TAGK",
    11.             "name": "fqdn",
    13.             "notes": "",
    14.             "created": 1362655264,
    15.             "custom": null,
    16.             "displayName": ""
    17.         },
    18.         {
    19.             "uid": "0010D0",
    20.             "type": "TAGV",
    21.             "name": "web01.mysite.com",
    22.             "description": "",
    23.             "notes": "",
    24.             "created": 1362720007,
    25.             "custom": null,
    26.             "displayName": ""
    27.         },
    28.         {
    29.             "uid": "0010D5",
    30.             "type": "TAGV",
    31.             "name": "web02.mysite.com",
    32.             "description": "",
    33.             "notes": "",
    34.             "created": 1362720007,
    35.             "custom": null,
    36.             "displayName": ""
    37.         }
    38.     ],
    39.     "startIndex": 0,

    Annotation Response

    The Annotation endpoint returns a list of Annotation objects that match the query.