Skip to main content
GET
/
api
/
agentTools
/
exportData
Export Data
curl --request GET \
  --url https://api.example.com/api/agentTools/exportData
import requests

url = "https://api.example.com/api/agentTools/exportData"

response = requests.get(url)

print(response.text)
const options = {method: 'GET'};

fetch('https://api.example.com/api/agentTools/exportData', 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.example.com/api/agentTools/exportData",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);

$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.example.com/api/agentTools/exportData"

req, _ := http.NewRequest("GET", url, nil)

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.example.com/api/agentTools/exportData")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/agentTools/exportData")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
The query parameters, cURL example, and response schema are generated from the OpenAPI definition in the API panel.
Check export status and retrieve export metadata for a task.
1

Use a taskId

Pass the taskId returned by executeTask or searchTasks.
2

Select export options

exportFileType defaults to JSON. previewRows defaults to 5.
3

Follow response guidance

Use retryGuidance and suggestedNextCall to decide whether and when to call again.
searchTemplates -> executeTask -> exportData
searchTasks -> startOrStopTask -> exportData

Supported formats

EXCEL, CSV, HTML, JSON, and XML.

Preview rows

previewRows accepts 0 through 20.
Do not assume clients should automatically download or parse exportFileUrl. Treat it as an export artifact reference and follow response guidance.
collecting: the task is still collecting data.exporting: export is being prepared.exported: export metadata is available.no_data, failed, and invalid: no export artifact should be assumed.
When status is exported, response.data includes exportFileUrl and may include sampleData.
page, pageSize, and total are returned when paged export metadata is available.