cases

Search Case Aggregates

Return global case totals and per-stage counts for the current filters.

get/workspaces/{workspace_id}/cases/search/aggregate

Request

  • Base URL
    https://platform.tracecat.com/api
  • Auth
    • API key in cookie fastapiusersauth
    • or HTTP bearer

Path parameters

workspace_idstring uuid required

Query parameters

search_termstring nullable

Text to search for in case summary, description, short ID, or case UUID

search_mode'full_text' | 'literal'

Explicit lexical modes; omitted table mode remains a legacy policy.

Explicit full_text or literal; omitted mode preserves legacy search.

search_columnsstring[] nullable

Selected text fields; omitted searches both.

short_idstring nullable
case_idstring uuid nullable
statusCaseStatus[] nullable

Filter by case status

priorityCasePriority[] nullable

Filter by case priority

severityCaseSeverity[] nullable

Filter by case severity

tagsstring[] nullable

Filter by tag IDs or slugs (matches cases with any of the tags)

dropdownstring[] nullable

Filter by dropdown values. Format: definition_ref:option_ref (AND across definitions, OR within)

start_timestring date-time nullable

Return cases created at or after this timestamp

end_timestring date-time nullable

Return cases created at or before this timestamp

updated_afterstring date-time nullable

Return cases updated at or after this timestamp

updated_beforestring date-time nullable

Return cases updated at or before this timestamp

assignee_idstring[] nullable

Filter by assignee ID or 'unassigned'

hierarchy'all' | 'top_level'

Return every case, or only top-level cases without a parent.

parent_idstring uuid nullable

Return only the sub-cases of this parent case

Response

Successful Response

totalinteger required

Changes

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