Segments

Lire vos segments, leur définition et les leads qui les composent.

Un segment regroupe les leads qui remplissent des conditions sur leurs événements et leurs attributs. Les segments se créent dans Engagement → Segments ; l’API permet de les lire et d’en extraire les membres, par exemple pour synchroniser une audience publicitaire ou votre CRM.

L'objet segment

Champ Type Description
id uuid Identifiant du segment.
name string Nom.
description string | null Description.
definition object Conditions du segment (format décrit plus bas).
lead_count integer Uniquement sur GET /segments/:id : nombre de leads calculé au moment de l’appel.
created_at datetime Date de création.
updated_at datetime | null Dernière modification.

Lister les segments

GET /api/platform/v1/segments segments:read

Retourne les segments du compte.

Paramètres de requête

Champ Type Description
limit integer Nombre d’éléments par page, de 1 à 100. Par défaut 25.
cursor string Valeur next_cursor de la page précédente. Voir Pagination.

Exemple de requête

curl 'https://strikespace.net/api/platform/v1/segments' \
  -H "Authorization: Bearer $STRIKE_API_KEY"
// Node.js 18+ (fetch natif)
const response = await fetch('https://strikespace.net/api/platform/v1/segments', {
  headers: {
    Authorization: `Bearer ${process.env.STRIKE_API_KEY}`,
  },
})
const data = await response.json()
if (!response.ok) throw new Error(`${data.error.type}: ${data.error.message}`)
console.log(data)
import os
import requests

response = requests.get(
    "https://strikespace.net/api/platform/v1/segments",
    headers={"Authorization": f"Bearer {os.environ['STRIKE_API_KEY']}"},
    timeout=10,
)
response.raise_for_status()
print(response.json())
<?php
$ch = curl_init('https://strikespace.net/api/platform/v1/segments');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('STRIKE_API_KEY'),
    ],
]);
$body = json_decode(curl_exec($ch), true);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

if ($status >= 400) {
    throw new RuntimeException($body['error']['message'] ?? 'Erreur STRIKE');
}

Réponse

Réponse 200
{
  "object": "list",
  "data": [
    {
      "object": "segment",
      "id": "a87ff679-a2f3-4e71-9181-0c7e4b2d5f63",
      "name": "Paniers abandonnés (30 j)",
      "description": "Ont commencé un paiement sans le terminer ce mois-ci.",
      "definition": {
        "match": "all",
        "conditions": [
          {
            "type": "event",
            "event": "checkout_started",
            "timeframe": "last_30_days"
          },
          {
            "type": "event",
            "event": "order_paid",
            "count": "= 0",
            "timeframe": "last_30_days"
          }
        ]
      },
      "created_at": "2026-09-02T10:00:00.000Z",
      "updated_at": "2026-10-01T08:30:00.000Z"
    }
  ],
  "has_more": false,
  "next_cursor": null
}

Équivalent pour les agents IA : l'outil MCP list_segments.

Récupérer un segment

GET /api/platform/v1/segments/:id segments:read

Retourne un segment, sa définition et son nombre de leads actuel.

Paramètres de chemin

Champ Type Description
id requis uuid Identifiant du segment.

Exemple de requête

curl 'https://strikespace.net/api/platform/v1/segments/a87ff679-a2f3-4e71-9181-0c7e4b2d5f63' \
  -H "Authorization: Bearer $STRIKE_API_KEY"
// Node.js 18+ (fetch natif)
const response = await fetch('https://strikespace.net/api/platform/v1/segments/a87ff679-a2f3-4e71-9181-0c7e4b2d5f63', {
  headers: {
    Authorization: `Bearer ${process.env.STRIKE_API_KEY}`,
  },
})
const data = await response.json()
if (!response.ok) throw new Error(`${data.error.type}: ${data.error.message}`)
console.log(data)
import os
import requests

response = requests.get(
    "https://strikespace.net/api/platform/v1/segments/a87ff679-a2f3-4e71-9181-0c7e4b2d5f63",
    headers={"Authorization": f"Bearer {os.environ['STRIKE_API_KEY']}"},
    timeout=10,
)
response.raise_for_status()
print(response.json())
<?php
$ch = curl_init('https://strikespace.net/api/platform/v1/segments/a87ff679-a2f3-4e71-9181-0c7e4b2d5f63');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('STRIKE_API_KEY'),
    ],
]);
$body = json_decode(curl_exec($ch), true);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

if ($status >= 400) {
    throw new RuntimeException($body['error']['message'] ?? 'Erreur STRIKE');
}

Réponse

Réponse 200
{
  "object": "segment",
  "id": "a87ff679-a2f3-4e71-9181-0c7e4b2d5f63",
  "name": "Paniers abandonnés (30 j)",
  "description": "Ont commencé un paiement sans le terminer ce mois-ci.",
  "definition": {
    "match": "all",
    "conditions": [
      {
        "type": "event",
        "event": "checkout_started",
        "timeframe": "last_30_days"
      },
      {
        "type": "event",
        "event": "order_paid",
        "count": "= 0",
        "timeframe": "last_30_days"
      }
    ]
  },
  "created_at": "2026-09-02T10:00:00.000Z",
  "updated_at": "2026-10-01T08:30:00.000Z",
  "lead_count": 128
}

Erreurs spécifiques

404 Segment introuvable, ou appartenant à un autre compte (not_found).

Les erreurs communes (401, 403 insufficient_scope / plan_required, 429) sont décrites dans Conventions.

Leads d’un segment

GET /api/platform/v1/segments/:id/leads segments:read

Évalue le segment au moment de l’appel et retourne les leads qui en font partie.

Paramètres de chemin

Champ Type Description
id requis uuid Identifiant du segment.

Paramètres de requête

Champ Type Description
limit integer Nombre d’éléments par page, de 1 à 100. Par défaut 25.
cursor string Valeur next_cursor de la page précédente. Voir Pagination.

Exemple de requête

curl 'https://strikespace.net/api/platform/v1/segments/a87ff679-a2f3-4e71-9181-0c7e4b2d5f63/leads?limit=100' \
  -H "Authorization: Bearer $STRIKE_API_KEY"
// Node.js 18+ (fetch natif)
const response = await fetch('https://strikespace.net/api/platform/v1/segments/a87ff679-a2f3-4e71-9181-0c7e4b2d5f63/leads?limit=100', {
  headers: {
    Authorization: `Bearer ${process.env.STRIKE_API_KEY}`,
  },
})
const data = await response.json()
if (!response.ok) throw new Error(`${data.error.type}: ${data.error.message}`)
console.log(data)
import os
import requests

response = requests.get(
    "https://strikespace.net/api/platform/v1/segments/a87ff679-a2f3-4e71-9181-0c7e4b2d5f63/leads",
    headers={"Authorization": f"Bearer {os.environ['STRIKE_API_KEY']}"},
    params={
        "limit": 100,
    },
    timeout=10,
)
response.raise_for_status()
print(response.json())
<?php
$ch = curl_init('https://strikespace.net/api/platform/v1/segments/a87ff679-a2f3-4e71-9181-0c7e4b2d5f63/leads?limit=100');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('STRIKE_API_KEY'),
    ],
]);
$body = json_decode(curl_exec($ch), true);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

if ($status >= 400) {
    throw new RuntimeException($body['error']['message'] ?? 'Erreur STRIKE');
}

Réponse

Réponse 200
{
  "object": "list",
  "data": [
    {
      "object": "lead",
      "id": "8f14e45f-ceea-4e7a-9a3b-2c1d5e6f7a80",
      "first_name": "Awa",
      "email": "awa@exemple.com",
      "phone_number": "+22997000000",
      "country_code": "BJ",
      "preferred_channel": "whatsapp",
      "status": "warm",
      "funnel_id": "3c59dc04-8f1e-4b6a-9d2c-1e5f7a9b0c21",
      "traits": {
        "plan": "pro",
        "city": "Cotonou"
      },
      "unsubscribed": false,
      "unsubscribed_at": null,
      "created_at": "2026-10-14T09:12:31.000Z",
      "updated_at": "2026-10-15T16:02:11.000Z"
    }
  ],
  "has_more": true,
  "next_cursor": "MjAyNi0xMC0xNFQwOToxMjozMS4wMDBafDhmMTRlNDVm"
}

Erreurs spécifiques

404 Segment introuvable, ou appartenant à un autre compte (not_found).

Les erreurs communes (401, 403 insufficient_scope / plan_required, 429) sont décrites dans Conventions.

Équivalent pour les agents IA : l'outil MCP get_segment_leads.

Format de définition d'un segment

Le champ definition est un document JSON. Vous le construisez visuellement dans Engagement → Segments, avec un aperçu des leads concernés ; il peut ensuite déclencher un parcours ou servir de condition dans le Journey Builder.

JSON · « connecté plus de 2 fois cette semaine, offre Pro, jamais passé commande »
{
  "match": "all",
  "conditions": [
    { "type": "event", "event": "login", "count": "> 2", "timeframe": "last_7_days" },
    { "type": "attribute", "field": "traits.plan", "operator": "eq", "value": "pro" },
    { "type": "event", "event": "checkout", "count": "= 0" }
  ]
}

Conditions sur un événement

Clé Valeurs
event Nom de l'événement, tel qu'envoyé à track ou POST /events.
count >, >=, <, <=, =, != suivi d'un nombre. Par défaut >= 1. = 0 inclut les leads qui n'ont jamais fait l'action.
timeframe last_<n>_minutes|hours|days|weeks|months, all_time (défaut) ou une plage { "from": "…", "to": "…" } en dates ISO.
where Filtres sur les propriétés : { "property": "cart.total", "operator": "gte", "value": 20000 }.

Conditions sur un attribut

field désigne une colonne du lead (first_name, email, phone_number, country_code, status, preferred_channel, funnel_id, created_at) ou un trait (traits.<chemin>).

Opérateurs disponibles (attributs et filtres where) : eq, neq, gt, gte, lt, lte, contains (texte, insensible à la casse), in (liste de valeurs), exists, not_exists.

Groupes imbriqués

Combinez "match": "all" (ET) et "match": "any" (OU) avec des conditions de type group, jusqu'à 4 niveaux et 50 conditions par segment.

JSON · « a abandonné son panier ce mois-ci, à Cotonou ou Abidjan »
{
  "match": "all",
  "conditions": [
    {
      "type": "event", "event": "checkout_started", "timeframe": "last_30_days",
      "where": [{ "property": "cart_total", "operator": "gte", "value": 20000 }]
    },
    { "type": "event", "event": "order_paid", "count": "= 0", "timeframe": "last_30_days" },
    {
      "type": "group", "match": "any",
      "conditions": [
        { "type": "attribute", "field": "traits.city", "operator": "in", "value": ["Cotonou", "Abidjan"] },
        { "type": "attribute", "field": "country_code", "operator": "eq", "value": "CI" }
      ]
    }
  ]
}

Une question sur l'intégration ? Écrivez à contact@strike.app en indiquant l'endpoint, l'heure et le request_id de la réponse.