Skip to main content

Data Export - API Documentation

Overview​

Export endpoints generate downloadable data files from collections, request handlers, or provided in-memory payloads.

Authentication & Permissions​

  • Export creation endpoints use dashboard user authentication (api_key or auth_token).
  • /o/export/db, /o/export/request, /o/export/requestQuery, and /o/export/data require authenticated dashboard access.
  • /o/export/download/{task_id} is validated with core read access rules.

Export Modes​

  1. Database export:
    • Reads directly from a selected collection and streams/returns a formatted file.
  2. Request export:
    • Calls a target API path and exports its returned payload.
  3. Request-query export:
    • Creates an async export task and returns a task ID.
  4. Data export:
    • Exports a provided data payload without querying DB collections.
  5. Download:
    • Streams task output from stored task results.

Supported Formats​

  • json
  • csv
  • xls
  • xlsx

Configuration & Settings​

SettingAffectsImpact
api.export_limit/o/export/dbCaps maximum exported document count when limit is provided.

Storage & Collections​

CollectionPurpose
countly.membersMember identity/permissions used by export endpoint management-read and core-read validations.
countly.long_tasksStores async export task metadata, status, and output references.
countly_fs.task_resultsStores large/binary export results (GridFS).

Last Updated​

2026-02-17