> ## Documentation Index
> Fetch the complete documentation index at: https://docs.textyess.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Deliverability Status

> Get deliverability status for a single campaign

## Overview

The get deliverability status endpoint returns deliverability metrics (sent, pending, delivered, read, failed, etc.) for a single campaign by ID. Use this to monitor message delivery for one campaign.

## Authentication

This endpoint requires a valid JWT token in the `x-auth-token` header. You can find your token in the [Developers section](https://ai.textyess.com/developers):

```bash theme={null}
x-auth-token: your_jwt_token
```

## Path Parameters

<ParamField path="id" type="string" required>
  The unique identifier of the campaign (MongoDB ObjectId)
</ParamField>

## Response

The response is a single deliverability status object:

<ResponseField name="_id" type="string">
  The deliverability record ID
</ResponseField>

<ResponseField name="asset" type="string">
  The campaign ID this status refers to
</ResponseField>

<ResponseField name="total_contacts" type="number">
  Total number of contacts targeted
</ResponseField>

<ResponseField name="sent" type="number">
  Number of messages sent
</ResponseField>

<ResponseField name="pending" type="number">
  Number of messages still pending
</ResponseField>

<ResponseField name="blacklisted" type="number">
  Number of blacklisted contacts
</ResponseField>

<ResponseField name="failed_to_send" type="number">
  Number of messages that failed to send
</ResponseField>

<ResponseField name="delayed" type="number">
  Number of delayed messages
</ResponseField>

<ResponseField name="failed_to_receive" type="number">
  Number that failed to be received
</ResponseField>

<ResponseField name="read" type="number">
  Number of messages read
</ResponseField>

<ResponseField name="delivered" type="number">
  Number of messages delivered
</ResponseField>

<ResponseField name="opted_out" type="number">
  Number of contacts who opted out
</ResponseField>

<ResponseField name="createdAt" type="string">
  ISO date when the record was created
</ResponseField>

<ResponseField name="updatedAt" type="string">
  ISO date when the record was last updated
</ResponseField>

<ResponseExample>
  ```json 200 theme={null}
  {
    "_id": "507f1f77bcf86cd799439013",
    "asset": "507f1f77bcf86cd799439011",
    "total_contacts": 1000,
    "sent": 980,
    "pending": 0,
    "blacklisted": 5,
    "failed_to_send": 15,
    "delayed": 0,
    "failed_to_receive": 0,
    "read": 450,
    "delivered": 950,
    "opted_out": 2,
    "createdAt": "2024-01-15T10:00:00.000Z",
    "updatedAt": "2024-01-15T12:30:00.000Z"
  }
  ```

  ```json 404 theme={null}
  {
    "message": "Campaign not found",
    "statusCode": 404
  }
  ```

  ```json 404 theme={null}
  {
    "message": "Deliverability status not found",
    "statusCode": 404
  }
  ```

  ```json 401 theme={null}
  {
    "message": "Unauthorized"
  }
  ```
</ResponseExample>
