/o/internal-events

Endpoint

/o/internal-events

Overview

Returns the deduplicated list of internal Countly event keys available in the running server context.

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: core 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	Conditionally required	Required for non-global users under read-permission validation.

Response

Success Response

[
  "[CLY]_session_begin",
  "[CLY]_session",
  "[CLY]_llm_interaction"
]

Response Fields

Field	Type	Description
(root)	Array	Raw array of internal event names.
[]	String	Internal event key prefixed with [CLY]_.

Error Responses

400 Bad Request

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

400 Bad Request

{
  "result": "Token not valid"
}

401 Unauthorized

{
  "result": "No app_id provided"
}

401 Unauthorized

{
  "result": "User does not exist"
}

401 Unauthorized

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

401 Unauthorized

{
  "result": "User is locked"
}

401 Unauthorized

{
  "result": "App does not exist"
}

401 Unauthorized

{
  "result": "Token is invalid"
}

Behavior/Processing

• Reads internal events from core and drill internal event registries.
• Merges both sets and removes duplicates.
• Returns the resulting array as raw output.

Database Collections

Collection	Used for	Data touched by this endpoint
countly.members	Read-permission validation	Reads authenticated user and feature access rights.
countly.apps	App validation for non-global-admin users	Reads app context for app_id validation.

Examples

Read internal event keys

/o/internal-events?api_key=YOUR_API_KEY&app_id=YOUR_APP_ID

Limitations

• Returned list depends on currently loaded features and runtime registration.
• Order of event keys is implementation-dependent.

Related Endpoints

• Features - Feature List

Last Updated

2026-02-17