Skip to main content

Reports - Reports Read

Endpoint

/o/reports/all

Overview

Returns reports visible to the authenticated user.

Authentication

Countly API supports three authentication methods:

  1. api_key=YOUR_API_KEY
  2. auth_token=YOUR_AUTH_TOKEN
  3. countly-token: YOUR_AUTH_TOKEN

Permissions

Requires reports Read permission.

Request Parameters

ParameterTypeRequiredDescription
api_keyStringYes (or use auth_token)API key for authentication.
auth_tokenStringNoAuth token as query parameter or countly-token header.
app_idStringYesApp id used by permission validation.

Response

Success Response

[
{
"_id": "6262742dbf7392a8bfd8c1f6",
"title": "Monthly Analytics Report",
"report_type": "core",
"apps": [
"615f0c4120543a8ed03a89b8"
],
"emails": [
"analytics@company.com"
],
"frequency": "monthly",
"timezone": "America/New_York",
"user": "60afbaa84723f369db477fee",
"isValid": true
}
]

Response Fields

FieldTypeDescription
[]ArrayReport records visible to requester.
[].isValidBooleanCore reports are always true; non-core reports are validated via /report/verify hook.

Error Responses

Standard authentication/authorization errors from read validation.

Behavior/Processing

  • Non-global admins only receive reports they own or where their email appears in emails.
  • Global admins receive all reports.
  • Missing report_type defaults to core in output.

Database Collections

CollectionUsed forData touched by this endpoint
countly.reportsReports sourceReads report definitions.

Examples

Read reports for current user

/o/reports/all?api_key=YOUR_API_KEY&app_id=6991c75b024cb89cdc04efd2

Last Updated

2026-03-05