latestOpenAPI 3.1.02026-08-223321,1001.6 MB

2134ebffd1ef

Get Metric Detail

Return a metric's detail view — a ranked table for every metric that has one today.

Requires organization admin role or higher. A metric with no detail view is a 404 (ANALYTICS_METRIC_HAS_NO_DETAIL) rather than an empty table.

get/v2/analytics/{metric}/detail

Path parameters

metric'active_users' | 'new_users' | 'session_starters' | 'sessions' | 'sessions_and_users' | 'sessions_per_user' | 'activity_heatmap' | 'top_users' | 'top_channels' | 'top_sessions' | 'investigators' required

Stable, public metric ids. Append-only — never rename or repurpose.

Query parameters

start_timestring date-time nullable

Start timestamp (inclusive), ISO 8601 with timezone. Defaults to 30 days ago.

Example:2025-01-15T00:00:00.000Z

Start timestamp (inclusive), ISO 8601 with timezone. Defaults to 30 days ago.

end_timestring date-time nullable

End timestamp (exclusive), ISO 8601 with timezone. Defaults to now.

Example:2025-02-15T23:59:59.999Z

End timestamp (exclusive), ISO 8601 with timezone. Defaults to now.

Response

Successful Response

metric'active_users' | 'new_users' | 'session_starters' | 'sessions' | 'sessions_and_users' | 'sessions_per_user' | 'activity_heatmap' | 'top_users' | 'top_channels' | 'top_sessions' | 'investigators' required

Stable, public metric ids. Append-only — never rename or repurpose.

Example response

{
  "window": {
    "timezone": "UTC"
  }
}