Events

Events search returns events that match a list of search criteria.

Call

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

Using curl as an example:

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

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

{
  "instance_uuid": "instanceUUID",
  "filters": [
    {
      "dimension_reference": "textRef",
      "dimension_type": "text",
      "value": "value"
    },
    {
      "dimension_reference": "dateRef",
      "dimension_type": "dateRange",
      "from": "yyyy-mm-dd",
      "to": "yyyy-mm-dd"
    }, ...
  ],
  "include_worker": true|false
}

The properties of the filter depend on the type of the dimension. For text dimensions, a value match is used. These values should match the value properties returned from the Dimension search, i.e. be normalized. For date dimensions, a from and to date are used. to is inclusive (i.e. the last date), and from and to are both optional.

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

Workers are only returned if include_worker is true.

Output

{
  "results": [
    {
      "event_timestamp": "yyyy-mm-ddThh:mm:ss.ttt",
      ..., 
      "worker": {
        "worker_uuid": "uuid",
        ...
      }
    }, ... more documents ...
  ]
}

The response is a JSON object. The results property is an array of objects. Each object represents an event and associated worker. See Event data and Worker data for details.