EventIntervalQuery

Query event counts by bucketed by a time interval

Query the API for a list of counts by time interval

Sample Request

curl -X POST 'https://api.jumpcloud.com/insights/directory/v1/events/interval' -H 'Content-Type: application/json' -H 'x-api-key: REPLACE_KEY_VALUE' --data '{"service": ["all"], "start_time": "2021-07-14T23:00:00Z", "end_time": "2021-07-28T14:00:00Z", "timezone": "-0500", "interval_unit": "h", "interval_value": "2"}'

post/events/interval

Request

Base URL
https://api.jumpcloud.com/insights/directory/v1
Auth
API key in header x-api-key and API key in header x-org-id
TypeScript
https://skmtc.dev/jumpcloud/apis/directory-insights-api/docs/events/interval/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

end_timestring date-time

optional query end time, UTC in RFC3339 format

servicestring[] required

service name to query.

start_timestring date-time required

query start time, UTC in RFC3339 format

exact_matchstring

optional string for specifying exact match query, do not use with full text query

exclude_provider_activityboolean

When true, exclude provider-level events and return only child organization activity.

interval_unit's' | 'm' | 'h' | 'd' | 'w' required

interval_valuestring

Interval Value. This specifies how many units you want to bucket the event counts by

qstring

optional string for specifying a full text query

timezonestring

TimeZone. Specify the timezone in which the user is in optional

Response

List of bucketed event counts

Changes

No recorded changes to this operation across all 1 revision of this API.