Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[R225] Add description/example for eventTypeFilters param #41

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions spec/descriptions/getEvents.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ This endpoint retrieves all available events for the requested timeframe.
- **excludeTriggeredBefore:** Whether to exclude events that have been triggered before the requested timeframe in order to enable searching for events that have started within the given timeframe, excluding events that are previously active already. This is useful for 3rd party integrations that fetch events from Instana with a scheduled batch job in a fixed interval using tumbling windows, when you only care about new events.
This option is more restrictive than `filterEventUpdates` and does not inform about event state updates that got `CLOSED` in the timeframe of the query if not also the start time of the event is within that query timeframe.
- **filterEventUpdates:** Filters results to event updates only. This means that an event is only included when its event state changed in the given query timeframe. This is useful for 3rd party integrations that fetch events from Instana with a scheduled batch job in a fixed interval using a tumbling windows, when you care about event state updates.
- **eventTypeFilters:** Filters results to the specified event type(s), such as `incident`, `issue` or `change`. By default, events of any type are returned.

### Examples

Expand All @@ -24,3 +25,10 @@ Fetch all events that have been opened or closed within the last minute, using a
TO_MILLIS=$((($(date +%s) - 120) * 1000)) curl --request GET "https://<Host>/api/events?windowSize=60000&to=$TO_MILLIS&filterEventUpdates=true" \
--header 'Authorization: apiToken <Token>'
```

Fetch all incidents and issues which duration overlaps with the last 10 minutes.

```bash
curl --request GET 'https://<Host>/api/events?eventTypeFilters=incident&eventTypeFilters=issue' \
--header 'Authorization: apiToken <Token>'
```