Get Metric Detail

Changed on

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

Request

  • Base URL
    https://api.traversal.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.traversal.com/v2/analytics/{metric}/detail
  • Auth
    none declared

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
end_timestring date-time nullable

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

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

1-indexed page number. Ignored unless limit is also set; defaults to 1.

limitinteger nullable

Rows per page. Omit to return every row in the window (the original, unpaginated behavior).

querystring nullable

Case-insensitive substring match against the session title or the creator's email. Blank is treated as no search; otherwise must be at least 3 non-whitespace characters.

actor_type'user' | 'service_account'

Count only this kind of actor. Omit to count users and service accounts together.

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.

countinteger nullable

Rows in this page; None when the response is unpaginated.

previnteger nullable

Previous page number, if any.

nextinteger nullable

Next page number, if any.

totalinteger nullable

Total rows matching the window/search across all pages; None when unpaginated.

Example response

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

Changes

    • warning

      added the new actor enum value to the /// response property for the response status

    • info

      added the new optional query request parameter actor_type

    • info

      added the required property /// to the response with the status