Investigation

get

List investigations (with optional filtering, sorting, and search)

Returns a paginated list of investigations. By default, only completed investigations (state='success') are returned. Use query parameters to filter by state, outcomes, priorities, date ranges, and more.

Authorizations
AuthorizationstringRequired
Query parameters
alert_create_fromstringOptional

Filter by alert creation time (from). ISO 8601 format

alert_create_untilstringOptional

Filter by alert creation time (until). ISO 8601 format

alert_start_fromstringOptional

Filter by alert start time (from). ISO 8601 format (e.g., 2024-01-01 or 2024-01-01T00:00:00Z)

alert_start_untilstringOptional

Filter by alert start time (until). ISO 8601 format

alert_tenantsstring[]Optional

Filter by alert tenant name (can be repeated)

alert_typesstring[]Optional

Filter by alert type/handler key (can be repeated)

direct_source_labelsstring[]Optional

Filter by alert source label (can be repeated)

feedback_updated_fromstringOptional

Filter by feedback last updated time (from). ISO 8601 format

feedback_updated_untilstringOptional

Filter by feedback last updated time (until). ISO 8601 format

insight_tag_namesstring[]Optional

Filter by insight tag name (can be repeated)

inv_complete_fromstringOptional

Filter by investigation completion time (from). ISO 8601 format

inv_complete_untilstringOptional

Filter by investigation completion time (until). ISO 8601 format

investigation_statestring · enumOptional

Filter by investigation state. Valid values: not_asked (queued), loading (running), success (complete), error (stopped). Defaults to 'success'.

Possible values:
limitintegerOptional

Number of results per page

offsetintegerOptional

Number of results to skip

priority_statusesstring[]Optional

Filter by priority status (can be repeated)

searchstringOptional

Free-text search across investigation fields

sort_dirstring · enumOptional

Sort direction. Defaults to 'desc'.

Possible values:
sort_typestring · enumOptional

Sort field. Defaults to 'alert_create'.

Possible values:
stopped_reasonsstring[]Optional

Filter by stopped reason for error/canceled investigations (can be repeated)

tenant_idstringOptional

Filter by tenant ID

tenant_integration_keystringOptional

Filter by tenant integration key

Responses
200

Paginated list of investigations Returns a paginated list of investigations. By default, only completed investigations (state='success') are returned. Use query parameters to filter by state, outcomes, priorities, date ranges, and more. Use next and previous URLs in the response for easy page navigation.

application/json
get
/app/api/v1/investigation
post

Creates a new alert investigation, returning investigation_id Returns existing id if alert already exists (unless force_reinvestigation=True) Then: Use GET /app/api/v1/investigation/{investigation_id} for updates

Authorizations
AuthorizationstringRequired
Body
force_reinvestigationbooleanOptionalDefault: false
raw_alert_contentobjectOptional
schema_keystringOptional
tenant_union_idnumber | nullableOptionalDefault: null
Responses
200

Existing investigation found

application/json
post
/app/api/v1/investigation/create
post

Request body = arbitrary alert JSON to be parsed & investigated Response = investigation_id if successful, error_msg otherwise Returns existing id if alert already exists (unless ?force_reinvestigation=True) Then: Use GET /app/api/v1/investigation/{investigation_id} for updates

Authorizations
AuthorizationstringRequired
Query parameters
force_reinvestigationbooleanOptional

Force reinvestigation

tenant_union_idintegerOptional

Tenant union ID

Body
objectOptional
Responses
200

Existing investigation found

application/json
post
/app/api/v1/investigation/create/custom
get

Returns an alert investigation

Authorizations
AuthorizationstringRequired
Path parameters
investigation_idstringRequired
Responses
200

Investigation data object. For progress: investigation.status=

application/json
get
/app/api/v1/investigation/{investigation_id}

Last updated

Was this helpful?