API - Segment

Owned by Stéphane Larzet (Unlicensed)
30 Aug 2019
2 min read

 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

Récupère les informations d'un segment

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

Paramètres obligatoires :

  • "id" : l'identifiant SPREAD du segment

Paramètres complémentaires :

Aucun

Réponse :

Si GET ok alors

"segment": {
	"id": "1234",
	"name": "Code postal 27000",
	"tags": null,
	"createdAt": "2019-01-18 09:53:33",
	"updatedAt": "2019-03-26 15:17:26",
	"lastComputeAt": "2019-03-26 15:17:26",
	"status": "1",
	"count": "5",
	"type": "Dynamic"
}

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/1234");
// Authentification avec la clé publique et la clé privée (voir dans Paramétrage > Tracker)
curl_setopt($curl, CURLOPT_USERPWD, "clef_public:clef_privee");
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
$curl_return = curl_exec($curl);
var_dump($curl_return);
curl_close($curl);


GET Segments

Récupère tous les segments d'un backoffice.

GET ⇒ social-sb.com/api/v2/segments

Paramètres obligatoires :

Aucun

Paramètres complémentaires :

Aucun

Réponse :

Si GET ok alors

"segments": [
{
	"id": "1235",
	"name": "Femmes",
	"tags": "|tag1|tag2|",
	"createdAt": "2017-10-17 08:26:04",
	"updatedAt": "2019-04-04 15:16:32",
	"lastComputeAt": "2019-01-03 07:42:44",
	"status": "1",
	"count": "19",
	"type": "Dynamic"
},
{
	"id": "1234",
	"name": "Code postal 27000",
	"tags": null,
	"createdAt": "2019-01-18 09:53:33",
	"updatedAt": "2019-03-26 15:17:26",
	"lastComputeAt": "2019-03-26 15:17:26",
	"status": "1",
	"count": "5",
	"type": "Nightly"
}
],
 "count": 2,
 "nextPageUrl": "http://social-sb.com/api/v2/segments?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");
// Authentification avec la clé publique et la clé privée (voir dans Paramétrage > Tracker)
curl_setopt($curl, CURLOPT_USERPWD, "clef_public:clef_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 d'affinage possibles :

  • "createdAfter" ⇒ seuls les segments créés après la date passée en paramètre seront remontés

  • "createBefore" ⇒ seuls les segments créés avant la date passée en paramètre seront remontés

  • "modifiedAfter" ⇒ seuls les segments modifiés après la date passée en paramètre seront remontés

  • "modifiedBefore" ⇒ seuls les segments modifiés avant la date passée en paramètre seront retournés

Les paramètres sur la pagination :

  • "startAt" ⇒ permet de commencer la liste des segments à partir de l'occurence passée en paramètre

  • "maxResult" ⇒ permet de limiter le nombre de segments remontées par pages (max 5000)


GET Segments Compute

Déclenche le calcul d'un segment.

GET ⇒ social-sb.com/api/v2/segments/{id}/compute

Paramètres obligatoires :

  • "id" : identifiant SPREAD du segment

Paramètres complémentaires :

Aucun

Réponse :

Si GET ok alors

"segment": {
	"id": "1234",
	"name": "Code postal 27000",
	"tags": null,
	"createdAt": "2019-01-18 09:53:33",
	"updatedAt": "2019-03-26 15:17:26",
	"lastComputeAt": "2019-08-28 21:03:41",
	"status": "1",
	"count": "15",
	"type": "Dynamic"
}

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/1234/compute");
// Auth avec la clé publique et la clé privée (voir dans Paramétrage > Tracker)
curl_setopt($curl, CURLOPT_USERPWD, "clef_public:clef_privee");
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
$curl_return = curl_exec($curl);
var_dump($curl_return);
curl_close($curl);