Export Format Documentation

Overview

The export creates a ZIP archive containing your StreamElements data in multiple formats. JSON files contain the complete raw data, while CSV files provide spreadsheet-friendly versions for easy viewing and analysis.

flowchart LR
    subgraph Auth["🔐 Authentication"]
        OAuth["OAuth Token"]
        JWT["JWT Token"]
    end

    subgraph API["☁️ StreamElements API"]
        direction TB
        Endpoints["API Endpoints
/commands, /overlays,
/points, etc."]
        CDN["Asset CDN
images, sounds"]
    end

    subgraph Process["⚙️ Export Process"]
        direction TB
        Fetch["Fetch Data"]
        Download["Download Assets"]
        Extract["Extract Widgets"]
        Hash["Compute Hashes"]
    end

    subgraph Output["📦 Output"]
        direction TB
        JSON["JSON Files
complete data"]
        CSV["CSV Files
spreadsheet format"]
        Code["Code Files
HTML/CSS/JS"]
        Media["Media Files"]
        Manifest["manifest.json
with SHA-256"]
    end

    ZIP["📥 .zip Download"]

    OAuth --> Endpoints
    JWT --> Endpoints
    Endpoints --> Fetch
    CDN --> Download
    Fetch --> Extract
    Download --> Hash
    Extract --> Hash
    Hash --> JSON
    Hash --> CSV
    Hash --> Code
    Hash --> Media
    Hash --> Manifest
    JSON --> ZIP
    CSV --> ZIP
    Code --> ZIP
    Media --> ZIP
    Manifest --> ZIP
      

Export process from authentication to ZIP download

Each export includes a manifest.json file with metadata about the export, including SHA-256 hashes for file integrity verification, and a README.md with human-readable documentation.

Data Relationships

The export archive contains multiple data types that relate to each other. This diagram shows how the different components connect.

flowchart TB
    subgraph Export["📦 Export Archive"]
        direction TB
        Manifest["manifest.json
Metadata & Hashes"]
        README["README.md"]
    end

    subgraph Bot["🤖 Bot Configuration"]
        direction TB
        Commands["Commands
custom & default"]
        Timers["Timers"]
        Filters["Chat Filters"]
        Variables["Variables"]

        Commands -.->|"uses"| Variables
        Timers -.->|"uses"| Variables
    end

    subgraph Visual["🎨 Visual Layer"]
        direction TB
        Overlays["Overlays"]

        subgraph WidgetTypes["Widgets"]
            Standard["Standard
alertbox, chatbox,
eventlist, etc."]
            Custom["Custom
with code"]
        end

        Assets["Assets
images, sounds,
videos"]

        Overlays -->|"contains"| Standard
        Overlays -->|"contains"| Custom
        Standard -.->|"references"| Assets
        Custom -.->|"references"| Assets
    end

    subgraph CustomCode["📝 Custom Widget Code"]
        direction LR
        HTML["HTML"]
        CSS["CSS"]
        JS["JavaScript"]
        Data["Data"]
        Fields["Fields"]
    end

    subgraph Loyalty["💰 Loyalty System"]
        direction TB
        Settings["Loyalty Settings"]
        Leaderboard["Leaderboard
all users"]
        Store["Store Items"]

        Settings -->|"configures"| Leaderboard
        Store -.->|"costs"| Settings
    end

    subgraph Analytics["📊 Analytics"]
        ChannelStats["Channel Stats"]
        ChatStats["Chat Stats"]
    end

    Custom -->|"extracts to"| CustomCode

    Export --- Bot
    Export --- Visual
    Export --- Loyalty
    Export --- Analytics
      

Data flow and relationships between export components

Key Relationships

Archive Structure

The export creates a ZIP file with a hierarchical folder structure organized by data type.

flowchart LR
    subgraph Root["📦 {username}-export.zip"]
        direction TB
        M["📄 manifest.json"]
        R["📄 README.md"]

        subgraph Cmd["📁 commands/"]
            C1["custom-commands.json"]
            C2["default-commands.json"]
            C3["custom-commands.csv"]
        end

        subgraph Tim["📁 timers/"]
            T1["timers.json"]
            T2["timers.csv"]
        end

        subgraph Ovr["📁 overlays/"]
            O1["index.json"]
            O2["{name}.json"]

            subgraph Wgt["📁 {name}_widgets/"]
                W1["_index.json"]
                subgraph Std["📁 standard/"]
                    S1["{widget}.json"]
                end
                subgraph Cst["📁 custom/"]
                    CW1["{widget}.json"]
                    CW2["{widget}.html"]
                    CW3["{widget}.css"]
                    CW4["{widget}.js"]
                end
            end

            subgraph Ast["📁 assets/"]
                A1["asset-manifest.json"]
                A2["{media files}"]
            end
        end

        subgraph Pts["📁 points/"]
            P1["loyalty-settings.json"]
            P2["leaderboard.json"]
            P3["leaderboard.csv"]
        end

        subgraph Sts["📁 stats/"]
            ST1["channel-stats.json"]
            ST2["chat-stats.json"]
        end

        subgraph Str["📁 store/"]
            SR1["store-items.json"]
            SR2["store-items.csv"]
        end

        subgraph Flt["📁 filters/"]
            F1["chat-filters.json"]
        end

        subgraph Var["📁 variables/"]
            V1["variables.json"]
            V2["variables.csv"]
        end
    end
      

Visual representation of the export archive structure

Detailed File Tree

{username}-export/
├── manifest.json          # Export metadata and file hashes
├── README.md              # Human-readable documentation
├── commands/
│   ├── custom-commands.json
│   ├── default-commands.json
│   └── custom-commands.csv
├── timers/
│   ├── timers.json
│   └── timers.csv
├── overlays/
│   ├── index.json            # Summary of all overlays
│   ├── {overlay-name}.json   # Full overlay definition
│   ├── {overlay-name}_widgets/
│   │   ├── _index.json       # Widget manifest
│   │   ├── standard/         # Built-in SE widgets
│   │   │   └── {widget}.json
│   │   └── custom/           # Custom widgets with code
│   │       ├── {widget}.json
│   │       ├── {widget}.html
│   │       ├── {widget}.css
│   │       ├── {widget}.js
│   │       ├── {widget}.data.json
│   │       └── {widget}.fields.json
│   └── assets/
│       ├── asset-manifest.json
│       └── {media files}
├── points/
│   ├── loyalty-settings.json
│   ├── leaderboard.json
│   └── leaderboard.csv
├── stats/
│   ├── channel-stats.json
│   └── chat-stats.json
├── store/
│   ├── store-items.json
│   └── store-items.csv
├── filters/
│   └── chat-filters.json
└── variables/
    ├── variables.json
    └── variables.csv

Manifest File

The manifest.json file contains metadata about the export and integrity hashes for all included files.

Schema

Example

{
  "exportDate": "2024-01-15T10:30:00.000Z",
  "account": "mychannel",
  "version": "1.1",
  "complete": true,
  "cancelled": false,
  "exported": ["commands", "timers", "overlays", "points"],
  "errors": [],
  "files": [
    {
      "path": "commands/custom-commands.json",
      "size": 4523,
      "sha256": "a1b2c3d4..."
    }
  ],
  "stats": {
    "totalFiles": 42,
    "totalSize": 1548234,
    "duration": 12500
  }
}

Commands

Chat commands created in the StreamElements dashboard.

custom-commands.json JSON

Your custom chat commands with all configuration options.

Access Levels

default-commands.json JSON

Built-in StreamElements commands with your enabled/disabled settings.

custom-commands.csv CSV

Spreadsheet-friendly format with flattened nested fields.

Timers

Automated messages that post to chat on intervals.

timers.json JSON

timers.csv CSV

Spreadsheet-friendly format for easy viewing.

Overlays

Stream overlay configurations including all widgets and their settings.

index.json JSON

Summary list of all your overlays with basic metadata.

{overlay-name}.json JSON

Full overlay definition including all widgets and their configurations.

Widgets

Each overlay's widgets are extracted into a dedicated folder, segregated into standard/ (built-in SE widgets) and custom/ (widgets with custom code).

flowchart TB
    Overlay["Overlay
contains widgets array"]

    Overlay --> Check{"Has custom code?
HTML, CSS, JS,
data, or fields"}

    Check -->|"No"| Standard["📁 standard/"]
    Check -->|"Yes"| Custom["📁 custom/"]

    Standard --> StdFiles["widget.json
settings only"]

    Custom --> CstFiles["widget.json
widget.html
widget.css
widget.js
widget.data.json
widget.fields.json"]

    subgraph Types["Standard Widget Types"]
        direction LR
        T1["alertbox"]
        T2["chatbox"]
        T3["eventlist"]
        T4["goals"]
        T5["ticker"]
        T6["labels"]
    end

    Standard -.-> Types
      

Widget classification and file extraction logic

_index.json (Widget Manifest) JSON

Summary of all widgets in this overlay.

standard/ (Built-in Widgets)

Contains StreamElements' built-in widgets like alertbox, chatbox, eventlist, etc.

{widget}.json JSON

custom/ (Custom Widgets)

Contains widgets with custom HTML/CSS/JS code. Each custom widget includes:

Assets

Media files used by your overlays (images, sounds, videos).

asset-manifest.json JSON

Maps each downloaded file to its original URL and usage information.

Points / Loyalty

Your loyalty points system configuration and user balances.

loyalty-settings.json JSON

leaderboard.json JSON

Complete leaderboard with all users and their points balances.

leaderboard.csv CSV

Spreadsheet-friendly format for easy analysis.

Statistics

Channel and chat analytics from StreamElements.

channel-stats.json JSON

Channel-level analytics and metrics including follower counts, stream history, and engagement data.

chat-stats.json JSON

Chat activity statistics including message counts, active chatters, and chat patterns.

Store Items

Loyalty store items that viewers can redeem with their points.

store-items.json JSON

store-items.csv CSV

Spreadsheet-friendly format.

Chat Filters

Moderation settings for your chat.

chat-filters.json JSON

Contains all moderation rules including:

• Spam filters - Caps, emotes, symbols, repetition limits
• Link filters - Whitelist/blacklist domains, permit levels
• Word filters - Banned words and phrases
• Moderation levels - Who is exempt from each filter

Variables

Custom variables that can be used in commands and timers.

variables.json JSON

variables.csv CSV

Spreadsheet-friendly format.

File Integrity Verification

Each file in the export includes a SHA-256 hash in the manifest for integrity verification. This allows you to verify that files haven't been corrupted or tampered with.

File Entry Structure

Verification Commands

Linux / macOS

sha256sum path/to/file

Windows PowerShell

Get-FileHash path/to/file -Algorithm SHA256

Python

import hashlib

with open('path/to/file', 'rb') as f:
    print(hashlib.sha256(f.read()).hexdigest())