---
title: "Return engagement by domain or sender"
method: GET
path: "/v3/metrics/tracking"
tags: ["Tracking events"]
---

# Return engagement by domain or sender

`GET /v3/metrics/tracking`

## Request

- Base URL: `https://api.us.nylas.com`
- URL: `https://api.us.nylas.com/v3/metrics/tracking`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/nylas/apis/nylas-api/docs/v3/metrics/tracking/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns open and click counts and rates grouped by sending domain or sender address. Use it to
compare engagement across your domains and Agent Accounts. Rows are sorted by the number of
messages sent with open tracking by default.

## Query parameters

- `group_by` 'sending_domain' | 'agent_account'
- `sort` string
- `limit` integer
- `start` string, date
- `end` string, date
- `sending_domain` string

## Response `200`

Success. Returns one row per group.

- object
  - `request_id` string: The request ID.
  - `data` TrackingBreakdown
    - `group_by` 'sending_domain' | 'agent_account': What the rows are grouped by.
    - `window` Window: A date window. Both days are UTC dates and both are included.
      - `start` string, date: The first day of the window.
      - `end` string, date: The last day of the window.
    - `rows` object[]: One row per group, sorted by `sort`.
      - `key` string: The sending domain or sender email address. `(others)` for the combined row.
      - `tracked_opens` integer: The number of messages sent with open tracking on.
      - `tracked_links` integer: The number of messages sent with link click tracking on.
      - `opened` integer: The number of messages with open tracking that were opened at least once.
      - `clicked` integer: The number of messages with link click tracking that had at least one click.
      - `opens_total` integer: The number of opens, including repeat opens.
      - `clicks_total` integer: The number of link clicks, including repeat clicks.
      - `open_rate` number, nullable: Opened messages as a percentage of messages sent with open tracking. `null` when no messages were sent with open tracking.
      - `click_rate` number, nullable: Clicked messages as a percentage of messages sent with link click tracking. `null` when no messages were sent with link click tracking.
      - `is_others` boolean: `true` for the final row that combines every group past `limit`.

## Other responses

- `400`: Bad request. A query parameter or the request body isn't valid.
- `401`: Unauthorized
- `403`: Forbidden. These endpoints need your application's API key, not a grant access token.

## Changes

- **2026-10-30** `7b9fe7c66c1c`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/nylas/apis/nylas-api/changes/v3/metrics/tracking/get.md)

---

[API](https://skmtc.dev/nylas/apis/nylas-api.md) - [All operations](https://skmtc.dev/nylas/apis/nylas-api/llms.txt) - [OpenAPI document](https://skmtc.dev/nylas/apis/nylas-api/revisions/7782a3e3ab70?raw)