Analyses
Export an object of the workspace
Creates an export (a report of type export) in pending status and starts the bender flow that builds the export files, as CSVs or XLSXs, and emails the requester a download link. export_type says what is exported and target_id which object; params holds what that type needs beside the target, passed to the flow as-is. For search_project, target_id is the Search project and params the Search page state when the user clicked Export All. Requires read access to the workspace.
POST
/
v1
/
organizations
/
{organization_id}
/
workspaces
/
{workspace_id}
/
exports
Export an object of the workspace
curl --request POST \
--url https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/exports \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"export_type": "search_project",
"target_id": "10000",
"format": "csv",
"params": {
"version": 1,
"date_stamp": "2026-11-10",
"current_collect_id": "c-42",
"current_collect_date": "2026-11-09",
"previous_collect_id": "c-41",
"filters": {
"sources": [
"chatgpt",
"gemini"
],
"thematics": [
"t-1"
],
"topics": [
"tp-1",
"tp-2"
],
"personas": [],
"website_category": [
"brand",
"media"
],
"collect_ids_applied": [],
"previous_collect_ids_applied": [],
"date_range_start": null,
"date_range_end": null,
"date_breakdown": "weekly",
"keyword_type": [],
"funnel_stage": [],
"strength": [],
"weakness": [],
"is_neutral": false
}
}
}
'import requests
url = "https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/exports"
payload = {
"export_type": "search_project",
"target_id": "10000",
"format": "csv",
"params": {
"version": 1,
"date_stamp": "2026-11-10",
"current_collect_id": "c-42",
"current_collect_date": "2026-11-09",
"previous_collect_id": "c-41",
"filters": {
"sources": ["chatgpt", "gemini"],
"thematics": ["t-1"],
"topics": ["tp-1", "tp-2"],
"personas": [],
"website_category": ["brand", "media"],
"collect_ids_applied": [],
"previous_collect_ids_applied": [],
"date_range_start": None,
"date_range_end": None,
"date_breakdown": "weekly",
"keyword_type": [],
"funnel_stage": [],
"strength": [],
"weakness": [],
"is_neutral": False
}
}
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
export_type: 'search_project',
target_id: '10000',
format: 'csv',
params: {
version: 1,
date_stamp: '2026-11-10',
current_collect_id: 'c-42',
current_collect_date: '2026-11-09',
previous_collect_id: 'c-41',
filters: {
sources: ['chatgpt', 'gemini'],
thematics: ['t-1'],
topics: ['tp-1', 'tp-2'],
personas: [],
website_category: ['brand', 'media'],
collect_ids_applied: [],
previous_collect_ids_applied: [],
date_range_start: null,
date_range_end: null,
date_breakdown: 'weekly',
keyword_type: [],
funnel_stage: [],
strength: [],
weakness: [],
is_neutral: false
}
}
})
};
fetch('https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/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.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/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([
'export_type' => 'search_project',
'target_id' => '10000',
'format' => 'csv',
'params' => [
'version' => 1,
'date_stamp' => '2026-11-10',
'current_collect_id' => 'c-42',
'current_collect_date' => '2026-11-09',
'previous_collect_id' => 'c-41',
'filters' => [
'sources' => [
'chatgpt',
'gemini'
],
'thematics' => [
't-1'
],
'topics' => [
'tp-1',
'tp-2'
],
'personas' => [
],
'website_category' => [
'brand',
'media'
],
'collect_ids_applied' => [
],
'previous_collect_ids_applied' => [
],
'date_range_start' => null,
'date_range_end' => null,
'date_breakdown' => 'weekly',
'keyword_type' => [
],
'funnel_stage' => [
],
'strength' => [
],
'weakness' => [
],
'is_neutral' => false
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/exports"
payload := strings.NewReader("{\n \"export_type\": \"search_project\",\n \"target_id\": \"10000\",\n \"format\": \"csv\",\n \"params\": {\n \"version\": 1,\n \"date_stamp\": \"2026-11-10\",\n \"current_collect_id\": \"c-42\",\n \"current_collect_date\": \"2026-11-09\",\n \"previous_collect_id\": \"c-41\",\n \"filters\": {\n \"sources\": [\n \"chatgpt\",\n \"gemini\"\n ],\n \"thematics\": [\n \"t-1\"\n ],\n \"topics\": [\n \"tp-1\",\n \"tp-2\"\n ],\n \"personas\": [],\n \"website_category\": [\n \"brand\",\n \"media\"\n ],\n \"collect_ids_applied\": [],\n \"previous_collect_ids_applied\": [],\n \"date_range_start\": null,\n \"date_range_end\": null,\n \"date_breakdown\": \"weekly\",\n \"keyword_type\": [],\n \"funnel_stage\": [],\n \"strength\": [],\n \"weakness\": [],\n \"is_neutral\": false\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
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.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/exports")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"export_type\": \"search_project\",\n \"target_id\": \"10000\",\n \"format\": \"csv\",\n \"params\": {\n \"version\": 1,\n \"date_stamp\": \"2026-11-10\",\n \"current_collect_id\": \"c-42\",\n \"current_collect_date\": \"2026-11-09\",\n \"previous_collect_id\": \"c-41\",\n \"filters\": {\n \"sources\": [\n \"chatgpt\",\n \"gemini\"\n ],\n \"thematics\": [\n \"t-1\"\n ],\n \"topics\": [\n \"tp-1\",\n \"tp-2\"\n ],\n \"personas\": [],\n \"website_category\": [\n \"brand\",\n \"media\"\n ],\n \"collect_ids_applied\": [],\n \"previous_collect_ids_applied\": [],\n \"date_range_start\": null,\n \"date_range_end\": null,\n \"date_breakdown\": \"weekly\",\n \"keyword_type\": [],\n \"funnel_stage\": [],\n \"strength\": [],\n \"weakness\": [],\n \"is_neutral\": false\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/exports")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"export_type\": \"search_project\",\n \"target_id\": \"10000\",\n \"format\": \"csv\",\n \"params\": {\n \"version\": 1,\n \"date_stamp\": \"2026-11-10\",\n \"current_collect_id\": \"c-42\",\n \"current_collect_date\": \"2026-11-09\",\n \"previous_collect_id\": \"c-41\",\n \"filters\": {\n \"sources\": [\n \"chatgpt\",\n \"gemini\"\n ],\n \"thematics\": [\n \"t-1\"\n ],\n \"topics\": [\n \"tp-1\",\n \"tp-2\"\n ],\n \"personas\": [],\n \"website_category\": [\n \"brand\",\n \"media\"\n ],\n \"collect_ids_applied\": [],\n \"previous_collect_ids_applied\": [],\n \"date_range_start\": null,\n \"date_range_end\": null,\n \"date_breakdown\": \"weekly\",\n \"keyword_type\": [],\n \"funnel_stage\": [],\n \"strength\": [],\n \"weakness\": [],\n \"is_neutral\": false\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "pending",
"created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"report_type": "baseline_report",
"url": "<string>",
"search_project_id": "<string>",
"workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"export_type": "search_project",
"target_id": "<string>",
"analysis": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}Path Parameters
Body
application/jsonapplication/x-www-form-urlencodedmultipart/form-data*/*
Response
Export created in pending status, flow started.
Was this page helpful?
⌘I
Export an object of the workspace
curl --request POST \
--url https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/exports \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"export_type": "search_project",
"target_id": "10000",
"format": "csv",
"params": {
"version": 1,
"date_stamp": "2026-11-10",
"current_collect_id": "c-42",
"current_collect_date": "2026-11-09",
"previous_collect_id": "c-41",
"filters": {
"sources": [
"chatgpt",
"gemini"
],
"thematics": [
"t-1"
],
"topics": [
"tp-1",
"tp-2"
],
"personas": [],
"website_category": [
"brand",
"media"
],
"collect_ids_applied": [],
"previous_collect_ids_applied": [],
"date_range_start": null,
"date_range_end": null,
"date_breakdown": "weekly",
"keyword_type": [],
"funnel_stage": [],
"strength": [],
"weakness": [],
"is_neutral": false
}
}
}
'import requests
url = "https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/exports"
payload = {
"export_type": "search_project",
"target_id": "10000",
"format": "csv",
"params": {
"version": 1,
"date_stamp": "2026-11-10",
"current_collect_id": "c-42",
"current_collect_date": "2026-11-09",
"previous_collect_id": "c-41",
"filters": {
"sources": ["chatgpt", "gemini"],
"thematics": ["t-1"],
"topics": ["tp-1", "tp-2"],
"personas": [],
"website_category": ["brand", "media"],
"collect_ids_applied": [],
"previous_collect_ids_applied": [],
"date_range_start": None,
"date_range_end": None,
"date_breakdown": "weekly",
"keyword_type": [],
"funnel_stage": [],
"strength": [],
"weakness": [],
"is_neutral": False
}
}
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
export_type: 'search_project',
target_id: '10000',
format: 'csv',
params: {
version: 1,
date_stamp: '2026-11-10',
current_collect_id: 'c-42',
current_collect_date: '2026-11-09',
previous_collect_id: 'c-41',
filters: {
sources: ['chatgpt', 'gemini'],
thematics: ['t-1'],
topics: ['tp-1', 'tp-2'],
personas: [],
website_category: ['brand', 'media'],
collect_ids_applied: [],
previous_collect_ids_applied: [],
date_range_start: null,
date_range_end: null,
date_breakdown: 'weekly',
keyword_type: [],
funnel_stage: [],
strength: [],
weakness: [],
is_neutral: false
}
}
})
};
fetch('https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/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.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/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([
'export_type' => 'search_project',
'target_id' => '10000',
'format' => 'csv',
'params' => [
'version' => 1,
'date_stamp' => '2026-11-10',
'current_collect_id' => 'c-42',
'current_collect_date' => '2026-11-09',
'previous_collect_id' => 'c-41',
'filters' => [
'sources' => [
'chatgpt',
'gemini'
],
'thematics' => [
't-1'
],
'topics' => [
'tp-1',
'tp-2'
],
'personas' => [
],
'website_category' => [
'brand',
'media'
],
'collect_ids_applied' => [
],
'previous_collect_ids_applied' => [
],
'date_range_start' => null,
'date_range_end' => null,
'date_breakdown' => 'weekly',
'keyword_type' => [
],
'funnel_stage' => [
],
'strength' => [
],
'weakness' => [
],
'is_neutral' => false
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/exports"
payload := strings.NewReader("{\n \"export_type\": \"search_project\",\n \"target_id\": \"10000\",\n \"format\": \"csv\",\n \"params\": {\n \"version\": 1,\n \"date_stamp\": \"2026-11-10\",\n \"current_collect_id\": \"c-42\",\n \"current_collect_date\": \"2026-11-09\",\n \"previous_collect_id\": \"c-41\",\n \"filters\": {\n \"sources\": [\n \"chatgpt\",\n \"gemini\"\n ],\n \"thematics\": [\n \"t-1\"\n ],\n \"topics\": [\n \"tp-1\",\n \"tp-2\"\n ],\n \"personas\": [],\n \"website_category\": [\n \"brand\",\n \"media\"\n ],\n \"collect_ids_applied\": [],\n \"previous_collect_ids_applied\": [],\n \"date_range_start\": null,\n \"date_range_end\": null,\n \"date_breakdown\": \"weekly\",\n \"keyword_type\": [],\n \"funnel_stage\": [],\n \"strength\": [],\n \"weakness\": [],\n \"is_neutral\": false\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
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.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/exports")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"export_type\": \"search_project\",\n \"target_id\": \"10000\",\n \"format\": \"csv\",\n \"params\": {\n \"version\": 1,\n \"date_stamp\": \"2026-11-10\",\n \"current_collect_id\": \"c-42\",\n \"current_collect_date\": \"2026-11-09\",\n \"previous_collect_id\": \"c-41\",\n \"filters\": {\n \"sources\": [\n \"chatgpt\",\n \"gemini\"\n ],\n \"thematics\": [\n \"t-1\"\n ],\n \"topics\": [\n \"tp-1\",\n \"tp-2\"\n ],\n \"personas\": [],\n \"website_category\": [\n \"brand\",\n \"media\"\n ],\n \"collect_ids_applied\": [],\n \"previous_collect_ids_applied\": [],\n \"date_range_start\": null,\n \"date_range_end\": null,\n \"date_breakdown\": \"weekly\",\n \"keyword_type\": [],\n \"funnel_stage\": [],\n \"strength\": [],\n \"weakness\": [],\n \"is_neutral\": false\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/exports")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"export_type\": \"search_project\",\n \"target_id\": \"10000\",\n \"format\": \"csv\",\n \"params\": {\n \"version\": 1,\n \"date_stamp\": \"2026-11-10\",\n \"current_collect_id\": \"c-42\",\n \"current_collect_date\": \"2026-11-09\",\n \"previous_collect_id\": \"c-41\",\n \"filters\": {\n \"sources\": [\n \"chatgpt\",\n \"gemini\"\n ],\n \"thematics\": [\n \"t-1\"\n ],\n \"topics\": [\n \"tp-1\",\n \"tp-2\"\n ],\n \"personas\": [],\n \"website_category\": [\n \"brand\",\n \"media\"\n ],\n \"collect_ids_applied\": [],\n \"previous_collect_ids_applied\": [],\n \"date_range_start\": null,\n \"date_range_end\": null,\n \"date_breakdown\": \"weekly\",\n \"keyword_type\": [],\n \"funnel_stage\": [],\n \"strength\": [],\n \"weakness\": [],\n \"is_neutral\": false\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "pending",
"created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"report_type": "baseline_report",
"url": "<string>",
"search_project_id": "<string>",
"workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"export_type": "search_project",
"target_id": "<string>",
"analysis": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}