SDK - Config Read

Endpoint

/o?method=sdk-config

Overview

Returns stored SDK config for dashboard/admin usage.

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 sdk Read permission.

Request Parameters

Parameter	Type	Required	Description
method	String	Yes	Must be sdk-config.
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	App id.

Response

Success Response

{
  "tracking": true,
  "crt": true,
  "vt": true,
  "bom": true,
  "bom_at": 10,
  "bom_rqp": 50
}

Response Fields

Field	Type	Description
(root)	Object	Stored config object for the app (config).

Error Responses

• 400

{
  "result": "Error: undefined"
}

Behavior/Processing

Behavior Modes

Mode	Trigger	Processing Path	Response Shape
Config exists	App has sdk_configs document with config object	Reads and returns stored config.	Raw SDK config object.
No config doc	No matching document for app	Returns empty object fallback.	{}
Read failure	Read operation rejects/errors	Returns wrapped error response.	Wrapped error in result.

Database Collections

Collection	Used for	Data touched by this endpoint
countly_out.sdk_configs	SDK config source	Reads per-app SDK config document.

---

Examples

Read stored SDK config

/o?method=sdk-config&api_key=YOUR_API_KEY&app_id=6991c75b024cb89cdc04efd2

Related Endpoints

• SDK - Config Upload
• SDK - SDK Config Read

Last Updated

2026-03-05