# get_site_email_credit_stats

Source: https://modulify.ai/docs/api/emails/get-site-email-credit-stats

Counts the AI credits a site's email used over a period and the extra emails they bought.

- Title: Count the credits a site spent on email over time
- Scope: `config:read`
- Access: Read only
- Endpoint: `POST /v1/get_site_email_credit_stats`

It counts them the way the **Credits** view of the **Insights** tab shows them: `credits` and `emails` for the whole window, after any refunds, and `days` with one entry per hour, day or month, as `interval` says. `windowDays` says how many days the window spans. Pass `period`, or `from` and `to` for a custom range, and leave all three out for `30d`. See [Credits spent on email](https://modulify.ai/docs/automations/emails#credits-spent-on-email).

## Request

Call it with a `POST` to `https://api.modulify.ai/v1/get_site_email_credit_stats`, 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/get_site_email_credit_stats \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"projectId":"PROJECT_ID"}'
```

Over MCP, the same method is the [get_site_email_credit_stats tool](https://modulify.ai/docs/mcp/emails/get-site-email-credit-stats).

## 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. Defaults to `30d`, and is left 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`. |

## 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.