Core

get
Authorizations
AuthorizationstringRequired
Query parameters
timestamp__lteanyOptional

timestamp__lte

timestamp__gteanyOptional

timestamp__gte

identityanyOptional

identity

data_sourceanyOptional

data_source

actoranyOptional

actor

locationanyOptional

location

labelsanyOptional

labels

cursoranyOptional

The pagination cursor value.

page_sizeanyOptional

Number of results to return per page.

filter_uuidanyOptional

UUID of filter to apply to results.

Responses
200Success
application/json
nextstring · uriOptional
previousstring · uriOptional
get
/core/activity/
200Success
get

View to return first and last activity timestamps.

Authorizations
AuthorizationstringRequired
Responses
200Success
application/json
get
/core/activity/first_last/
200Success
get

Provides a view returning a list of actors with activity count intervals corresponding to the time range and interval count requested.

Authorizations
AuthorizationstringRequired
Query parameters
timestamp__lteanyOptional

timestamp__lte

timestamp__gteanyOptional

timestamp__gte

interval_countanyOptional

interval_count

pageanyOptional

A page number within the paginated result set.

page_sizeanyOptional

Number of results to return per page.

filter_uuidanyOptional

UUID of filter to apply to results.

Responses
200Success
application/json
countintegerRequired
interval_durationnumberOptional
get
/core/activity/statistics/actor/
200Success
get

Provides a view returning overall activity stats for an organization or datasource. Used primarily for populated brush timeline data.

Authorizations
AuthorizationstringRequired
Query parameters
timestamp__lteanyOptional

timestamp__lte

timestamp__gteanyOptional

timestamp__gte

interval_countanyOptional

interval_count

pageanyOptional

A page number within the paginated result set.

page_sizeanyOptional

Number of results to return per page.

Responses
200Success
application/json
countintegerRequired
interval_durationnumberOptional
get
/core/activity/statistics/combined/
200Success
get

Provides a view of activity statistics aggreagted by datasource.

Authorizations
AuthorizationstringRequired
Query parameters
timestamp__lteanyOptional

timestamp__lte

timestamp__gteanyOptional

timestamp__gte

interval_countanyOptional

interval_count

pageanyOptional

A page number within the paginated result set.

page_sizeanyOptional

Number of results to return per page.

Responses
200Success
application/json
countintegerRequired
interval_durationnumberOptional
get
/core/activity/statistics/datasource/
200Success
get

View for returning activity counts by label, bucketed by data source.

Authorizations
AuthorizationstringRequired
Query parameters
timestamp__lteanyOptional

timestamp__lte

timestamp__gteanyOptional

timestamp__gte

data_sourceanyOptional

data_source

interval_countanyOptional

interval_count

pageanyOptional

A page number within the paginated result set.

page_sizeanyOptional

Number of results to return per page.

filter_uuidanyOptional

UUID of filter to apply to results.

Responses
200Success
application/json
countintegerRequired
interval_durationnumberOptional
get
/core/activity/statistics/label/
200Success
get

Provides a view returning a list of locations with activity count intervals corresponding to the time range and interval count requested.

Authorizations
AuthorizationstringRequired
Query parameters
timestamp__lteanyOptional

timestamp__lte

timestamp__gteanyOptional

timestamp__gte

interval_countanyOptional

interval_count

pageanyOptional

A page number within the paginated result set.

page_sizeanyOptional

Number of results to return per page.

Responses
200Success
application/json
countintegerRequired
interval_durationnumberOptional
get
/core/activity/statistics/location/
200Success
get
Authorizations
AuthorizationstringRequired
Path parameters
uuidanyRequired
Responses
200Success
application/json
activity_uuidstring · uuidRequired
get
/core/activity/{uuid}/raw/
200Success
get
Authorizations
AuthorizationstringRequired
Path parameters
uuidanyRequired
Responses
200Success
application/json
get
/core/activity/{uuid}/raw/details/
200Success
get
Authorizations
AuthorizationstringRequired
Query parameters
orderinganyOptional

Which field to use when ordering the results.

cursoranyOptional

The pagination cursor value.

page_sizeanyOptional

Number of results to return per page.

searchanyOptional

Search string

identitiesanyOptional

Filter by identity UUIDs (comma-separated)

Responses
200Success
application/json
nextstring · uriOptional
previousstring · uriOptional
get
/core/actors/
200Success
get
Authorizations
AuthorizationstringRequired
Path parameters
uuidanyRequired
Responses
200Success
application/json
idintegerRead-onlyOptional
uuidstring · uuidRead-onlyOptional
given_namestring · max: 255Optional
family_namestring · max: 255Optional
organizationstring · uuidRequired
identitiesstring · uuid[]Read-onlyOptional
get
/core/actors/{uuid}/
200Success
get
Authorizations
AuthorizationstringRequired
Query parameters
searchanyOptional

A search term.

pageanyOptional

A page number within the paginated result set.

page_sizeanyOptional

Number of results to return per page.

min_countanyOptional

Return only event types with at least this many activities.

Responses
200Success
application/json
countintegerRequired
nextstring · uriOptional
previousstring · uriOptional
get
/core/event-type/
200Success
post
Authorizations
AuthorizationstringRequired
Body
idintegerRead-onlyOptional
uuidstring · uuidRead-onlyOptional
integration_typestring · uuidRequired
namestring · min: 1 · max: 255Required
slugstring · min: 1 · max: 255Required
discardbooleanOptional
Responses
post
/core/event-type/
201Success
get
Authorizations
AuthorizationstringRequired
Query parameters
event_typesanyOptional

Filter by event type UUIDs (comma-separated)

uuidsanyOptional

Filter by event type UUIDs (comma-separated, alternative to event_types)

pageanyOptional

A page number within the paginated result set.

Responses
200Success
application/json
countintegerRequired
nextstring · uriOptional
previousstring · uriOptional
get
/core/event-type/descriptions/
200Success
get

GET Endpoint for EventTypeDetails

Authorizations
AuthorizationstringRequired
Path parameters
event_type__uuidanyRequired
Responses
200Success
application/json
descriptionstring · min: 1Required
get
/core/event-type/{event_type__uuid}/details/
200Success
get
Authorizations
AuthorizationstringRequired
Path parameters
uuidanyRequired
Responses
200Success
application/json
idintegerRead-onlyOptional
uuidstring · uuidRead-onlyOptional
integration_typestring · uuidRequired
namestring · min: 1 · max: 255Required
slugstring · min: 1 · max: 255Required
discardbooleanOptional
get
/core/event-type/{uuid}/
200Success
get
Authorizations
AuthorizationstringRequired
Query parameters
pageanyOptional

A page number within the paginated result set.

page_sizeanyOptional

Number of results to return per page.

Responses
200Success
application/json
countintegerRequired
nextstring · uriOptional
previousstring · uriOptional
get
/core/filters/builtin/
200Success
get
Authorizations
AuthorizationstringRequired
Path parameters
uuidanyRequired
Responses
200Success
application/json
uuidstring · uuidRead-onlyOptional
highlightstring[]Optional
is_templatebooleanRead-onlyOptionalDefault: true
get
/core/filters/builtin/{uuid}/
200Success
get
Authorizations
AuthorizationstringRequired
Query parameters
pageanyOptional

A page number within the paginated result set.

page_sizeanyOptional

Number of results to return per page.

modeanyOptional

Specify what types of filters to fetch:

  • exclude_temporary: Fetch filters only manually saved filters
  • only_temporary: Fetch filters only temporary filters
  • all: Fetch all types of filters
Responses
200Success
application/json
countintegerRequired
nextstring · uriOptional
previousstring · uriOptional
get
/core/filters/user/
200Success
post
Authorizations
AuthorizationstringRequired
Body
uuidstring · uuidRead-onlyOptional
userstring · uuidRead-onlyOptional
last_user_editorstring · uuidRead-onlyOptional
analystintegerOptional
last_analyst_editorintegerOptional
organizationintegerOptional
visibilitystring · enumOptionalPossible values:
is_temporarybooleanOptional
created_atstring · date-timeRead-onlyOptional
updated_atstring · date-timeRead-onlyOptional
Responses
post
/core/filters/user/
201Success
get
Authorizations
AuthorizationstringRequired
Path parameters
uuidanyRequired
Responses
200Success
application/json
uuidstring · uuidRequired
userstring · uuidRequired
last_user_editorstring · uuidRequired
visibilitystring · enumRequiredPossible values:
is_temporarybooleanRequired
created_atstring · date-timeRequired
updated_atstring · date-timeRequired
get
/core/filters/user/{uuid}/
200Success
put
Authorizations
AuthorizationstringRequired
Path parameters
uuidanyRequired
Body
uuidstring · uuidRead-onlyOptional
userstring · uuidRead-onlyOptional
last_user_editorstring · uuidRead-onlyOptional
analystintegerOptional
last_analyst_editorintegerOptional
organizationintegerOptional
visibilitystring · enumRequiredPossible values:
is_temporarybooleanOptional
created_atstring · date-timeRead-onlyOptional
updated_atstring · date-timeRead-onlyOptional
Responses
200Success
application/json
uuidstring · uuidRead-onlyOptional
userstring · uuidRead-onlyOptional
last_user_editorstring · uuidRead-onlyOptional
analystintegerOptional
last_analyst_editorintegerOptional
organizationintegerOptional
visibilitystring · enumRequiredPossible values:
is_temporarybooleanOptional
created_atstring · date-timeRead-onlyOptional
updated_atstring · date-timeRead-onlyOptional
put
/core/filters/user/{uuid}/
200Success
delete
Authorizations
AuthorizationstringRequired
Path parameters
uuidanyRequired
Responses
delete
/core/filters/user/{uuid}/
204Success

No content

patch
Authorizations
AuthorizationstringRequired
Path parameters
uuidanyRequired
Body
visibilitystring · enumOptionalPossible values:
Responses
200Success
application/json
uuidstring · uuidRequired
userstring · uuidRequired
last_user_editorstring · uuidRequired
visibilitystring · enumRequiredPossible values:
is_temporarybooleanRequired
created_atstring · date-timeRequired
updated_atstring · date-timeRequired
patch
/core/filters/user/{uuid}/
200Success
get
Authorizations
AuthorizationstringRequired
Query parameters
uuidanyOptional

uuid

uuidsanyOptional

Filter by identity UUIDs (comma-separated)

searchanyOptional

A search term.

pageanyOptional

A page number within the paginated result set.

page_sizeanyOptional

Number of results to return per page.

Responses
200Success
application/json
countintegerRequired
nextstring · uriOptional
previousstring · uriOptional
get
/core/identity/
200Success
get
Authorizations
AuthorizationstringRequired
Path parameters
uuidanyRequired
Responses
200Success
application/json
idintegerRead-onlyOptional
uuidstring · uuidRead-onlyOptional
given_namestring · max: 255Optional
family_namestring · max: 255Optional
identifierstring · email · min: 1Read-onlyOptional
data_sourceintegerOptional
get
/core/identity/{uuid}/
200Success
get
Authorizations
AuthorizationstringRequired
Query parameters
uuidanyOptional

uuid

uuidsanyOptional

Filter by location UUIDs (comma-separated)

locationsanyOptional

Filter by location UUIDs (comma-separated, alternative to uuids param)

searchanyOptional

A search term.

pageanyOptional

A page number within the paginated result set.

page_sizeanyOptional

Number of results to return per page.

Responses
200Success
application/json
countintegerRequired
nextstring · uriOptional
previousstring · uriOptional
get
/core/locations/
200Success
get
Authorizations
AuthorizationstringRequired
Path parameters
uuidanyRequired
Responses
200Success
application/json
uuidstring · uuidRead-onlyOptional
ip_addressstring · min: 1Read-onlyOptional
citystring · min: 1Read-onlyOptional
regionstring · min: 1Read-onlyOptional
countrystring · min: 1Read-onlyOptional
country_codestring · min: 1Read-onlyOptional
latitudenumberRead-onlyOptional
longitudenumberRead-onlyOptional
categorystring · enumRead-onlyOptionalPossible values:
get
/core/locations/{uuid}/
200Success
patch
Authorizations
AuthorizationstringRequired
Path parameters
uuidanyRequired
Body
categorystring · enumRequiredPossible values:
Responses
200Success
application/json
categorystring · enumRequiredPossible values:
patch
/core/locations/{uuid}/
200Success
get
Authorizations
AuthorizationstringRequired
Query parameters
pageanyOptional

A page number within the paginated result set.

Responses
200Success
application/json
countintegerRequired
nextstring · uriOptional
previousstring · uriOptional
get
/core/queries/user/
200Success
get

A view for providing the current build version.

Authorizations
AuthorizationstringRequired
Responses
200Success
application/json
versionstring · min: 1Required
get
/core/version/
200Success

Last updated