Adoption export App
The Adoption export app exports usage and change activity from Atlan so that you can analyze how users are adopting assets across your environment. It focuses on the most viewed assets, the most changed assets, and the most common UI-based searches.
You can use this app to build adoption reports, share summaries with stakeholders, or perform further analysis in tools such as spreadsheets or BI dashboards.
Access
The Adoption export app isn't enabled by default. To use this app, contact Atlan support and request it be added to your tenant. Once enabled, workflows can be set up and run by admins or users with workflow permissions.
Configuration
This section defines the fields required to configure the Adoption export workflow.
Views
Settings in this section control whether the workflow exports adoption metrics based on asset views, how those assets are ranked, and how much contextual metadata is included in the export.
Workflow name
Specifies the display name for the workflow in Atlan. This name appears in the workflow list and on run history pages, so choose a name that clearly reflects the adoption segment or time window you are exporting.
Example:
Quarterly adoption export (Production)
Include most-viewed assets?
Controls whether the workflow computes and exports adoption metrics based on asset views. This setting also determines how assets are ranked in the output.
You must select one of the following options:
-
By unique users: Includes a Views worksheet and ranks assets by the number of distinct users who viewed each asset within the workflow run. Multiple views by the same user are counted once.
Use this option to understand breadth of adoption, such as which assets are broadly accessed across teams or roles, regardless of repeat usage by individuals.
-
By raw views: Includes a Views worksheet and ranks assets by the total number of view events, including repeated views by the same user.
Use this option to identify assets with the highest overall activity or traffic, such as frequently referenced dashboards or tables.
-
No: Disables view-based adoption metrics entirely. When selected the Views worksheet isn't generated. All other view-related settings in this section are ignored.
Maximum assets
Specifies the maximum number of assets to include in the Views worksheet, ranked according to the option selected in Include most-viewed assets?. This controls both the focus of the analysis and the size of the exported file.
- Default:
100 - Minimum:
1
Use this to limit the export to the top N most-viewed assets for the configured reporting window.
Include details
Controls whether the workflow produces a User views worksheet (or CSV) in addition to the aggregate Views worksheet.
The Views worksheet always contains one row per asset with view counts and distinct user totals, regardless of this setting.
-
Yes: Adds a User views worksheet with one row per individual view event between the configured From date and To date. This exposes two additional configuration fields that define the reporting window:
-
From date: Defines the earliest date from which view events are included in the User views worksheet. View events before this date are excluded.
-
To date: Defines the latest date up to which view events are included. Leave this blank to include all views from the From date onwards.
Use this option when you need a per-event breakdown for a specific reporting window, such as a monthly, quarterly, or campaign-based adoption report.
-
-
No: Omits the User views worksheet and restricts the export to the aggregate Views worksheet only.
Changes
Settings in this section control how the workflow identifies and exports the assets with the most changes.
Include asset changes?
Controls whether the export includes a Changes worksheet for assets with the highest volume of change activity.
- Yes: Adds a Changes worksheet to the export and enables additional filters to narrow the activity to specific users, actions, and dates.
- No: Skips the Changes worksheet and excludes all change-based adoption metrics from the export.
Limit to user
Optionally restricts the Changes worksheet to assets updated by specific users.
- Provide one or more user identifiers through the Users selector to focus on the impact of particular stewards, creators, or teams.
- Leave this blank to include changes from all users across the tenant.
Example:
Limit by action
Optionally restricts the export to specific types of changes (for example, description edits, certification updates, or ownership changes).
- Select one or more change actions from the list to analyze particular behaviors, such as stewardship curation or governance updates.
- Leave this blank to include all supported change types.
From date
Defines the earliest change date to include when computing change-based adoption metrics.
- Changes before this date are excluded.
- Use this to bound the export to a specific reporting window, such as a sprint, quarter, or project period.
Example:
2025-09-17
To date
Defines the latest change date to include when computing change-based adoption metrics.
- Changes after this date are excluded.
- Leave this blank to include all changes from the From date up to the present.
Example:
2025-12-16
Maximum assets
Specifies the maximum number of assets to include in the Changes worksheet, ranked by the number of changes within the configured timeframe and filters.
- Default:
100 - Minimum:
1
Use this to limit the export to the top N most actively changed assets for the selected reporting window.
Include details
Controls whether the workflow produces a User changes worksheet (or CSV) in addition to the aggregate Changes worksheet.
The Changes worksheet always contains one row per asset with total change counts, regardless of this setting.
-
Yes: Adds a User changes worksheet with one row per individual change event. Each row includes the time of the change, the user who made it, the action taken, the asset type, the qualified name, the change agent (UI, workflow, or SDK), and a direct link to the asset profile in Atlan.
Use this option when you need a per-event audit trail or want to investigate which users and actions are driving the most change activity.
-
No: Omits the User changes worksheet and restricts the export to the aggregate Changes worksheet only.
Automation filter
Controls how automation-originated updates are counted in the change metrics. Use this setting to exclude or include changes made by workflows or SDK-based processes.
- None (default): Includes only UI-driven changes, where the change originated from the Atlan web application. Workflow and SDK changes are excluded.
- WFL: Includes UI-driven and workflow-driven changes. SDK-driven changes are excluded.
- SDK: Includes UI-driven and SDK-driven changes. Workflow-driven changes are excluded.
- All: Includes all change sources, including UI, workflows, and SDK. Exports with this option can be significantly larger for active tenants.
Searches
Settings in this section control whether the workflow exports adoption metrics based on UI-based user searches.
Include user searches?
Controls whether the workflow includes a User searches worksheet in the export.
- Yes: Adds a User searches worksheet (or CSV) and enables the From date and To date fields that define the search reporting window. Each row represents a single UI-based search performed within the configured date range.
- No: Skips search-based adoption metrics and omits the User searches worksheet.
From date
Defines the earliest search date to include for search-based adoption metrics. Search events before this date are excluded.
Example:
2025-09-17
To date
Defines the latest search date to include for search-based adoption metrics. Leave this blank to include all searches from the From date onwards.
Delivery
Settings in this section control how the workflow structures the exported results and how the files are delivered.
File format
Defines the structure of the exported results.
-
Single Excel file: Exports all enabled adoption metrics to a single Excel workbook (
adoption-export.xlsx), with a separate worksheet for each enabled area:- Views (if Include most-viewed assets? is enabled)
- User views (if Include details is enabled under Views)
- Changes (if Include asset changes? is enabled)
- User changes (if Include details is enabled under Changes)
- User searches (if Include user searches? is enabled)
Use this option when you want a single file for manual analysis or sharing.
-
Multiple CSV files: Exports separate CSV files for each enabled area:
views.csv(if Include most-viewed assets? is enabled)user-views.csv(if Include details is enabled under Views)changes.csv(if Include asset changes? is enabled)user-changes.csv(if Include details is enabled under Changes)user-searches.csv(if Include user searches? is enabled)
Use this option when you plan to load the results into downstream tools or automated pipelines that work best with CSV files.
Export via
Defines how you access the exported file or files.
- Direct download
- Object storage
Results are always available as a direct download from the workflow run in Atlan. This mode is always enabled and doesn't require additional configuration.
Sends the exported file or files as an email attachment.
- In the Email addresses field, enter a comma-separated list of email addresses that receive the export. For example:
Uploads the exported results to a cloud object store such as Amazon S3, Google Cloud Storage (GCS), or Azure Data Lake Storage (ADLS). Object storage is recommended for larger exports, automated pipelines, or recurring reports where the export files are consumed outside Atlan.
When you select Object storage, the workflow writes the export file or files to a specific path or object location in your storage system. The objects created follow the file format and structure defined in the File format settings.
For detailed information on configuring storage credentials, access methods, and required fields for each provider, see Object storage configuration for apps. The same configuration patterns apply here for S3, GCS, and ADLS destinations.
Output
The Adoption export app compiles all selected adoption metrics into a single Excel workbook or multiple CSV files, depending on the File format configuration. Each enabled area produces its own worksheet or CSV file.
- Views worksheet
- User views worksheet
- Changes worksheet
- User changes worksheet
- User searches worksheet
Always present when Include most-viewed assets? is enabled. Contains one row per asset ranked by view activity. Columns include:
- Type: Asset type.
- Qualified name: Unique identifier for the asset in Atlan. In combination with Type, this is unique.
- Name: Simple display name of the asset.
- Total views: Total number of view events for the asset, including repeated views by the same user.
- Distinct users: Number of unique users who viewed the asset.
- Link: Direct link to the asset's profile in Atlan.
Present when Include details is enabled under Views. Contains one row per individual view event within the configured date range. Columns include:
- Time: When the view occurred.
- Username: Who viewed the asset.
- Total: Total assets returned in the view context.
- Type(s): Asset types observed in the view results.
- Qualified name(s): Qualified names of assets in the view results.
- Link: Direct link to the viewed asset's profile in Atlan.
Always present when Include asset changes? is enabled. Contains one row per asset ranked by change activity. Columns include:
- Type: Asset type.
- Qualified name: Unique identifier for the asset in Atlan.
- Name: Simple display name of the asset.
- Total changes: Total number of changes made to the asset within the selected timeframe and filters.
- Link: Direct link to the asset's profile in Atlan.
Present when Include details is enabled under Changes. Contains one row per individual change event. Columns include:
- Time: When the change occurred.
- Username: Who made the change.
- Action: The type of change action performed.
- Type: Asset type of the changed asset.
- Qualified name: Unique identifier for the changed asset.
- Agent: The origin of the change: UI, workflow, or SDK.
- Details: Additional context about the change.
- Link: Direct link to the changed asset's profile in Atlan.
Present when Include user searches? is enabled. Contains one row per UI-based search performed within the configured date range. Columns include:
- Time: When the search occurred.
- Username: Who ran the search.
- Query: The search text entered by the user. Blank when the search was made using filters only, with no text query.
- Total: Total number of assets returned by the search.
- Types: Asset types of the first 20 results.
- Qualified names: Qualified names of the first 20 results.