Import File Run History

This API fetches the file processing status of each file contained in an import. The API request must contain either the import _name or the import_id. If you are not sure of the import-id or the import_name, you can use the Import Details API to get the import details, which can be further used in the Import File Run History API.

POST /fileimports/import/run/history

Import File Run History

cURL

curl --request POST \
  --url https://fileimports-data-api-0{dc}.moengage.com/v1.0/data/fileimports/import/run/history \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --header 'MOE-APPKEY: <moe-appkey>' \
  --data '
{
  "import_id": "<string>",
  "import_name": "<string>",
  "date": {
    "start_date": "2023-11-07T05:31:56Z",
    "end_date": "2023-11-07T05:31:56Z",
    "format": "<string>"
  },
  "file_status": [
    "SUCCESSFUL"
  ],
  "offset": 1
}
'

200

success_response

{ "status": "success", "total_count": "1", "data": null, "type": "object", "items": { "type": "object", "properties": { "id": "672561rr0abd2da34cf7f7df", "file_name": "filename.csv", "scheduled_at": "2024-11-14T12:31:31.713000", "completed_at": "2024-11-14T12:32:09.942000", "type": "AUX_DATA", "file_size": "1544", "file_status": "SUCCESSFUL", "status_msg": "", "total_rows": 10, "skipped_rows": 0, "updated_rows": 0, "failed_rows": 0, "aux_data_added_count": 10, "aux_data_failed_count": 0, "added_rows": 10 } }, "offset": 1, "more_files": "false" }

Rate Limit

You can create 50 requests per minute.

Postman Collections

We have made it easy for you to test the APIs. Click here to view it in Postman.

Authorizations

Authorization · string · header · required

This authentication parameter, used for access control, must be passed along with the request. The API request will be authenticated through Basic Authentication. Basic Authentication sends a Base64-encoded string containing your username and password with every API request. It encodes a 'username:password' string in Base64 and appends the encoded string with 'Basic '. This string is included in the authorization header as shown below:

{"Authorization: Basic Base64_ENCODED_WORKSPACEID_APIKEY=="}

The username and password details can be obtained from the MoEngage Dashboard. If you're using the API for the first time, follow these steps:

1. Navigate to Settings -> Account -> APIs.
2. Copy the following details:
   • Username: Under Workspace ID (earlier app id), click the copy icon to copy the username.
   • Password: In the API keys section, click the copy icon in the Data tile to copy the API key.

Use these details to authenticate the API requests.

Headers

MOE-APPKEY · string · required

This is your MoEngage account's WORKSPACE ID that has to be passed along with the request.You can find your MoEngage Workspace ID at Settings -> Account -> APIs -> Workspace ID (earlier app id).

Body

application/json

import_id · string · required

The unique identifier is used to identify the import. You can find this on the Data Imports page of the MoEngage dashboard. Data > Data Imports > Click the ellipsis icon for an import > View. The import_id or the import_name must be passed.

import_name · string · required

This field denotes the name of the import.The import_id or import_name has to be passed. If both are passed, import_id takes precedence.

date · object

This field denotes the file processing date. Supported values are:

• start_date
• end_date
• format

If this field is not passed, the API will respond with details of all the files corresponding to the import_id / import_name passed and in accordance to the offset and limit values.

Supported date time formats are:

• "datetime_format": "YYYY-MM-DD" (2022-01-22)
• "datetime_format": "YYYY/MM/DD" (2022/01/22)
• "datetime_format": "DD/MM/YYYY" (22/01/2022)
• "datetime_format": "DD-MM-YYYY" (22-01-2022)
• "datetime_format": "DD-MM-YYYY hh:mm:ss" (31-12-2022 12:10:33)
• "datetime_format": "DD/MM/YYYY hh:mm:ss" (31/12/2022 12:10:33)
• "datetime_format": "YYYY-MM-DD hh:mm:ss" (2019-02-22 17:54:14)
• "datetime_format": "YYYY/MM/DD hh:mm:ss" (2019/02/22 17:54:14)

Show child attributes

file_status · enum<string>[]

This field denotes the status of files contained in an import.

Available options: SUCCESSFUL, FAILED, PARTIAL_SUCCESS, PROCESSING, QUEUED, WAITING

offset · integer · default: 1

'API responds with a maximum of 50 file details in a single response. For example, if there are a total of 150 files that are part of the API response, then:

• Offset = 1 will fetch the details of the first 50 files
• Offset = 2 will fetch the file details of the next 50 imports
• Offset = 3 will fetch the import details of the last 50 imports
• If offset is not passed in the request body, the API response will consider offset = 1.

You can refer to the total_count parameter in the response to understand how many total files are part of the response.

OR

If the API responds with more_files = true, it indicates that there are more files that are not part of the current response for which another API request must be made with offset +1.'

Response

200

application/json

Success.

status · string

This field denotes the status of the API response.

Example:

"success"

total_count · integer

This field denotes the total count of the files fetched based on the API request.

Example:

1

data · object[]

This field contains the file data details.

Show child attributes

offset · integer

This field denotes the pagination value of the imports. For example, if there are 100 imports to be fetched in the response:

• Offset = 1 will return the first 50 imports
• Offset = 2 will return the next 50 import details

more_files · string

This field indicates if there are more files. For example, if there are 100 imports and offset = 1, 50 imports will be returned with more_file = true to indicate that offset = 2 must be passed to get the next 50 imports.