Справочник API

Аналитика

Аналитика отдаёт графики вашей «Панели», для всего аккаунта или одной персоны. Серия считает метрику по минутам, часам, дням или месяцам в вашем часовом поясе. Последние ответы, DM и горячие лиды приходят списками лидов.

Эндпоинты

GET/v1/analytics/:metric

Объект серии аналитики

Один график «Панели», метрика во времени для аккаунта или одной персоны. Пустые периоды не включаются.

Атрибуты

objectstring
Всегда analytics_series.
metricstring
Метрика.
leads_foundleads_scoredhot_leadshot_ratesources_addedleads_enrolleddms_sentrepliesreply_ratenew_followerslikescommentsfollows
unitstring
percentage для hot_rate и reply_rate, иначе count.
countpercentage
persona_idstring или null
Персона, если вы её запросили.
scalestring
Длина периода.
minutehourdaymonth
startstring
Начало диапазона, ISO 8601.
endstring
Конец диапазона, ISO 8601.
timezonestring
Часовой пояс периодов.
totalobject
Весь диапазон. У процента также есть numerator и denominator, например ответы к отправленным DM.
dataмассив objects
По одной записи на период, с period, например 2026-11-06, 2026-11-06T14:00 или 2026-11, значением value, а для процента ещё с numerator и denominator.

Объект серии аналитики

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

Получение аналитики

GET/v1/analytics/:metricПраво readMCPget_analytics

Возвращает один график «Панели». Масштаб по минутам охватывает не больше 3 дней, по часам 93 дня, а по дням 3 700 дней.

Параметры пути

metricstringОбязательно
Серия или last_replies, last_dms_sent и last_hot_leads с 4 последними лидами в каждом. hot_rate и reply_rate выражены в процентах.
leads_foundleads_scoredhot_leadshot_ratesources_addedleads_enrolleddms_sentrepliesreply_ratenew_followerslikescommentsfollowslast_replieslast_dms_sentlast_hot_leads

Параметры запроса

personastring
Только персона с этим ID. По умолчанию весь аккаунт.
scalestring
Длина периода. По умолчанию day.
minutehourdaymonth
startstring
Начало диапазона, ISO 8601. По умолчанию за 3 часа, 2 дня, 14 дней или год до end, в зависимости от масштаба.
endstring
Конец диапазона, ISO 8601. По умолчанию текущий момент.
timezonestring
Часовой пояс IANA для периодов. По умолчанию часовой пояс владельца, иначе UTC.

Возвращает

Объект серии аналитики. Для метрики-списка возвращается список с metric, её persona_id, а в data для каждого лида его lead_id, at и объект лида.

Ошибки

404resource_missing
В аккаунте ключа нет персоны с этим ID.
400parameter_invalid
API не принимает значение параметра. Название параметра указано в param.

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"

Ответ200

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