Read property value list
Ⓔ Enterprise Only
This API is available exclusively in Countly Enterprise.
Endpoint
/o/data-manager/list-values
Overview
Returns paginated property values from drill metadata for an event segment or user property.
Authentication
Countly API supports three authentication methods:
- API key query parameter:
api_key=YOUR_API_KEY - Auth token query parameter:
auth_token=YOUR_AUTH_TOKEN - Auth token header:
countly-token: YOUR_AUTH_TOKEN
Permissions
Requires data_manager Read permission.
Request Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
app_id | String | Yes | Target app ID. |
group | String | Yes | Property group path (for example sg, custom, up). |
property | String | Yes | Property key name. |
event | String | Conditional | Required for event segments (user_property=false). |
user_property | String | No | Set to true for user properties. |
iDisplayStart | Number | No | Pagination start offset. |
iDisplayLength | Number | No | Page length (-1 means all). |
sSearch | String | No | Case-insensitive search filter. |
sEcho | String | No | Echo value returned in response. |
api_key | String | Conditional | Required if auth_token is not provided. |
auth_token | String | Conditional | Required if api_key is not provided. |
Response
Success Response
{
"sEcho": "1",
"iTotalRecords": 12,
"iTotalDisplayRecords": 4,
"aaData": [
{ "name": "US" },
{ "name": "CA" }
]
}
Response Fields
| Field | Type | Description |
|---|---|---|
sEcho | String | Echo value from request (if provided). |
iTotalRecords | Number | Total value count. |
iTotalDisplayRecords | Number | Count after filter. |
aaData | Array | Value rows. Each row contains name. |
Error Responses
This endpoint does not define a dedicated structured error payload for aggregation failures; errors are logged and may return generic error responses.
Behavior/Processing
- Builds metadata
_idfrom app, event hash/group/property, or_meta_uppath. - Reads values from
countly_drill.drill_meta.valuesvia aggregation pipeline. - Applies search and pagination when provided.
- Decodes stored value names before returning.
Audit & System Logs
- This endpoint does not emit
/systemlogsactions.
Database Collections
| Collection | Used for | Data touched by this endpoint |
|---|---|---|
countly_drill.drill_meta | Property value dictionary source | Reads values keys for event segment or user-property metadata documents and returns paginated value names. |
Examples
Event segment values
/o/data-manager/list-values?
app_id=64f5c0d8f4f7ac0012ab3456&
event=purchase&
group=sg&
property=country&
iDisplayStart=0&
iDisplayLength=25
User property values
/o/data-manager/list-values?
app_id=64f5c0d8f4f7ac0012ab3456&
user_property=true&
group=custom&
property=subscription_tier
Related Endpoints
Last Updated
2026-02-16