# Delivery rates by day, carrier, or sending number

Source: https://joinsimplesms.com/docs/api/deliverability/get
Index: https://joinsimplesms.com/llms.txt

`GET /v1/deliverability`

Final outcomes (delivered/failed) aggregated over a UTC date range of up to 90 days. Test keys report sandbox traffic, live keys live traffic. Scope: messages:read.

Send your API key as a bearer token: `Authorization: Bearer ssms_sk_...`. Test keys run this endpoint against the [sandbox](/docs/sandbox); see [Authentication](/docs/authentication) for key modes and scopes.

## Query parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `group_by` | `day`, `carrier`, `number` | No | Default "day". |
| `start_date` | string (date) | No | Default: 6 days before end_date |
| `end_date` | string (date) | No | Default: today (UTC) |

## Responses

| Status | Meaning | Body |
| --- | --- | --- |
| 200 | Deliverability report | `Deliverability` |
| 400 | Invalid range or group_by | `Error` |
| 401 | Missing, malformed, or revoked API key | `Error` |
| 402 | Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged | `Error` |
| 429 | Rate limit or quota exceeded | `Error` |

### 200: `Deliverability` fields

| Field | Type | Description |
| --- | --- | --- |
| `object` | `deliverability` |  |
| `mode` | `test`, `live` |  |
| `start_date` | string (date) |  |
| `end_date` | string (date) |  |
| `group_by` | `day`, `carrier`, `number` |  |
| `totals` | DeliverabilityRow |  |
| `data` | array of DeliverabilityRow |  |

## Errors

| Status | When |
| --- | --- |
| 400 | Invalid range or group_by |
| 401 | Missing, malformed, or revoked API key |
| 402 | Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged |
| 429 | Rate limit or quota exceeded |

Every error has the same JSON shape, and `request_id` matches the `X-Request-Id` response header. [Errors](/docs/errors) lists every code and what to do about it.

```json
{
  "error": {
    "code": "invalid_request",
    "message": "What went wrong, in plain words.",
    "param": "the_field",
    "request_id": "req_a1B2c3D4e5F6g7H8"
  }
}
```

## Examples

### curl

```bash
curl -X GET "https://api.joinsimplesms.com/v1/deliverability" \
  -H "Authorization: Bearer $SIMPLESMS_API_KEY"
```

### Node.js

The Node.js SDK does not wrap this endpoint yet; call it with `fetch`.

```javascript
const res = await fetch('https://api.joinsimplesms.com/v1/deliverability', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.SIMPLESMS_API_KEY}`,
  },
});

if (!res.ok) throw new Error((await res.json()).error.message);
const data = await res.json();
```

### Python

The Python SDK does not wrap this endpoint yet; call it over HTTP.

```python
import json, os, urllib.request

req = urllib.request.Request(
    "https://api.joinsimplesms.com/v1/deliverability",
    method="GET",
    headers={
        "Authorization": f"Bearer {os.environ['SIMPLESMS_API_KEY']}",
    },
)
with urllib.request.urlopen(req) as res:
    data = json.load(res)
```

## Related

- Guide: [Deliverability](/docs/deliverability)
- [All deliverability endpoints](/docs/api#deliverability)
- [API reference](/docs/api)