Atlan Activity Report

This repo fetches Atlan access events and builds an HTML report.

It uses the Atlan SDK as documented here: Retrieve access events.

Prerequisites

• Python 3.9+
• An Atlan API Key with permissions to read admin events

Setup

1. Create a virtual environment and install dependencies:

python3 -m venv .venv
./.venv/bin/pip install -r requirements.txt

2. Configure authentication and settings:

• Copy the example config to a local file and edit it:

  cp config.example.yaml config.yaml

  • Set tenant.base_url for your Atlan tenant
  • Adjust the reporting window (report.date_from, report.date_to)
  • Note: config.yaml is intentionally in .gitignore to avoid committing secrets
• Create a .env file with ATLAN_API_KEY (recommended) and optionally ATLAN_BASE_URL.

Environment variables:

• ATLAN_API_KEY – must be set (via .env or your environment)
• ATLAN_BASE_URL – optional; if not set, the app uses tenant.base_url from config.yaml

Run

./.venv/bin/python -m src.main --config config.yaml

Outputs are written under output/ by default.

For filter options and details, see: Retrieve access events.

Charts included

• Top users by admin events: bar chart of the top 20 users by event count
• Events by operation type: bar chart of counts per operation
• Top resource types: bar chart of the top 20 resource types
• Per-user operation breakdown: stacked bar for top 10 users, colored by operation
• Events over time (daily): line chart of events per day
• Heatmap by day and hour: density heatmap of events by weekday and hour
• Top resource path patterns: horizontal bar of top 20 paths (when available)

Notes on secrets and version control

• Do not commit secrets. config.yaml, .env, and output/ are ignored by .gitignore.
• If config.yaml was previously committed, remove it from version control history and rotate the API key.