Get Deliverability Status

Get deliverability status for a single campaign

GET /campaigns/{id}/deliverability-status

Get Deliverability Status

cURL

curl --request GET \
  --url https://api-ai.textyess.com/campaigns/{id}/deliverability-status \
  --header 'x-auth-token: <api-key>'

200

{
  "_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"
}

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:

x-auth-token: your_jwt_token

Path Parameters

id · string · required

The unique identifier of the campaign (MongoDB ObjectId)

Response

The response is a single deliverability status object:

_id · string

The deliverability record ID

asset · string

The campaign ID this status refers to

total_contacts · number

Total number of contacts targeted

sent · number

Number of messages sent

pending · number

Number of messages still pending

blacklisted · number

Number of blacklisted contacts

failed_to_send · number

Number of messages that failed to send

delayed · number

Number of delayed messages

failed_to_receive · number

Number that failed to be received

read · number

Number of messages read

delivered · number

Number of messages delivered

opted_out · number

Number of contacts who opted out

createdAt · string

ISO date when the record was created

updatedAt · string

ISO date when the record was last updated

200

{
  "_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"
}