Get a log export

GET/v1/logs/export/{jobId}

Get a log export.

Returns the export job's status (PENDING, RUNNING, DONE or FAILED), the number of rows exported and, for a failed job, why. Once it is DONE, download the file. Fails with 404 for an unknown job, or one more than an hour old.

Requires an organization owner or admin of the job's organization, or an organization-scoped va_ key with the admin role.

Authorization

AuthorizationBearer va_
A platform API key (va_...), created under Settings > API keys. Scoped to an organization or one workspace, with an admin or member role. Used by the management API.

Path parameters

jobIdstringrequired
the job's id, as returned when it was started

Responses

200application/json

job_idstring
The job's id. Use it to check progress and download the file.
statusenum<string>
PENDING, RUNNING, DONE or FAILED.
One of "PENDING", "RUNNING", "DONE", "FAILED"
formatenum<string>
The file format: csv or json.
One of "csv", "json"
row_countinteger<int32>
How many logs were exported; 0 until the job is done.
error_messagestring
Why the job failed; null unless the status is FAILED.
created_atstring<date-time>
When the job was started (ISO 8601 date-time). The job and its file are kept for one hour from then.
completed_atstring<date-time>
When the job finished or failed (ISO 8601 date-time); null while it runs.

VectorAxis is built by GK Labs, a member of NVIDIA Inception.