API-referentie

Analytics

Analytics zijn de grafieken van je Dashboard, voor het hele account of één persona. Een reeks telt een metric per minuut, uur, dag of maand, in je tijdzone. De laatste antwoorden, DM's en hete leads komen als lijsten van leads.

Endpoints

GET/v1/analytics/:metric

Het reeksobject

Eén grafiek van het Dashboard, een metric in de tijd voor het account of één persona. Periodes zonder data worden weggelaten.

Attributen

objectstring
Altijd analytics_series.
metricstring
De metric.
leads_foundleads_scoredhot_leadshot_ratesources_addedleads_enrolleddms_sentrepliesreply_ratenew_followerslikescommentsfollows
unitstring
percentage voor hot_rate en reply_rate, anders count.
countpercentage
persona_idstring of null
De persona, als je die hebt opgegeven.
scalestring
De grootte van een periode.
minutehourdaymonth
startstring
Het begin van het bereik, in ISO 8601.
endstring
Het einde van het bereik, in ISO 8601.
timezonestring
De tijdzone van de periodes.
totalobject
Het hele bereik. Een percentage heeft ook een numerator en denominator, zoals antwoorden gedeeld door verstuurde DM's.
dataarray van objects
Eén per periode, met period zoals 2026-11-06, 2026-11-06T14:00 of 2026-11, de value, en bij een percentage de numerator en denominator.

Het reeksobject

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

Analytics ophalen

GET/v1/analytics/:metricScope readMCPget_analytics

Geeft één grafiek van het Dashboard terug. Een schaal per minuut beslaat maximaal 3 dagen, per uur 93 dagen en per dag 3 700 dagen.

Padparameters

metricstringVerplicht
Een reeks, of last_replies, last_dms_sent en last_hot_leads voor telkens de 4 nieuwste leads. hot_rate en reply_rate zijn percentages.
leads_foundleads_scoredhot_leadshot_ratesources_addedleads_enrolleddms_sentrepliesreply_ratenew_followerslikescommentsfollowslast_replieslast_dms_sentlast_hot_leads

Queryparameters

personastring
Alleen de persona met deze ID. Standaard het hele account.
scalestring
De grootte van een periode. Standaard day.
minutehourdaymonth
startstring
Het begin van het bereik, in ISO 8601. Standaard 3 uur, 2 dagen, 14 dagen of een jaar vóór end, afhankelijk van de schaal.
endstring
Het einde van het bereik, in ISO 8601. Standaard nu.
timezonestring
De IANA-tijdzone van de periodes. Standaard die van de eigenaar, anders UTC.

Resultaat

Een reeksobject. Bij een lijstmetric een lijst met de metric, de persona_id en in data per lead de lead_id, at en het lead-object.

Fouten

404resource_missing
Geen persona met deze ID op het account van de sleutel.
400parameter_invalid
Een parameter heeft een waarde die de API niet accepteert. param geeft aan welke.

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"

Response200

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