EventDistinctQuery

Query event distinct field values

Query the API for a list of distinct values for a field

Sample Request

curl -X POST 'https://api.jumpcloud.com/insights/directory/v1/events/distinct' -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", "sort": "DESC", "field": "event_type"}'

post/events/distinct

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/distinct/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

exclude_provider_activityboolean

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

fieldstring required

field is what they wish to query on

Response

List of distinct field values

doc_count_error_upper_boundinteger

sum_other_doc_countinteger

Changes

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