---
title: "Get Universal Activity Metrics"
method: GET
path: "/universal-activity/metrics"
tags: ["Inbox"]
---

# Get Universal Activity Metrics

`GET /universal-activity/metrics`

## Request

- Base URL: `https://be.graph8.com/api/v1`
- URL: `https://be.graph8.com/api/v1/universal-activity/metrics`
- Auth: HTTP bearer

Activity metrics for a window.

`tz` is REQUIRED, deliberately: every bucket boundary is a local calendar
day, so a default would silently bucket a customer's data in the wrong
timezone rather than failing loudly.

## Query parameters

- `tz` string, required: IANA timezone name, e.g. `America/New_York`.
- `range` 'today' | 'yesterday' | 'week' | 'month' | 'custom'
- `scope` 'mine' | 'all' | 'team': `team` is accepted for back-compat; the service aliases it to `mine`.
- `start_date` string, date, nullable: Custom range start, inclusive, in `tz`.
- `end_date` string, date, nullable: Custom range end, inclusive, in `tz`.
- `workspace_id` string, nullable: Workspace UUID; omit for org-wide.
- `channel` string, nullable: Restrict to one channel.

## Headers

- `Authorization` string, nullable
- `X-Target-Org-Id` string, nullable

## Response `200`

Successful Response

- ApiResponseAny
  - `data` unknown, required
  - `pagination` PaginationMeta
    - `page` integer, required: Current page number (1-indexed)
    - `limit` integer, required: Items per page
    - `total` integer, required: Total number of items
    - `has_next` boolean, required: Whether there are more pages
    - `next_cursor` string, nullable: Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers.
    - `total_available` integer, nullable: Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search.
    - `total_is_lower_bound` boolean, nullable: Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search.
    - `notes` string[], nullable: Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/graph8/apis/graph8-developer-api.md) · [All operations](https://skmtc.dev/graph8/apis/graph8-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/graph8/apis/graph8-developer-api/revisions/2e7cfa0ca921?raw)