API Reference
Create an export
Queue a private CSV or Parquet export.
POST
/
datasets
/
{dataset}
/
exports
Create Dataset Export
curl --request POST \
--url https://api.soriaanalytics.com/v1/datasets/{dataset}/exports \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"columns": [
"<string>"
],
"filters": [
{
"column": "<string>",
"value": "<unknown>"
}
],
"order_by": [
{
"column": "<string>",
"direction": "asc"
}
],
"format": "csv"
}
'import requests
url = "https://api.soriaanalytics.com/v1/datasets/{dataset}/exports"
payload = {
"columns": ["<string>"],
"filters": [
{
"column": "<string>",
"value": "<unknown>"
}
],
"order_by": [
{
"column": "<string>",
"direction": "asc"
}
],
"format": "csv"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
columns: ['<string>'],
filters: [{column: '<string>', value: '<unknown>'}],
order_by: [{column: '<string>', direction: 'asc'}],
format: 'csv'
})
};
fetch('https://api.soriaanalytics.com/v1/datasets/{dataset}/exports', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.soriaanalytics.com/v1/datasets/{dataset}/exports",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'columns' => [
'<string>'
],
'filters' => [
[
'column' => '<string>',
'value' => '<unknown>'
]
],
'order_by' => [
[
'column' => '<string>',
'direction' => 'asc'
]
],
'format' => 'csv'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.soriaanalytics.com/v1/datasets/{dataset}/exports"
payload := strings.NewReader("{\n \"columns\": [\n \"<string>\"\n ],\n \"filters\": [\n {\n \"column\": \"<string>\",\n \"value\": \"<unknown>\"\n }\n ],\n \"order_by\": [\n {\n \"column\": \"<string>\",\n \"direction\": \"asc\"\n }\n ],\n \"format\": \"csv\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.soriaanalytics.com/v1/datasets/{dataset}/exports")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"columns\": [\n \"<string>\"\n ],\n \"filters\": [\n {\n \"column\": \"<string>\",\n \"value\": \"<unknown>\"\n }\n ],\n \"order_by\": [\n {\n \"column\": \"<string>\",\n \"direction\": \"asc\"\n }\n ],\n \"format\": \"csv\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.soriaanalytics.com/v1/datasets/{dataset}/exports")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"columns\": [\n \"<string>\"\n ],\n \"filters\": [\n {\n \"column\": \"<string>\",\n \"value\": \"<unknown>\"\n }\n ],\n \"order_by\": [\n {\n \"column\": \"<string>\",\n \"direction\": \"asc\"\n }\n ],\n \"format\": \"csv\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"dataset": "<string>",
"format": "csv",
"status": "queued",
"created_at": "2023-11-07T05:31:56Z",
"status_url": "<string>",
"row_count": 123,
"size_bytes": 123,
"completed_at": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z",
"download_url": "<string>",
"error": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Body
application/json
Columns to export. Empty means every customer-visible column.
Structured filters combined with AND.
Maximum array length:
20Show child attributes
Show child attributes
Optional sort keys. Exports are unordered when omitted.
Maximum array length:
10Show child attributes
Show child attributes
Generated file format.
Available options:
csv, parquet Response
Successful Response
Available options:
csv, parquet Available options:
queued, running, ready, failed, expired ⌘I
Create Dataset Export
curl --request POST \
--url https://api.soriaanalytics.com/v1/datasets/{dataset}/exports \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"columns": [
"<string>"
],
"filters": [
{
"column": "<string>",
"value": "<unknown>"
}
],
"order_by": [
{
"column": "<string>",
"direction": "asc"
}
],
"format": "csv"
}
'import requests
url = "https://api.soriaanalytics.com/v1/datasets/{dataset}/exports"
payload = {
"columns": ["<string>"],
"filters": [
{
"column": "<string>",
"value": "<unknown>"
}
],
"order_by": [
{
"column": "<string>",
"direction": "asc"
}
],
"format": "csv"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
columns: ['<string>'],
filters: [{column: '<string>', value: '<unknown>'}],
order_by: [{column: '<string>', direction: 'asc'}],
format: 'csv'
})
};
fetch('https://api.soriaanalytics.com/v1/datasets/{dataset}/exports', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.soriaanalytics.com/v1/datasets/{dataset}/exports",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'columns' => [
'<string>'
],
'filters' => [
[
'column' => '<string>',
'value' => '<unknown>'
]
],
'order_by' => [
[
'column' => '<string>',
'direction' => 'asc'
]
],
'format' => 'csv'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.soriaanalytics.com/v1/datasets/{dataset}/exports"
payload := strings.NewReader("{\n \"columns\": [\n \"<string>\"\n ],\n \"filters\": [\n {\n \"column\": \"<string>\",\n \"value\": \"<unknown>\"\n }\n ],\n \"order_by\": [\n {\n \"column\": \"<string>\",\n \"direction\": \"asc\"\n }\n ],\n \"format\": \"csv\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.soriaanalytics.com/v1/datasets/{dataset}/exports")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"columns\": [\n \"<string>\"\n ],\n \"filters\": [\n {\n \"column\": \"<string>\",\n \"value\": \"<unknown>\"\n }\n ],\n \"order_by\": [\n {\n \"column\": \"<string>\",\n \"direction\": \"asc\"\n }\n ],\n \"format\": \"csv\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.soriaanalytics.com/v1/datasets/{dataset}/exports")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"columns\": [\n \"<string>\"\n ],\n \"filters\": [\n {\n \"column\": \"<string>\",\n \"value\": \"<unknown>\"\n }\n ],\n \"order_by\": [\n {\n \"column\": \"<string>\",\n \"direction\": \"asc\"\n }\n ],\n \"format\": \"csv\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"dataset": "<string>",
"format": "csv",
"status": "queued",
"created_at": "2023-11-07T05:31:56Z",
"status_url": "<string>",
"row_count": 123,
"size_bytes": 123,
"completed_at": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z",
"download_url": "<string>",
"error": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}