Skip to main content
POST
/
v1
/
evaluations
/
exports
Create evaluation export
curl --request POST \
  --url https://api.craftcx.com/v1/evaluations/exports \
  --header 'Content-Type: application/json' \
  --data '
{
  "kind": "axis",
  "filters": {
    "from": 1,
    "to": 1
  },
  "format": "csv"
}
'
import requests

url = "https://api.craftcx.com/v1/evaluations/exports"

payload = {
"kind": "axis",
"filters": {
"from": 1,
"to": 1
},
"format": "csv"
}
headers = {"Content-Type": "application/json"}

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

print(response.text)
const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({kind: 'axis', filters: {from: 1, to: 1}, format: 'csv'})
};

fetch('https://api.craftcx.com/v1/evaluations/exports', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
{
  "id": "<string>",
  "filters": {
    "from": 1,
    "to": 1
  },
  "format": "csv",
  "download_url": "<string>",
  "created_at": 123,
  "updated_at": 123,
  "error_message": "<string>"
}
{
"status": 400,
"title": "<string>",
"type": "about:blank",
"detail": "<string>"
}
{
"status": 401,
"title": "<string>",
"type": "about:blank",
"detail": "<string>"
}
{
"status": 500,
"title": "<string>",
"type": "about:blank",
"detail": "<string>"
}

Body

application/json
kind
enum<string>
required

The evaluation export type

Available options:
axis
filters
object
required

Supported filters for the export

format
enum<string>
required

The export format

Available options:
csv

Response

The queued evaluation export job

id
string
required

The export ID

status
enum<string>
required

The status of the export

Available options:
pending,
running,
complete,
failed
kind
enum<string>
required

The evaluation export type

Available options:
axis,
resolution_audit
filters
object
required

Filters applied to the export

format
enum<string>
required

The export format

Available options:
csv
download_url
string<uri> | null
required

Download URL for the completed export

created_at
number
required

Epoch timestamp (milliseconds) for when the export was created

updated_at
number
required

Epoch timestamp (milliseconds) for when the export was last updated

error_message
string | null

A human-readable error if the export failed