API reference

Analytics

Analytics are the charts of your Dashboard, for the whole account or one persona. A series counts a metric by minute, hour, day or month, in your time zone. The last replies, DMs and hot leads come as lists of leads.

Endpoints

GET/v1/analytics/:metric

The analytics series object

One chart of the Dashboard, a metric over time for the account or one persona. Periods with nothing are left out.

Attributes

objectstring
Always analytics_series.
metricstring
The metric.
leads_foundleads_scoredhot_leadshot_ratesources_addedleads_enrolleddms_sentrepliesreply_ratenew_followerslikescommentsfollows
unitstring
percentage for hot_rate and reply_rate, else count.
countpercentage
persona_idstring or null
The persona, when you asked for one.
scalestring
The size of a period.
minutehourdaymonth
startstring
The range's start, ISO 8601.
endstring
The range's end, ISO 8601.
timezonestring
The time zone of the periods.
totalobject
The whole range. A percentage also has its numerator and denominator, like replies over DMs sent.
dataarray of objects
One a period, with its period like 2026-11-06, 2026-11-06T14:00 or 2026-11, its value, and for a percentage its numerator and denominator.

Analytics series object

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

Retrieve analytics

GET/v1/analytics/:metricread scopeMCPget_analytics

Returns one chart of the Dashboard. A minute scale covers 3 days at most, an hour 93 days and a day 3 700 days.

Path parameters

metricstringRequired
A series, or last_replies, last_dms_sent and last_hot_leads for the 4 latest leads of each. hot_rate and reply_rate are percentages.
leads_foundleads_scoredhot_leadshot_ratesources_addedleads_enrolleddms_sentrepliesreply_ratenew_followerslikescommentsfollowslast_replieslast_dms_sentlast_hot_leads

Query parameters

personastring
Only this persona ID. Default the whole account.
scalestring
The size of a period. Default day.
minutehourdaymonth
startstring
The range's start, ISO 8601. Default 3 hours, 2 days, 14 days or a year before end, by scale.
endstring
The range's end, ISO 8601. Default now.
timezonestring
The IANA time zone of the periods. Default the owner's, else UTC.

Returns

An analytics series object. For a list metric, a list with the metric, its persona_id, and in data each lead's lead_id, at and lead object.

Errors

404resource_missing
No persona with this ID on the key's account.
400parameter_invalid
A parameter has a value the API does not accept. param names it.

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