WHERE DO I START?
You are here:... (Miscellaneous) > API > Events > Getting Event Data
  • Top ↑

Events - Getting Event Data

The events API allows you to consume events generated by Netuitive. You can either grab a list of events generated by Netuitive or grab an individual event by its ID.

Tip   To explore Netuitive's REST API and test some requests, go here.

Get a list of events

This method will return a list of events filtered by any parameters you pass into the method call.

Method GET URL https://api.app.netuitive.com/events
Parameters Required/Optional Description
duration Optional Query parameter. Gives Netuitive an ISO 8601-formatted duration time frame to retrieve data. The duration ends at the current time and begins anytime in the past two weeks. The duration parameter will take precedence over startTime and endTime if all attributes are included in your request.
startTime Optional Query parameter. The start of the window of time from which events will be returned. The startTime must be in ISO 8601 format. The default startTime is 12:00 AM in the authenticating user's specified time zone.
endTime Optional Query parameter. The end of the window of time from which events will be returned. The endTime must be in ISO 8601 format. The default endTime is the current time.
category Optional Query parameter. Array of categories assigned to the desired events.
elementId Optional Query parameter. Array of element IDs to which the desired events are associated.
elementName Optional Query parameter. Array of element names to which the desired events are associated.
elementType Optional Query parameter. Array of element types to which the desired events are associated.
elementTags Optional Query parameter. JSON-encoded map of element tags to which the desired events are associated.
policy Optional Query parameter. Array of Policy IDs to which the desired events are associated.
isExternal Optional Query parameter. Whether the event is external or not.
title Optional Query parameter. The title of the event.
type Optional Query parameter. The type of event.

Input JSON Format for Request Header

Header Name Header Value
Content-Type application/json
Authorization: Basic (Base64 encoded authentication value)

Delete events created by a policy

This method will delete events created by a policy.

Method DELETE URL https://api.app.netuitive.com/events/delete/policy/{policyId}
Important   Replace {policyId} in the above URL with the Policy ID from any of your policies.
Parameters Required/Optional Description
policyId Required URL (path) parameter. The ID of the policy.

Input JSON Format for Request Header

Header Name Header Value
Content-Type application/json
Authorization: Basic (Base64 encoded authentication value)

Get an event by ID

This method will return an event based on the ID you pass into the URL.

Method GET URL https://api.app.netuitive.com/events/{eventId}
Important   Replace {eventId} in the above URL with the event ID from any of your events.
Parameters Required/Optional Description
eventId required URL (path) parameter. Your event ID.

Input JSON Format for Request Header

Header Name Header Value
Content-Type application/json
Authorization: Basic (Base64 encoded authentication value)