CSV Export

The Export API allows you to programmatically queue an export job. By requesting a CSV export you receive a download uri in the response body where eventually the file will be available for download. All CSV report types supported in the Web Application are supported as Export API jobs.

🚧

Exports are generated asynchronously. There is no guarantee that on receiving the response the export file is immediately ready for download. Depending on size of the export the generation process can take from a couple of seconds to a couple of minutes.

Request

Endpoint

POST /v1/csvexport/{reportType}

Path Parameters

Query Parameters

Response

HTTP status code

202

Body

{
  "meta": {
    "message": "Export request queued",
    "uri": "..." // download uri of export resource
  }
}

Example

POST /v1/csvexport/measurements?startDate=2024-01-01&endDate=2024-01-07 HTTP/1.1
Authorization: Bearer <api-key>
Host: api.luscii.com
Content-Type: application/json
Content-Length: 0

HTTP/1.1 202 Accepted
Date: Wed, 14 Feb 2024 11:03:24 GMT
Content-Type: application/json

{"meta":{"message":"Export request queued", "uri": "..."}}

Structure of the export

The downloaded csv file will have the following structure depending on the type of export which was requested.