Skip to navigation
EndpointsAPI

Log a terminal CSV import summary

Records bounded browser-observed counts and timing; it does not persist import lifecycle state.

Authentication: Bearer token required.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Headers

X-Organization-IDstring or nullOptional
Idempotency-KeystringOptional<=255 characters

A unique key (up to 255 printable ASCII characters, e.g. a UUID) that makes a retry of this request safe. Envoy stores the response for 24 hours; a retry with the same key and the same request returns it again with Idempotent-Replayed: true instead of running twice. The same key with a different request returns 422 idempotency_key_reused; while the first request is still running, 409 idempotency_key_in_progress. 5xx and 429 responses are not stored.

Request

This endpoint expects an object.
import_idstringRequiredformat: "uuid"
entity_typeenumRequired

Which entity a CSV upload is for — echoed in the response and the correlated logs.

Allowed values:
outcomeenumRequired
Allowed values:
rows_parsedintegerRequired0-10000000
rows_client_invalidintegerRequired0-10000000
rows_submittedintegerRequired0-10000000
rows_createdintegerRequired0-10000000
rows_updatedintegerRequired0-10000000
rows_failedintegerRequired0-10000000
rows_not_attemptedintegerRequired0-10000000
backend_duration_msdoubleRequired0-604800000
end_to_end_duration_msdoubleRequired0-604800000
archival_outcomeenumRequired
Allowed values:
rows_skippedintegerOptional0-10000000Defaults to 0

Rows accepted but deliberately not written (e.g. TMS-protection skips)

rows_indeterminateintegerOptional0-10000000Defaults to 0
Rows in a failed chunk whose commit state the browser cannot know
archival_duration_msdouble or nullOptional0-604800000
failure_categoryenum or nullOptional
Allowed values:

Response

Successful Response
import_idstringformat: "uuid"
loggedbooleanOptionalDefaults to true

Errors

401
Unauthorized Error
403
Forbidden Error
409
Conflict Error
422
Unprocessable Entity Error
429
Too Many Requests Error