Get operational pulse

GET

/api/v3/metrics/operational-pulse

const url = 'https://api.tryletterhead.com/api/v3/metrics/operational-pulse?api=true';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.tryletterhead.com/api/v3/metrics/operational-pulse?api=true' \
  --header 'Authorization: Bearer <token>'

Month-to-date send volume and stale drafts, deliverability stats (bounce/spam rates and the channels with the highest bounce rates), and notable per-channel changes (a metric that moved sharply against its own recent trend). Backs the goals page’s Operational Pulse card. Refreshed at most once an hour.

v3 endpoints expect a company API key.

Authorizations

bearerAuth

Parameters

Query Parameters

api

required

boolean

Required. Set to true.

Responses

200

Get operational pulse

application/json

object

items

object

sendOperations

object

monthSends

integer

staleDrafts

integer

staleDraftThresholdDays

Currently fixed at: 5.

integer

deliverability

object

highBounceNewsletters

Count of channels over bounceThresholdPct.

integer

bounceThresholdPct

Currently fixed at: 2.0.

number

topHighBounce

The top 3 channels by bounce rate.

Array<object>

object

channelName

string

bounceRatePct

number

spamComplaintRatePct

number

spamComplaintThresholdPct

Currently fixed at: 0.1.

number

notableChanges

Array<object>

object

channelName

string

metric

A metric label, e.g. new-subscribers, open-rate, or click-rate.

string

currentValue

number

comparisonValue

number

percentChange

number

tone

Reflects the direction of the change.

string

message

string

total

integer

Example

{
  "items": {
    "sendOperations": {
      "monthSends": 24,
      "staleDrafts": 3,
      "staleDraftThresholdDays": 5
    },
    "deliverability": {
      "highBounceNewsletters": 1,
      "bounceThresholdPct": 2,
      "topHighBounce": [
        {
          "channelName": "An Example Newsletter",
          "bounceRatePct": 3.4
        }
      ],
      "spamComplaintRatePct": 0.02,
      "spamComplaintThresholdPct": 0.1
    },
    "notableChanges": [
      {
        "channelName": "An Example Newsletter",
        "metric": "open-rate",
        "currentValue": 0.42,
        "comparisonValue": 0.35,
        "percentChange": 20,
        "tone": "positive"
      }
    ]
  },
  "message": "Operational pulse retrieved successfully.",
  "total": 1
}

Still can’t find what you need? Contact support.