Référence API

Statistiques

Les statistiques sont les graphiques de ton Dashboard, pour tout le compte ou un persona. Une série compte une métrique par minute, heure, jour ou mois, dans ton fuseau horaire. Les dernières réponses, les derniers DM et les derniers leads chauds arrivent sous forme de listes de leads.

Endpoints

GET/v1/analytics/:metric

L'objet série de statistiques

Un graphique du Dashboard, une métrique dans le temps pour le compte ou un persona. Les périodes vides sont omises.

Attributs

objectstring
Toujours analytics_series.
metricstring
La métrique.
leads_foundleads_scoredhot_leadshot_ratesources_addedleads_enrolleddms_sentrepliesreply_ratenew_followerslikescommentsfollows
unitstring
percentage pour hot_rate et reply_rate, sinon count.
countpercentage
persona_idstring ou null
Le persona, si tu en as demandé un.
scalestring
La taille d'une période.
minutehourdaymonth
startstring
Le début de la plage, en ISO 8601.
endstring
La fin de la plage, en ISO 8601.
timezonestring
Le fuseau horaire des périodes.
totalobject
Toute la plage. Un pourcentage a aussi son numerator et son denominator, comme les réponses sur les DM envoyés.
datatableau d'objects
Une par période, avec sa period comme 2026-11-06, 2026-11-06T14:00 ou 2026-11, sa value, et pour un pourcentage son numerator et son denominator.

L'objet série de statistiques

{
  "object": "analytics_series",
  "metric": "reply_rate",
  "unit": "percentage",
  "persona_id": "lvWBPnytpS",
  "scale": "day",
  "start": "2026-10-23T00:00:00.000Z",
  "end": "2026-11-06T08:30:00.000Z",
  "timezone": "Europe/Paris",
  "total": {
    "value": 13.8,
    "numerator": 57,
    "denominator": 412
  },
  "data": [
    {
      "period": "2026-11-04",
      "value": 13.6,
      "numerator": 3,
      "denominator": 22
    },
    {
      "period": "2026-11-05",
      "value": 16,
      "numerator": 4,
      "denominator": 25
    },
    {
      "period": "2026-11-06",
      "value": 11.1,
      "numerator": 1,
      "denominator": 9
    }
  ]
}

Récupérer les statistiques

GET/v1/analytics/:metricScope readMCPget_analytics

Renvoie un graphique du Dashboard. L'échelle minute couvre 3 jours au plus, l'heure 93 jours et le jour 3 700 jours.

Paramètres de chemin

metricstringObligatoire
Une série, ou last_replies, last_dms_sent et last_hot_leads pour les 4 derniers leads de chacune. hot_rate et reply_rate sont des pourcentages.
leads_foundleads_scoredhot_leadshot_ratesources_addedleads_enrolleddms_sentrepliesreply_ratenew_followerslikescommentsfollowslast_replieslast_dms_sentlast_hot_leads

Paramètres de requête

personastring
Seulement le persona avec cet ID. Tout le compte par défaut.
scalestring
La taille d'une période. day par défaut.
minutehourdaymonth
startstring
Le début de la plage, en ISO 8601. Par défaut 3 heures, 2 jours, 14 jours ou un an avant end, selon l'échelle.
endstring
La fin de la plage, en ISO 8601. Maintenant par défaut.
timezonestring
Le fuseau horaire IANA des périodes. Par défaut celui du propriétaire, sinon UTC.

Renvoie

Un objet série de statistiques. Pour une métrique en liste, une liste avec la metric, son persona_id, et dans data le lead_id, le at et l'objet lead de chaque lead.

Erreurs

404resource_missing
Aucun persona avec cet ID sur le compte de la clé.
400parameter_invalid
Un paramètre a une valeur que l'API n'accepte pas. param indique lequel.

GET/v1/analytics/:metric

curl -G https://gemlead.ai/api/v1/analytics/reply_rate \
  -H "Authorization: Bearer $GEMLEAD_API_KEY" \
  -d persona=lvWBPnytpS \
  -d scale=day \
  --data-urlencode "timezone=Europe/Paris"

Réponse200

{
  "object": "analytics_series",
  "metric": "reply_rate",
  "unit": "percentage",
  "persona_id": "lvWBPnytpS",
  "scale": "day",
  "start": "2026-10-23T00:00:00.000Z",
  "end": "2026-11-06T08:30:00.000Z",
  "timezone": "Europe/Paris",
  "total": {
    "value": 13.8,
    "numerator": 57,
    "denominator": 412
  },
  "data": [
    {
      "period": "2026-11-04",
      "value": 13.6,
      "numerator": 3,
      "denominator": 22
    },
    {
      "period": "2026-11-05",
      "value": 16,
      "numerator": 4,
      "denominator": 25
    },
    {
      "period": "2026-11-06",
      "value": 11.1,
      "numerator": 1,
      "denominator": 9
    }
  ]
}