Kontak: segmen

Jalankan segmen

Dapatkan kontak yang saat ini cocok dengan segmen tersimpan. Output dan paginasinya sama dengan Query Contacts.

POSThttps://g.sendcorex.com/v1/contactscommand: run_segment
i

Membutuhkan scope contact:read pada API key Anda.

Argumen

  • segment_idstringwajib

    Segmen yang dijalankan.

    mis. "engaged-vips"

  • limitnumberopsional

    Ukuran halaman, dari 1 sampai 1000. Default 50.

  • cursorstringopsional

    next_cursor dari halaman sebelumnya.

  • selectstring[]opsional

    Hanya kembalikan bagian ini dari setiap kontak, misalnya ["status", "fields.plan", "stats.open_count"]. email selalu dikembalikan. Tanpanya, Anda mendapatkan kontak lengkap.

Mulai cepat

import axios from 'axios';

const response = await axios.post(
  'https://g.sendcorex.com/v1/contacts',
  {
    commands: [
      {
        command: "run_segment",
        args: {
          segment_id: "engaged-vips",
          select: [
            "first_name",
            "stats.open_rate"
          ],
          limit: 500
        }
      }
    ]
  },
  { 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": "run_segment",
      "id": "0",
      "type": "SUCCESS",
      "took_ms": 14,
      "data": {
        "contacts": [
          {
            "email": "ana@acme.com",
            "first_name": "Ana",
            "stats": {
              "open_rate": 0.58
            }
          }
        ],
        "has_more": false,
        "next_cursor": null,
        "plan": {
          "driver": "tag:vip",
          "examined": 412,
          "keys_only": false,
          "ms": {
            "scan": 4,
            "fetch": 9,
            "filter": 1,
            "total": 14
          }
        }
      }
    }
  ]
}

Field respons

  • contacts

    Kontak yang cocok. Kontak lengkap, atau hanya bagian yang Anda minta dengan select.

  • has_more / next_cursor

    Paginasi. Selama has_more bernilai true, kirim next_cursor sebagai cursor dengan where dan sort yang sama.

  • plan.driver

    Indeks yang dipilih server untuk dipindai, misalnya tag:vip atau list:customers.

  • plan.examined

    Jumlah entri indeks yang dibaca untuk mengisi halaman ini.

  • plan.keys_only

    true jika halaman dijawab hanya dari indeks, tanpa memuat kontak.

  • plan.ms

    Waktu untuk memindai, mengambil, memfilter, dan total, dalam milidetik.

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, sudah dicabut, atau dinonaktifkan di dashboard.

  • 429RATE_LIMITED

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

  • CMDMISSING_SCOPE

    API key tidak memiliki scope yang dibutuhkan perintah ini. Perintah lain dalam request tetap berjalan.

  • CMDINVALID_ARGS

    Argumen wajib tidak ada atau tidak valid: email, nilai field, opsi enum, key where, id list…

  • CMDNOT_FOUND

    Kontak, list, field, atau segmen tidak ada.

  • CMDINVALID_CURSOR

    Cursor tidak valid atau milik query atau akun lain.

  • CMDINTERNAL

    Error server. Detailnya hanya ditulis ke log server.