Counters: Membaca

Ambil bulan

Satu bulan kalender (UTC). Tanpa `month`, bulan berjalan.

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

Membutuhkan scope counters:read pada API key Anda.

Argumen

  • monthstringopsional

    Bulannya, YYYY-MM. Default-nya bulan berjalan dalam UTC.

    mis. "2026-10"

Mulai cepat

import axios from 'axios';

const response = await axios.post(
  'https://g.sendcorex.com/v1/counters',
  {
    commands: [
      {
        command: "get_month",
        args: {
          month: "2026-10"
        }
      }
    ]
  },
  { 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_month",
      "id": "0",
      "type": "SUCCESS",
      "took_ms": 18,
      "data": {
        "month": "2026-10",
        "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

  • month

    Bulannya, YYYY-MM.

  • delivered

    Email yang diterima server penerima.

  • bounced

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

  • 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).

  • 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.

  • rate_limited

    Email yang terus ditunda server penerima sampai percobaan ulang habis.

  • total

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

  • delivered_rate / bounce_rate / blocked_rate / complaint_rate / 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`.

  • CMDINVALID_ARGS

    Ada argumen yang tidak valid: bulan yang bukan YYYY-MM, hari yang bukan YYYY-MM-DD, zona waktu tidak dikenal, from lebih lambat dari to, rentang yang terlalu panjang…

  • CMDINTERNAL

    Error server. Detailnya hanya ditulis ke log server.