Receipt log

Workflow

Configure push receipt event collection

1. Activate Log Service

   Log on to the Log Service console and activate Log Service.

   Note

   The receipt log feature delivers data to Log Service through flow logs. This process incurs fees for both flow log generation and Log Service usage. For more information, see Flow Log Billing and Billable Items for Pay-As-You-Go.

2. Log on to the EMAS console and select the Mobile Push product.

3. On the Mobile Push product page, in the left-side navigation pane, go to Data Statistics > Receipt Log to open the receipt log page.

4. Click Configure Log Audit Service to go to the Global Settings page of Log Audit Service.

5. On the Global Settings page, configure the following parameters:

   1. In the Region of central project section, select the destination region for centralized log storage.

   2. Configure authorization for data collection and synchronization.

      Select Authorize with AccessKey, enter your AccessKey information, and then click Authorize. Your AccessKey is used only for temporary authorization and is not stored.

      After successful authorization, the message The current account is authorized to collect and sync logs for Log Service appears.

   3. In the list of cloud products, find the Mobile Push row, turn on the Push Receipt Event switch, and configure the retention period.

      

   4. Click Save.

      Wait 1 minute for the configuration to take effect. Then, return to the Receipt Log page and refresh it. For more information about configuring Log Audit Service, see Log Audit Service Overview.

Query receipt logs

1. Return to the main Receipt Log page.

2. Click Query to go to the Log Search page.

3. Select a time range to filter the receipt logs.

4. In the search box, enter a query and analysis statement and click Query/Analysis to view the results. For sample queries, see the Sample log query statements section in this topic.

5. The following table describes the fields in a receipt log.

   Field	Description
   __time__	The event time. Example: 2018-02-27 11:58:15.
   __topic__	The topic, which is fixed to cps_callback_event.
   app_key	The AppKey of your application.
   message_id	The message ID. Example: 868947123456789.
   event_time	The time of the push receipt event. Example: 2020-03-02 11:04:51.
   event_type	The type of the push receipt event. Valid values: sent: The message was sent through the proprietary channel or a third-party channel. sent_fail: The message failed to send. This event logs synchronous error information returned by the channel. arrive: The message was successfully delivered. arrive_fail: The message failed to be delivered. This event logs asynchronous error information returned as a receipt by a third-party channel. If the third-party channel does not support receipts, no arrive_fail log is generated. ext_ack: A receipt for an iOS extended notification. To enable this feature, see iOS Extension SDK Integration. click: The notification was clicked. This event depends on reports from the device and the third-party channel. clean: The notification was cleared. This event depends on reports from the device and the third-party channel. Note Currently, offline delivery through the proprietary channel does not generate a sent log. The arrive, click, and clean events depend on reports from the device or third-party channel. Some channels, such as APNs, do not support this reporting mechanism. iOS notifications are delivered to Apple's APNs servers. Because APNs does not return arrive receipts, no arrive receipt information is generated when you use the APNs third-party channel. For iOS clean events, ensure that you have configured them correctly. For more information, see Configure reporting for iOS notification deletion.
   device_id	The device ID. Example: 96d7c9db01ccxxxxxxxxxxxxxxxxxxxx.
   device_type	The device type. Example: ANDROID, iOS, or HarmonyOS.
   last_active_time	The last active time of the device. Example: 2025-01-31 11:58:02.
   app_version	The application version. Example: 5.20.
   client_ip	The client IP address.
   brand	The device brand. Example: vivo.
   network_type	The device network type. Example: WIFI.
   os	The device operating system. Example: Android.
   os_version	The device operating system version or API level. Example: 34.
   isp	The device's carrier. Example: China Unicom.
   job_key	The custom identifier for the push task. This field is included in the receipt log if the JobKey parameter was not empty in the push request. Example: 123.
   event_channel	The sending channel. Possible values include accs, huawei, honor, xiaomi, oppo, vivo, meizu, gcm, fcm, and apns. More channel types may be added in the future.
   vendor_message_id	The message ID from the third-party channel.
   reason	The reason for a send or delivery failure. The format is typically code#msg, where code is the error code from the third-party channel and msg is an error description or an HTTP status code. For more details, look up the code in the third-party channel's documentation.
   owner_id	The UID of the primary Alibaba Cloud account.

Message receipt analysis

1. Return to the main Receipt Log page.

2. Click Analyze to go to the Android message receipt analysis/iOS message receipt analysis page.

3. Enter an app_key to filter the analysis results.

4. The following information is displayed in the receipt analysis:

   Parameter	Description
   Source IP distribution	Displays the IP address distribution of all receipts within the selected time range.
   Total count	Displays the total number of all receipts within the selected time range.
   Delivered count	The total number of messages delivered to devices. Android: The total number of messages received by all devices. Both proprietary and third-party channels for Android provide delivery receipts. The delivered count is the sum of all arrive receipts. iOS: iOS notifications are delivered to Apple's APNs servers. A message is considered delivered as long as the APNs server does not return an error. HarmonyOS: The total number of messages received by all devices. Both proprietary and third-party channels for HarmonyOS provide delivery receipts. The delivered count is the sum of all arrive receipts.
   Click count	The number of times users clicked notifications or messages delivered to devices. This is calculated by counting all receipts where event_type is click.
   Receipt trend	The trend for the count of each receipt type.
   Brand distribution	The brand distribution of devices that successfully received pushes.
   Carrier distribution	The carrier distribution of devices that successfully received pushes.
   OS distribution	The operating system distribution of devices that successfully received pushes.
   OS version distribution	The operating system version distribution of devices that successfully received pushes.

Sample log query statements

device_type:iOS and event_type:click| 
SELECT COUNT(1) AS "Today's Clicks" FROM log 

device_type:iOS and (event_type:sent or event_type:ext_ack or event_type:click) | 
SELECT
  event_type,
  COUNT(1) AS cnt
FROM  log
GROUP BY
  event_type
ORDER BY   cnt DESC

device_type:iOS| 
SELECT
  SUM(
    CASE
      WHEN event_type = 'ext_ack' THEN 1
      ELSE 0
    END
  ) * 1.0 
  / 
  SUM(
    CASE
      WHEN event_type = 'sent' THEN 1
      ELSE 0
    END
  ) AS "Extended Delivery Rate"

device_type:iOS| 
SELECT
  date_trunc('day', __time__) AS ts_day,
  SUM(CASE WHEN event_type = 'ext_ack' THEN 1 ELSE 0 END) * 1.0 /
  NULLIF(SUM(CASE WHEN event_type = 'sent'   THEN 1 ELSE 0 END), 1) AS "Extended Delivery Rate"
GROUP BY
  ts_day
ORDER BY
  ts_day

device_type: Android | 
SELECT
  event_channel AS channel,
  COUNT(1) AS cnt
FROM log
GROUP BY
  event_channel
ORDER BY
  cnt DESC

device_type: ANDROID AND event_channel: accs| 
SELECT
  date_trunc('hour', __time__) AS ts_hour,
  COUNT(*) AS "Click Count"
GROUP BY
  ts_hour
ORDER BY
  ts_hour

device_type: Android and (event_type:sent or event_type:arrive or event_type:click) | 
SELECT
  event_type,
  COUNT(1) AS cnt
FROM  log
GROUP BY
  event_type
ORDER BY
  cnt DESC