Skip to content
EyesOnItDocumentation6.1

Export Live Search Coverage

GET /api/v1/live-searches/{liveSearchId}/coverage-export.csv

Export retained authorized history, including deleted searches with immutable ownership.

Capture-warning intervals overlap [startTime, endTime); source recovery is selected by detection time. At most 10,000 rows/8 MiB: larger ranges fail explicitly without returning a partial file. Empty history is not healthy-coverage proof.

Access

Section titled “Access”

Authentication options declared in the contract include user cookie session or bearer service token.

The shared authentication policy requires searches:read. Resource access also depends on the caller’s role, organization, camera grants, and the operation’s validation.

Authentication and permissions explains tokens, cookies, CSRF, and workspace context.

Parameters

Section titled “Parameters”
Name Location Required Type Description and constraints
liveSearchId path Yes string (uuid)
startTime query Yes string (date-time)
endTime query Yes string (date-time)
X-EyesOnIt-Session-Id header No string (uuid) The sessionId the caller expects. Required when switching workspaces and for cookie requests after workspace rotation. A mismatched value returns 409 with X-EyesOnIt-Workspace-Changed: 1. Bootstrap with getCurrentPrincipal; never replay a mutation automatically after changing context. Bearer clients do not use this header.

cURL request template

Section titled “cURL request template”

Set the connection variables described in Get started. Replace each additional EOI_… variable with the parameter value for this request. This template sends the request when run.

Terminal window
curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer ${EOI_SERVICE_TOKEN}" \
  --url-query "startTime=${EOI_STARTTIME}" \
  --url-query "endTime=${EOI_ENDTIME}" \
  --dump-header response-headers.txt \
  --output response.bin \
  "${EOI_API_BASE_URL}/live-searches/${EOI_LIVESEARCHID}/coverage-export.csv"

Contract responses

Section titled “Contract responses”

The table records responses declared by the OpenAPI contract. See Errors and status codes for the runtime error envelope and shared failures.

Status Description Media type Body
200 Successful Response text/csv string (binary)
422 Validation Error application/json HTTPValidationError

Operation identifier exportLiveSearchCoverage. Browse Live searches.

Image preview