We're updating help docs to reflect our new product naming. Gladly Sidekick (AI) is now called just Gladly, and Gladly Hero (the Platform) is now Gladly Team. Some articles may display outdated names while we update everything. Thank you for your patience! Learn more

Export Tool (Beta Feature)

Prev Next
REQUIRED USER ROLE 
API User
PERMISSION OVERVIEW
View permissions by role

The Support Tools Portal is a web-based application that provides a user-friendly GUI wrapper around Gladly's REST APIs. It enables customers and support teams to perform common API operations without writing code, significantly reducing manual work and technical barriers.

Beta testing

This tool is currently in beta testing as we collect feedback and continuously improve its features and capabilities.

Access

  1. Go to https://support-tools.gladly.tools/.

    • Username – Enter your Gladly email address which is the same email address you use to access Gladly.

    • API Token – Log into Gladly Team and generate the API Token by going to Setting > API Tokens > Create Token. The token will remain visible for you to copy and paste in to the the API Token field.

      • Note – You have have the API User permission assigned to you to create tokens. Save the token in a safe place (e.g., 1Pass) so you can use it again later to access the tool instead of generating a new token.

    • Gladly URL – Enter your Instance URL: This is your Gladly instance URL (e.g., us-1.gladly.com)

  2. Click Authenticate.

Once connected, you'll see the sidebar with five sections: Configuration, Conversations, Bulk Close, Logs, and IVR.

Configuration exports options for downloading various data formats in Gladly platform.

Pick a type of export

Use the table of contents on the right side of the page to get to the sections listed below:

  • Configuration – Export your Gladly configuration data (topics, Inboxes, answers, and audiences) to CSV for auditing or reference.

  • Conversations –  Export Conversation records and metadata, from a single Conversation to bulk date-range reports with handle times, channels, and Agent assignments.

  • Bulk Close – Close Conversations or Tasks in bulk by uploading a CSV of IDs, with optional topic application and a downloadable results file.

  • Logs  – Look up detailed call event timelines for a specific phone call to troubleshoot routing or audio issues.

  • IVR – Download all IVR prompt recordings and their associated IDs as a ZIP file for backup or review.

Configuration Exports

Export your Gladly configuration data to CSV format. These exports give you a snapshot of your current setup and are useful for auditing, onboarding documentation, or planning configuration changes.

Export Topics

Downloads a CSV of all Topics configured in your Gladly instance.

Column

Description

Id

The unique identifier for the topic

Disabled

Whether the topic is currently disabled (true or false)

Name

The display name of the topic, including hierarchy (e.g., Resolved | Customer Action)

Use case: Audit your topic taxonomy, review which topics are active or disabled, or prepare a mapping document for a configuration update.

Export Inboxes

Downloads a CSV of all Inboxes configured in your Gladly instance.

Column

Description

id

The unique identifier for the inbox

name

The display name of the inbox

disabled

Whether the inbox is currently disabled (true or false)

Use case: Review your Inbox routing structure, identify unused or disabled Inboxes, or document your inbox configuration for training purposes.

Export Answers

Downloads a CSV of all Answers (canned responses) in your Gladly instance. This is one of the larger exports, as it includes the full response content for each channel.

Column

Description

Description

Optional description of the answer

Id

The unique identifier for the answer

Title

The display name of the answer

Response Content - Email

The HTML-formatted email response content

Response Content - Messaging

The messaging (chat/SMS) response content

Response Content - Public

The public-facing (Help Center) response content

Response Title - Public

The public-facing title for the answer

Info Content

Additional informational content for internal use

Internal

Whether the answer is internal-only

Email Subject

The default email subject line when using this answer

Language

The language code for the answer (e.g., en-us)

Audiences

Comma-separated list of Audience names (e.g., audience-1,audience-2).

Use case: Audit your answer library for accuracy and consistency, review content across channels, plan content updates, or export for translation workflows.

Export Audiences

Downloads a CSV of all Audience segments configured in your Gladly instance.

Column

Description

id

The unique identifier for the audience

name

The display name of the audience segment

Use case: Review your audience segmentation setup or document audience configuration for team reference.

Conversation Exports

Export conversation data from your Gladly instance. These exports provide detailed Conversation-level and Contact-level data for reporting and analysis.

Export Conversation (Single)

Export a single Conversation by its ID. Returns a CSV containing every Conversation item (message, note, activity) within that Conversation.

Input: Conversation ID (found in the Gladly URL or conversation details panel)

Column

Description

id

Unique conversation item ID

customerId

The customer's unique ID

conversationId

The parent conversation ID

sessionId

The contact session ID

timestamp

When the item was created (ISO 8601)

initiator.id

ID of the person or system that created the item

initiator.type

Type of initiator (CUSTOMER, AGENT, AUTOMATION)

responder.id

ID of the responder, if applicable

responder.type

Type of responder

content.type

The type of content (EMAIL, CHAT_MESSAGE, PHONE_CALL, NOTE, TOPIC_CHANGE, etc.)

content.messageType

Sub-type for messages

content.sessionId

The session this content belongs to

content.content

The text body of the message or note

content.attachments

File attachment details, if any

content.status

Status of the item (e.g., for emails: sent, delivered)

content.title

Title, if applicable (e.g., for activity items)

content.body

Body content for activity-type items

content.activityType

Type of activity (e.g., topic change, Inbox transfer)

content.sourceName

Source system name for external activities

content.link.url

URL for linked content

content.link.text

Display text for linked content

content.expandByDefault

Whether the item is expanded by default in the UI

content.occurredAt

When the event actually occurred

content.receivedAt

When the item was received

content.from

Sender email address (for emails)

content.to

Recipient email address(es)

content.cc

CC email address(es)

content.bcc

BCC email address(es)

content.subject

Email subject line

content.pageId

Associated Help Center page ID

content.userId

Associated user ID

content.startedAt

Call start time (for phone calls)

content.answeredAt

Call answer time (for phone calls)

content.completedAt

Call completion time (for phone calls)

content.recordingUrl

URL to the call recording (for phone calls)

content.recordingDuration

Length of the recording in seconds

content.recordingSummary.status

AI summary generation status

content.recordingSummary.summary

AI-generated call summary text

content.recordingSummary.language

Language of the recording summary

content.addedTopicIds

Topic IDs added in this item

content.removedTopicIds

Topic IDs removed in this item

Use case: Deep-dive into a specific conversation's full history, review all messages and activities in sequence, or audit a conversation for quality review.


Customer Conversations

Export all Conversations for a specific customer. Returns a ZIP file containing two CSV files:

Input: Customer ID (found in the Gladly URL when viewing a customer profile)

File 1: conversations.csv

Column

Description

id

Conversation ID

topicIds

Comma-separated list of applied topic IDs

customAttributes

Custom attribute values, if any

customerId

The customer's unique ID

createdAt

When the conversation was created (ISO 8601)

agentId

The currently assigned Agent's ID

inboxId

The current Inbox ID

status

Current conversation status (e.g., OPEN, CLOSED, WAITING)

File 2: conversation-items.csv

Same columns as the single Export Conversation format above.

Use case: Pull a customer's complete interaction history for account review, escalation investigation, or data migration.

Export Conversation Contact Information

Export Conversation-level metadata and contact information for all Conversations created within a date range. This is the primary reporting export for Conversation analytics.

Inputs:

  • From date — Start of the date range

  • To date — End of the date range

Column

Description

Timezone Filter

The timezone applied to the export

Inboxes Filter

Which Inboxes were included in the export

Created At

When the conversation was created

Conversation ID

Unique conversation identifier

Customer ID

Unique customer identifier

Conversation Link

Direct URL to the conversation in Gladly

Status

Current status (Open, Closed)

Assigned Agent ID - Current

ID of the currently assigned Agent

Assigned Agent Name - Current

Name of the currently assigned Agent

Inbox ID - Current

ID of the current Inbox

Inbox Name - Current

Name of the current Inbox

First Closed At

Timestamp of the first time the conversation was closed

Last Closed At

Timestamp of the most recent close

Initiator Type - Created

Who started the conversation (CUSTOMER, AGENT, AUTOMATION)

Initiator Agent ID - Created

Agent ID if the conversation was Agent-initiated

Initiator Agent Name - Created

Agent name if Agent-initiated

Inbox ID - Created

The Inbox the conversation was initially routed to

Inbox Name - Created

Name of the initial Inbox

Assigned Agent ID - Created

Agent assigned at creation

Assigned Agent Name - Created

Agent name at creation

Initiator Type - Last Closed

Who closed the conversation the last time

Initiator Agent ID - Last Closed

Agent ID of who last closed it

Initiator Agent Name - Last Closed

Agent name of who last closed it

Initiator Rule ID - Last Closed

Rule ID if closed by automation

Inbox ID - Last Closed

Inbox at the time of last close

Inbox Name - Last Closed

Inbox name at the time of last close

Assigned Agent ID - Last Closed

Agent assigned at last close

Assigned Agent Name - Last Closed

Agent name at last close

Topics

Comma-separated list of applied topic names

Topics with Hierarchy

Topic names including parent hierarchy

First Contact ID

ID of the first contact in the conversation

First Channel

The channel of the first contact (e.g., EMAIL, CHAT, PHONE_CALL, SMS)

Second Channel

Channel of the second contact, if any

Third Channel

Channel of the third contact, if any

Last Channel

Channel of the most recent contact

Created-to-First Closed Time in seconds

Time from creation to first close

Created-to-Last Closed Time in seconds

Time from creation to last close

Conversation Handle Time in seconds

Total Agent handle time

Is FCR Eligible

Whether the conversation is eligible for First Contact Resolution

Is FCR Success

Whether the conversation achieved First Contact Resolution

Merged Conversations

IDs of any merged conversations

Count of Contacts

Total number of contacts (messages/calls)

Count of Channels

Number of distinct channels used

Count of Notes

Number of internal notes

Count of Agents Assigned

Number of Agents who were assigned

Count of Inboxes Assigned

Number of Inboxes the conversation passed through

Times Agent Unassigned by Rule

How many times a rule removed the Agent assignment

Times Closed

Total number of times closed

Times Reopened

Total number of times reopened

Times Topic Added

Number of topic additions

Times Topic Removed

Number of topic removals

Payment Requests - Completed

Count of completed payment requests

Payment Requests - Declined

Count of declined payment requests

Payment Amount - Completed USD

Total completed payment amount in USD

Payment Amount - Declined USD

Total declined payment amount in USD

Name

The Customer’s name

Address

The Customer’s address

Email

Customer's email address

Phone

Customer's phone number

Phone Type

Phone number type (e.g., MOBILE, HOME)

SMS Preference

Customer's SMS opt-in preference

External Customer IDs

Unique Customer identified for integration mapping

Use case: Build operational reports, analyze handle times, measure FCR rates, review channel mix, or audit topic application across a date range.

Export Conversations with Freeform Topics

Same as the Contact Information export above, with one additional column:

Inputs:

  • From date — Start of the date range

  • To date — End of the date range

Additional Column

Description

customAttributes

JSON-formatted custom attribute values applied to the Conversation

All other columns are identical to the Contact Information export.

Use case: When you need the same analytics as the Contact Information export but also want to include any custom attributes (freeform topics) applied to Conversations.

GET File Export

Browse and download completed export jobs that have been run via the Gladly API. These are the large-scale file exports that Gladly generates asynchronously.

All-time / multi-day historical raw transcript data can only be generated by Gladly Support. However, the Get File Export feature makes it easier to comb through large data with more targeted results.

Inputs:

  1. Click Export.

  2. Click Find Jobs to retrieve the list of available export jobs and enter the job ID in the field you’re provided to find the correct export (shows job ID, date range, and timestamp).

  3. Select a job from the dropdown and provide the following information if necessary for more targeted results.

    • Contact Information – Search for conversation items where content.from or the customer's emailAddresses/phoneNumbers match. Supports exact emails, E.164 phone numbers, or domain patterns (@example.com).

    • Digital Transript Search – Search (case-insensitive) for any transcript body, email subject, or topic added/removed matching any of the phrases.

  4. Choose format: CSV or JSON

  5. Click Export.

Each export job is a ZIP file containing:

File

Description

agents.jsonl

Agent records (IDs, names, roles) active during the export window

conversation_items.jsonl

All Conversation items (subject, messages,topics, notes, calls, activities, email address)

customers.jsonl

Customer Profile records

topics.jsonl

Topic records and hierarchy

Use case: Download bulk data exports for BI tools, data warehouses, or offline analysis. These are typically scheduled exports that run on a recurring basis.

Events

Export Events

Export Events allows you to download event data from your Gladly instance using the Events API. Events represent specific actions or occurrences within Gladly (such as conversation status changes, agent assignments, customer interactions, and system activities). This tool provides a simple interface to export these events into either CSV or JSON format for analysis, reporting, or integration purposes.

Gladly's Events API provides granular system activity data, but accessing it typically requires API knowledge and scripting. This tool makes event data accessible to non-technical users who need to audit system activity, troubleshoot issues, generate reports, or export data for compliance.

What Gets Exported:

You can export event data including:

  • Event types you select via checkboxes (one or more).

  • Event timestamps and metadata.

  • Associated conversation IDs and customer information.

  • Agent details and system information.

  • Event-specific data fields depending on the event type selected.

Available export formats:

  • CSV - Spreadsheet format for analysis in Excel/Google Sheets.

  • JSON - Structured data format for technical integrations or custom processing.

When You'd Use This:

  • Recent Activity Audit: Review what happened in your instance over the past 24 hours.

  • Troubleshooting: Export events related to a specific incident or customer complaint.

  • Reporting & Analysis: Generate custom reports on event activity and patterns.

  • Compliance: Document system activity for audits and maintain records.

How it works:

  1. From the Events tab, select one or more event types using the checkboxes.

  2. Select the start and end date/time (within the 24 hour window allowed).

  3. Select the Entity Types:

    • AGENT_AVAILABILITY

    • AGENT_STATUS

    • CONTACT

    • CONVERSATION

    • CUSTOMER

    • PAYMENT_REQUEST

  4. Choose your export format (CSV or JSON).

  5. Click Export.

  6. Download the generated file.

Current Limitations

24-Hour Window Only. Due to Events API requirements and limitations, you can only export events from the past 24 hours. No historical data beyond this timeframe is available. This is a hard API limitation, not a tool restriction.

Tips

Be selective. Only select the event types you actually need to reduce file size.

Know your timeframe: Remember you're limited to the past 24 hours - plan accordingly.

CSV for quick analysis: Use CSV if you want to open the data in Excel or Google Sheets.

JSON for integrations: Use JSON if feeding data into another system.

Bulk Close

Perform bulk operations on conversations and Tasks by uploading a CSV file. These are action tools, not data exports — they modify records in your Gladly instance.

Close Conversations

Upload a CSV to bulk-close conversations and optionally apply a topic to each one before closing.

CSV format: One column named conversationId, with one conversation ID per row. A sample template is available for download within the tool.

Optional input: Topic ID — If provided, this topic will be applied to every conversation before it is closed.

How it works:

  1. Upload your CSV file

  2. Optionally enter a Topic ID to apply

  3. Click Start Bulk Close

  4. Confirm the action in the dialog

  5. The tool processes each Conversation and displays real-time progress

  6. When complete, download a Results CSV with the success/error status for each Conversation

Use case: Close out a batch of stale or resolved Conversations, clean up after a migration, or apply a disposition topic in bulk.

Close Tasks

Upload a CSV to bulk-close Tasks. The tool preserves each Task's current assignee during the close operation.

CSV format: One column named taskId, with one task ID per row. A sample template is available for download within the tool.

How it works:

  1. Upload your CSV file

  2. Click Start Bulk Close

  3. Confirm the action in the dialog

  4. The tool retrieves each Task's current assignee, then closes the task while maintaining the assignment

  5. When complete, download a Results CSV with the success/error status for each task

Use case: Bulk-close completed or outdated Tasks, clean up task backlogs, or close Tasks associated with a decommissioned workflow.

Logs

Look up event-level data for troubleshooting and investigation.

Call Events

Download participant events for a specific phone call Conversation item. This provides a detailed timeline of everything that happened during a voice call.

Input: Call Conversation Item ID — This is the ID of the specific phone call item within a Conversation (not the conversation ID itself). You can find this in the Conversation details or via the Gladly API.

Output: A detailed log of call events such as ringing, answering, holding, transferring, and hanging up, with timestamps for each participant.

Use case: Troubleshoot call routing issues, investigate dropped or transferred calls, audit Agent call handling, or verify call timing for quality reviews.

IVR

Export IVR (Interactive Voice Response) recording data from your Gladly configuration.

IVR Recording Export

Download all IVR recordings and their associated IVR IDs as a ZIP file. The ZIP contains the audio files (MP3 format) for every IVR prompt configured in your instance.

Output: A ZIP file named ivr-recordings.zip containing MP3 audio files. Each file is named with its IVR prompt name.

Use case: Back up your IVR recordings, review prompt audio for quality or compliance, or prepare recordings for migration to a new system.

Tips and Notes

  • Date ranges: When exporting Conversation data by date range, dates use your browser's local timezone. The exported CSV will include a Timezone Filter column showing which timezone was applied.

  • Large exports: For very large date ranges, consider using the GET File Export option, which leverages Gladly's asynchronous export jobs designed for high-volume data.

  • IDs in exports: Most exports include Gladly-internal IDs. You can use these IDs to cross-reference data between exports or look up specific records in the Gladly UI by constructing a URL (e.g., https://yourcompany.us-1.gladly.com/customer/{customerId}/conversation/{conversationId}).

  • Bulk Close is irreversible: The Bulk Close operations modify live data. Always review your CSV carefully and confirm the count in the dialog before proceeding. Download the Results CSV afterward to verify success.

  • Beta notice: This tool is currently in Beta release. If you encounter issues or have feedback, contact Gladly Support.