Export query results as CSV

POST

https://api.channelautomation.com/api/analytics/export/csv

Authorization

bearerAuth
optional
bearerAuth

apiKey
optional
apiKey

Request body JSON required

sql_query
string
required
The SQL query to execute and export
filename
optional
string
Custom filename for the export (without extension)

default: "analytics_export"

Returns

200

CSV file download

400

Invalid query, missing workspace ID, or no data to export

JSON

error
optional
string
details
optional
string

500

Export failed

JSON

error
optional
string
details
optional
string

Export query results as CSV

curl --request POST \
  --url https://api.channelautomation.com/api/analytics/export/csv \
  --header 'Content-Type: application/json' \
  --data @- <<'EOF'
{
  "sql_query": "SELECT id, name, email FROM contacts WHERE workspace_id = 'workspace-id'",
  "filename": "monthly_leads_report"
}
EOF

const url = 'https://api.channelautomation.com/api/analytics/export/csv';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    sql_query: 'SELECT id, name, email FROM contacts WHERE workspace_id = \'workspace-id\'',
    filename: 'monthly_leads_report'
  })
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

import requests

url = "https://api.channelautomation.com/api/analytics/export/csv"

payload = {
    "sql_query": "SELECT id, name, email FROM contacts WHERE workspace_id = 'workspace-id'",
    "filename": "monthly_leads_report"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

Response example

string

{
  "error": "string",
  "details": "string"
}

{
  "error": "string",
  "details": "string"
}