Getting Started
Webhook
Task
Routing
Flow
Data
Setting
Import/Export
File
curl -X GET "https://apiweb.mile.app/api/v3/import-monitoring/65f8a4c2d9e3b1234567890a" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"{
"status": true,
"message": "Success",
"data": {
"_id": "65f8a4c2d9e3b1234567890a",
"organizationId": "63c61d865347e356d05e3052",
"type": "string",
"hubId": "63c63ab1b6972d3150348172",
"filename": "outlets_import.xlsx",
"totalRows": 150,
"totalValid": 145,
"totalInvalid": 5,
"status": "partially",
"dataTypeId": "63db2fb476bc679c540369c4",
"dataTypeName": "OutletDetail",
"fileTemplate": "https://staticdev.mile.app/dev-mile/templates/template_OutletDetail.xlsx",
"fileFailedImported": "https://staticdev.mile.app/dev-mile/failed/failed_outlets_import_65f8a4c2d9e3b1234567890a.xlsx",
"errorMessage": null,
"processedAt": "2024-03-18 10:32:15",
"processingDuration": 90,
"totalChunks": 3,
"processedChunks": 3,
"createdBy": "john.doe@mile.app",
"updatedBy": "system",
"createdTime": "2024-03-18 10:30:45",
"updatedTime": "2024-03-18 10:32:15"
}
}Read import monitoring record by ID
This endpoint retrieves detailed information about a specific import monitoring record by its ID. Use this to check the status and results of a particular import operation.
Use Cases:
- Get detailed status of a specific import
- Download failed records file
- Retrieve import statistics
- Monitor import progress
curl -X GET "https://apiweb.mile.app/api/v3/import-monitoring/65f8a4c2d9e3b1234567890a" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"{
"status": true,
"message": "Success",
"data": {
"_id": "65f8a4c2d9e3b1234567890a",
"organizationId": "63c61d865347e356d05e3052",
"type": "string",
"hubId": "63c63ab1b6972d3150348172",
"filename": "outlets_import.xlsx",
"totalRows": 150,
"totalValid": 145,
"totalInvalid": 5,
"status": "partially",
"dataTypeId": "63db2fb476bc679c540369c4",
"dataTypeName": "OutletDetail",
"fileTemplate": "https://staticdev.mile.app/dev-mile/templates/template_OutletDetail.xlsx",
"fileFailedImported": "https://staticdev.mile.app/dev-mile/failed/failed_outlets_import_65f8a4c2d9e3b1234567890a.xlsx",
"errorMessage": null,
"processedAt": "2024-03-18 10:32:15",
"processingDuration": 90,
"totalChunks": 3,
"processedChunks": 3,
"createdBy": "john.doe@mile.app",
"updatedBy": "system",
"createdTime": "2024-03-18 10:30:45",
"updatedTime": "2024-03-18 10:32:15"
}
}Authorizations
Use a valid Bearer token to authenticate.
Path Parameters
The import monitoring record ID.
Example: 65f8a4c2d9e3b1234567890a
Response
Success
Status of response.
Message of API response.
Complete import monitoring record with all fields from the ImportMonitoring model
Show child attributes
Show child attributes
Unique identifier for the import monitoring record generated by system.
Example: 65f8a4c2d9e3b1234567890a
Organization ID that owns this import.
Example: 63c61d865347e356d05e3052
The input type of the component (e.g., string, number, date, etc.)
Hub ID associated with this import (if applicable).
Example: 63c63ab1b6972d3150348172
Original filename of the uploaded file.
Example: outlets_import.xlsx
Total number of rows in the imported file (excluding header).
Example: 150
Total number of valid rows successfully imported.
Example: 145
Total number of invalid rows that failed validation or import.
Example: 5
Current status of the import process.
onprocess: Import is currently being processedsuccess: All rows imported successfullypartially: Some rows succeeded, some failedfailed: Import completely failed enum:onprocess,success,partially,failedExample:partially
onprocess, success, partially, failed URL to download the template file for this import type. Template is generated based on data type schema or flow configuration.
Example: https://staticdev.mile.app/dev-mile/templates/template_OutletDetail.xlsx
URL to download file containing failed records. Only available when status is 'partially' or 'failed' and there are invalid rows. File includes error messages for each failed row.
Example: https://staticdev.mile.app/dev-mile/failed/failed_outlets_import_65f8a4c2d9e3b1234567890a.xlsx
[Datasource Import Only] Data type ID for datasource imports. This field is populated only when type='datasource'.
Use GET /data-types API to get valid data type IDs.
Example: 63db2fb476bc679c540369c4
[Datasource Import Only] Data type name for datasource imports. This field is populated only when type='datasource'.
Example: OutletDetail
[Task Import Only] Flow ID for task imports. This field is populated only when type='task'. Note: Full task import implementation may still be in progress.
Use GET /flows API to get valid flow IDs.
Example: 63d8c9b0dbd5ef20a627dd86
[Task Import Only] Flow name for task imports. This field is populated only when type='task'. Note: Full task import implementation may still be in progress.
Example: Delivery
[Visit Import Only - Future] Visit type ID for visit imports. This field will be populated when type='visit'. Feature may be under development.
Example: 64a5c8d2e9f1b2345678901c
[Visit Import Only - Future] Visit type name for visit imports. This field will be populated when type='visit'. Feature may be under development.
Example: Customer Visit
[Route Import Only - Future] Route configuration ID for route imports. This field will be populated when type='route'. Feature may be under development.
Example: 65b6d9e3f0a2c3456789012d
[Route Import Only - Future] Route configuration name for route imports. This field will be populated when type='route'. Feature may be under development.
Example: Daily Route Config
Error message if the import completely failed. Populated when status='failed'.
Example: File validation failed: Invalid data type ID
Timestamp when the import processing was completed. Format: Y-m-d H:i:s
Example: 2024-03-18 10:32:15
Duration of import processing in seconds. Calculated as difference between processedAt and createdTime.
Example: 90
Total number of chunks the file was divided into for processing. Large files are processed in chunks for better performance.
Example: 3
Number of chunks that have been processed. Use this with totalChunks to calculate processing progress.
Example: 3
Email of the user who initiated the import.
Example: john.doe@mile.app
Email of the user/system that last updated this record. Usually 'system' for background processing updates.
Example: system
Timestamp when the import was created. Format: Y-m-d H:i:s
Example: 2024-03-18 10:30:45
Timestamp when the record was last updated. Format: Y-m-d H:i:s
Example: 2024-03-18 10:32:15