Read internal events

Enterprise

This endpoint is part of Countly Enterprise. To get access, contact sales or compare versions. Existing customers can reach the support portal with questions.

Endpoint

/o/data-manager/events/internal

Overview

Returns the Drill metadata of the internal events that Data Manager can manage. At present this is the view event ([CLY]_view).

Authentication

Pass api_key or auth_token as a query parameter, or send countly-token as a header. See Authentication.

Permissions

Requires data_manager Read permission.

Request Parameters

Parameter	Type	Required	Description
app_id	String	Yes	Target app ID.
api_key	String	Conditional	Required if auth_token is not provided.
auth_token	String	Conditional	Required if api_key is not provided.

Examples

Read internal events

/o/data-manager/events/internal?
  app_id=64f5c0d8f4f7ac0012ab3456&
  api_key=YOUR_API_KEY

Response

Success Response

An array with one Drill metadata document for each internal event that has metadata in the app:

[
  {
    "e": "[CLY]_view",
    "app_id": "64f5c0d8f4f7ac0012ab3456"
  }
]

Response Fields

Field	Type	Description
(root)	Array	Drill metadata documents of the internal events. Empty if the app has none.
e	String	Event key.
app_id	String	App ID.

Error Responses

• 500

{
  "result": "Error"
}

Behavior

• Only the [CLY]_view event is returned.

Related Endpoints

• Events Extended - Read
• Event Segments - Read