Skip to main content

SDK - SDK Config Read

Endpoint

/o/sdk?method=sc

Overview

Returns runtime SDK configuration for a device.

Authentication

SDK authentication is used.

Required SDK identity parameters:

  • app_key
  • device_id

Permissions

No dashboard permission check is applied. Access is validated through app/device context.

Request Parameters

ParameterTypeRequiredDescription
methodStringYesMust be sc.
app_keyStringYesApp key used by SDK endpoints.
device_idStringYesDevice/user identifier.

Response

Success Response

{
"v": 2,
"t": 1741286400000,
"c": {
"tracking": true,
"crt": true,
"vt": true,
"bom": true,
"bom_at": 10,
"bom_rqp": 0.5
}
}

Response Fields

FieldTypeDescription
vNumberSDK config payload version (2).
tNumberServer timestamp in milliseconds.
cObjectEffective SDK config after enforcement filtering.
c.bom_rqpNumberReturned as ratio (0..1) by dividing stored integer percent by 100.

Error Responses

  • 400
{
"result": "Missing parameter \"app_key\" or \"device_id\""
}
  • 400
{
"result": "Error: undefined"
}

Behavior/Processing

  • Loads app config from sdk_configs and enforcement from sdk_enforcement.
  • If enforcement has a key set to false, that key is removed from response c.
  • Sets v=2, t=Date.now() on every response.

Database Collections

CollectionUsed forData touched by this endpoint
countly_out.sdk_configsSDK config sourceReads per-app SDK config (config).
countly_out.sdk_enforcementEnforcement sourceReads per-app enforcement filter (enforcement).

Examples

Read SDK config

/o/sdk?method=sc&app_key=YOUR_APP_KEY&device_id=device-123

Last Updated

2026-03-05