GET custom_events/all?checkId={checkId}&fromUtc={fromUtc}&toUtc={toUtc}&fromMillisecondsUtc={fromMillisecondsUtc}&toMillisecondsUtc={toMillisecondsUtc}&include_tag_op={include_tag_op}

Gets all custom events using optional filter.

URL Parameters

Name	Description
checkId	Check identifier filter.
includeTag	Check tag filter to include in the response (see the Filtering by Tags section in Remarks for details).
excludeTag	Check tag filter to exclude from the response (see the Filtering by Tags section in Remarks for details).
fromUtc	Timestamp in UTC format. Example: 2013-08-20T13:32:08.
toUtc	Timestamp in UTC format. Example: 2013-09-20T13:32:08.
fromMillisecondsUtc	Timestamp represented as a UNIX Epoch timestamp (millisecs after 1970). Type: numeric. Example: 1376980667000.
toMillisecondsUtc	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 "http://api-wpm2.apicasystem.com/v3/custom_events/all?checkId=12345&includeTag=Environment~Dev;Prod&excludeTag=Environment~Beta&fromMillisecondsUtc=1376980667000&toMillisecondsUtc=1376980667000&auth_ticket=C471ADC4-19B4-4219-BBF4-671A97EC653E"

Response body model example and description

[
  {
    "id": 155,
    "name": "Event name.",
    "description": "Test event.",
    "from_utc": "2015-09-12T11:44:02.546",
    "to_utc": "2015-09-12T11:44:02.546",
    "severity": "F",
    "is_all_check": true,
    "checks": [
      12345,
      678,
      234234
    ]
  },
  {
    "id": 155,
    "name": "Event name.",
    "description": "Test event.",
    "from_utc": "2015-09-12T11:44:02.546",
    "to_utc": "2015-09-12T11:44:02.546",
    "severity": "F",
    "is_all_check": true,
    "checks": [
      12345,
      678,
      234234
    ]
  },
  {
    "id": 155,
    "name": "Event name.",
    "description": "Test event.",
    "from_utc": "2015-09-12T11:44:02.546",
    "to_utc": "2015-09-12T11:44:02.546",
    "severity": "E",
    "is_all_check": true,
    "checks": [
      12345,
      678,
      234234
    ]
  }
]

Name	Type	Description
id	Integer	The event's numeric identity.
name	String	The event's name.
description	String	The event's description.
from_utc	DateTime	The event's start timestamp.
to_utc	DateTime	The event's end timestamp.
severity	String	The event's severity.
is_all_check	Boolean	The event for all checks.
checks	Array	The event's checks list.