Add rich menu summary and daily report to the Insight API

[kiruto]

Summary

Adds two endpoints to the Insight API for the impression and click statistics of rich menus created via the Messaging API:

Method	Path
GET	/v2/bot/insight/richmenu/{richMenuId}/summary
GET	/v2/bot/insight/richmenu/{richMenuId}/daily

summary returns metrics aggregated over the whole period; daily returns per-day metrics.

Why

These endpoints let developers retrieve impression and click statistics for rich menus they create through the Messaging API (POST /v2/bot/richmenu), using the standard public Messaging API surface — the same kind of insight already offered for messages and followers.

Details

Common to both endpoints:

• Authorized with a channel access token (Bearer).
• Query parameters from and to, both inclusive, format yyyyMMdd, time zone UTC+9. from must be within the most recent 3 years.
• Impression metrics are aggregated for the whole rich menu; click metrics are aggregated per tappable area. Each area is expressed by bounds (top-left x, y, width, height).
• metricsFrom / metricsTo (the period actually covered) and the per-day date are returned as yyyyMMdd strings (JST), consistent with the from / to request parameters.
• When the total number of unique clicks in the period is below the privacy threshold, only richMenuId is returned and the other fields are omitted.

Per-endpoint period limit:

• summary: to can be up to 396 days after from.
• daily: to can be up to 99 days after from.

Example — summary

GET /v2/bot/insight/richmenu/{richMenuId}/summary?from=20260213&to=20260215

{
  "richMenuId": "richmenu-0123456789abcdef0123456789abcdef",
  "metricsFrom": "20260213",
  "metricsTo": "20260215",
  "impression": {
    "metrics": { "count": 567, "uniqueUsers": 300 }
  },
  "clicks": [
    {
      "bounds": { "x": 0, "y": 0, "width": 400, "height": 250 },
      "metrics": { "count": 123, "uniqueUsers": 45 }
    },
    {
      "bounds": { "x": 400, "y": 0, "width": 400, "height": 250 },
      "metrics": { "count": 45, "uniqueUsers": 24 }
    }
  ]
}

Example — daily

GET /v2/bot/insight/richmenu/{richMenuId}/daily?from=20260213&to=20260215

{
  "richMenuId": "richmenu-0123456789abcdef0123456789abcdef",
  "metricsFrom": "20260213",
  "metricsTo": "20260215",
  "impression": {
    "metrics": [
      { "date": "20260213", "count": 300, "uniqueUsers": 191 },
      { "date": "20260214", "count": 267, "uniqueUsers": 222 }
    ]
  },
  "clicks": [
    {
      "bounds": { "x": 0, "y": 0, "width": 400, "height": 250 },
      "metrics": [
        { "date": "20260213", "count": 45, "uniqueUsers": 22 },
        { "date": "20260214", "count": 78, "uniqueUsers": 35 }
      ]
    }
  ]
}

Below the privacy threshold

{ "richMenuId": "richmenu-0123456789abcdef0123456789abcdef" }

[CLAassistant]

All committers have signed the CLA.

[github-actions]

JAVA

You can check generated code in java

Check the diff here

[github-actions]

NODEJS

You can check generated code in nodejs

Check the diff here

[github-actions]

PHP

You can check generated code in php

Check the diff here

[github-actions]

PYTHON

You can check generated code in python

Check the diff here

[github-actions]

GO

You can check generated code in go

Check the diff here

[github-actions]

RUBY

You can check generated code in ruby

Check the diff here