Get statistics of sent messages

With the Messaging API, you can get statistics on how users interact with messages sent from a LINE Official Account. How you get statistics depends on the type of message you send.

• Statistics for messages sent to all friends or to friends selected using audiences or attributes
  • Broadcast messages
  • Narrowcast messages
• Statistics for messages sent by specifying particular friends, group chats, or phone numbers
  • Push messages
  • Multicast messages
  • LINE notification messages

Statistics for messages sent to all friends or to friends selected using audiences or attributes

You can get statistics for each send request on how users interact with narrowcast messages or broadcast messages. For more information, see Get user interaction statistics in the Messaging API reference.

Statistics for messages sent by specifying particular friends, group chats, or phone numbers

You can get statistics per unit on how users interact with push messages, multicast messages, or LINE notification messages.

Normally, you can't get statistics about actions that users perform on push messages, multicast messages, and LINE notification messages, such as opening a message or tapping a URL, to protect user privacy. However, it is possible to get statistics by aggregating into units you define and making it impossible to identify individuals.

As illustrated below, you can get statistics for each unit by assigning a unit name and sending a message.

Statistics per unit

You can get the following statistics per unit about your messages:

• Number of users who opened the message
• Number of users who opened any URL in the message
• Number of users who started playing any video or audio in the message

By getting message statistics, you can see what users have done with the messages you sent. By using such statistics, the following information can be checked:

Example using the obtained statistics

Notes on aggregated statistics

The statistical data may contain some errors. To protect users' privacy, the values of some properties related to user interactions will be displayed as null in these cases:

• The value of the aggregated statistics is less than 20.
• Even if the value of the aggregated statistics is higher than or equal to 20, the actual number of users who generated the event is less than 20.
  • For example, if the number of times the video has been started is 30, but the number of users who have started the video is 15, both will be displayed as null.

The response from the Get statistics per unit endpoint doesn't include either the number of messages sent or the number of recipients. Also, overview.uniqueImpression is the number of unique users who opened a message at least once during the aggregation period. Therefore, you can't use this response alone to calculate an open rate with the number of messages sent as the denominator or a reach rate with the number of recipients as the denominator.

Assign a unit name

To get statistics, assign an aggregation unit name when you send a push message, multicast message, or LINE notification message. Specify the name in the customAggregationUnits property of the request body. You can only specify one unit name when you send a message. For the specification on sending push messages or multicast messages, see Message in the Messaging API reference.

Here is an example request to assign an aggregation unit name, promotion_a, on a push message:

curl -v -X POST https://api.line.me/v2/bot/message/push \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer {channel access token}' \
-d '{
    "to": "U4af4980629...",
    "messages":[
        {
            "type": "text",
            "text": "Hello, world1"
        }
    ],
    "customAggregationUnits": [
        "promotion_a"
    ]
}'

Maximum number of unit name types

During the current month (from the 1st to the last day of the month), you can assign up to 1,000 different unit names when sending messages.

For example, if you send messages in March with 1,000 unit name types from promotion_0001 to promotion_1000, you can send messages in the next month (April) with the same 1,000 unit name types from promotion_0001 to promotion_1000. It is also possible to send messages with 1,000 new unit name types, from promotion_1001 to promotion_2000, in the next month (April).

Note that if you send messages with a 1,001st or subsequent type of unit name, the messages themselves will be sent, but those unit names won't be assigned. For example, if you send messages with 1,500 types of unit names from promotion_0001 to promotion_1500, unit names from promotion_1001 onward won't be assigned to the messages.

If you have many types of unit names, confirm that unit names can be assigned or have been assigned using one of the following methods:

• Before sending a message, use the Get the number of unit name types assigned during this month endpoint to confirm that the number of unit names for the current month has not yet reached 1,000
• After sending a message, use the Get a list of unit names assigned during this month endpoint to confirm that the assigned unit name exists

Statistics for push messages, multicast messages, LINE notification messages (template), and LINE notification messages (flexible) sent with the same unit name are aggregated together. The monthly number of unit name types is calculated by counting unique unit names across all of these sending methods.

Get statistics per unit

You can get user interaction statistics for messages sent with unit names by using the Get statistics per unit endpoint. Here is an example request to get statistics of a unit named promotion_a:

curl -v -X GET https://api.line.me/v2/bot/insight/message/event/aggregation \
-H 'Authorization: Bearer {channel access token}' \
--data-urlencode 'customAggregationUnit=promotion_a' \
--data-urlencode 'from=20210301' \
--data-urlencode 'to=20210331' \
-G

In addition, you can get a list of unit names assigned during this month by using the Get a list of unit names assigned during this month endpoint. There is no endpoint to check unit names assigned before the current month.

Example of getting statistics of a message containing a URL

The following steps show how to get statistics per unit for a message containing a URL:

1. Send a message by assigning a unit name

First, send a message with the same content to multiple users.

Suppose we want to send the message to 150 users using multicast messages. The unit name is then specified in the customAggregationUnits property.

curl -v -X POST https://api.line.me/v2/bot/message/multicast \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer {channel access token}' \
-d '{
    "to": ["U4af4980629...","U0c229f96c4...",...], // 150 user IDs
    "messages":[
        {
            "type": "text",
            "text": "🆕 Our new product is available now!\nhttps://example.com/new-item/"
        }
    ],
    "customAggregationUnits": [
        "new-item-message-yyyymmdd"
    ]
}'

2. Get and aggregate statistics

Wait a few days after sending the message to get statistics per unit.

curl -v -X GET https://api.line.me/v2/bot/insight/message/event/aggregation \
-H 'Authorization: Bearer {channel access token}' \
--data-urlencode 'customAggregationUnit=new-item-message-yyyymmdd' \
--data-urlencode 'from=20210301' \
--data-urlencode 'to=20210331' \
-G

In this example, the following statistics can be obtained:

{
  "overview": {
    "uniqueImpression": 111,
    "uniqueClick": 74,
    "uniqueMediaPlayed": null,
    "uniqueMediaPlayed100Percent": null
  },
  "messages": [
    {
      "seq": 1,
      "impression": 111,
      "uniqueImpression": 111,
      "mediaPlayed": null,
      "mediaPlayed25Percent": null,
      "mediaPlayed50Percent": null,
      "mediaPlayed75Percent": null,
      "mediaPlayed100Percent": null,
      "uniqueMediaPlayed": null,
      "uniqueMediaPlayed25Percent": null,
      "uniqueMediaPlayed50Percent": null,
      "uniqueMediaPlayed75Percent": null,
      "uniqueMediaPlayed100Percent": null
    }
  ],
  "clicks": [
    {
      "seq": 1,
      "url": "https://example.com/new-item/",
      "click": 74,
      "uniqueClick": 74,
      "uniqueClickOfRequest": 74
    }
  ]
}

You can use this information to check message open rates, URL tap rates, etc.