Skip to Content

POST /attempt/search

Search Attempt

Search paginated attempt history. Canonical for all view contexts.

Request Body (SearchAttemptApiRequest)

FieldTypeRequiredDescription
target_profile_idstringNoScope to a single profile (record-style)
profile_idsstring[]NoFilter to specific profiles (intersected with visible set)
cohort_idsstring[]NoCohort IDs to filter by
department_idsstring[]NoDepartment IDs to filter by
role_idsstring[]NoRole resource IDs to filter profiles by
simulation_idsstring[]NoSimulation IDs to filter by
scenario_idsstring[]NoScenario IDs to filter by
practicebooleanNoTrue=practice-only, False=general-only, None=both
infinite_modebooleanNoFilter by infinite mode status
show_archivedbooleanNoInclude archived attempts
start_datestringNoFilter start date (ISO)
end_datestringNoFilter end date (ISO)
simulation_searchstringNoSubstring match on simulation_name
scenario_searchstringNoSubstring match on scenario titles
profile_searchstringNoSubstring match on profile_name
sort_bystringNoSort field
sort_orderstringNoSort direction (asc or desc)
pageintegerNoPage number
page_sizeintegerNoItems per page
snapshot_keystringNoCache snapshot key for consistent reads across related requests

Response (HistoryResponse)

FieldTypeRequiredDescription
dataHistoryItem[]NoList of history items
total_countintegerNoTotal number of matching records
pageintegerNoCurrent page number
page_sizeintegerNoItems per page
total_pagesintegerNoTotal number of pages
simulation_optionsFilterOption[]NoFilter options for simulations
scenario_optionsFilterOption[]NoFilter options for scenarios
profile_optionsFilterOption[]NoFilter options for profiles
Last updated on