Skip to main content

Read property value list

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/list-values

Overview

Returns paginated property values from drill metadata for an event segment or user property.

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

ParameterTypeRequiredDescription
app_idStringYesTarget app ID.
groupStringYesProperty group path (for example sg, custom, up).
propertyStringYesProperty key name.
eventStringConditionalRequired for event segments (user_property=false).
user_propertyStringNoSet to true for user properties.
iDisplayStartNumberNoPagination start offset.
iDisplayLengthNumberNoPage length (-1 means all).
sSearchStringNoCase-insensitive search filter.
sEchoStringNoEcho value returned in response.
api_keyStringConditionalRequired if auth_token is not provided.
auth_tokenStringConditionalRequired if api_key is not provided.

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

Response

Success Response

{
"sEcho": "1",
"iTotalRecords": 12,
"iTotalDisplayRecords": 4,
"aaData": [
{ "name": "US" },
{ "name": "CA" }
]
}

Response Fields

FieldTypeDescription
sEchoStringEcho value from request (if provided).
iTotalRecordsNumberTotal value count.
iTotalDisplayRecordsNumberCount after filter.
aaDataArrayValue 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

  • Builds metadata _id from app, event hash/group/property, or _meta_up path.
  • Reads values from countly_drill.drill_meta.values via aggregation pipeline.
  • Applies search and pagination when provided.
  • Decodes stored value names before returning.
Implementation details

Audit & System Logs

  • This endpoint does not emit /systemlogs actions.

Database Collections

CollectionUsed forData touched by this endpoint
countly_drill.drill_metaProperty value dictionary sourceReads values keys for event segment or user-property metadata documents and returns paginated value names.