Contacts : recherche

Compter les contacts

Comptez les contacts correspondant à un where, sans les récupérer. Utile pour afficher « 1 834 personnes recevront ceci » avant un envoi.

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

Nécessite le scope contact:read sur votre API key.

Arguments

  • whereobjectfacultatif

    Le même where que Query Contacts. Omettez-le pour compter tous les contacts.

  • maxnumberfacultatif

    Arrête de compter à ce nombre, de 1 à 1 000 000. 100 000 par défaut.

Démarrage rapide

import axios from 'axios';

const response = await axios.post(
  'https://g.sendcorex.com/v1/contacts',
  {
    commands: [
      {
        command: "count_contacts",
        args: {
          where: {
            list: "customers",
            sendable: true
          }
        }
      }
    ]
  },
  { 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);

Réponse

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

Champs de la réponse

  • count

    Combien de contacts correspondent.

  • exact

    false quand le comptage s'est arrêté plus tôt, à max ou à la limite de temps de la requête. Le nombre réel est alors au moins count.

Des totaux sans compter

Pour des totaux par statut, liste ou tag, Get Stats est moins coûteux : il lit des compteurs tenus à jour à chaque modification, au lieu de parcourir les contacts.

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.

  • 401INVALID_API_KEY

    L'API key n'existe pas, a été révoquée ou désactivée dans le dashboard.

  • 429RATE_LIMITED

    Plus de 15 requêtes/s ou 15 simultanées pour la même IP + API key. Attendez le nombre de secondes indiqué dans Retry-After.

  • CMDMISSING_SCOPE

    L'API key n'a pas le scope requis par cette commande. Les autres commandes de la requête s'exécutent quand même.

  • CMDINVALID_ARGS

    Un argument obligatoire est manquant ou invalide : email, valeur de champ, option d'enum, clé de where, id de liste…

  • CMDINTERNAL

    Erreur serveur. Le détail n'est écrit que dans le log du serveur.