Get Deliverability Status
curl --request GET \
--url https://api-ai.textyess.com/campaigns/{id}/deliverability-status \
--header 'x-auth-token: <api-key>'import requests
url = "https://api-ai.textyess.com/campaigns/{id}/deliverability-status"
headers = {"x-auth-token": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-auth-token': '<api-key>'}};
fetch('https://api-ai.textyess.com/campaigns/{id}/deliverability-status', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-ai.textyess.com/campaigns/{id}/deliverability-status",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-auth-token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api-ai.textyess.com/campaigns/{id}/deliverability-status"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-auth-token", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api-ai.textyess.com/campaigns/{id}/deliverability-status")
.header("x-auth-token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-ai.textyess.com/campaigns/{id}/deliverability-status")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-auth-token"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"_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"
}
{
"message": "Campaign not found",
"statusCode": 404
}
{
"message": "Deliverability status not found",
"statusCode": 404
}
{
"message": "Unauthorized"
}
Campaigns API
Get Deliverability Status
Get deliverability status for a single campaign
GET
/
campaigns
/
{id}
/
deliverability-status
Get Deliverability Status
curl --request GET \
--url https://api-ai.textyess.com/campaigns/{id}/deliverability-status \
--header 'x-auth-token: <api-key>'import requests
url = "https://api-ai.textyess.com/campaigns/{id}/deliverability-status"
headers = {"x-auth-token": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-auth-token': '<api-key>'}};
fetch('https://api-ai.textyess.com/campaigns/{id}/deliverability-status', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-ai.textyess.com/campaigns/{id}/deliverability-status",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-auth-token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api-ai.textyess.com/campaigns/{id}/deliverability-status"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-auth-token", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api-ai.textyess.com/campaigns/{id}/deliverability-status")
.header("x-auth-token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-ai.textyess.com/campaigns/{id}/deliverability-status")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-auth-token"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"_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"
}
{
"message": "Campaign not found",
"statusCode": 404
}
{
"message": "Deliverability status not found",
"statusCode": 404
}
{
"message": "Unauthorized"
}
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 thex-auth-token header. You can find your token in the Developers section:
x-auth-token: your_jwt_token
Path Parameters
string
required
The unique identifier of the campaign (MongoDB ObjectId)
Response
The response is a single deliverability status object:string
The deliverability record ID
string
The campaign ID this status refers to
number
Total number of contacts targeted
number
Number of messages sent
number
Number of messages still pending
number
Number of blacklisted contacts
number
Number of messages that failed to send
number
Number of delayed messages
number
Number that failed to be received
number
Number of messages read
number
Number of messages delivered
number
Number of contacts who opted out
string
ISO date when the record was created
string
ISO date when the record was last updated
{
"_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"
}
{
"message": "Campaign not found",
"statusCode": 404
}
{
"message": "Deliverability status not found",
"statusCode": 404
}
{
"message": "Unauthorized"
}