Search Report Event Entities

Search over a customer's events

Request

URI

POST

https://{api_host}/api/v2/search/event

COPY

Request Body

EventSearchRequest of type(s) application/json

Optional

{
    "cursor": "string",
    "limit": 100,
    "query": [
        {
            "key": "string",
            "value": "string",
            "values": [
                "string"
            ],
            "matchingMethod": "string",
            "negated": false,
            "start": 0,
            "end": 0
        }
    ],
    "timeRange": {
        "earliestStartTimeEpochMillis": 0,
        "latestStartTimeEpochMillis": 0
    },
    "relatedEventTimeRange": {
        "earliestStartTimeEpochMillis": 0,
        "latestStartTimeEpochMillis": 0
    },
    "sortTimeAscending": false,
    "sortScoreMethod": "string"
}

string

cursor

Optional

The id (exclusive) from which search results resume returning. Users should supply an entity 'id' to this property. Its main purpose is to resume where a previous search left off because of the 'limit' parameter. If a user supplies the last id in a set of results to cursor, while keeping the query the same, the system will return the next page of results

integer As int32 As int32

limit

Optional

The number of results to return. Default: 100

array of SearchQuery

query

Optional

A list of queries by which to limit the search results

EventTimeRange

timeRange

Optional

timeRange

RelatedEventTimeRange

relatedEventTimeRange

Optional

relatedEventTimeRange

boolean

sortTimeAscending

Optional

Whether to sort event results ascending in start time. Default: false

string

sortScoreMethod

Optional

Whether to sort events on similarity score : {NONE, SCORE_ASC, SCORE_DES}. Default: NONE. If sortScoreMethod is set to SCORE_ASC or SCORE_DES, it will override time sort

Possible values are : SCORE_ASC, SCORE_DES, NONE,

Authentication

This operation uses the following authentication methods.

api_key

Responses

200

successful operation

Returns ResponseContainerPagedEvent of type(s) application/json

{
    "status": {
        "result": "string",
        "message": "string",
        "code": 0
    },
    "response": {
        "items": [
            {
                "computedHlps": [
                    {
                        "severity": "string",
                        "host": "string",
                        "startTime": 0,
                        "label": "string",
                        "observed": 0,
                        "firing": 0
                    }
                ],
                "table": "string",
                "name": "string",
                "id": "string",
                "startTime": 0,
                "endTime": 0,
                "createdEpochMillis": 0,
                "updatedEpochMillis": 0,
                "tags": [
                    "string"
                ],
                "metricsUsed": [
                    "string"
                ],
                "createdAt": 0,
                "hosts": [
                    "string"
                ],
                "summarizedEvents": 0,
                "alertTags": [
                    "string"
                ],
                "isUserEvent": false,
                "isEphemeral": false,
                "creatorId": "string",
                "updaterId": "string",
                "updatedAt": 0,
                "runningState": "string",
                "canDelete": false,
                "canClose": false,
                "creatorType": [
                    "string"
                ]
            }
        ],
        "offset": 0,
        "limit": 0,
        "cursor": "string",
        "totalItems": 0,
        "moreItems": false,
        "sort": {
            "ascending": false,
            "field": "string",
            "default": false
        }
    }
}

ResponseStatus

status

Required

status

PagedEvent

response

Optional

response

On This Page

Description

Request

Request Body

Authentication

Response

200 Response Body

Search Operations