Export data

curl --request POST \
  --url https://api.orchestrivo.com/api/v1/export_data \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "user_id": "<string>",
  "export_fields": [
    "<string>"
  ],
  "start_date": "2023-11-07T05:31:56Z",
  "end_date": "2023-11-07T05:31:56Z",
  "data_type": "workflows",
  "category_filter": "<string>",
  "export_level": "organization",
  "include_all_workspaces": false,
  "include_personal_workspaces": false,
  "workspace_ids": [
    "<string>"
  ],
  "entity_ids": [
    "<string>"
  ]
}
'

import requests

url = "https://api.orchestrivo.com/api/v1/export_data"

payload = {
    "user_id": "<string>",
    "export_fields": ["<string>"],
    "start_date": "2023-11-07T05:31:56Z",
    "end_date": "2023-11-07T05:31:56Z",
    "data_type": "workflows",
    "category_filter": "<string>",
    "export_level": "organization",
    "include_all_workspaces": False,
    "include_personal_workspaces": False,
    "workspace_ids": ["<string>"],
    "entity_ids": ["<string>"]
}
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({
    user_id: '<string>',
    export_fields: ['<string>'],
    start_date: '2023-11-07T05:31:56Z',
    end_date: '2023-11-07T05:31:56Z',
    data_type: 'workflows',
    category_filter: '<string>',
    export_level: 'organization',
    include_all_workspaces: false,
    include_personal_workspaces: false,
    workspace_ids: ['<string>'],
    entity_ids: ['<string>']
  })
};

fetch('https://api.orchestrivo.com/api/v1/export_data', 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.orchestrivo.com/api/v1/export_data",
  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([
    'user_id' => '<string>',
    'export_fields' => [
        '<string>'
    ],
    'start_date' => '2023-11-07T05:31:56Z',
    'end_date' => '2023-11-07T05:31:56Z',
    'data_type' => 'workflows',
    'category_filter' => '<string>',
    'export_level' => 'organization',
    'include_all_workspaces' => false,
    'include_personal_workspaces' => false,
    'workspace_ids' => [
        '<string>'
    ],
    'entity_ids' => [
        '<string>'
    ]
  ]),
  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.orchestrivo.com/api/v1/export_data"

	payload := strings.NewReader("{\n  \"user_id\": \"<string>\",\n  \"export_fields\": [\n    \"<string>\"\n  ],\n  \"start_date\": \"2023-11-07T05:31:56Z\",\n  \"end_date\": \"2023-11-07T05:31:56Z\",\n  \"data_type\": \"workflows\",\n  \"category_filter\": \"<string>\",\n  \"export_level\": \"organization\",\n  \"include_all_workspaces\": false,\n  \"include_personal_workspaces\": false,\n  \"workspace_ids\": [\n    \"<string>\"\n  ],\n  \"entity_ids\": [\n    \"<string>\"\n  ]\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.orchestrivo.com/api/v1/export_data")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"user_id\": \"<string>\",\n  \"export_fields\": [\n    \"<string>\"\n  ],\n  \"start_date\": \"2023-11-07T05:31:56Z\",\n  \"end_date\": \"2023-11-07T05:31:56Z\",\n  \"data_type\": \"workflows\",\n  \"category_filter\": \"<string>\",\n  \"export_level\": \"organization\",\n  \"include_all_workspaces\": false,\n  \"include_personal_workspaces\": false,\n  \"workspace_ids\": [\n    \"<string>\"\n  ],\n  \"entity_ids\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.orchestrivo.com/api/v1/export_data")

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  \"user_id\": \"<string>\",\n  \"export_fields\": [\n    \"<string>\"\n  ],\n  \"start_date\": \"2023-11-07T05:31:56Z\",\n  \"end_date\": \"2023-11-07T05:31:56Z\",\n  \"data_type\": \"workflows\",\n  \"category_filter\": \"<string>\",\n  \"export_level\": \"organization\",\n  \"include_all_workspaces\": false,\n  \"include_personal_workspaces\": false,\n  \"workspace_ids\": [\n    \"<string>\"\n  ],\n  \"entity_ids\": [\n    \"<string>\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data_export_id": "<string>",
  "state": "REQUESTED",
  "created_ts": "2023-11-07T05:31:56Z"
}

POST

export_data

Export data

curl --request POST \
  --url https://api.orchestrivo.com/api/v1/export_data \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "user_id": "<string>",
  "export_fields": [
    "<string>"
  ],
  "start_date": "2023-11-07T05:31:56Z",
  "end_date": "2023-11-07T05:31:56Z",
  "data_type": "workflows",
  "category_filter": "<string>",
  "export_level": "organization",
  "include_all_workspaces": false,
  "include_personal_workspaces": false,
  "workspace_ids": [
    "<string>"
  ],
  "entity_ids": [
    "<string>"
  ]
}
'

import requests

url = "https://api.orchestrivo.com/api/v1/export_data"

payload = {
    "user_id": "<string>",
    "export_fields": ["<string>"],
    "start_date": "2023-11-07T05:31:56Z",
    "end_date": "2023-11-07T05:31:56Z",
    "data_type": "workflows",
    "category_filter": "<string>",
    "export_level": "organization",
    "include_all_workspaces": False,
    "include_personal_workspaces": False,
    "workspace_ids": ["<string>"],
    "entity_ids": ["<string>"]
}
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({
    user_id: '<string>',
    export_fields: ['<string>'],
    start_date: '2023-11-07T05:31:56Z',
    end_date: '2023-11-07T05:31:56Z',
    data_type: 'workflows',
    category_filter: '<string>',
    export_level: 'organization',
    include_all_workspaces: false,
    include_personal_workspaces: false,
    workspace_ids: ['<string>'],
    entity_ids: ['<string>']
  })
};

fetch('https://api.orchestrivo.com/api/v1/export_data', 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.orchestrivo.com/api/v1/export_data",
  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([
    'user_id' => '<string>',
    'export_fields' => [
        '<string>'
    ],
    'start_date' => '2023-11-07T05:31:56Z',
    'end_date' => '2023-11-07T05:31:56Z',
    'data_type' => 'workflows',
    'category_filter' => '<string>',
    'export_level' => 'organization',
    'include_all_workspaces' => false,
    'include_personal_workspaces' => false,
    'workspace_ids' => [
        '<string>'
    ],
    'entity_ids' => [
        '<string>'
    ]
  ]),
  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.orchestrivo.com/api/v1/export_data"

	payload := strings.NewReader("{\n  \"user_id\": \"<string>\",\n  \"export_fields\": [\n    \"<string>\"\n  ],\n  \"start_date\": \"2023-11-07T05:31:56Z\",\n  \"end_date\": \"2023-11-07T05:31:56Z\",\n  \"data_type\": \"workflows\",\n  \"category_filter\": \"<string>\",\n  \"export_level\": \"organization\",\n  \"include_all_workspaces\": false,\n  \"include_personal_workspaces\": false,\n  \"workspace_ids\": [\n    \"<string>\"\n  ],\n  \"entity_ids\": [\n    \"<string>\"\n  ]\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.orchestrivo.com/api/v1/export_data")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"user_id\": \"<string>\",\n  \"export_fields\": [\n    \"<string>\"\n  ],\n  \"start_date\": \"2023-11-07T05:31:56Z\",\n  \"end_date\": \"2023-11-07T05:31:56Z\",\n  \"data_type\": \"workflows\",\n  \"category_filter\": \"<string>\",\n  \"export_level\": \"organization\",\n  \"include_all_workspaces\": false,\n  \"include_personal_workspaces\": false,\n  \"workspace_ids\": [\n    \"<string>\"\n  ],\n  \"entity_ids\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.orchestrivo.com/api/v1/export_data")

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  \"user_id\": \"<string>\",\n  \"export_fields\": [\n    \"<string>\"\n  ],\n  \"start_date\": \"2023-11-07T05:31:56Z\",\n  \"end_date\": \"2023-11-07T05:31:56Z\",\n  \"data_type\": \"workflows\",\n  \"category_filter\": \"<string>\",\n  \"export_level\": \"organization\",\n  \"include_all_workspaces\": false,\n  \"include_personal_workspaces\": false,\n  \"workspace_ids\": [\n    \"<string>\"\n  ],\n  \"entity_ids\": [\n    \"<string>\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data_export_id": "<string>",
  "state": "REQUESTED",
  "created_ts": "2023-11-07T05:31:56Z"
}

What can I export, and how do I scope it?

The export supports seven data types:

Workflow data (data_type: "workflows"): Includes workflow runs, workbook details, user information, and other organizational data.
Agent data (data_type: "agents"): Includes agent configurations, metadata, tools, and creator information.
Agent interaction data (data_type: "agent_interactions"): Includes agent interaction data with timestamps, credit costs, trigger types, and message counts.
Credit log data (data_type: "credit_logs"): Includes credit transaction history with charges, balances, categories, and user attribution.
Interaction evaluation data (data_type: "interaction_evaluations"): Includes one row per completed evaluation of a chat, with its grade, call outcome, sentiment, and the model that graded it.
Orchestrivo Controls data (data_type: "orchestrivocontrols"): Includes Orchestrivo Controls MCP tool call activity with timestamps, statuses, and latency.
Artifact analytics data (data_type: "artifact_analytics"): Includes one row per artifact viewed in the date range, with views, unique viewers, time on page, tool calls, and location, device, and browser breakdowns. Available as a one-time export only, not as a data drain.

The available export_fields depend on the selected data_type. See the field descriptions below for details.Scoping requirement: For workflow, agent, agent interaction, and interaction evaluation exports, at least one scoping parameter must be provided: workspace_ids, include_all_workspaces, include_personal_workspaces, or entity_ids. Requests that omit all scoping parameters will receive a 400 error.Note: Credit log exports work differently from workflow and agent exports. When data_type is "credit_logs", the following parameters are not applicable and will be ignored: export_level, workspace_ids, include_all_workspaces, include_personal_workspaces, and entity_ids. Credit log exports are always scoped to the entire organization. Use category_filter to filter by credit log category.

Authorizations

Authorization

string

header

required

A personal API key or an OAuth 2.0 access token. Personal API keys also require the x-auth-key header with your user ID.

Body

application/json

user_id

string

required

The ID of the user requesting the export.

export_fields

string[]

required

Array of fields to include in the export. The available fields depend on the data_type.

Workflow fields (when data_type is "workflows"):

workbook_id - The workbook identifier
workbook_name - The workbook name
workbook_created_ts - Workbook creation timestamp
user_id - The user identifier
user_email - The user's email address
workspace_id - The workspace identifier
workspace_name - The workspace name
run_id - The flow run identifier
credit_cost - Credits consumed by the run
pl_run_created_ts - Flow run creation timestamp
pl_run_finished_ts - Flow run completion timestamp
pipeline - The full pipeline configuration (JSON)

Agent fields (when data_type is "agents"):

agent_id - The agent identifier
agent_name - The agent name
agent_description - The agent description
agent_model - The model used by the agent
agent_system_prompt - The agent's system prompt
agent_created_ts - Agent creation timestamp
agent_tools - Tools configured for the agent (JSON)
agent_metadata - Additional agent metadata (JSON)
agent_evaluations_enabled - Whether the agent's own Evaluations are turned on (true/false)
creator_email - Email of the user who created the agent
workspace_id - The workspace identifier
workspace_name - The workspace name
folder_id - The identifier of the folder containing the agent (empty when the agent is not in a folder)
folder_name - The name of the folder containing the agent (empty when the agent is not in a folder)

Agent interaction fields (when data_type is "agent_interactions"):

interaction_id - Unique identifier for the chat session
agent_id - The agent identifier
agent_name - The agent name
interaction_type - Type of interaction (e.g., chat, slack, api, triggered)
interaction_name - Display name of the chat session
trigger_type - For triggered interactions, the specific trigger type (e.g., time_based, polling_new_record_salesforce). Null for non-triggered interactions.
interaction_created_ts - Chat session creation timestamp
user_email - Email of the user who initiated the chat
credit_cost - Total credits consumed (LLM + tool + flow)
llm_credit_cost - Credits consumed by LLM calls only
tool_credit_cost - Credits consumed by tool calls
flow_credit_cost - Credits consumed by pipeline runs
message_count - Number of messages in the conversation
workspace_id - The workspace identifier
workspace_name - The workspace name

Interaction evaluation fields (when data_type is "interaction_evaluations"):

evaluation_id - Unique identifier for the evaluation row
interaction_id - The chat session that was evaluated (one chat can have several evaluation rows)
agent_id - The identifier of the agent that was evaluated
organization_evaluation_id - The organization-level evaluation this row belongs to (empty for agent-level rubrics)
evaluation_created_ts - When the evaluation reached its final state
status - The evaluation's state
grade - The grade the evaluation produced
call_outcome - The outcome the evaluation recorded for the conversation
sentiment - The sentiment the evaluation recorded
error_code - Error code when the evaluation could not complete
summary - The evaluation's written summary
evaluation_model - The model that ran the evaluation
credit_cost - Credits consumed by the evaluation
user_email - Email of the user whose chat was evaluated

Credit log fields (when data_type is "credit_logs"):

user_email - Email of the user associated with the credit log entry
permission_group_id - Custom role ID(s) the user belongs to (semicolon-separated if multiple) (disabled by default)
permission_group_name - Custom role name(s) the user belongs to (semicolon-separated if multiple) (disabled by default)
timestamp - When the credit transaction occurred
category - The category of the credit log (e.g., PIPELINE_RUN, AGENT_RUN)
type - The specific type of credit charge
name - Display name of the credit log entry
amount - Number of credits charged or adjusted
balance - Credit balance after the transaction
log_id - Unique identifier for the credit log entry
correlation_id - Join key to the related run or interaction (disabled by default)
balance_scope - Whether the balance is organization- or user-scoped (disabled by default)
project_id - The project identifier (disabled by default)

Artifact analytics fields (when data_type is "artifact_analytics"). Organization scope covers every artifact viewed in the organization; personal scope covers artifacts in your personal workspace or with a published version you created, as long as you can still open their Analytics tab:

artifact_id - The artifact identifier
artifact_name - The artifact's display name (empty for a deleted artifact)
views - Number of page opens in the date range
unique_viewers - Distinct signed-in users plus distinct anonymous visitors
total_time_on_page_ms - Active time on page across all views, in milliseconds
avg_time_on_page_ms - Average active time per view, in milliseconds (a view that reported no active time counts as 0)
last_viewed_at - Timestamp of the most recent view
tool_calls - Tool calls made from the artifact in the date range and attributed to a view. A call attributed to a view opened up to 2 hours before the start date counts here but appears in no view_details entry
failed_tool_calls - Attributed tool calls that ended in an error
views_by_country - Views per country (JSON)
views_by_city - Views per country, region, and city (JSON)
views_by_device - Views per device type (JSON)
views_by_browser - Views per browser (JSON)
view_details - Every view with its viewer, location, device, browser, active-time chunks, and attributed tool call metadata. Tool call inputs and outputs and viewer IP addresses are never included (JSON, disabled by default)

Not all combinations of selected fields are guaranteed to produce data for every row.

start_date

string<date-time>

required

Start date for the export in ISO 8601 format (e.g., 2025-01-01T00:00:00Z).

end_date

string<date-time>

required

End date for the export in ISO 8601 format (e.g., 2025-12-31T23:59:59Z).

data_type

enum<string>

default:workflows

The type of data to export. Use "workflows" to export workflow run data, "agents" to export agent configuration data, "agent_interactions" to export agent interaction data, "credit_logs" to export credit transaction history, "interaction_evaluations" to export completed chat evaluations, "orchestrivocontrols" to export Orchestrivo Controls tool call activity, or "artifact_analytics" to export per-artifact view analytics. Defaults to "workflows". Audit-log exports are available in the Orchestrivo app only, not through this endpoint.

Available options:

workflows,

agents,

agent_interactions,

credit_logs,

interaction_evaluations,

orchestrivocontrols,

artifact_analytics

category_filter

string

Only applicable when data_type is "credit_logs". Optional filter to export only credit logs matching a specific category (e.g., "PIPELINE_RUN", "AGENT_RUN", "CUSTOM_NODE_RD", "EXTERNAL_GUMCP_CALL"). When omitted, all categories are included.

export_level

enum<string>

default:organization

The scope of the export. Use "organization" to export across the entire organization, or "workspace" to export from a single workspace (requires exactly one ID in workspace_ids). Defaults to "organization". Not applicable when data_type is "credit_logs".

Available options:

workspace,

organization

include_all_workspaces

boolean

default:false

Whether to include all workspaces in the organization. When true, also sets include_personal_workspaces to true. Not applicable when data_type is "credit_logs".

include_personal_workspaces

boolean

default:false

Whether to include personal workspaces in the export. Ignored if include_all_workspaces is true. Not applicable when data_type is "credit_logs".

workspace_ids

string[]

An optional array of workspace IDs to include in the export. When export_level is "workspace", exactly one workspace ID is required. Ignored if include_all_workspaces is true. Not applicable when data_type is "credit_logs".

entity_ids

string[]

An optional array of specific entity IDs to filter the export. For workflow exports (data_type: "workflows"), these are workbook IDs. For agent exports (data_type: "agents") and agent interaction exports (data_type: "agent_interactions"), these are agent IDs. For artifact analytics exports (data_type: "artifact_analytics"), these are artifact IDs. When provided, only data for the specified entities will be included. Not applicable when data_type is "credit_logs".

Response

Data export successfully initiated

success

boolean

Indicates whether the export was successfully initiated.

data_export_id

string

Unique identifier for the data export job. Use this with the Get export status endpoint to check progress and download the completed export.

state

enum<string>

The initial state of the export job. Will be REQUESTED upon creation.

Available options:

REQUESTED

created_ts

string<date-time>

Timestamp when the export was created (ISO 8601).

Core concepts

Agents

Sessions

Skills

Artifacts

MCP

Browser profiles

Personal wiki

Evaluations

Organization evaluations

Brain

Teams

Models

File operations

Enterprise organization

Export data

Authorizations

Body

Response