Counters: Membaca

Ambil total

Semua yang telah dikirim akun Anda sejak awal, dalam satu panggilan.

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

Membutuhkan scope counters:read pada API key Anda.

Argumen

Endpoint ini tidak menerima argumen.

Mulai cepat

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);

Respons

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

Field respons

  • totals

    Penghitung sejak akun dibuat.

  • totals.delivered

    Email yang diterima server penerima.

  • totals.bounced

    Email yang tidak berhasil masuk: ditolak server penerima, kedaluwarsa di antrean, atau dihentikan sebelum dikirim. Alasan masing-masing ada di Bounces & Complaints.

  • totals.blocked

    Email yang ditolak server penerima sebagai spam, karena kebijakan, atau reputasi saat pengiriman. Alamatnya baik-baik saja: masalahnya ada pada pengiriman (kualitas daftar, volume, autentikasi, konten).

  • totals.complaints

    Penerima yang melaporkan email Anda sebagai spam setelah menerimanya: feedback loop (Outlook, Yahoo…) dan laporan penyalahgunaan. Tidak termasuk dalam total, karena email tersebut sudah dihitung sebagai terkirim.

  • totals.rate_limited

    Email yang terus ditunda server penerima sampai percobaan ulang habis.

  • totals.total

    delivered + bounced + blocked + rate_limited: setiap email yang mendapat hasil.

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

    Setiap penghitung sebagai persentase dari total, dengan 2 desimal. 0 jika total bernilai 0.

Error

Error di level HTTP mengembalikan type, code, dan message. Error yang ditandai CMD dikembalikan di dalam hasil perintah, dengan HTTP 200.

  • 401INVALID_API_KEY

    API key tidak ada, telah dicabut, atau dinonaktifkan di dashboard.

  • 429RATE_LIMITED

    Lebih dari 15 request/dtk atau 15 bersamaan untuk IP + API key yang sama. Tunggu sejumlah detik yang ada di Retry-After.

  • CMDMISSING_SCOPE

    API key tidak memiliki `counters:read`.

  • CMDINTERNAL

    Error server. Detailnya hanya ditulis ke log server.