{
"links": {
"next": "uri",
"prev": "uri"
},
"results": [
{
"createdAt": "date-time",
"dateFormat": "string",
"delimiter": "string",
"exportType": "string",
"fileExtension": "string",
"fileName": "string",
"fileUrl": "uri",
"filters": {
"activityTypes": [
"string"
],
"fromDate": "date-time",
"reportId": "string",
"segmentId": "string",
"toDate": "date-time"
},
"finishedAt": "date-time",
"id": "string",
"origin": "string",
"progress": "integer",
"status": "string",
"total": "integer"
}
]
}
Name | Type | Description | Additional |
---|---|---|---|
links | object |
The pagination links |
Optional |
links.next | uri |
The next list page url if there are more elements |
Optional |
links.prev | uri |
The previous list page url if there is a previous page |
|
results[] | array |
The exports list |
|
results[].createdAt | date-time |
The date of export creation in ISO8601 format |
|
results[].dateFormat | string |
The file dates format Possible values are:
|
|
results[].delimiter | string |
The file delimiter Possible values are:
|
|
results[].exportType | string |
The export type Possible values are:
|
|
results[].fileExtension | string |
The export file format |
Optional |
results[].fileName | string |
The export file name |
Optional |
results[].fileUrl | uri |
The export file url. This url will be defined only when the export status is finished. Any time the resource is requested a new url will be generated and it will be valid for 100 minutes. |
Optional |
results[].filters | object |
The export filters |
Optional |
results[].filters.activityTypes[] | array of string |
Filter by activity types. This field can be set only for "activities" export type but is optional. If it is not provided, no filter will be applied |
Optional |
results[].filters.fromDate | date-time |
Filter from a given date in ISO8601 format. This field can be set only for "activities" and "data-explorer" export types and it is required for these export types. |
Optional |
results[].filters.reportId | string |
Filter by a given data explorer report. This field applies only for "data-explorer" export type and it is required for this export type. |
Optional |
results[].filters.segmentId | string |
Filter by contacts that are in a given segment. It applies for both "contacts" and "activities" export types |
Optional |
results[].filters.toDate | date-time |
Filter to a given date in ISO8601 format. This field can be set only for "activities" and "data-explorer" export types and it is required for these export types. |
Optional |
results[].finishedAt | date-time |
The date of export finish in ISO8601 format |
Optional |
results[].id | string |
The identifier of the Export |
|
results[].origin | string |
The export origin. The export was created from the api or from the Connectif app. Possible values are:
|
|
results[].progress | integer |
The number of exported items |
Optional |
results[].status | string |
The export status Possible values are:
|
|
results[].total | integer |
The total number of items to export |
Optional |