events.get.response

events.get.response
events.get.response
JSON Example
{
    "events": [
        {
            "text": "string",
            "timestamp": 0,
            "timestampString": "string",
            "fields": [
                {
                    "name": "string",
                    "content": "string",
                    "startPosition": 0,
                    "length": 0
                }
            ]
        }
    ],
    "results": [
        {
            "text": "string",
            "timestamp": 0,
            "timestampString": "string"
        }
    ],
    "complete": false,
    "duration": "number",
    "warnings": [
        {
            "id": "number",
            "details": "string",
            "progress": "number"
        }
    ]
}
array of object
events
Optional

Lists events that match the query. Present when view=DEFAULT

array of object
results
Optional

List of events in a simple flat map format. Present when view=SIMPLE

boolean
complete
Required

Indicates whether all matching events were returned (true), or if only some of them where, because the timeout expired (false). See also 'warnings'.

number
duration
Optional

The time required to compute the results, in milliseconds.

array of object
warnings
Optional

A list of problems that were encountered while processing the query. Present if 'complete' is false.