Connectif API

Create an export for a given data explorer report.

Request

POST https://api.connectif.cloud/exports/type/data-explorer

The request body takes a complete DataExplorerExportCreation resource, containing the following writable properties:

{
    "delimiter": "string",
    "filters": {
        "fromDate": "date",
        "reportId": "string",
        "toDate": "date"
    }
}

Name	Type	Description	Additional
delimiter	string	The file delimiter Possible values are: `,` `;`
filters	object	The data explorer export filters	Optional
filters.fromDate	date	Filter from a given date in YYYY-MM-DD format. It includes all data since the start of this day based on the account timezone. The range between fromDate and toDate cannot be greater than 31 days.
filters.reportId	string	Filter by a given data explorer report.
filters.toDate	date	Filter to a given date in YYYY-MM-DD format. It includes all data until the end of this day based on the account timezone. The range between fromDate and toDate cannot be greater than 31 days.

This request requires the use of one of following authorization methods: API key .

The following HTTP status codes may be returned, optionally with a response resource.

Status code	Description	Resource
201	Created Success.	Export
400	Bad Request Bad request, i.e.: invalid json.	HttpError
401	Unauthorized Not authorized to access API.
403	Forbidden Permission not granted to the API Key or account has been blocked.	HttpError
415	Unsupported Media Type Request without application/json Content-Type header.	HttpError
422	Unprocessable Entity Resource contains validation errors.	HttpUnprocessableEntityError
429	Too Many Requests Requests rate limit reached.