API - Segment Customer

 Pour être informés de toutes les mises à jour concernant l’API v2 de SPREAD, inscrivez-vous ici : https://social-sb.com/z/newsletter-api-v1-v2

Méthodes disponibles


GET Segment Customer

Récupère les profils appartenant à un segment

GET ⇒ social-sb.com/api/v2/segments-customers/{segment_id}

Paramètres obligatoires :

  • "segment_id" : l'identifiant SPREAD du segment

Paramètres complémentaires :

Aucun

Réponse :

Si GET ok alors

"segment": {
 "id": "6215",
 "customers": [
	 {
		 "customerId": "14985899"
	 },
	 {
		 "customerId": "15134089"
	 }
 ]
 },
 "count": 2,
 "nextPageUrl": "http://:social-sb.com/api/v2/segments-customers?startAt=2"

Sinon, affichage d'un message d'erreur


Exemple d'appel PHP :

$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, "https://social-sb.com/api/v2/segments-customers/123456");
// Auth avec la clé publique et la clé privée (voir dans Paramétrage > Tracker)
curl_setopt($curl, CURLOPT_USERPWD, "clef_public:cle_privee");
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
$curl_return = curl_exec($curl);
var_dump($curl_return);
curl_close($curl);

Faire une recherche précise :

Il est possible d'affiner la liste retournée en passant des paramètres GET. 

Les paramètres sur la pagination :

  • "startAt" ⇒ permet de commencer la liste des consentements à partir de l'occurence passée en paramètre
  • "maxResult" ⇒ permet de limiter le nombre de consentements remontés par pages (max 5000)