月別クリック数取得API
指定した期間内の月別(YYYY-MM)クリック数を取得するAPIです。
長期的なトラフィックの変化や成長傾向を分析し、キャンペーン成果やユーザー動向を把握できます。
このAPIはパーソナルプラン以上で利用可能です。
GET
/api/statistics/v1/clicks-by-month?startYm={startYm}&endYm={endYm}
GET /api/statistics/v1/clicks-by-month
?startYm=2026-01
&endYm=2026-04
Request Parameters
- startYm string required
-
取得開始年月です。
YYYY-MM形式で入力してください。例:2026-01 - endYm string required
-
取得終了年月です。
YYYY-MM形式で入力してください。例:2026-04
取得可能な開始範囲はプランによって異なります。
パーソナルプラン:過去90日以内
プレミアムプラン:過去180日以内
ビジネスプラン:過去365日以内 - linkId string
-
リンクIDです。特殊文字やUnicodeが含まれる場合は、
URLエンコードを適用してください。
パーソナルプラン:linkIdとdomainは必須。個別リンクのみ取得可能です。
プレミアムプラン以上:任意指定。 - domain string
- リンクのドメインです。カスタムドメインにも対応しています。
- grpIdx integer
-
リンクグループIDです。
グループIDXはグループ一覧APIまたはダッシュボードで確認できます。
指定すると、グループ内すべてのリンクのクリック合計が返されます。
プレミアムプラン以上で利用可能です。
{
"code": 0,
"message": "",
"result": [
{
"ym": "2026-01",
"acesCnt": 384,
"pernCnt": 295
},
{
"ymd": "2026-02",
"acesCnt": 1785,
"pernCnt": 1720
},
{
"ymd": "2026-03",
"acesCnt": 19542,
"pernCnt": 19083
},
{
"ymd": "2026-04",
"acesCnt": 3596,
"pernCnt": 3274
}
]
}
Response Parameters
- codeinteger
- レスポンスコード: 0 = 成功、それ以外 = エラー
- messagestring
- レスポンスメッセージ。レスポンスコードが0以外の場合、エラー内容のメッセージが返されます。
- resultarray
- ym string
-
年月です。
YYYY-MM形式で返されます。例:2026-01 - acesCnt integer
- 指定した月の総クリック数です。
- pernCnt integer
- 指定した月にリンクをクリックしたユニークユーザー数です。
このAPIを利用する場面
リンクのトラフィック推移を月単位で把握したい場合に利用します。
四半期・半期ごとのキャンペーン成果の整理や、季節性トラフィックの分析、年間レポート作成に適しています。
日別クリック数APIと比較して、長期的なトレンド分析に適しています。
日別クリックAPIとの違い
日別クリックAPIは日単位で集計され、短期トレンドの把握に適しています。一方、月別クリックAPIは月単位で集計され、長期トレンドの分析に適しています。
また、月別APIはプランに応じて最大365日まで取得可能で、年間分析にも活用できます。
※ ビジネスプラスおよびエンタープライズプランは契約により最大2年まで取得可能
プラン別取得制限
このAPIはパーソナルプラン以上で利用可能です。取得可能な期間はプランによって異なります。
パーソナルプランは直近90日、プレミアムプランは180日、ビジネスプランは365日まで取得可能です。
grpIdxによるグループ単位の取得はプレミアムプラン以上でのみ利用できます。
主要指標と分析基準
このAPIは月単位の集計データを提供します。
月別クリック数(accsCnt)
- 該当月の総クリック数
- トラフィックの増減トレンドを把握
ユーザー数(pernCnt)
- 該当月のユニークユーザー数
- 実際の流入規模を分析
これらの指標により、成長率、季節性、長期的なパフォーマンスを評価できます。
活用例
- 四半期レポート:
startYmとendYmで期間を指定し、月別クリック推移を分析 - 季節性分析: 1年分のデータを取得し、トラフィックが集中する月を特定
- キャンペーンの長期推移:
grpIdxでグループ単位の月別クリック傾向を把握 - 年間レポート: ビジネスプランで最大365日分のデータを取得し、年次分析に活用
利用時の注意点
startYmとendYmは必須パラメータで、YYYY-MM形式で入力してください。- 取得可能な期間はプランによって異なります。上限を超えるとエラーが返されます。
linkIdに特殊文字やUnicodeが含まれる場合は、URLエンコードが必要です。- このAPIはパーソナルプラン以上で利用可能です。事前にプランをご確認ください。