User Profiles - Sessions

Endpoint

/o?method=user_details&calculate=sessions

Ⓔ Enterprise Only
This API is available exclusively in Countly Enterprise.

Overview

Returns session table for a single user.

Authentication

Authentication methods:

• API Key (parameter): api_key=YOUR_API_KEY
• Auth Token (parameter): auth_token=YOUR_AUTH_TOKEN
• Auth Token (header): countly-token: YOUR_AUTH_TOKEN

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 sessions
uid	String	No	User ID
did	String	No	Device ID alternative
period	String	No	Requested period
periodOffset	Number	No	Period offset in minutes
iSortCol_0	Number	No	Sort column index
sSortDir_0	String	No	Sort direction
dbOverride	String	No	Query adapter override
comparisonMode	Boolean/String	No	Comparison mode flag

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.

Response

Success Response

{
  "sEcho": "1",
  "iTotalRecords": 5,
  "iTotalDisplayRecords": 5,
  "aaData": [
    {
      "ts": 1739557500,
      "dur": 324,
      "did": "device_123"
    }
  ]
}

Response Fields

Field	Type	Description
sEcho	String	Echo value for table requests
iTotalRecords	Number	Total records count
iTotalDisplayRecords	Number	Displayed records count
aaData	Array	Session rows

Error Responses

• HTTP 400 - Query execution issue:

{
  "result": "Error. Please check logs."
}

Behavior/Processing

• Resolves uid from did when required.
• Returns {} when user cannot be resolved.

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.

---

Examples

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

Related Endpoints

• User Profiles - Timeline Graph
• User Profiles - Events Table

Ⓔ Enterprise

This feature is part of Countly Enterprise.

Get Access:

• Learn about Enterprise
• Contact Sales
• Compare Versions

Already a Customer? Use support portal if you have any questions.

---

Last Updated

2026-02-16