SEsenso
History Imports

Get a history import

Returns one of your organization's history-import jobs — the way to follow a job until it finishes. Only your own organization's jobs are visible; any other id reads as not found. Requires the GEO product.

get/org/history-imports/{importId}

Request

  • Base URL
    https://apiv2.senso.ai/api/v1
  • Auth
    API key in header X-API-Key

Path parameters

importIdstring uuid required

The history-import job's id.

Response

The history-import job.

idstring uuid required

The job's id.

daysinteger required

How many days of history the job covers.

statusstring required

The job's progress: pending (accepted, not started), running, completed or failed. A failed job may be retried automatically, so it can return to running on its own — treat failed as the latest attempt rather than a final answer.

prompts_countinteger nullable required

How many of your prompts the job matched. Null until the job completes, so its absence does not mean zero. A completed job reporting 0 matched none of your prompts and copied nothing, which is why this is the field to read rather than the status.

historic_runs_importedinteger nullable required

How many historic runs the job copied onto your prompts. Null until the job completes.

errorstring nullable required

Set when the latest attempt failed, null otherwise; cleared again when the job is retried. Always the same fixed sentence — the failure reason itself is not exposed.

created_atstring date-time required

When the job was accepted.

updated_atstring date-time required

When the job was last updated. A running job refreshes this regularly while it works, so it is not only a state-change timestamp.

completed_atstring date-time nullable required

When the job completed. Null until it does — including for a failed job, which has not completed.

Example response

{
  "days": 7,
  "status": "completed",
  "prompts_count": 12,
  "historic_runs_imported": 340,
  "error": "The import failed and may be retried."
}

Changes

No recorded changes to this operation across all 1 revision of this API.