Important points

Request

The elements to send in the request body are:

field Name	type	required	Description
startDate	Alphabetic	Yes	Indicate the start date with the format ISO 8601
endDate	Alphabetic	Yes	Indicate the end date with the format ISO 8601

Successful response

To know the fields of a successful response we suggest you look at our example called success in the response section.

Inside the response object you will receive the csvBase64 parameter.

field Name	Description
csvBase64	Will be a base64 string with the content of the generated CSV file

{
    "id": "65011d14175f923075a8ab94",
    "createdAt": "2023-09-13T02:23:16.848273076Z",
    "finishedAt": "2023-09-13T02:23:16.904213851Z",
    "duration": 55,
    "status": "SUCCESS",
    "request": {
        "endDate": "2023-07-25T16:17:26.446Z",
        "startDate": "2023-06-29T16:17:26.446Z"
    },
    "response": {
        "csvBase64": "LHNlcD07Ck5vLjtObyBkZSB0cmFuc2FjY2lvbiBSZWZlcmVuY2lhIGRlbCBPcGVyYWRvcjtGZWNoYTtOb21icmUgKHMpO1BhdGVybm87TWF0ZXJubztSRkM7Q2FsbGUgLSBOby47Q29sb25pYTtDaXVkYWQ7RWRvLjtJbmdyZXNvIG51ZXZhbWVudGUgZGUgTklQO1Jlc3B1ZXN0YSBhIGxleWVuZGEgZGUgYXV0b3JpemFjaW9uO05vIEZvbGlvIGRlIGNvbnN1bHRhIEJDCg=="
    }
}

Juste decode in base64 the csvBase64 field to obtain the text plain file like below :

Possible Errors

Required fields

If any of the required fields are not provided in the request body, a 400 bad request HTTP error code will be returned.

{
    "endDate": "EMPTY_ERROR; can't be empty",
    "startDate": "EMPTY_ERROR; can't be empty"
}

Invalid format

If any of the required fields do not conform the specific format in the request body, a 400 bad request HTTP error code will be returned.

{
    "endDate": "FORMAT_ERROR; make sure the date format is correct, should be: 2006-01-02T15:04:05.700Z",
    "startDate": "FORMAT_ERROR; make sure the date format is correct, should be: 2006-01-02T15:04:05.700Z"
}

End date before start date

If the end date is before the start date, you will receive an HTTP error with code 400.

{
    "endDate": "the end date cannot be less than the start date"
}