Recevoir des emails : Contacts et audience

Compter les contacts

Compte les contacts qui correspondent à un filtre. Lecture seule.

POSThttps://g.sendcorex.com/v1command: count_contacts

Arguments

  • whereobjectfacultatif

    Filtres : statut, tags, domaine, ouvertures et clics, dates et champs personnalisés. Même format que les contacts du dashboard.

  • maxnumberfacultatif

    Arrête de compter à ce nombre, jusqu’à 100 000. Par défaut 10 000.

Démarrage rapide

import axios from 'axios';

const response = await axios.post(
  'https://g.sendcorex.com/v1',
  {
    commands: [
      {
        command: "count_contacts",
        args: {
          where: {
            status: "subscribed"
          }
        }
      }
    ]
  },
  { headers: { Authorization: process.env.SENDCOREX_TOKEN } },
);

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

Réponse

{
  "type": "SUCCESS",
  "results": [
    {
      "command": "count_contacts",
      "id": "0",
      "type": "SUCCESS",
      "data": {
        "count": 1240,
        "exact": true
      }
    }
  ]
}

Champs de la réponse

  • count

    Combien de contacts correspondent.

  • exact

    false quand le comptage s’est arrêté à max.

Erreurs

Les erreurs au niveau HTTP renvoient type, code et message. Les erreurs marquées CMD reviennent dans le résultat de la commande, avec HTTP 200.

  • 401TOKEN_EXPIRED

    L'access token a expiré. Appelez Refresh Token et relancez la requête.

  • 401INVALID_TOKEN

    Le token est mal formé, inconnu ou révoqué.

  • 429RATE_LIMITED

    Plus de 15 requêtes/s ou 15 en cours pour la même IP + boîte aux lettres. Attendez le nombre de secondes indiqué dans Retry-After.

  • CMDINVALID_ARGS

    Un argument obligatoire est manquant ou invalide.

  • CMDINTERNAL

    Erreur serveur. Le détail est uniquement écrit dans le log du serveur.