Skip to main content
Glama

Export data

export_data
Destructive

Create and initiate organization or workspace data exports for workflows, agents, interactions, credit logs, evaluations, or Gumstack activity.

Instructions

This endpoint allows enterprise organization administrators to create and initiate a comprehensive data export for their organization or specific workspaces.

The export supports six 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.

  • Gumstack data (data_type: "gumstack"): Includes Gumstack MCP tool call activity with timestamps, statuses, and latency.

The available export_fields depend on the selected data_type. See the field descriptions below for details.

Scoping requirement: For non-credit-log 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. Explicit confirmation is required for this exact account operation. Runs can spend credits or trigger downstream actions; never resubmit unknown outcomes automatically.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
accountNoNamed private Gumloop account; selects private credentials and user/team identity.
confirmNoSet true only when the user asked for exactly this action.
payloadNoComplete JSON request body instead of body flags. Preserves current endpoint fields and values.
user_idNoThe ID of the user requesting the export.
end_dateNoEnd date for the export in ISO 8601 format (e.g., `2025-12-31T23:59:59Z`).
data_typeNo
entity_idsNo
start_dateNoStart date for the export in ISO 8601 format (e.g., `2025-01-01T00:00:00Z`).
export_levelNo
payload_fileNoRegular local JSON body file, at most 5 MB. Cannot be mixed with body flags or payload.
export_fieldsNo
workspace_idsNo
category_filterNo
include_all_workspacesNo
include_personal_workspacesNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed75 schema fields changedv3.0.0
    • addedInput schema / $defs / category_filter
      Added value: +{
      +  "description": "**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.\n",
      +  "type": "string"
      +}
    • addedInput schema / $defs / data_type
      Added value: +{
      +  "default": "workflows",
      +  "description": "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, or `\"gumstack\"` to export Gumstack tool call activity. Defaults to `\"workflows\"`. Audit-log exports are available in the Gumloop app only, not through this endpoint.\n",
      +  "enum": [
      +    "workflows",
      +    "agents",
      +    "agent_interactions",
      +    "credit_logs",
      +    "interaction_evaluations",
      +    "gumstack"
      +  ],
      +  "type": "string"
      +}
    • addedInput schema / $defs / entity_ids
      Added value: +{
      +  "description": "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. When provided, only data for the specified entities will be included. **Not applicable when `data_type` is `\"credit_logs\"`.**\n",
      +  "items": {
      +    "type": "string"
      +  },
      +  "type": "array"
      +}
    • addedInput schema / $defs / export_fields
      Added value: +{
      +  "description": "Array of fields to include in the export. The available fields depend on the `data_type`.\n\n**Workflow fields** (when `data_type` is `\"workflows\"`):\n- `workbook_id` - The workbook identifier\n- `workbook_name` - The workbook name\n- `workbook_created_ts` - Workbook creation timestamp\n- `user_id` - The user identifier\n- `user_email` - The user's email address\n- `workspace_id` - The workspace identifier\n- `workspace_name` - The workspace name\n- `run_id` - The flow run identifier\n- `credit_cost` - Credits consumed by the run\n- `pl_run_created_ts` - Flow run creation timestamp\n- `pl_run_finished_ts` - Flow run completion timestamp\n- `pipeline` - The full pipeline configuration (JSON)\n\n**Agent fields** (when `data_type` is `\"agents\"`):\n- `agent_id` - The agent identifier\n- `agent_name` - The agent name\n- `agent_description` - The agent description\n- `agent_model` - The model used by the agent\n- `agent_system_prompt` - The agent's system prompt\n- `agent_created_ts` - Agent creation timestamp\n- `agent_tools` - Tools configured for the agent (JSON)\n- `agent_metadata` - Additional agent metadata (JSON)\n- `agent_evaluations_enabled` - Whether the agent's own Evaluations are turned on (`true`/`false`)\n- `creator_email` - Email of the user who created the agent\n- `workspace_id` - The workspace identifier\n- `workspace_name` - The workspace name\n- `folder_id` - The identifier of the folder containing the agent (empty when the agent is not in a folder)\n- `folder_name` - The name of the folder containing the agent (empty when the agent is not in a folder)\n\n**Agent interaction fields** (when `data_type` is `\"agent_interactions\"`):\n- `interaction_id` - Unique identifier for the chat session\n- `agent_id` - The agent identifier\n- `agent_name` - The agent name\n- `interaction_type` - Type of interaction (e.g., chat, slack, api, triggered)\n- `interaction_name` - Display name of the chat session\n- `trigger_type` - For triggered interactions, the specific trigger type (e.g., time_based, polling_new_record_salesforce). Null for non-triggered interactions.\n- `interaction_created_ts` - Chat session creation timestamp\n- `user_email` - Email of the user who initiated the chat\n- `credit_cost` - Total credits consumed (LLM + tool + flow)\n- `llm_credit_cost` - Credits consumed by LLM calls only\n- `tool_credit_cost` - Credits consumed by tool calls\n- `flow_credit_cost` - Credits consumed by pipeline runs\n- `message_count` - Number of messages in the conversation\n- `workspace_id` - The workspace identifier\n- `workspace_name` - The workspace name\n\n**Interaction evaluation fields** (when `data_type` is `\"interaction_evaluations\"`):\n- `evaluation_id` - Unique identifier for the evaluation row\n- `interaction_id` - The chat session that was evaluated (one chat can have several evaluation rows)\n- `agent_id` - The identifier of the agent that was evaluated\n- `organization_evaluation_id` - The organization-level evaluation this row belongs to (empty for agent-level rubrics)\n- `evaluation_created_ts` - When the evaluation reached its final state\n- `status` - The evaluation's state\n- `grade` - The grade the evaluation produced\n- `call_outcome` - The outcome the evaluation recorded for the conversation\n- `sentiment` - The sentiment the evaluation recorded\n- `error_code` - Error code when the evaluation could not complete\n- `summary` - The evaluation's written summary\n- `evaluation_model` - The model that ran the evaluation\n- `credit_cost` - Credits consumed by the evaluation\n- `user_email` - Email of the user whose chat was evaluated\n\n**Credit log fields** (when `data_type` is `\"credit_logs\"`):\n- `user_email` - Email of the user associated with the credit log entry\n- `permission_group_id` - Custom role ID(s) the user belongs to (semicolon-separated if multiple) (disabled by default)\n- `permission_group_name` - Custom role name(s) the user belongs to (semicolon-separated if multiple) (disabled by default)\n- `timestamp` - When the credit transaction occurred\n- `category` - The category of the credit log (e.g., PIPELINE_RUN, AGENT_RUN)\n- `type` - The specific type of credit charge\n- `name` - Display name of the credit log entry\n- `amount` - Number of credits charged or adjusted\n- `balance` - Credit balance after the transaction\n- `log_id` - Unique identifier for the credit log entry\n- `correlation_id` - Join key to the related run or interaction (disabled by default)\n- `balance_scope` - Whether the balance is organization- or user-scoped (disabled by default)\n- `project_id` - The project identifier (disabled by default)\n\nNot all combinations of selected fields are guaranteed to produce data for every row.\n",
      +  "items": {
      +    "type": "string"
      +  },
      +  "type": "array"
      +}
    • addedInput schema / $defs / export_level
      Added value: +{
      +  "default": "organization",
      +  "description": "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\"`.**\n",
      +  "enum": [
      +    "workspace",
      +    "organization"
      +  ],
      +  "type": "string"
      +}
    • addedInput schema / $defs / include_all_workspaces
      Added value: +{
      +  "default": false,
      +  "description": "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\"`.**",
      +  "type": "boolean"
      +}
    • addedInput schema / $defs / include_personal_workspaces
      Added value: +{
      +  "default": false,
      +  "description": "Whether to include personal workspaces in the export. Ignored if `include_all_workspaces` is `true`. **Not applicable when `data_type` is `\"credit_logs\"`.**",
      +  "type": "boolean"
      +}
    • addedInput schema / $defs / workspace_ids
      Added value: +{
      +  "description": "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\"`.**",
      +  "items": {
      +    "type": "string"
      +  },
      +  "type": "array"
      +}
    • addedInput schema / properties / category_filter / $ref
      Added value: +"#/$defs/category_filter"
    • removedInput schema / properties / category_filter / description
      Removed value: -"**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.\n"
    • removedInput schema / properties / category_filter / type
      Removed value: -"string"
    • changedInput schema / properties / confirm / description
      Previous value: -"Must be true for this exact requested account change, agent/flow execution, upload or deletion."New value: +"Set true only when the user asked for exactly this action."
    • addedInput schema / properties / data_type / $ref
      Added value: +"#/$defs/data_type"
    • removedInput schema / properties / data_type / default
      Removed value: -"workflows"
    • removedInput schema / properties / data_type / description
      Removed value: -"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, or `\"gumstack\"` to export Gumstack tool call activity. Defaults to `\"workflows\"`. Audit-log exports are available in the Gumloop app only, not through this endpoint.\n"
    • removedInput schema / properties / data_type / enum
      Removed value: -[
      -  "workflows",
      -  "agents",
      -  "agent_interactions",
      -  "credit_logs",
      -  "interaction_evaluations",
      -  "gumstack"
      -]
    • removedInput schema / properties / data_type / type
      Removed value: -"string"
    • addedInput schema / properties / entity_ids / $ref
      Added value: +"#/$defs/entity_ids"
    • removedInput schema / properties / entity_ids / description
      Removed value: -"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. When provided, only data for the specified entities will be included. **Not applicable when `data_type` is `\"credit_logs\"`.**\n"
    • removedInput schema / properties / entity_ids / items
      Removed value: -{
      -  "type": "string"
      -}
    • removedInput schema / properties / entity_ids / type
      Removed value: -"array"
    • addedInput schema / properties / export_fields / $ref
      Added value: +"#/$defs/export_fields"
    • removedInput schema / properties / export_fields / description
      Removed value: -"Array of fields to include in the export. The available fields depend on the `data_type`.\n\n**Workflow fields** (when `data_type` is `\"workflows\"`):\n- `workbook_id` - The workbook identifier\n- `workbook_name` - The workbook name\n- `workbook_created_ts` - Workbook creation timestamp\n- `user_id` - The user identifier\n- `user_email` - The user's email address\n- `workspace_id` - The workspace identifier\n- `workspace_name` - The workspace name\n- `run_id` - The flow run identifier\n- `credit_cost` - Credits consumed by the run\n- `pl_run_created_ts` - Flow run creation timestamp\n- `pl_run_finished_ts` - Flow run completion timestamp\n- `pipeline` - The full pipeline configuration (JSON)\n\n**Agent fields** (when `data_type` is `\"agents\"`):\n- `agent_id` - The agent identifier\n- `agent_name` - The agent name\n- `agent_description` - The agent description\n- `agent_model` - The model used by the agent\n- `agent_system_prompt` - The agent's system prompt\n- `agent_created_ts` - Agent creation timestamp\n- `agent_tools` - Tools configured for the agent (JSON)\n- `agent_metadata` - Additional agent metadata (JSON)\n- `agent_evaluations_enabled` - Whether the agent's own Evaluations are turned on (`true`/`false`)\n- `creator_email` - Email of the user who created the agent\n- `workspace_id` - The workspace identifier\n- `workspace_name` - The workspace name\n- `folder_id` - The identifier of the folder containing the agent (empty when the agent is not in a folder)\n- `folder_name` - The name of the folder containing the agent (empty when the agent is not in a folder)\n\n**Agent interaction fields** (when `data_type` is `\"agent_interactions\"`):\n- `interaction_id` - Unique identifier for the chat session\n- `agent_id` - The agent identifier\n- `agent_name` - The agent name\n- `interaction_type` - Type of interaction (e.g., chat, slack, api, triggered)\n- `interaction_name` - Display name of the chat session\n- `trigger_type` - For triggered interactions, the specific trigger type (e.g., time_based, polling_new_record_salesforce). Null for non-triggered interactions.\n- `interaction_created_ts` - Chat session creation timestamp\n- `user_email` - Email of the user who initiated the chat\n- `credit_cost` - Total credits consumed (LLM + tool + flow)\n- `llm_credit_cost` - Credits consumed by LLM calls only\n- `tool_credit_cost` - Credits consumed by tool calls\n- `flow_credit_cost` - Credits consumed by pipeline runs\n- `message_count` - Number of messages in the conversation\n- `workspace_id` - The workspace identifier\n- `workspace_name` - The workspace name\n\n**Interaction evaluation fields** (when `data_type` is `\"interaction_evaluations\"`):\n- `evaluation_id` - Unique identifier for the evaluation row\n- `interaction_id` - The chat session that was evaluated (one chat can have several evaluation rows)\n- `agent_id` - The identifier of the agent that was evaluated\n- `organization_evaluation_id` - The organization-level evaluation this row belongs to (empty for agent-level rubrics)\n- `evaluation_created_ts` - When the evaluation reached its final state\n- `status` - The evaluation's state\n- `grade` - The grade the evaluation produced\n- `call_outcome` - The outcome the evaluation recorded for the conversation\n- `sentiment` - The sentiment the evaluation recorded\n- `error_code` - Error code when the evaluation could not complete\n- `summary` - The evaluation's written summary\n- `evaluation_model` - The model that ran the evaluation\n- `credit_cost` - Credits consumed by the evaluation\n- `user_email` - Email of the user whose chat was evaluated\n\n**Credit log fields** (when `data_type` is `\"credit_logs\"`):\n- `user_email` - Email of the user associated with the credit log entry\n- `permission_group_id` - Custom role ID(s) the user belongs to (semicolon-separated if multiple) (disabled by default)\n- `permission_group_name` - Custom role name(s) the user belongs to (semicolon-separated if multiple) (disabled by default)\n- `timestamp` - When the credit transaction occurred\n- `category` - The category of the credit log (e.g., PIPELINE_RUN, AGENT_RUN)\n- `type` - The specific type of credit charge\n- `name` - Display name of the credit log entry\n- `amount` - Number of credits charged or adjusted\n- `balance` - Credit balance after the transaction\n- `log_id` - Unique identifier for the credit log entry\n- `correlation_id` - Join key to the related run or interaction (disabled by default)\n- `balance_scope` - Whether the balance is organization- or user-scoped (disabled by default)\n- `project_id` - The project identifier (disabled by default)\n\nNot all combinations of selected fields are guaranteed to produce data for every row.\n"
    • removedInput schema / properties / export_fields / items
      Removed value: -{
      -  "type": "string"
      -}
    • removedInput schema / properties / export_fields / type
      Removed value: -"array"
    • addedInput schema / properties / export_level / $ref
      Added value: +"#/$defs/export_level"
    • removedInput schema / properties / export_level / default
      Removed value: -"organization"
    • removedInput schema / properties / export_level / description
      Removed value: -"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\"`.**\n"
    • removedInput schema / properties / export_level / enum
      Removed value: -[
      -  "workspace",
      -  "organization"
      -]
    • removedInput schema / properties / export_level / type
      Removed value: -"string"
    • addedInput schema / properties / include_all_workspaces / $ref
      Added value: +"#/$defs/include_all_workspaces"
    • removedInput schema / properties / include_all_workspaces / default
      Removed value: -false
    • removedInput schema / properties / include_all_workspaces / description
      Removed value: -"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\"`.**"
    • removedInput schema / properties / include_all_workspaces / type
      Removed value: -"boolean"
    • addedInput schema / properties / include_personal_workspaces / $ref
      Added value: +"#/$defs/include_personal_workspaces"
    • removedInput schema / properties / include_personal_workspaces / default
      Removed value: -false
    • removedInput schema / properties / include_personal_workspaces / description
      Removed value: -"Whether to include personal workspaces in the export. Ignored if `include_all_workspaces` is `true`. **Not applicable when `data_type` is `\"credit_logs\"`.**"
    • removedInput schema / properties / include_personal_workspaces / type
      Removed value: -"boolean"
    • addedInput schema / properties / payload / properties / category_filter / $ref
      Added value: +"#/$defs/category_filter"
    • removedInput schema / properties / payload / properties / category_filter / description
      Removed value: -"**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.\n"
    • removedInput schema / properties / payload / properties / category_filter / type
      Removed value: -"string"
    • addedInput schema / properties / payload / properties / data_type / $ref
      Added value: +"#/$defs/data_type"
    • removedInput schema / properties / payload / properties / data_type / default
      Removed value: -"workflows"
    • removedInput schema / properties / payload / properties / data_type / description
      Removed value: -"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, or `\"gumstack\"` to export Gumstack tool call activity. Defaults to `\"workflows\"`. Audit-log exports are available in the Gumloop app only, not through this endpoint.\n"
    • removedInput schema / properties / payload / properties / data_type / enum
      Removed value: -[
      -  "workflows",
      -  "agents",
      -  "agent_interactions",
      -  "credit_logs",
      -  "interaction_evaluations",
      -  "gumstack"
      -]
    • removedInput schema / properties / payload / properties / data_type / type
      Removed value: -"string"
    • addedInput schema / properties / payload / properties / entity_ids / $ref
      Added value: +"#/$defs/entity_ids"
    • removedInput schema / properties / payload / properties / entity_ids / description
      Removed value: -"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. When provided, only data for the specified entities will be included. **Not applicable when `data_type` is `\"credit_logs\"`.**\n"
    • removedInput schema / properties / payload / properties / entity_ids / items
      Removed value: -{
      -  "type": "string"
      -}
    • removedInput schema / properties / payload / properties / entity_ids / type
      Removed value: -"array"
    • addedInput schema / properties / payload / properties / export_fields / $ref
      Added value: +"#/$defs/export_fields"
    • removedInput schema / properties / payload / properties / export_fields / description
      Removed value: -"Array of fields to include in the export. The available fields depend on the `data_type`.\n\n**Workflow fields** (when `data_type` is `\"workflows\"`):\n- `workbook_id` - The workbook identifier\n- `workbook_name` - The workbook name\n- `workbook_created_ts` - Workbook creation timestamp\n- `user_id` - The user identifier\n- `user_email` - The user's email address\n- `workspace_id` - The workspace identifier\n- `workspace_name` - The workspace name\n- `run_id` - The flow run identifier\n- `credit_cost` - Credits consumed by the run\n- `pl_run_created_ts` - Flow run creation timestamp\n- `pl_run_finished_ts` - Flow run completion timestamp\n- `pipeline` - The full pipeline configuration (JSON)\n\n**Agent fields** (when `data_type` is `\"agents\"`):\n- `agent_id` - The agent identifier\n- `agent_name` - The agent name\n- `agent_description` - The agent description\n- `agent_model` - The model used by the agent\n- `agent_system_prompt` - The agent's system prompt\n- `agent_created_ts` - Agent creation timestamp\n- `agent_tools` - Tools configured for the agent (JSON)\n- `agent_metadata` - Additional agent metadata (JSON)\n- `agent_evaluations_enabled` - Whether the agent's own Evaluations are turned on (`true`/`false`)\n- `creator_email` - Email of the user who created the agent\n- `workspace_id` - The workspace identifier\n- `workspace_name` - The workspace name\n- `folder_id` - The identifier of the folder containing the agent (empty when the agent is not in a folder)\n- `folder_name` - The name of the folder containing the agent (empty when the agent is not in a folder)\n\n**Agent interaction fields** (when `data_type` is `\"agent_interactions\"`):\n- `interaction_id` - Unique identifier for the chat session\n- `agent_id` - The agent identifier\n- `agent_name` - The agent name\n- `interaction_type` - Type of interaction (e.g., chat, slack, api, triggered)\n- `interaction_name` - Display name of the chat session\n- `trigger_type` - For triggered interactions, the specific trigger type (e.g., time_based, polling_new_record_salesforce). Null for non-triggered interactions.\n- `interaction_created_ts` - Chat session creation timestamp\n- `user_email` - Email of the user who initiated the chat\n- `credit_cost` - Total credits consumed (LLM + tool + flow)\n- `llm_credit_cost` - Credits consumed by LLM calls only\n- `tool_credit_cost` - Credits consumed by tool calls\n- `flow_credit_cost` - Credits consumed by pipeline runs\n- `message_count` - Number of messages in the conversation\n- `workspace_id` - The workspace identifier\n- `workspace_name` - The workspace name\n\n**Interaction evaluation fields** (when `data_type` is `\"interaction_evaluations\"`):\n- `evaluation_id` - Unique identifier for the evaluation row\n- `interaction_id` - The chat session that was evaluated (one chat can have several evaluation rows)\n- `agent_id` - The identifier of the agent that was evaluated\n- `organization_evaluation_id` - The organization-level evaluation this row belongs to (empty for agent-level rubrics)\n- `evaluation_created_ts` - When the evaluation reached its final state\n- `status` - The evaluation's state\n- `grade` - The grade the evaluation produced\n- `call_outcome` - The outcome the evaluation recorded for the conversation\n- `sentiment` - The sentiment the evaluation recorded\n- `error_code` - Error code when the evaluation could not complete\n- `summary` - The evaluation's written summary\n- `evaluation_model` - The model that ran the evaluation\n- `credit_cost` - Credits consumed by the evaluation\n- `user_email` - Email of the user whose chat was evaluated\n\n**Credit log fields** (when `data_type` is `\"credit_logs\"`):\n- `user_email` - Email of the user associated with the credit log entry\n- `permission_group_id` - Custom role ID(s) the user belongs to (semicolon-separated if multiple) (disabled by default)\n- `permission_group_name` - Custom role name(s) the user belongs to (semicolon-separated if multiple) (disabled by default)\n- `timestamp` - When the credit transaction occurred\n- `category` - The category of the credit log (e.g., PIPELINE_RUN, AGENT_RUN)\n- `type` - The specific type of credit charge\n- `name` - Display name of the credit log entry\n- `amount` - Number of credits charged or adjusted\n- `balance` - Credit balance after the transaction\n- `log_id` - Unique identifier for the credit log entry\n- `correlation_id` - Join key to the related run or interaction (disabled by default)\n- `balance_scope` - Whether the balance is organization- or user-scoped (disabled by default)\n- `project_id` - The project identifier (disabled by default)\n\nNot all combinations of selected fields are guaranteed to produce data for every row.\n"
    • removedInput schema / properties / payload / properties / export_fields / items
      Removed value: -{
      -  "type": "string"
      -}
    • removedInput schema / properties / payload / properties / export_fields / type
      Removed value: -"array"
    • addedInput schema / properties / payload / properties / export_level / $ref
      Added value: +"#/$defs/export_level"
    • removedInput schema / properties / payload / properties / export_level / default
      Removed value: -"organization"
    • removedInput schema / properties / payload / properties / export_level / description
      Removed value: -"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\"`.**\n"
    • removedInput schema / properties / payload / properties / export_level / enum
      Removed value: -[
      -  "workspace",
      -  "organization"
      -]
    • removedInput schema / properties / payload / properties / export_level / type
      Removed value: -"string"
    • addedInput schema / properties / payload / properties / include_all_workspaces / $ref
      Added value: +"#/$defs/include_all_workspaces"
    • removedInput schema / properties / payload / properties / include_all_workspaces / default
      Removed value: -false
    • removedInput schema / properties / payload / properties / include_all_workspaces / description
      Removed value: -"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\"`.**"
    • removedInput schema / properties / payload / properties / include_all_workspaces / type
      Removed value: -"boolean"
    • addedInput schema / properties / payload / properties / include_personal_workspaces / $ref
      Added value: +"#/$defs/include_personal_workspaces"
    • removedInput schema / properties / payload / properties / include_personal_workspaces / default
      Removed value: -false
    • removedInput schema / properties / payload / properties / include_personal_workspaces / description
      Removed value: -"Whether to include personal workspaces in the export. Ignored if `include_all_workspaces` is `true`. **Not applicable when `data_type` is `\"credit_logs\"`.**"
    • removedInput schema / properties / payload / properties / include_personal_workspaces / type
      Removed value: -"boolean"
    • addedInput schema / properties / payload / properties / workspace_ids / $ref
      Added value: +"#/$defs/workspace_ids"
    • removedInput schema / properties / payload / properties / workspace_ids / description
      Removed value: -"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\"`.**"
    • removedInput schema / properties / payload / properties / workspace_ids / items
      Removed value: -{
      -  "type": "string"
      -}
    • removedInput schema / properties / payload / properties / workspace_ids / type
      Removed value: -"array"
    • addedInput schema / properties / workspace_ids / $ref
      Added value: +"#/$defs/workspace_ids"
    • removedInput schema / properties / workspace_ids / description
      Removed value: -"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\"`.**"
    • removedInput schema / properties / workspace_ids / items
      Removed value: -{
      -  "type": "string"
      -}
    • removedInput schema / properties / workspace_ids / type
      Removed value: -"array"
  2. First observedv2.0.1

TDQS

A4.3/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare destructiveHint=true, readOnlyHint=false, openWorldHint=true and idempotentHint=false, but the description adds real substance: it can spend credits or trigger downstream actions, explicit confirmation is required, and unknown outcomes must not be resubmitted automatically. It also discloses the 400 failure mode for missing scoping and the divergent credit_logs behavior.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loaded with the core action and then organized under headers and bullets for the six data types, scoping requirement, and credit_logs caveat. It is long, but the length is driven by genuinely distinct data-type semantics rather than repetition; a few of the type summaries overlap with the schema text.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a 15-parameter, nested-object tool with no output schema, the description covers data-type selection, scoping rules, and the credit_logs exception well. The main gap is that it never explains the async return/polling model (get_export_status exists as a sibling), leaving the agent unsure what the call yields.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is low (47%), so the description has to carry weight, and it does: it explains that export_fields depend on data_type, that the scoping params are not applicable to credit_logs, and points to category_filter as the credit_logs alternative. It does not, however, describe the confirm/account/payload wrapper params or date-range semantics.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb+resource ('create and initiate a comprehensive data export') and scopes it to organization admins and workspaces. It enumerates all six data types with their contents and even distinguishes itself from audit-log exports ('available in the Gumloop app only, not through this endpoint'), so an agent can tell it apart from sibling export/status tools.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives concrete prerequisites and conditions: the scoping requirement (at least one of workspace_ids/include_all_workspaces/include_personal_workspaces/entity_ids, else 400), and the credit_logs exception where scoping params are ignored. It does not explicitly route the agent to get_export_status for polling, so it stops short of naming alternatives.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools