Referencia de la API

Analíticas

Las analíticas son los gráficos de tu Panel, para toda la cuenta o para un buyer persona. Una serie cuenta una métrica por minuto, hora, día o mes, en tu zona horaria. Las últimas respuestas, los últimos DM y los últimos leads calientes llegan como listas de leads.

Endpoints

GET/v1/analytics/:metric

El objeto analytics series

Un gráfico del Panel, una métrica en el tiempo para la cuenta o para un buyer persona. Los periodos vacíos se omiten.

Atributos

objectstring
Siempre analytics_series.
metricstring
La métrica.
leads_foundleads_scoredhot_leadshot_ratesources_addedleads_enrolleddms_sentrepliesreply_ratenew_followerslikescommentsfollows
unitstring
percentage para hot_rate y reply_rate, count en los demás casos.
countpercentage
persona_idstring o null
El buyer persona, si pediste uno.
scalestring
El tamaño de un periodo.
minutehourdaymonth
startstring
El inicio del rango, en ISO 8601.
endstring
El final del rango, en ISO 8601.
timezonestring
La zona horaria de los periodos.
totalobject
Todo el rango. Un porcentaje tiene además su numerator y su denominator, como las respuestas sobre los DM enviados.
dataarray de objects
Uno por periodo, con su period como 2026-11-06, 2026-11-06T14:00 o 2026-11, su value y, para un porcentaje, su numerator y su denominator.

El objeto analytics series

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

Obtener analíticas

GET/v1/analytics/:metricScope readMCPget_analytics

Devuelve un gráfico del Panel. Una escala por minuto abarca 3 días como máximo, por hora 93 días y por día 3 700 días.

Parámetros de ruta

metricstringObligatorio
Una serie, o last_replies, last_dms_sent y last_hot_leads para los 4 últimos leads de cada una. hot_rate y reply_rate son porcentajes.
leads_foundleads_scoredhot_leadshot_ratesources_addedleads_enrolleddms_sentrepliesreply_ratenew_followerslikescommentsfollowslast_replieslast_dms_sentlast_hot_leads

Parámetros de consulta

personastring
Solo el buyer persona con este ID. Por defecto, toda la cuenta.
scalestring
El tamaño de un periodo. Por defecto day.
minutehourdaymonth
startstring
El inicio del rango, en ISO 8601. Por defecto 3 horas, 2 días, 14 días o un año antes de end, según la escala.
endstring
El final del rango, en ISO 8601. Por defecto, ahora.
timezonestring
La zona horaria IANA de los periodos. Por defecto, la del propietario o, si no, UTC.

Devuelve

Un objeto analytics series. Para una métrica de lista, una lista con la metric, su persona_id y, en data, el lead_id, el at y el objeto lead de cada lead.

Errores

404resource_missing
No hay ningún buyer persona con este ID en la cuenta de la clave.
400parameter_invalid
Un parámetro tiene un valor que la API no acepta. 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"

Respuesta200

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