---
title: "Get recipient engagement"
method: GET
path: "/metrics/recipients"
tags: ["Analytics"]
---

# Get recipient engagement

`GET /metrics/recipients`

Returns a paginated list of recipients with their open, click, and unsubscribe events. Use this to sync engagement data to your own database.

## Query parameters

- `email` string
- `campaignId` string
- `sequenceId` string
- `period` '1h' | '24h' | '7d' | '30d' | '90d'
- `start` string, date-time
- `end` string, date-time
- `page` integer
- `limit` integer
- `includeMachineEngagement` boolean

## Response `200`

Success

- object
  - `success` boolean
  - `recipients` object[]
    - `email` string, nullable
    - `opened` object[]
      - `campaignId` string, nullable
      - `subject` string, nullable
      - `machine` boolean
      - `engagementQuality` 'human' | 'machine' | 'asset'
      - `classificationReasons` string[]
      - `at` string, date-time
    - `clicked` object[]
      - `campaignId` string, nullable
      - `subject` string, nullable
      - `url` string, nullable
      - `machine` boolean
      - `engagementQuality` 'human' | 'machine' | 'asset'
      - `classificationReasons` string[]
      - `at` string, date-time
    - `unsubscribed` boolean
  - `pagination` Pagination
    - `page` integer
    - `limit` integer
    - `total` integer
    - `totalPages` integer

## Other responses

- `400` — Bad request
- `401` — Unauthorized
- `404` — Campaign or sequence not found

---

[API](https://skmtc.net/sequenzy/apis/sequenzy-api.md) · [All operations](https://skmtc.net/sequenzy/apis/sequenzy-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/sequenzy/sequenzy-api/versions/af1cf9620482/schema)