Trace deletions

Get trace deletion

Changed on

Returns one trace deletion, including its status and how much it has deleted so far.

get/v1/projects/{projectSlug}/trace-deletions/{deletionId}

Request

  • Base URL
    https://api.latitude.so
  • Auth
    HTTP bearer

Path parameters

projectSlugstring required

Project slug (human-readable identifier)

Project slug (human-readable identifier). The CLI can also read this from the LATITUDE_PROJECT_SLUG environment variable.

deletionIdstring required

Trace deletion id, as returned by createTraceDeletion.

Response

Trace deletion

idstring required

Trace deletion identifier. Use it to poll the deletion with getTraceDeletion.

status'pending' | 'running' | 'completed' | 'failed' required

pending until work starts, running while traces are being deleted, then completed or failed. Deletion is irreversible: traces deleted before a failure stay deleted.

filtersobject required

The trace filter the deletion selects with, including any explicit trace ids as a traceId condition. Only traces that started before createdAt are deleted.

includeDatasetRowsboolean required

Whether dataset rows copied from the deleted traces are deleted too.

matchedTraceCountinteger required

Traces deleted so far. Final once status is completed or failed.

deletedRecordCountinteger required

Records deleted so far across the traces, their spans, and everything derived from them (scores, annotations, search indexes, session analyses).

errorstring nullable required

Why the deletion failed. null unless status is failed.

createdAtstring required

ISO-8601 time the deletion was requested.

startedAtstring nullable required

ISO-8601 time work started, or null while pending.

completedAtstring nullable required

ISO-8601 time the deletion completed or failed, or null while it is still in progress.

Changes