APIリファレンス

アナリティクス

アナリティクスでは、ダッシュボードのグラフを、アカウント全体または1つのペルソナについて取得できます。系列は、指標をあなたのタイムゾーンで分、時間、日、月ごとに集計します。最新の返信、DM、ホットリードは、リードのリストとして返ります。

エンドポイント

GET/v1/analytics/:metric

アナリティクス系列オブジェクト

ダッシュボードのグラフ1つ分。アカウントまたは1つのペルソナについての、指標の推移です。値のない期間は含まれません。

属性

objectstring
常にanalytics_seriesです。
metricstring
指標。
leads_foundleads_scoredhot_leadshot_ratesources_addedleads_enrolleddms_sentrepliesreply_ratenew_followerslikescommentsfollows
unitstring
hot_rateとreply_rateはpercentage、それ以外はcountです。
countpercentage
persona_idstringまたはnull
ペルソナを指定した場合の、そのペルソナ。
scalestring
1期間の長さ。
minutehourdaymonth
startstring
範囲の開始日時。ISO 8601形式です。
endstring
範囲の終了日時。ISO 8601形式です。
timezonestring
期間のタイムゾーン。
totalobject
範囲全体の値。割合の場合は、送信したDMに対する返信のように、numeratorとdenominatorも含みます。
dataobjectsの配列
期間ごとに1件。2026-11-06、2026-11-06T14:00、2026-11のようなperiodと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/:metricreadスコープMCPget_analytics

ダッシュボードのグラフを1つ返します。指定できる範囲は、分単位で最大3日、時間単位で93日、日単位で3 700日です。

パスパラメーター

metricstring必須
系列、または各リストの最新4件のリードを返すlast_replies、last_dms_sent、last_hot_leads。hot_rateとreply_rateは割合です。
leads_foundleads_scoredhot_leadshot_ratesources_addedleads_enrolleddms_sentrepliesreply_ratenew_followerslikescommentsfollowslast_replieslast_dms_sentlast_hot_leads

クエリパラメーター

personastring
このペルソナIDのみ。デフォルトはアカウント全体です。
scalestring
1期間の長さ。デフォルトはdayです。
minutehourdaymonth
startstring
範囲の開始日時。ISO 8601形式です。デフォルトは単位に応じて、endの3時間前、2日前、14日前、または1年前です。
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
    }
  ]
}