Export resource

Methods

  • post - Create data explorer export
  • post - Create export
  • get - Get export detail by Id

Resource

{
    "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",
    "version": "string"
}

Properties

Name Type Description Additional
createdAt date-time

The date of export creation in ISO8601 format
dateFormat string

The file dates format

Possible values are:

  • ISO
  • L
  • LL
  • LLL
delimiter string

The file delimiter

Possible values are:

  • ,
  • ;
exportType string

The export type

Possible values are:

  • contacts
  • activities
  • form-stats
  • push-stats
  • webhooks-execution-logs
  • data-explorer
fileExtension string

The export file format

 Optional
fileName string

The export file name

 Optional
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
filters object

The export filters

 Optional
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
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
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
filters.segmentId string

Filter by contacts that are in a given segment. It applies for both "contacts" and "activities" export types

 Optional
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
finishedAt date-time

The date of export finish in ISO8601 format

 Optional
id string

The identifier of the Export
origin string

The export origin. The export was created from the api or from the Connectif app.

Possible values are:

  • api
  • app
progress integer

The number of exported items

 Optional
status string

The export status

Possible values are:

  • queued
  • inProgress
  • finished
  • error
total integer

The total number of items to export

 Optional
version string

The version of the export

Possible values are:

  • v1
  • v2