Create Export Job
curl --request POST \
--url https://api.shoal.xyz/v1/export/jobs \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.shoal.xyz/v1/export/jobs"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.shoal.xyz/v1/export/jobs', 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.shoal.xyz/v1/export/jobs",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.shoal.xyz/v1/export/jobs"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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.shoal.xyz/v1/export/jobs")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.shoal.xyz/v1/export/jobs")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_bodyExport
Create Export Job
Request an explicit historical export job for enterprise workflows
POST
/
v1
/
export
/
jobs
Create Export Job
curl --request POST \
--url https://api.shoal.xyz/v1/export/jobs \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.shoal.xyz/v1/export/jobs"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.shoal.xyz/v1/export/jobs', 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.shoal.xyz/v1/export/jobs",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.shoal.xyz/v1/export/jobs"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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.shoal.xyz/v1/export/jobs")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.shoal.xyz/v1/export/jobs")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_bodyUse export jobs when you need warehouse backfill, archive sync, or other bulk historical transfer.
Do not use feed, replay, or timeline routes as a substitute for export.
Access
- Access layer:
premium - Plan floor:
enterprise - Surface:
export
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
scope | string | Yes | One of organizations.registry, radar.history, signal.history, replay.global, timeline.by-organization |
format | string | Yes | One of jsonl, csv, parquet |
since | string | Conditional | ISO 8601 timestamp; required for historical scopes |
until | string | No | ISO 8601 timestamp; must be later than since |
organizationIds | integer[] | Conditional | Required for timeline.by-organization exports |
category | string | No | Optional category filter |
includeEvidence | boolean | No | Include evidence-rich output when supported |
note | string | No | Optional job note, max 500 characters |
Request
cURL
curl -X POST "https://api.shoal.xyz/v1/export/jobs" \
-H "Authorization: Bearer YOUR_ENTERPRISE_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"scope": "replay.global",
"format": "jsonl",
"since": "2026-04-01T00:00:00Z",
"until": "2026-04-10T00:00:00Z",
"includeEvidence": true,
"note": "Internal warehouse backfill for April incident review"
}'
Response (201)
{
"data": {
"id": "d9d2a2e6-2df2-45ef-9f08-2e1ab36ef8e0",
"appUserId": "app_user_123",
"apiKeyId": 17,
"scope": "replay.global",
"format": "jsonl",
"status": "requested",
"requestedParams": {
"since": "2026-04-01T00:00:00.000Z",
"until": "2026-04-10T00:00:00.000Z",
"category": null,
"includeEvidence": true,
"organizationIds": []
},
"note": "Internal warehouse backfill for April incident review",
"downloadUrl": null,
"expiresAt": null,
"error": null,
"createdAt": "2026-04-11T20:15:00.000Z",
"updatedAt": "2026-04-11T20:15:00.000Z"
}
}
Notes
- Export jobs are explicit enterprise workflows, not ordinary paginated API usage.
- Historical scopes require
since. timeline.by-organizationrequiresorganizationIds.- This route records the request only. Delivery and fulfillment happen asynchronously.
Errors
- 400 for invalid scope, format, or timestamps
- 403 if the API key does not meet the enterprise plan floor
- 500 on internal server error
⌘I