Get import status

client.data.getStatus(, ?): DataGetStatusResponse { createdAt, objectCount, status }

get/v1/data/status/{requestId}

Retrieve the status and progress of an import.

ParametersExpand Collapse

requestID: string

The request ID returned from the Add endpoint

ReturnsExpand Collapse

DataGetStatusResponse { createdAt, objectCount, status }

Response containing the status and progress of an add request.

createdAt: string

ISO timestamp when the request was created

objectCount: number

Number of objects in the request

status: "UPLOADING" | "INGESTING" | "COMPLETE"

Current processing status of the add request

Accepts one of the following:

"UPLOADING"

"INGESTING"

"COMPLETE"

Get import status

import Safetykit from 'safetykit';

const client = new Safetykit({
  apiKey: process.env['SAFETYKIT_API_KEY'], // This is the default and can be omitted
});

const response = await client.data.getStatus('requestId');

console.log(response.createdAt);

{
  "createdAt": "2024-01-15T10:30:00.000Z",
  "objectCount": 150,
  "status": "INGESTING"
}

Returns Examples

{
  "createdAt": "2024-01-15T10:30:00.000Z",
  "objectCount": 150,
  "status": "INGESTING"
}