Dimension

Dimension search returns a list of possible values for one dimension (property).

It is used for text properties, not for date or timestamp properties.

Call

Call the service at dhinstance/seach/dimension, passing input parameters in the POST body.

Using curl as an example:

curl -X POST -H "Content-Type: application/json" --data @dimension.json "dhinstance/search/dimension"

The call with also require an authorization header to identify the instance user, who is then used as the instance uuid.

See Data loads for a definition of dhinstance.

Input

{
  "dimension_reference": "dimensionReference",
  "value": "value"
}

The dimension reference identifies the dimension, which match the properties held in Insight Hub indexes. Available properties are listed in Index properties.

Value is optional. If passed, it is used to select values that contain the passed-in value, ignoring punctuation and case.

Output

{
  "values": [
    {
      "value": "value",
      "display": "display"
    }, ...
  ]
}

The response is a JSON object. The values property is an array of objects. Each object represents a possible value of the dimension, and has: