# Get overview

Retrieve an operational snapshot for the tenant Overview dashboard.

Source: https://statusdashboard.com/docs/api/account-management/overview/get

`GET /app/overview`

Returns aggregate counts for the authenticated tenant's Overview page — email, SMS, WhatsApp, and integration notification usage, active published events, component health, and dashboard count. Available to **admin**, **event**, and **subscriber** roles.

***

## Request
See [API Basics](/docs/api) for required headers.

This endpoint takes no request body or query parameters.

***

## Sample request
```bash
curl https://api.statusdashboard.com/app/overview \
  -H "Authorization: Bearer bcf847abf5c6:def456"
```

## Sample response
**Status: `200 OK`**

```json
{
  "emailMessages": {
    "month": "2026-06",
    "count": 42,
    "limit": 1000
  },
  "smsMessages": {
    "month": "2026-06",
    "count": 8,
    "limit": 50
  },
  "whatsappMessages": {
    "month": "2026-06",
    "count": 4,
    "limit": 50
  },
  "emailSubscribers": {
    "count": 12,
    "limit": 50
  },
  "smsSubscribers": {
    "count": 3,
    "limit": 5
  },
  "whatsappSubscribers": {
    "count": 2,
    "limit": 5
  },
  "integrations": {
    "messages": {
      "month": "2026-06",
      "count": 120,
      "limit": 1000
    },
    "endpoints": {
      "webhook": { "count": 2, "limit": 100 },
      "teams": { "count": 1, "limit": 100 },
      "gchat": { "count": 0, "limit": 100 }
    }
  },
  "events": {
    "activeIncidents": 1,
    "activeMaintenance": 0,
    "activeInformational": 2
  },
  "components": {
    "total": 15,
    "nonOperational": 3
  },
  "dashboards": {
    "count": 2
  }
}
```

***

## Response fields
| Field                            | Type   | Description                                                                                                                                          |
| -------------------------------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
| `emailMessages`                  | object | Monthly event notification email usage                                                                                                               |
| `emailMessages.month`            | string | UTC calendar month key (`YYYY-MM`)                                                                                                                   |
| `emailMessages.count`            | number | Emails sent this month                                                                                                                               |
| `emailMessages.limit`            | number | Plan quota from `enabledFeatures.emailMessages`                                                                                                      |
| `smsMessages`                    | object | Monthly event notification SMS usage                                                                                                                 |
| `smsMessages.month`              | string | UTC calendar month key (`YYYY-MM`)                                                                                                                   |
| `smsMessages.count`              | number | SMS messages sent this month                                                                                                                         |
| `smsMessages.limit`              | number | Plan quota from `enabledFeatures.smsMessages`                                                                                                        |
| `whatsappMessages`               | object | Monthly event notification WhatsApp usage                                                                                                            |
| `whatsappMessages.month`         | string | UTC calendar month key (`YYYY-MM`)                                                                                                                   |
| `whatsappMessages.count`         | number | WhatsApp template messages sent this month                                                                                                           |
| `whatsappMessages.limit`         | number | Plan quota from `enabledFeatures.whatsappMessages`                                                                                                   |
| `emailSubscribers`               | object | Unique email subscriber usage vs plan limit                                                                                                          |
| `emailSubscribers.count`         | number | Unique email subscribers in the org                                                                                                                  |
| `emailSubscribers.limit`         | number | Plan quota from `enabledFeatures.emailSubscribers` (`0` when email is not enabled)                                                                   |
| `smsSubscribers`                 | object | Unique SMS subscriber usage vs plan limit                                                                                                            |
| `smsSubscribers.count`           | number | Unique SMS subscribers in the org                                                                                                                    |
| `smsSubscribers.limit`           | number | Plan quota from `enabledFeatures.smsSubscribers` (`0` when SMS is not enabled)                                                                       |
| `whatsappSubscribers`            | object | Unique WhatsApp subscriber usage vs plan limit                                                                                                       |
| `whatsappSubscribers.count`      | number | Unique WhatsApp subscribers in the org                                                                                                               |
| `whatsappSubscribers.limit`      | number | Plan quota from `enabledFeatures.whatsappSubscribers` (`0` when WhatsApp is not enabled)                                                             |
| `integrations`                   | object | Outbound integration endpoints and combined delivery usage                                                                                           |
| `integrations.messages`          | object | Monthly outbound HTTP deliveries (webhook, Teams, Google Chat, and Slack combined)                                                                   |
| `integrations.messages.month`    | string | UTC calendar month key (`YYYY-MM`)                                                                                                                   |
| `integrations.messages.count`    | number | Deliveries reserved this month                                                                                                                       |
| `integrations.messages.limit`    | number | Organization limit `integrationMessages` (`0` when integrations are not entitled)                                                                    |
| `integrations.endpoints.webhook` | object | Unique webhook endpoint count vs organization limit                                                                                                  |
| `integrations.endpoints.teams`   | object | Unique Teams endpoint count vs organization limit                                                                                                    |
| `integrations.endpoints.gchat`   | object | Unique Google Chat endpoint count vs organization limit                                                                                              |
| `integrations.endpoints.slack`   | object | Unique Slack channel count vs organization limit                                                                                                     |
| `integrations.endpoints.*.count` | number | Unique endpoints registered for that channel                                                                                                         |
| `integrations.endpoints.*.limit` | number | Organization limit for the channel (`webhookEndpoints`, `teamsEndpoints`, `gchatEndpoints`, `slackChannels`); `0` when integrations are not entitled |
| `events`                         | object | Counts of published, active (unresolved) events                                                                                                      |
| `events.activeIncidents`         | number | Published incidents not in a final workflow phase                                                                                                    |
| `events.activeMaintenance`       | number | Published maintenance events in progress                                                                                                             |
| `events.activeInformational`     | number | Published informational events currently active                                                                                                      |
| `components`                     | object | Org-wide component health summary                                                                                                                    |
| `components.total`               | number | Total components                                                                                                                                     |
| `components.nonOperational`      | number | Components whose `currentStatus` is not `Operational`                                                                                                |
| `dashboards`                     | object | Status dashboard summary                                                                                                                             |
| `dashboards.count`               | number | Total status dashboards in the org                                                                                                                   |

### Field notes
**`emailMessages`** — Counts **event notification** emails only. Subscription verify/manage emails are exempt. When the monthly limit is reached, new notifications are not delivered and are not retried.

**`smsMessages`** — Counts **event notification** SMS messages only. Subscription verify/manage SMS are exempt. When the monthly limit is reached, new notifications are not delivered and are not retried.

**`whatsappMessages`** — Counts **event notification** WhatsApp template messages only. Subscription verify/manage templates are exempt. When the monthly limit is reached, new notifications are not delivered and are not retried.

**`integrations.messages`** — Counts outbound HTTP deliveries for webhook, Teams, Google Chat, and Slack as one organization limit. Endpoint caps are separate organization limits per channel.

**`events`** — Only **published** events in an active (unresolved) state are counted. Draft events are excluded.

***

## Error responses
| Status | When                  |
| ------ | --------------------- |
| `500`  | Internal server error |