Tracking Preferences : Lecture

Obtenir l'historique

Chaque changement d'un destinataire, du plus récent au plus ancien : ce qu'il a choisi, quand, et qui l'a modifié. Votre registre de consentement pour les audits.

POSThttps://g.sendcorex.com/v1/privacycommand: get_history
i

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

i

L'historique est conservé tant que la préférence existe. Chaque entrée est l'état complet après ce changement.

Arguments

  • emailstringobligatoire

    L'adresse du destinataire.

    ex. : "jane.doe@example.com"

  • limitnumberfacultatif

    Nombre de changements, de 1 à 500. Par défaut : 50.

    ex. : 50

Démarrage rapide

import axios from 'axios';

const response = await axios.post(
  'https://g.sendcorex.com/v1/privacy',
  {
    commands: [
      {
        command: "get_history",
        args: {
          email: "jane.doe@example.com",
          limit: 50
        }
      }
    ]
  },
  { 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": "get_history",
      "id": "0",
      "type": "SUCCESS",
      "took_ms": 6,
      "data": {
        "history": [
          {
            "email": "jane.doe@example.com",
            "track_opens": false,
            "track_clicks": true,
            "source": "page",
            "updated_at": "2026-10-24T07:20:12.031Z"
          },
          {
            "email": "jane.doe@example.com",
            "track_opens": true,
            "track_clicks": true,
            "source": "api",
            "updated_at": "2026-09-02T10:05:41.220Z"
          }
        ]
      }
    }
  ]
}

Champs de la réponse

  • history

    Les changements, du plus récent au plus ancien. Vide si le destinataire n'a jamais eu de préférence.

  • history[].email

    L'adresse du destinataire, en minuscules.

  • history[].track_opens

    true le destinataire autorise le suivi des ouvertures, false il l'a refusé, null il n'a jamais choisi.

  • history[].track_clicks

    true le destinataire autorise le suivi des clics, false il l'a refusé, null il n'a jamais choisi.

  • history[].source

    Qui a fait le changement : page (le destinataire, sur la page des préférences de tracking), api (vous, avec Set Preferences) ou dashboard.

  • history[].updated_at

    Quand le changement a été fait. ISO 8601, UTC.

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 a été 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 de cette commande (`privacy:read` pour lire, `privacy:write` pour modifier).

  • CMDINVALID_ARGS

    Un argument est invalide : `email` manquant ou mal formé, plus de 100 `emails`, `track_opens` qui ne vaut pas `true`/`false`, limit hors limites…

  • CMDINTERNAL

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