Skip to main content
POST
/
api
/
v1
/
export
ExportData
curl --request POST \
  --url https://api.siftstack.com/api/v1/export \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "outputFormat": "EXPORT_OUTPUT_FORMAT_UNSPECIFIED",
  "exportOptions": {
    "useLegacyFormat": true,
    "simplifyChannelNames": true,
    "combineRuns": true,
    "splitExportByAsset": true,
    "splitExportByRun": true
  },
  "channelIds": [
    "<string>"
  ],
  "calculatedChannelConfigs": [
    {
      "name": "<string>",
      "expression": "<string>",
      "channelReferences": [
        {
          "channelReference": "<string>",
          "channelIdentifier": "<string>"
        }
      ],
      "units": "<string>"
    }
  ]
}
'
{
  "presignedUrl": "<string>",
  "jobId": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.siftstack.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
outputFormat
enum<string>
default:EXPORT_OUTPUT_FORMAT_UNSPECIFIED
required
Available options:
EXPORT_OUTPUT_FORMAT_UNSPECIFIED,
EXPORT_OUTPUT_FORMAT_CSV,
EXPORT_OUTPUT_FORMAT_SUN
​
exportOptions
object
required
​
timeRange
object
​
runsAndTimeRange
object
​
assetsAndTimeRange
object
​
channelIds
string[]
​
calculatedChannelConfigs
object[]

Response

A successful response.

​
presignedUrl
string

Pre-signed URL of exported zip containing export files. This will be blank if the job is processed as a background job, in which case job_id will be non-empty.

​
jobId
string

This will be non-empty if the export is being processed asynchronously in a background job.