Referência da API

Analytics

Os analytics são os gráficos do seu Painel, para a conta inteira ou para uma persona. Uma série conta uma métrica por minuto, hora, dia ou mês, no seu fuso horário. As últimas respostas, DMs e leads quentes vêm como listas de leads.

Endpoints

GET/v1/analytics/:metric

O objeto analytics series

Um gráfico do Painel, uma métrica ao longo do tempo para a conta ou para uma persona. Os períodos sem dados ficam de fora.

Atributos

objectstring
Sempre analytics_series.
metricstring
A métrica.
leads_foundleads_scoredhot_leadshot_ratesources_addedleads_enrolleddms_sentrepliesreply_ratenew_followerslikescommentsfollows
unitstring
percentage para hot_rate e reply_rate, senão count.
countpercentage
persona_idstring ou null
A persona, quando você pediu uma.
scalestring
O tamanho de um período.
minutehourdaymonth
startstring
O início do intervalo, em ISO 8601.
endstring
O fim do intervalo, em ISO 8601.
timezonestring
O fuso horário dos períodos.
totalobject
O intervalo inteiro. Uma porcentagem também tem o numerator e o denominator, como respostas sobre DMs enviadas.
dataarray de objects
Um por período, com o period, como 2026-11-06, 2026-11-06T14:00 ou 2026-11, o value e, para uma porcentagem, o numerator e o denominator.

O 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
    }
  ]
}

Obter analytics

GET/v1/analytics/:metricScope readMCPget_analytics

Retorna um gráfico do Painel. Uma escala por minuto cobre no máximo 3 dias, por hora 93 dias e por dia 3 700 dias.

Parâmetros de caminho

metricstringObrigatório
Uma série, ou last_replies, last_dms_sent e last_hot_leads para os 4 leads mais recentes de cada. hot_rate e reply_rate são porcentagens.
leads_foundleads_scoredhot_leadshot_ratesources_addedleads_enrolleddms_sentrepliesreply_ratenew_followerslikescommentsfollowslast_replieslast_dms_sentlast_hot_leads

Parâmetros de consulta

personastring
Só a persona com este ID. O padrão é a conta inteira.
scalestring
O tamanho de um período. O padrão é day.
minutehourdaymonth
startstring
O início do intervalo, em ISO 8601. O padrão é 3 horas, 2 dias, 14 dias ou um ano antes de end, conforme a escala.
endstring
O fim do intervalo, em ISO 8601. O padrão é agora.
timezonestring
O fuso horário IANA dos períodos. O padrão é o do dono da conta, senão UTC.

Retorno

Um objeto analytics series. Para uma métrica de lista, uma lista com a metric, o persona_id dela e, em data, o lead_id, o at e o objeto lead de cada lead.

Erros

404resource_missing
Nenhuma persona com este ID na conta da chave.
400parameter_invalid
Um parâmetro tem um valor que a API não aceita. param diz qual.

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"

Resposta200

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