JUjumpcloud
EventQuery

Count Events

Changed on

Query the API for a count of matching events

Sample Request

curl -X POST 'https://api.jumpcloud.com/insights/directory/v1/events/count' -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", "fields": ["timestamp", "event_type", "initiated_by", "success", "client_ip", "provider", "organization"]}'
post/events/count

Request

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.

fieldsstring[]

optional list of fields to return from query

limitinteger

Max number of rows to return

qstring

optional string for specifying a full text query

search_afterobject[]

Specific query to search after, see x-* response headers for next values

skipinteger

optional offset into the result set to start with when returning

sortstring

ASC or DESC order for timestamp

Response

Count of matching event rows

countinteger

Changes

  • 17eea0b00afbRevision changes
    • breaking

      added required request body

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status