Export API

The Activity Export API allows you to export small windows of Agillic activity data through the asynchronous API.

Activity Export#

Execute activity export and retrieve the data through pagination. Exporting activity data through API has some limitations compared to normal export through UI or scheduling.

• Only one export type per request.
• The export window (difference between ‘from’ and ‘to’) must be no more than 4 hours.
• The ‘from’ parameters must be no more than 7 days ago.
• Export will expire 15 minutes after completion
• Export files cannot be accessed through Webdav or Files UI
• The request queue is limited to 10. Requests that attempt to exceed this will be failed.

Once the export is complete, which can be determined by the task endpoint or through callback, the data can be retrieved through the pagination endpoint using the task id.

Supported types#

• EMAIL
• TRANSACTIONAL_EMAIL
• SMS
• INBOUND_SMS
• EVENT
• LINK
• PROMOTION
• PRINT
• PUSH_NOTIFICATION
• PAGE
• QUESTIONNAIRE
• FACEBOOK_CA
• GOOGLE_CM
• TRACKING

File Export#

Available from version 25.5

Listing contents#

This will list the items and folders at the specified location.

Request#

GET /export/files/list

Optional: ?folder={folderName}

Parameters#

Name	Required	Description
folder	No	Path of the folder to list.

Response#

[
  {
    "name": "ExportFlow",
    "isFolder": true
  },
  {
    "name": "2101_2025-10-01_09-44-32--2025-10-02_09-44-32_staging.ZIP",
    "isFolder": false
  }
]

Example#

GET /export/files/list?folder=Campaigns/Exports

Downloading a file#

This will download the file. Please note a maximum file size of 1GB is supported.

Request#

GET /export/files/download?file={fileName}

Parameters#

Name	Required	Description
file	Yes	Path of the file to download.

Example#

curl -X GET "https://api-eu1.agillic.net/export/files/download?file=ExportFlow/ActivityExport.ZIP"

Deleting a file#

This will delete the file or folder.

Request#

DELETE /export/files/delete?file={fileName}

Parameters#

Name	Required	Description
file	Yes	Path of the file to delete.

Example#

curl -X DELETE "https://api-eu1.agillic.net/export/files/delete?file=ExportFlow/ActivityExport.ZIP"

API Documentation#