curl --request GET \
--url https://preuve.ai/api/agent/agency/reports/{id}/export \
--header 'Authorization: Bearer <token>'import requests
url = "https://preuve.ai/api/agent/agency/reports/{id}/export"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://preuve.ai/api/agent/agency/reports/{id}/export', 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://preuve.ai/api/agent/agency/reports/{id}/export",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
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://preuve.ai/api/agent/agency/reports/{id}/export"
req, _ := http.NewRequest("GET", 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.get("https://preuve.ai/api/agent/agency/reports/{id}/export")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://preuve.ai/api/agent/agency/reports/{id}/export")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"schemaVersion": 123,
"exportType": "agency-report",
"dataAsOf": "2023-11-07T05:31:56Z",
"exportedAt": "2023-11-07T05:31:56Z",
"report": {},
"ownerExclusions": [
{
"name": "<string>",
"reasonCode": "<string>",
"hiddenAt": "2023-11-07T05:31:56Z"
}
],
"locked": {
"reason": "<string>",
"unlockedBy": "<string>",
"fields": [
{
"path": "<string>",
"label": "<string>"
}
],
"note": "<string>"
}
}{
"error": "<string>",
"code": "<string>",
"details": {},
"limit": 123,
"remaining": 123,
"resetAt": "2023-11-07T05:31:56Z",
"tokenBalance": 123,
"scansUsed": 123,
"scansRemaining": 123,
"limitType": "<string>",
"upgradeHint": "<string>",
"creditScans": {
"available": 123,
"packCost": 123,
"packSize": 123,
"balance": 123,
"canBuyBundles": true
},
"paused": true,
"upsell": {
"offer": "founder_report",
"guarantee": "<string>",
"url": "<string>",
"locked": [
"<string>"
],
"note": "<string>"
}
}{
"error": "<string>",
"code": "<string>",
"details": {},
"limit": 123,
"remaining": 123,
"resetAt": "2023-11-07T05:31:56Z",
"tokenBalance": 123,
"scansUsed": 123,
"scansRemaining": 123,
"limitType": "<string>",
"upgradeHint": "<string>",
"creditScans": {
"available": 123,
"packCost": 123,
"packSize": 123,
"balance": 123,
"canBuyBundles": true
},
"paused": true,
"upsell": {
"offer": "founder_report",
"guarantee": "<string>",
"url": "<string>",
"locked": [
"<string>"
],
"note": "<string>"
}
}{
"error": "<string>",
"code": "<string>",
"details": {},
"limit": 123,
"remaining": 123,
"resetAt": "2023-11-07T05:31:56Z",
"tokenBalance": 123,
"scansUsed": 123,
"scansRemaining": 123,
"limitType": "<string>",
"upgradeHint": "<string>",
"creditScans": {
"available": 123,
"packCost": 123,
"packSize": 123,
"balance": 123,
"canBuyBundles": true
},
"paused": true,
"upsell": {
"offer": "founder_report",
"guarantee": "<string>",
"url": "<string>",
"locked": [
"<string>"
],
"note": "<string>"
}
}{
"error": "<string>",
"code": "<string>",
"details": {},
"limit": 123,
"remaining": 123,
"resetAt": "2023-11-07T05:31:56Z",
"tokenBalance": 123,
"scansUsed": 123,
"scansRemaining": 123,
"limitType": "<string>",
"upgradeHint": "<string>",
"creditScans": {
"available": 123,
"packCost": 123,
"packSize": 123,
"balance": 123,
"canBuyBundles": true
},
"paused": true,
"upsell": {
"offer": "founder_report",
"guarantee": "<string>",
"url": "<string>",
"locked": [
"<string>"
],
"note": "<string>"
}
}{
"error": "<string>",
"code": "<string>",
"details": {},
"limit": 123,
"remaining": 123,
"resetAt": "2023-11-07T05:31:56Z",
"tokenBalance": 123,
"scansUsed": 123,
"scansRemaining": 123,
"limitType": "<string>",
"upgradeHint": "<string>",
"creditScans": {
"available": 123,
"packCost": 123,
"packSize": 123,
"balance": 123,
"canBuyBundles": true
},
"paused": true,
"upsell": {
"offer": "founder_report",
"guarantee": "<string>",
"url": "<string>",
"locked": [
"<string>"
],
"note": "<string>"
}
}{
"error": "<string>",
"code": "<string>",
"details": {},
"limit": 123,
"remaining": 123,
"resetAt": "2023-11-07T05:31:56Z",
"tokenBalance": 123,
"scansUsed": 123,
"scansRemaining": 123,
"limitType": "<string>",
"upgradeHint": "<string>",
"creditScans": {
"available": 123,
"packCost": 123,
"packSize": 123,
"balance": 123,
"canBuyBundles": true
},
"paused": true,
"upsell": {
"offer": "founder_report",
"guarantee": "<string>",
"url": "<string>",
"locked": [
"<string>"
],
"note": "<string>"
}
}{
"error": "<string>",
"code": "<string>",
"details": {},
"limit": 123,
"remaining": 123,
"resetAt": "2023-11-07T05:31:56Z",
"tokenBalance": 123,
"scansUsed": 123,
"scansRemaining": 123,
"limitType": "<string>",
"upgradeHint": "<string>",
"creditScans": {
"available": 123,
"packCost": 123,
"packSize": 123,
"balance": 123,
"canBuyBundles": true
},
"paused": true,
"upsell": {
"offer": "founder_report",
"guarantee": "<string>",
"url": "<string>",
"locked": [
"<string>"
],
"note": "<string>"
}
}{
"error": "<string>",
"code": "<string>",
"details": {},
"limit": 123,
"remaining": 123,
"resetAt": "2023-11-07T05:31:56Z",
"tokenBalance": 123,
"scansUsed": 123,
"scansRemaining": 123,
"limitType": "<string>",
"upgradeHint": "<string>",
"creditScans": {
"available": 123,
"packCost": 123,
"packSize": 123,
"balance": 123,
"canBuyBundles": true
},
"paused": true,
"upsell": {
"offer": "founder_report",
"guarantee": "<string>",
"url": "<string>",
"locked": [
"<string>"
],
"note": "<string>"
}
}Export a client report
Structured JSON for one COMPLETED client report, or the same envelope rendered as Markdown with format=markdown. Starter and refunded reports keep their normal content restrictions, named under locked. The report webhook (see the Webhooks guide) hands out both URLs.
curl --request GET \
--url https://preuve.ai/api/agent/agency/reports/{id}/export \
--header 'Authorization: Bearer <token>'import requests
url = "https://preuve.ai/api/agent/agency/reports/{id}/export"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://preuve.ai/api/agent/agency/reports/{id}/export', 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://preuve.ai/api/agent/agency/reports/{id}/export",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
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://preuve.ai/api/agent/agency/reports/{id}/export"
req, _ := http.NewRequest("GET", 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.get("https://preuve.ai/api/agent/agency/reports/{id}/export")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://preuve.ai/api/agent/agency/reports/{id}/export")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"schemaVersion": 123,
"exportType": "agency-report",
"dataAsOf": "2023-11-07T05:31:56Z",
"exportedAt": "2023-11-07T05:31:56Z",
"report": {},
"ownerExclusions": [
{
"name": "<string>",
"reasonCode": "<string>",
"hiddenAt": "2023-11-07T05:31:56Z"
}
],
"locked": {
"reason": "<string>",
"unlockedBy": "<string>",
"fields": [
{
"path": "<string>",
"label": "<string>"
}
],
"note": "<string>"
}
}{
"error": "<string>",
"code": "<string>",
"details": {},
"limit": 123,
"remaining": 123,
"resetAt": "2023-11-07T05:31:56Z",
"tokenBalance": 123,
"scansUsed": 123,
"scansRemaining": 123,
"limitType": "<string>",
"upgradeHint": "<string>",
"creditScans": {
"available": 123,
"packCost": 123,
"packSize": 123,
"balance": 123,
"canBuyBundles": true
},
"paused": true,
"upsell": {
"offer": "founder_report",
"guarantee": "<string>",
"url": "<string>",
"locked": [
"<string>"
],
"note": "<string>"
}
}{
"error": "<string>",
"code": "<string>",
"details": {},
"limit": 123,
"remaining": 123,
"resetAt": "2023-11-07T05:31:56Z",
"tokenBalance": 123,
"scansUsed": 123,
"scansRemaining": 123,
"limitType": "<string>",
"upgradeHint": "<string>",
"creditScans": {
"available": 123,
"packCost": 123,
"packSize": 123,
"balance": 123,
"canBuyBundles": true
},
"paused": true,
"upsell": {
"offer": "founder_report",
"guarantee": "<string>",
"url": "<string>",
"locked": [
"<string>"
],
"note": "<string>"
}
}{
"error": "<string>",
"code": "<string>",
"details": {},
"limit": 123,
"remaining": 123,
"resetAt": "2023-11-07T05:31:56Z",
"tokenBalance": 123,
"scansUsed": 123,
"scansRemaining": 123,
"limitType": "<string>",
"upgradeHint": "<string>",
"creditScans": {
"available": 123,
"packCost": 123,
"packSize": 123,
"balance": 123,
"canBuyBundles": true
},
"paused": true,
"upsell": {
"offer": "founder_report",
"guarantee": "<string>",
"url": "<string>",
"locked": [
"<string>"
],
"note": "<string>"
}
}{
"error": "<string>",
"code": "<string>",
"details": {},
"limit": 123,
"remaining": 123,
"resetAt": "2023-11-07T05:31:56Z",
"tokenBalance": 123,
"scansUsed": 123,
"scansRemaining": 123,
"limitType": "<string>",
"upgradeHint": "<string>",
"creditScans": {
"available": 123,
"packCost": 123,
"packSize": 123,
"balance": 123,
"canBuyBundles": true
},
"paused": true,
"upsell": {
"offer": "founder_report",
"guarantee": "<string>",
"url": "<string>",
"locked": [
"<string>"
],
"note": "<string>"
}
}{
"error": "<string>",
"code": "<string>",
"details": {},
"limit": 123,
"remaining": 123,
"resetAt": "2023-11-07T05:31:56Z",
"tokenBalance": 123,
"scansUsed": 123,
"scansRemaining": 123,
"limitType": "<string>",
"upgradeHint": "<string>",
"creditScans": {
"available": 123,
"packCost": 123,
"packSize": 123,
"balance": 123,
"canBuyBundles": true
},
"paused": true,
"upsell": {
"offer": "founder_report",
"guarantee": "<string>",
"url": "<string>",
"locked": [
"<string>"
],
"note": "<string>"
}
}{
"error": "<string>",
"code": "<string>",
"details": {},
"limit": 123,
"remaining": 123,
"resetAt": "2023-11-07T05:31:56Z",
"tokenBalance": 123,
"scansUsed": 123,
"scansRemaining": 123,
"limitType": "<string>",
"upgradeHint": "<string>",
"creditScans": {
"available": 123,
"packCost": 123,
"packSize": 123,
"balance": 123,
"canBuyBundles": true
},
"paused": true,
"upsell": {
"offer": "founder_report",
"guarantee": "<string>",
"url": "<string>",
"locked": [
"<string>"
],
"note": "<string>"
}
}{
"error": "<string>",
"code": "<string>",
"details": {},
"limit": 123,
"remaining": 123,
"resetAt": "2023-11-07T05:31:56Z",
"tokenBalance": 123,
"scansUsed": 123,
"scansRemaining": 123,
"limitType": "<string>",
"upgradeHint": "<string>",
"creditScans": {
"available": 123,
"packCost": 123,
"packSize": 123,
"balance": 123,
"canBuyBundles": true
},
"paused": true,
"upsell": {
"offer": "founder_report",
"guarantee": "<string>",
"url": "<string>",
"locked": [
"<string>"
],
"note": "<string>"
}
}{
"error": "<string>",
"code": "<string>",
"details": {},
"limit": 123,
"remaining": 123,
"resetAt": "2023-11-07T05:31:56Z",
"tokenBalance": 123,
"scansUsed": 123,
"scansRemaining": 123,
"limitType": "<string>",
"upgradeHint": "<string>",
"creditScans": {
"available": 123,
"packCost": 123,
"packSize": 123,
"balance": 123,
"canBuyBundles": true
},
"paused": true,
"upsell": {
"offer": "founder_report",
"guarantee": "<string>",
"url": "<string>",
"locked": [
"<string>"
],
"note": "<string>"
}
}Authorizations
Query Parameters
Response
The export payload, JSON by default or Markdown with format=markdown.
Which fields this export left null, and why. Present only when the caller's tier withheld something, and absent entirely when the payload is complete. Read it before concluding a field is absent: a null under one of these paths is locked, not missing and not a failed analysis. It ships to every tier, paid included, and carries no price and no URL. On a batch export there is ONE object for the whole batch, the union of every exported item's withheld fields, deduplicated by path.
Show child attributes
Show child attributes