User Profiles - History

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?method=user_details&calculate=history

Overview

Returns single-user profile object enriched with historical property changes.

Authentication

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

Permissions

• User Profiles: Read permission.

Request Parameters

Parameter	Type	Required	Description
api_key	String	Yes (or auth_token)	API key authentication
auth_token	String	Yes (or api_key)	Auth token authentication
app_id	String	Yes	App ID
method	String	Yes	Must be user_details
calculate	String	Yes	Must be history
uid	String	No	User ID
did	String	No	Device ID alternative
period	String	No	Requested period
periodOffset	Number	No	Offset in minutes

Examples

/o?api_key=YOUR_API_KEY&app_id=YOUR_APP_ID&method=user_details&calculate=history&uid=u_102&period=30days

Response

Success Response

{
  "_id": "d8f4d8f91ac1f1f5a8e6f0d9d3f4c0a71b2e3d4f",
  "uid": "u_102",
  "name": "Jane Doe",
  "history": {
    "cc": {
      "US": true,
      "DE": true
    },
    "p": {
      "iOS": {
        "17.2": true
      }
    }
  }
}

Response Fields

Field	Type	Description
_id	String	User document ID
uid	String	User ID
history	Object	Historical property values map

Error Responses

• HTTP 400 - Missing user identifier:

{
  "result": "Missing parameter \"uid\" or \"did\""
}

• HTTP 400 - User not found:

{
  "result": "User not found"
}

Behavior

• Loads base user profile from app users collection.
• Fetches historical values from query layer and adds them under history.
• Returns raw user object.

Related Endpoints

• User Profiles - List or Profile

Implementation details

Configuration Impact

Setting	Default	Affects	User-visible impact
users.*	User profile feature defaults	User-details retrieval behavior in profile endpoints.	Changes to user feature settings can affect which profile-related fields/aggregations are returned.

Database Collections

Collection	Used for	Data touched by this endpoint
countly.app_users{appId}	Per-app user profiles	Stores user-level properties and profile fields affected by this endpoint.
countly_drill.drill_events	Drill event records	Stores granular event rows queried or updated by this endpoint.