Skip to main content

/o/analytics/durations

Endpoint

/o/analytics/durations

Overview

Returns session duration bucket distribution for the selected period.

Authentication

  • 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

  • Requires read access to feature core for the target app.

Request Parameters

ParameterTypeRequiredDescription
api_keyStringYes (or use auth_token)Dashboard API authentication key.
auth_tokenStringYes (or use api_key)Dashboard auth token.
app_idStringYesApp ID (24-char hex).
periodStringNoRequested period for bucket extraction.
timezoneStringNoOptional timezone override.
timestampNumberNoOptional reference timestamp.

Response

Success Response

[
{"ds": "7", "t": 403, "percent": "81.1"},
{"ds": "3", "t": 42, "percent": "8.5"},
{"ds": "4", "t": 18, "percent": "3.6"}
]

Response Fields

FieldTypeDescription
[]ArrayDuration bucket rows sorted by count descending.
[] .dsStringDuration bucket key.
[] .tNumberBucket count.
[] .percentStringBucket percentage as string.

Error Responses

Status Code: 400 Bad Request

{"result":"Missing parameter \"api_key\" or \"auth_token\""}

Status Code: 400 Bad Request

{"result":"Missing parameter \"app_id\""}

Behavior/Processing

Behavior Modes

  • Single mode:
    • Reads d-ranges metadata and extracts duration range data for requested period.

Impact on Other Data

  • Read-only endpoint.

Audit & System Logs

  • No /systemlogs action is emitted by this endpoint.

Database Collections

CollectionUsed forData touched by this endpoint
countly.membersAuthentication and permission validationReads member record by api_key or auth_token to verify read access.
countly.appsApp context validationReads app record (timezone, app state) for the requested app_id.
countly.users{appId}Duration range source (d-ranges) and countsRead for duration distribution output.

Examples

Example 1: Read duration distribution

/o/analytics/durations?
api_key=YOUR_API_KEY&
app_id=6991c75b024cb89cdc04efd2&
period=30days

Limitations

  • If duration range metadata is absent, response can be an empty array.

Last Updated

2026-02-17