# list_site_email_engagement

Source: https://modulify.ai/docs/api/emails/list-site-email-engagement

Lists the emails a site sent with open and click tracking on, 30 to a page, the way the Opens and clicks view of the Emails tab shows them.

- Title: List the tracked emails of a site by opens and clicks
- Scope: `config:read`
- Access: Read only
- Endpoint: `POST /v1/list_site_email_engagement`

Pass `period`, or `from` and `to` for a custom range, to narrow it to a window, and leave all three out for every tracked email. `activity` decides which tracked emails stay, `sort` their order, and `search` keeps the emails whose recipient or clicked link contains the text.

Items carry the same fields as `list_site_email_sends`, opens and clicks included, and `nextCursor` pages on with the same arguments. Opens are approximate and count per email, never per recipient, so the tool tells the client never to say that a particular recipient read one. See [Track opens and clicks](https://modulify.ai/docs/automations/emails#track-opens-and-clicks).

## Request

Call it with a `POST` to `https://api.modulify.ai/v1/list_site_email_engagement`, sending the inputs below as a JSON object. The token needs the `config:read` scope.

It only reads and changes nothing, so retrying it is safe.

```bash
curl -X POST https://api.modulify.ai/v1/list_site_email_engagement \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"projectId":"PROJECT_ID"}'
```

Over MCP, the same method is the [list_site_email_engagement tool](https://modulify.ai/docs/mcp/emails/list-site-email-engagement).

## Inputs

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `projectId` | string | Yes | The site id. |
| `period` | string | No | One of `day`, `24h`, `7d`, `30d`, `90d`, `12mo` or `all`. `day` is today so far, from midnight UTC, `24h` is the current hour and the 23 before it, `7d`, `30d` and `90d` are the last 7, 30 and 90 days counting today, `12mo` is this month and the 11 before it, and `all` reaches back to the first record. Leave it out when you send `from` and `to`. |
| `from` | string | No | The first day of a custom range as `YYYY-MM-DD` in UTC, sent together with `to`. |
| `to` | string | No | The last day of a custom range as `YYYY-MM-DD` in UTC, included in the range and sent together with `from`. |
| `activity` | string | No | Which tracked emails to keep: `engaged` for the ones opened or clicked, `opened`, `clicked`, `not-opened` for the ones delivered and never opened, or `tracked` for every tracked email. Defaults to `engaged`. |
| `sort` | string | No | The order of the list: `newest`, `oldest`, `most-opens` or `most-clicks`. Defaults to `newest`. |
| `search` | string | No | Keeps only the emails whose recipient or clicked link contains this text, at most 200 characters. |
| `cursor` | string | No | The `nextCursor` from the previous page, sent with the same arguments. Leave it out for the first page. |

## Response

Every call answers with the [JSON envelope](https://modulify.ai/docs/api/requests-and-responses#the-response) of `success`, `message`, `data`, `code` and `version`. `data` holds the result described above, and on a method that returns a total, `count` carries it. The [response headers](https://modulify.ai/docs/api/requests-and-responses#headers-on-every-method-call) carry the call's `X-Request-Id` and what is left of your per-minute budget in `X-RateLimit-Limit`, `X-RateLimit-Remaining` and `X-RateLimit-Reset`. [Errors](https://modulify.ai/docs/api/errors) explains every status code a call can answer with.