---
title: "Return an engagement summary"
method: GET
path: "/v3/metrics/tracking/summary"
tags: ["Tracking events"]
---

# Return an engagement summary

`GET /v3/metrics/tracking/summary`

## Request

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

Returns your open and click rates for a date window, compared with the previous window of the
same length, with the counts behind them. Use it to see whether engagement is going up or down.

The open rate is the share of messages with open tracking that were opened at least once. Treat
it as a trend rather than an exact count: some mail clients and privacy features load images
automatically, which counts as an open. Messages count on the day they were sent, so rates for
recent days keep rising as recipients open them.

## Query parameters

- `start` string, date
- `end` string, date
- `sending_domain` string

## Response `200`

Success. Returns the summary.

- object
  - `request_id` string: The request ID.
  - `data` TrackingSummary
    - `totals` EngagementCounts: Engagement counts. Each message counts on the day it was sent, so a message sent last week and opened today adds to last week's numbers.
      - `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.
    - `metrics` object: Open and click rates for the window, compared with the previous window of equal length.
      - `open_rate` RateTile: A rate for the window, compared with the same rate in the previous window of equal length.
        - `value` number, nullable: The rate for the window, as a percentage from 0 to 100. `null` when there is nothing to divide by.
        - `delta_pp` number, nullable: The change from the previous window, in percentage points (`value` minus `prior_value`). `null` when either value is `null`.
        - `prior_value` number, nullable: The same rate for the previous window. `null` when it can't be calculated.
      - `click_rate` RateTile: A rate for the window, compared with the same rate in the previous window of equal length.
        - `value` number, nullable: The rate for the window, as a percentage from 0 to 100. `null` when there is nothing to divide by.
        - `delta_pp` number, nullable: The change from the previous window, in percentage points (`value` minus `prior_value`). `null` when either value is `null`.
        - `prior_value` number, nullable: The same rate for the previous window. `null` when it can't be calculated.
    - `prior_period` 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.

## 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/summary/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)