Counters: Reading

Get Totals

Everything your account has sent since the beginning, in one call.

POSThttps://g.sendcorex.com/v1/counterscommand: get_totals
i

Needs the counters:read scope on your API key.

Arguments

This endpoint takes no arguments.

Quick start

import axios from 'axios';

const response = await axios.post(
  'https://g.sendcorex.com/v1/counters',
  {
    commands: [
      {
        command: "get_totals"
      }
    ]
  },
  { headers: { Authorization: process.env.SENDCOREX_API_KEY } },
);

const [result] = response.data.results;
if (result.type !== 'SUCCESS') throw new Error(`${result.code}: ${result.message}`);
console.log(result.data);

Response

{
  "type": "SUCCESS",
  "results": [
    {
      "command": "get_totals",
      "id": "0",
      "type": "SUCCESS",
      "took_ms": 18,
      "data": {
        "totals": {
          "delivered": 48210,
          "bounced": 612,
          "blocked": 88,
          "complaints": 9,
          "rate_limited": 140,
          "total": 49050,
          "delivered_rate": 98.29,
          "bounce_rate": 1.25,
          "blocked_rate": 0.18,
          "complaint_rate": 0.02,
          "rate_limited_rate": 0.29
        }
      }
    }
  ]
}

Response fields

  • totals

    The counters since the account was created.

  • totals.delivered

    Emails the recipient server accepted.

  • totals.bounced

    Emails that did not get through: rejected by the recipient server, expired in the queue, or stopped before sending. The reason of each one is in Bounces & Complaints.

  • totals.blocked

    Emails the recipient server refused as spam, by policy or reputation at delivery time. The address is fine: the problem was the send (list quality, volume, authentication, content).

  • totals.complaints

    Recipients who reported your email as spam after receiving it: feedback loops (Outlook, Yahoo…) and abuse reports. Not part of total, since those emails were already counted as delivered.

  • totals.rate_limited

    Emails the recipient server kept deferring until the retries ran out.

  • totals.total

    delivered + bounced + blocked + rate_limited: every email that got a result.

  • totals.delivered_rate / totals.bounce_rate / totals.blocked_rate / totals.complaint_rate / totals.rate_limited_rate

    Each counter as a percentage of total, with 2 decimals. 0 when total is 0.

Errors

HTTP-level errors return type, code and message. Errors marked CMD come back inside the command result, with HTTP 200.

  • 401INVALID_API_KEY

    The API key does not exist, was revoked or was disabled in the dashboard.

  • 429RATE_LIMITED

    More than 15 requests/s or 15 in flight for the same IP + API key. Wait the number of seconds in Retry-After.

  • CMDMISSING_SCOPE

    The API key does not have `counters:read`.

  • CMDINTERNAL

    Server error. The detail is only written to the server log.