POST: /metadata/key-suggest

Search for key suggestions. This endpoint is intended for use with auto-completion.

application/json

Structure
Field Type Purpose
key  <string> Key to help limit down suggestions, this is a free text value that is analyzed by the search engine.
filter  Filter Filter to apply
range  QueryDateRange The time range for which to get suggestions.
limit  <number> The time range for which to get suggestions.
match  MatchOptions Temporary match options to apply, only used for experiments.

Example Request


          {
  "key": "foo",
  "filter": ["=", "role", "heroic"],
  "limit": 10
}

      

Example Curl


          $ curl -XPOST -H "Content-Type: application/json" http://localhost:8080/metadata/key-suggest \
          -d '{ "key": "foo", "filter": ["=", "role", "heroic"], "limit": 10 }'
      

Example 200 Response

Status: 200, Content-Type: application/json

Structure
Field Type Purpose
errors  [RequestError, ...] Errors that occured during the request.
suggestions  required [{score: <number>, key: <string>}, ...] Suggest key values with scores.

          {
  "errors": [],
  "suggestions": [
    {"score": 1.5, "key": "foobar"},
    {"score": 0.9, "key": "folly"}
  ]
}