API-Referenz

Analysen

Analysen sind die Diagramme deines Dashboards, für das ganze Konto oder eine Persona. Eine Datenreihe zählt eine Metrik pro Minute, Stunde, Tag oder Monat, in deiner Zeitzone. Die letzten Antworten, DMs und heißen Leads kommen als Listen von Leads.

Endpoints

GET/v1/analytics/:metric

Das Datenreihenobjekt

Ein Diagramm des Dashboards, eine Metrik im Zeitverlauf für das Konto oder eine Persona. Zeiträume ohne Werte fallen weg.

Attribute

objectstring
Immer analytics_series.
metricstring
Die Metrik.
leads_foundleads_scoredhot_leadshot_ratesources_addedleads_enrolleddms_sentrepliesreply_ratenew_followerslikescommentsfollows
unitstring
percentage für hot_rate und reply_rate, sonst count.
countpercentage
persona_idstring oder null
Die Persona, falls du eine angefragt hast.
scalestring
Die Länge eines Zeitraums.
minutehourdaymonth
startstring
Der Beginn des Bereichs, ISO 8601.
endstring
Das Ende des Bereichs, ISO 8601.
timezonestring
Die Zeitzone der Zeiträume.
totalobject
Der ganze Bereich. Ein Prozentwert hat zusätzlich numerator und denominator, etwa Antworten geteilt durch gesendete DMs.
dataArray von objects
Ein Eintrag pro Zeitraum, mit period wie 2026-11-06, 2026-11-06T14:00 oder 2026-11, value und bei einem Prozentwert numerator und denominator.

Das Datenreihenobjekt

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

Analysen abrufen

GET/v1/analytics/:metricScope readMCPget_analytics

Gibt ein Diagramm des Dashboards zurück. Eine Skala in Minuten umfasst höchstens 3 Tage, in Stunden 93 Tage und in Tagen 3 700 Tage.

Pfadparameter

metricstringErforderlich
Eine Datenreihe, oder last_replies, last_dms_sent und last_hot_leads für jeweils die 4 neuesten Leads. hot_rate und reply_rate sind Prozentwerte.
leads_foundleads_scoredhot_leadshot_ratesources_addedleads_enrolleddms_sentrepliesreply_ratenew_followerslikescommentsfollowslast_replieslast_dms_sentlast_hot_leads

Query-Parameter

personastring
Nur diese Persona-ID. Standardmäßig das ganze Konto.
scalestring
Die Länge eines Zeitraums. Standardmäßig day.
minutehourdaymonth
startstring
Der Beginn des Bereichs, ISO 8601. Standardmäßig je nach Skala 3 Stunden, 2 Tage, 14 Tage oder ein Jahr vor end.
endstring
Das Ende des Bereichs, ISO 8601. Standardmäßig jetzt.
timezonestring
Die IANA-Zeitzone der Zeiträume. Standardmäßig die des Inhabers, sonst UTC.

Rückgabe

Ein Datenreihenobjekt. Bei einer Listenmetrik eine Liste mit metric, ihrer persona_id und in data für jeden Lead lead_id, at und das Lead-Objekt.

Fehler

404resource_missing
Keine Persona mit dieser ID im Konto des Schlüssels.
400parameter_invalid
Ein Parameter hat einen Wert, den die API nicht akzeptiert. param nennt ihn.

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"

Antwort200

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