cURL

curl -X POST "https://apiweb.mile.app/api/v3/data/import" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -F "file=@/path/to/datasource_import.xlsx" \
  -F "dataTypeId=63db2fb476bc679c540369c4" \
  -F "hubId=63c63ab1b6972d3150348172"

{
  "status": true,
  "message": "Import process has been queued successfully",
  "data": {
    "_id": "65f8a4c2d9e3b1234567890a",
    "organizationId": "63c61d865347e356d05e3052",
    "type": "string",
    "hubId": "63c63ab1b6972d3150348172",
    "filename": "outlets_import.xlsx",
    "totalRows": 150,
    "totalValid": 0,
    "totalInvalid": 0,
    "status": "onprocess",
    "dataTypeId": "63db2fb476bc679c540369c4",
    "dataTypeName": "OutletDetail",
    "fileTemplate": "https://staticdev.mile.app/dev-mile/templates/template_OutletDetail.xlsx",
    "totalChunks": 3,
    "processedChunks": 0,
    "createdBy": "john.doe@mile.app",
    "createdTime": "2024-03-18 10:30:45",
    "updatedTime": "2024-03-18 10:30:45"
  }
}

Data Import

Import data source from file

This endpoint allows users to upload a file (CSV, XLS, or XLSX) containing data source records for import. The file is validated and processed in the background via queue. The import process supports multiple import types: datasource, task, visit, and route. After upload, the import is queued for processing and can be monitored via the import-monitoring endpoints.

Background Processing:

Queue Name: readingImportDatasource
Processing is chunked for large files
Status updates are tracked in real-time

File Requirements:

Max Size: 20MB
Supported Formats: CSV, XLS, XLSX
File structure must match the data type schema

Important Notes:

For datasource import: dataTypeId is required
For datasource with hub-specific data: hubId is required (depends on commonData setting)
Failed records are exported to a separate file for review
Template file is generated based on data type schema

POST

data

import

cURL

curl -X POST "https://apiweb.mile.app/api/v3/data/import" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -F "file=@/path/to/datasource_import.xlsx" \
  -F "dataTypeId=63db2fb476bc679c540369c4" \
  -F "hubId=63c63ab1b6972d3150348172"

{
  "status": true,
  "message": "Import process has been queued successfully",
  "data": {
    "_id": "65f8a4c2d9e3b1234567890a",
    "organizationId": "63c61d865347e356d05e3052",
    "type": "string",
    "hubId": "63c63ab1b6972d3150348172",
    "filename": "outlets_import.xlsx",
    "totalRows": 150,
    "totalValid": 0,
    "totalInvalid": 0,
    "status": "onprocess",
    "dataTypeId": "63db2fb476bc679c540369c4",
    "dataTypeName": "OutletDetail",
    "fileTemplate": "https://staticdev.mile.app/dev-mile/templates/template_OutletDetail.xlsx",
    "totalChunks": 3,
    "processedChunks": 0,
    "createdBy": "john.doe@mile.app",
    "createdTime": "2024-03-18 10:30:45",
    "updatedTime": "2024-03-18 10:30:45"
  }
}

Authorizations

Authorization

string

header

required

Use a valid Bearer token to authenticate.

Body

multipart/form-data

file

required

The file containing data to import. Supported formats: CSV, XLS, XLSX. Maximum file size: 20MB. Example: datasource_import.xlsx

dataTypeId

string

required

The identifier for the data type. Required for datasource import type. Use GET /data-types API to get the list of Data Type IDs. Example: 63db2fb476bc679c540369c4

hubId

string

The identifier for the hub. Required if the data type has commonData set to false (hub-specific data). Use GET /hubs API to get the list of Hub IDs. Example: 63c63ab1b6972d3150348172

Response

Success - File uploaded and import process queued

status

boolean

Status of response.

message

string

Message of API response.

data

object

Import monitoring record created for this import.

Show child attributes

data._id

string

Import monitoring ID

data.organizationId

string

Organization ID

data.inputType

string

The input type of the component (e.g., string, number, date, etc.)

data.hubId

string

Hub ID (if applicable)

data.filename

string

Original uploaded filename

data.totalRows

integer

Total rows in the file

data.totalValid

integer

Total valid rows (initially 0, updated during processing)

data.totalInvalid

integer

Total invalid rows (initially 0, updated during processing)

data.status

enum<string>

Import status

Available options:

onprocess,

success,

partially,

failed

data.dataTypeId

string

Data type ID (for datasource import)

data.dataTypeName

string

Data type name (for datasource import)

data.fileTemplate

string

URL to download template file

data.createdBy

string

Email of user who initiated the import

data.createdTime

string

Timestamp when import was created

data.updatedTime

string

Timestamp when import was last updated

Export data source Read import monitoring records

⌘I

Getting Started

Webhook

Task

Routing

Flow

Data

Setting

Import/Export

File

Objects

Import data source from file

Authorizations

Body

Response