Counters: Rute

Run Commands

Satu-satunya titik masuk untuk penghitung akun Anda. Kirim 1 hingga 20 perintah dalam satu request dan dapatkan satu hasil per perintah.

POSThttps://g.sendcorex.com/v1/counters
i

Envelope-nya sama dengan Logs dan Contacts. Minta total, bulan ini, dan 30 hari terakhir dalam satu request.

i

Error dilaporkan per perintah. Perintah yang gagal tidak menghentikan perintah lain, dan status HTTP tetap 200.

Parameter body

  • commandsobject[]wajib

    1 hingga 20 perintah, dijalankan berurutan. Seluruh body bisa berukuran hingga 1 MB.

  • commands[].commandstringwajib

    get_totals, get_month, get_months, get_daily, atau get_hourly.

  • commands[].argsobjectopsional

    Argumen perintah.

  • commands[].idstringopsional

    Pengenal Anda sendiri untuk hasilnya. Default-nya indeks ("0", "1"…).

Mulai cepat

import axios from 'axios';

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

for (const result of response.data.results) {
  if (result.type !== 'SUCCESS') console.error(result.id, result.code, result.message);
  else console.log(result.id, result.data);
}

Respons

{
  "type": "SUCCESS",
  "results": [
    {
      "command": "get_totals",
      "id": "all",
      "type": "SUCCESS",
      "took_ms": 3,
      "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
        }
      }
    },
    {
      "command": "get_month",
      "id": "now",
      "type": "SUCCESS",
      "took_ms": 2,
      "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

  • type

    Selalu SUCCESS jika request itu sendiri diterima.

  • results[].command / id / type

    Perintah yang mana, id Anda (atau indeks), dan SUCCESS atau ERROR.

  • results[].data

    Output perintah. Hanya ada jika type bernilai SUCCESS.

  • results[].code / message

    Error-nya. Hanya ada jika type bernilai ERROR.

Autentikasi

Gunakan API key yang Anda buat di dashboard, di Developers → API Keys, dengan scope counters:read.

  • Authorization

    Kirim Authorization: <api key> atau Authorization: Bearer <api key>.

  • counters:read

    Satu-satunya scope yang dibutuhkan rute ini. Hanya baca.

  • Token mailbox

    Token webmail tidak berfungsi di sini. Token itu ditolak dengan WRONG_CREDENTIAL_TYPE.

Apa yang dihitung

  • Setiap email

    API, SMTP relay, dan kampanye, semuanya bersama. Setiap email dihitung sekali, saat mendapat hasil akhirnya.

  • Real-time

    Penghitung bergerak beberapa detik setelah setiap hasil pengiriman. Tidak ada batch harian.

  • Jam dan bulan dalam UTC

    get_hourly dan get_month(s) memakai UTC. get_daily membentuk hari di zona waktu yang Anda minta.

Rate limit dan cache

  • 15 request / detik

    Per IP + API key. Di atas itu Anda mendapat HTTP 429 dengan Retry-After.

  • Cache baca: 1,5 dtk

    Perintah yang sama dengan args yang sama dalam 1,5 detik mengembalikan hasil yang sama.

Error

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

  • 400INVALID_JSON

    Body bukan {"commands":[...]} atau lebih besar dari 1 MB.

  • 400INVALID_ARGS

    Request tidak memiliki perintah atau lebih dari 20.

  • 401MISSING_AUTH_HEADER

    Tidak ada header Authorization yang dikirim.

  • 401INVALID_API_KEY

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

  • 401API_KEY_EXPIRED

    API key telah melewati tanggal kedaluwarsa yang diatur di dashboard.

  • 401WRONG_CREDENTIAL_TYPE

    Yang dikirim adalah token mailbox. Counters API membutuhkan API key dari dashboard.

  • 403IP_NOT_ALLOWED

    Request berasal dari IP yang tidak termasuk IP yang diizinkan untuk key ini.

  • 403ACCOUNT_BLOCKED

    Akun diblokir.

  • 403MISSING_SCOPE

    Key tidak memiliki `counters:read`, jadi tidak ada perintah yang bisa dijalankan.

  • 429RATE_LIMITED

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

  • 503AUTH_UNAVAILABLE

    Autentikasi sementara tidak tersedia. Coba lagi.

  • CMDUNKNOWN_COMMAND

    Nama perintah tidak ada.

  • CMDINTERNAL

    Error server. Detailnya hanya ditulis ke log server.