Developer centerv1.0.0
Documentation menu
API reference

List search logs

Contract for GET /api/search-logs.

GET/api/search-logs

Tenant admins can list search audit records from their own institution. Response snapshots are excluded from list rows.

Authentication

This endpoint requires a tenant admin Bearer JWT.

Parameters

FieldInTypeDescription
pagequeryintegerOne-based page number.
pageSizequeryintegerResults per page, capped by the API key policy.
dateFromquerystringStart date filter in ISO date format.
dateToquerystringEnd date filter in ISO date format.
searchTypequerystringFilter API key searches or tenant JWT searches.
successquerystringFilter successful or failed records.
hasMatchquerystringFilter records by whether the search returned a match.
apiKeyIdquerystringFilter by API key id.
userIdquerystringFilter by user id.
qquerystringFree-text search across query, actor and top matched entity fields.
sourcequerystringFilter by requested or matched canonical source.

Responses

HTTPDescriptionSchema
200Successful responsePaginatedSearchLogs
400Invalid or missing request dataErrorResponse
401Authentication is missing or invalidErrorResponse
403Account, permission, source scope, domain or IP restriction failedErrorResponse
404Record not foundErrorResponse
500Server errorErrorResponse

Decision boundary

An API result is a candidate match. A final sanctions or compliance decision requires official-source verification and human review.