Riferimento API

Statistiche

Le statistiche sono i grafici della tua Dashboard, per tutto l'account o per una buyer persona. Una serie conta una metrica per minuto, ora, giorno o mese, nel tuo fuso orario. Le ultime risposte, gli ultimi DM e gli ultimi lead caldi arrivano come elenchi di lead.

Endpoint

GET/v1/analytics/:metric

L'oggetto serie di statistiche

Un grafico della Dashboard, una metrica nel tempo per l'account o per una buyer persona. I periodi vuoti vengono omessi.

Attributi

objectstring
Sempre analytics_series.
metricstring
La metrica.
leads_foundleads_scoredhot_leadshot_ratesources_addedleads_enrolleddms_sentrepliesreply_ratenew_followerslikescommentsfollows
unitstring
percentage per hot_rate e reply_rate, altrimenti count.
countpercentage
persona_idstring o null
La buyer persona, se ne hai indicata una.
scalestring
La durata di un periodo.
minutehourdaymonth
startstring
L'inizio dell'intervallo, ISO 8601.
endstring
La fine dell'intervallo, ISO 8601.
timezonestring
Il fuso orario dei periodi.
totalobject
L'intero intervallo. Una percentuale ha anche il suo numerator e il suo denominator, come le risposte sui DM inviati.
dataarray di objects
Uno per periodo, con il suo period come 2026-11-06, 2026-11-06T14:00 o 2026-11, il suo value e, per una percentuale, il suo numerator e il suo denominator.

L'oggetto serie di statistiche

{
  "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
    }
  ]
}

Recupera le statistiche

GET/v1/analytics/:metricScope readMCPget_analytics

Restituisce un grafico della Dashboard. Una scala al minuto copre al massimo 3 giorni, all'ora 93 giorni e al giorno 3 700 giorni.

Parametri di percorso

metricstringObbligatorio
Una serie, oppure last_replies, last_dms_sent e last_hot_leads per gli ultimi 4 lead di ciascuno. hot_rate e reply_rate sono percentuali.
leads_foundleads_scoredhot_leadshot_ratesources_addedleads_enrolleddms_sentrepliesreply_ratenew_followerslikescommentsfollowslast_replieslast_dms_sentlast_hot_leads

Parametri di query

personastring
Solo la buyer persona con questo ID. Di default tutto l'account.
scalestring
La durata di un periodo. Di default day.
minutehourdaymonth
startstring
L'inizio dell'intervallo, ISO 8601. Di default 3 ore, 2 giorni, 14 giorni o un anno prima di end, in base alla scala.
endstring
La fine dell'intervallo, ISO 8601. Di default adesso.
timezonestring
Il fuso orario IANA dei periodi. Di default quello del proprietario, altrimenti UTC.

Restituisce

Un oggetto serie di statistiche. Per una metrica a elenco, un elenco con la metric, il suo persona_id e, in data, il lead_id, at e l'oggetto lead di ogni lead.

Errori

404resource_missing
Nessuna buyer persona con questo ID sull'account della chiave.
400parameter_invalid
Un parametro ha un valore che l'API non accetta. param lo indica.

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"

Risposta200

{
  "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
    }
  ]
}