/o/data-manager/category

Endpoint

/o/data-manager/category

Overview

Returns all event categories configured for the selected app.

Authentication

Countly API supports three authentication methods:

1. API Key (parameter): api_key=YOUR_API_KEY
2. Auth Token (parameter): auth_token=YOUR_AUTH_TOKEN
3. Auth Token (header): countly-token: YOUR_AUTH_TOKEN

Permissions

• Required permission: data_manager Read.

Request Parameters

Parameter	Type	Required	Description
api_key	String	Yes (or use auth_token)	API key for authentication.
auth_token	String	No	Auth token as query parameter or countly-token header.
app_id	String	Yes	Target app ID.

Response

Success Response

[
  {
    "_id": "65f0b7d9a1b2c3d4e5f60789",
    "app": "6991c75b024cb89cdc04efd2",
    "name": "Revenue"
  },
  {
    "_id": "65f0b7d9a1b2c3d4e5f60790",
    "app": "6991c75b024cb89cdc04efd2",
    "name": "Engagement"
  }
]

Response Fields

Field	Type	Description
(root)	Array	Raw category document list.
[]._id	String	Category document ID.
[].app	String	App ID owning this category.
[].name	String	Category name.

Error Responses

500 Internal Server Error

{
  "result": "Error"
}

400 Bad Request

{
  "result": "Missing parameter \"api_key\" or \"auth_token\""
}

401 Unauthorized

{
  "result": "User does not have right"
}

Behavior/Processing

• Validates read access for data_manager.
• Fetches all category documents where app matches app_id.
• Returns raw category array.

Database Collections

Collection	Used for	Data touched by this endpoint
countly.members	Authentication and permission validation	Reads member record by api_key or auth_token to verify read access.
countly.apps	App context validation	Reads app record for the requested app_id during access validation.
countly.event_categories	Stores per-app event category definitions	Reads category documents by app.

Examples

Read app categories

/o/data-manager/category?api_key=YOUR_API_KEY&app_id=YOUR_APP_ID

Related Endpoints

• Data Manager - Category Create
• Data Manager - Category Edit
• Data Manager - Category Delete

Last Updated

2026-02-17