GET   events?message={message}&severity={severity}&check_id={check_id}&timestamp_utc_from={timestamp_utc_from}&timestamp_utc_to={timestamp_utc_to}&milliseconds_utc_from={milliseconds_utc_from}&milliseconds_utc_to={milliseconds_utc_to}&include_tag_op={include_tag_op}

Gets a list of events for the current user.

URL Parameters

NameDescription
message

Message filter.

severity

Severity filter. Allowed any combination of values: I, W, E, F. Example: IFE.

check_id

Check identifier filter.

include_tag

Check tag filter to include in the response (see the Filtering by Tags section in Remarks for details).

exclude_tag

Check tag filter to exclude from the response (see the Filtering by Tags section in Remarks for details).

timestamp_utc_from

Timestamp in UTC format. Example: 2013-08-20T13:32:08.

timestamp_utc_to

Timestamp in UTC format. Example: 2013-08-20T13:32:08.

milliseconds_utc_from

Timestamp represented as a UNIX Epoch timestamp (millisecs after 1970). Type: numeric. Example: 1376980667000.

milliseconds_utc_to

Timestamp represented as a UNIX Epoch timestamp (millisecs after 1970). Type: numeric. Example: 1376980667000.

include_tag_op

AND/OR mode for including tags. Allowed values: 'or', 'and'. Default value: 'or'.

Remarks

Filtering by Tags

Events can be filtered on the check 'tags', using tag 'key' and/or 'value'. Tilde '~' is used to indicate values. Multiple values are separated with semicolon ';'. Example: Environment~Dev;Prod (Key: 'Environment', Values: 'Dev' and 'Prod').

You can provide the tag key only (all checks with that key) or only the value (all checks with that value in any key). Examples: Environment (key); ~Dev (value).

You can use the tag or key ID, by adding a '.' (period) before the ID. Examples: .4568~Prod (Tag key ID:'4568', value 'Prod'); Environment~.6985 (Tag key: 'Environment', value ID:'6985').

Request example

curl --request GET "https://api-asm1.apica.io/v3/events?message=apica&include_tag=Environment~Dev;Prod&exclude_tag=Environment~Beta&severity=I&check_id=12345&milliseconds_utc_from=1376980667000&milliseconds_utc_to=1376980667000&auth_ticket=C471ADC4-19B4-4219-BBF4-671A97EC653E"

Response body model example and description

[
  {
    "check_symbol": "sample string 1",
    "event_type": "CheckEvent",
    "check_id": 2,
    "check_descriptor": "sample string 3",
    "severity": "I",
    "event_message": "sample string 4",
    "time_stamp_utc": "2024-05-19T11:52:31",
    "event_age_seconds": 1
  },
  {
    "check_symbol": "sample string 1",
    "event_type": "CheckEvent",
    "check_id": 2,
    "check_descriptor": "sample string 3",
    "severity": "I",
    "event_message": "sample string 4",
    "time_stamp_utc": "2024-05-19T11:52:31",
    "event_age_seconds": 1
  },
  {
    "check_symbol": "sample string 1",
    "event_type": "CheckEvent",
    "check_id": 2,
    "check_descriptor": "sample string 3",
    "severity": "I",
    "event_message": "sample string 4",
    "time_stamp_utc": "2024-05-19T11:52:31",
    "event_age_seconds": 1
  }
]
NameType Description
check_symbol String

The symbolic identifier for the check for which the event was issued.

event_type String

The indicator that takes values of "CheckEvent" or "CustomEvent" depending of event type.

check_id Integer

The numeric identifier for the check for which the event was issued.

check_descriptor String

The descriptive name of the check for which the event was issued.

severity String

The severity (I=Information, W=Warning, E=Error, F=Fatal).

event_message String

The event message.

time_stamp_utc DateTime

The time at which the event was issued.

event_age_seconds Integer

Number of seconds since the event was issued.