Skip to main content

Remote Config - Dashboard Read

Endpoint​

/o?method=remote-config

Overview​

Returns all remote config parameters and conditions for dashboard management views.

Authentication​

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

Permissions​

Requires remote_config Read permission.

Request Parameters​

ParameterTypeRequiredDescription
methodStringYesMust be remote-config.
api_keyStringYes (or use auth_token)API key for authentication.
auth_tokenStringNoAuth token as query parameter or countly-token header.
app_idStringYesApp id.

Examples​

Read dashboard config model​

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

Response​

Success Response​

{
"parameters": [
{
"_id": "65f1f7b2ad5b9b001f12ab34",
"parameter_key": "button_color",
"default_value": "#FF5722",
"description": "Checkout button color",
"status": "Running",
"conditions": [
{
"condition_id": "65f1f7b2ad5b9b001f12ab99",
"value": "#0099FF"
}
]
}
],
"conditions": [
{
"_id": "65f1f7b2ad5b9b001f12ab99",
"condition_name": "iOS Users",
"condition_color": 1,
"condition": "{\"up._os\":{\"$eq\":\"iOS\"}}",
"used_in_parameters": 1
}
]
}

Response Fields​

FieldTypeDescription
parametersArrayFull parameter documents for app.
conditionsArrayFull condition documents for app.
conditions[].used_in_parametersNumberCount of parameters currently referencing that condition id.

Error Responses​

  • 401
{
"result": "Error while fetching remote config data."
}

Behavior​

  • Reads all parameters and all conditions from app collections.
  • Computes used_in_parameters count for each condition at response time.

Limitations​

  • Returns full arrays; no pagination.
Implementation details

Database Collections

CollectionUsed forData touched by this endpoint
countly_out.remoteconfig_parameters{appId}Parameter sourceReads all parameter documents.
countly_out.remoteconfig_conditions{appId}Condition sourceReads all condition documents and computes usage count.