Sign in
Connections

Start a Data Import

This endpoint will start a data import with the given connection. The request requires a connection ID and dimension IDs necessary to start an import.

post/connections/{connection_id}/imports

Path parameters

connection_idstring uuid required

Headers

X-Company-IDstring required

Associates request with company

Request body

dimensionsobject required
otherinteger[] required
timeobject required
scenariointeger required

Response

The import was queued and a message was sent in the metadata.

idinteger required
created_atstring date-time required
completed_atstring date-time nullable
status'CANCELLED' required
  • CANCELLED - Cancelled
status_messagestring nullable
source_import_type'USER' | 'SCHEDULED' required
  • USER - User
  • SCHEDULED - Scheduled

Changes