应用内消息统计

有两种方法可以返回即时应用内消息营销活动的统计数据。使用 inapps:totals 获取一个或多个营销活动在某一时段内的总数，使用 inapps:timeline 获取单个营销活动的时间序列数据。这些值与 Control Panel 中的应用内消息统计屏幕相匹配。

从 Journey 发送的应用内消息

这些方法仅涵盖即时应用内消息营销活动。由 Customer Journey 元素发送的应用内消息，其报告由 Get Journey stats 按 Journey 节点提供。

指标

字段	类型	描述
impressions	number	应用内消息被展示的次数。在 Control Panel 中标记为 Impressions。
unique_impressions	number	应用内消息被展示到的独立设备数量。
interactions	number	与应用内消息内容的互动：按钮点击、链接点击和表单提交。
unique_interactions	number	与应用内消息互动的独立设备数量。
skips	number	用户在未互动的情况下关闭应用内消息的次数。
audience	number	在指定时段内产生任何应用内消息事件的独立设备数量。

注意

独立指标和 audience 是近似值，因为它们使用了概率性去重计数。各平台的数据加总不等于营销活动的总数：一个在两个平台上都出现的设备，在每个平台的细分数据中各计一次，在营销活动总数中计一次。

inapps:totals

返回指定时段内的总数。传递 inapp_codes 以报告特定营销活动，或省略该参数以逐页遍历应用的所有应用内消息。这是用于计划性导出的方法。

POST https://api.pushwoosh.com/api/v2/statistics/inapps:totals

Headers

名称	必需	描述
Authorization	是	Server API token，格式为 Authorization: Api <Server Key>。

请求体参数

名称	必需	类型	描述
application	是	String	Application code。
date_range	是	Object	报告时段。date_from 和 date_to 使用 YYYY-MM-DD 格式，且包含起止日期。时段以 UTC 计算，且不得超过 366 天。
inapp_codes	否	Array	In-app codes，每次请求最多 100 个。省略此参数则报告该应用的所有应用内消息。如果列表中的任何代码不属于该应用，整个请求将以 404 失败。
platforms	否	Array	将指标限制在这些平台。可能的值："IOS"、"ANDROID"、"HUAWEI_ANDROID"、"AMAZON"、"OSX"、"WINDOWS"、"SAFARI"、"CHROME"、"FIREFOX"、"WEB"。
with_platforms	否	Boolean	为每个项目添加按平台的细分数据。
page	否	Integer	页码，从 0 开始。当省略 inapp_codes 时适用。
per_page	否	Integer	每页项目数，默认为 20，最多为 100。

请求示例

curl -X POST https://api.pushwoosh.com/api/v2/statistics/inapps:totals \
  -H "Authorization: Api YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "application": "XXXXX-XXXXX",
    "date_range": {
      "date_from": "2026-07-01",
      "date_to": "2026-07-31"
    },
    "inapp_codes": ["AAAAA-BBBBB"],
    "with_platforms": true
  }'

响应字段

total 是请求匹配的应用内消息数量。当省略 inapp_codes 时，这是应用的所有应用内消息，因此可以通过分页遍历。items 包含当前页的数据。page 从 0 开始计数。

响应示例

{
  "total": 1,
  "page": 0,
  "per_page": 20,
  "items": [{
    "inapp": {
      "code": "AAAAA-BBBBB",
      "name": "Summer sale",
      "status": "active",
      "rich_media_code": "CCCCC-DDDDD"
    },
    "metrics": {
      "impressions": 15230,
      "unique_impressions": 9120,
      "interactions": 2311,
      "unique_interactions": 1980,
      "skips": 640,
      "audience": 9120
    },
    "platforms": [{
      "platform": "IOS",
      "metrics": {
        "impressions": 8100,
        "unique_impressions": 4900,
        "interactions": 1300,
        "unique_interactions": 1120,
        "skips": 310,
        "audience": 4900
      }
    }],
    "frequency_capping": {
      "suppressions": 45,
      "affected_users": 30,
      "data_available_from": "2026-07-17"
    }
  }]
}

inapps:timeline

返回一个应用内消息营销活动在指定时段内的总数和时间序列数据。

POST https://api.pushwoosh.com/api/v2/statistics/inapps:timeline

请求体参数

名称	必需	类型	描述
application	是	String	Application code。
inapp_code	是	String	In-app code。
date_range	是	Object	报告时段。date_from 和 date_to 使用 YYYY-MM-DD 格式，且包含起止日期。时段以 UTC 计算，且不得超过 366 天。可选的 interval："HOUR"、"DAY"（默认）、"WEEK" 或 "MONTH"。"HOUR" 适用于不超过 31 天的时段。
platforms	否	Array	将指标限制在这些平台。
with_platforms	否	Boolean	为总数和每一行添加按平台的细分数据。

请求示例

curl -X POST https://api.pushwoosh.com/api/v2/statistics/inapps:timeline \
  -H "Authorization: Api YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "application": "XXXXX-XXXXX",
    "inapp_code": "AAAAA-BBBBB",
    "date_range": {
      "date_from": "2026-07-01",
      "date_to": "2026-07-07",
      "interval": "DAY"
    }
  }'

响应示例

{
  "inapp": {
    "code": "AAAAA-BBBBB",
    "name": "Summer sale",
    "status": "active",
    "rich_media_code": "CCCCC-DDDDD"
  },
  "totals": {
    "impressions": 15230,
    "unique_impressions": 9120,
    "interactions": 2311,
    "unique_interactions": 1980,
    "skips": 640,
    "audience": 9120
  },
  "frequency_capping": {
    "suppressions": 45,
    "affected_users": 30,
    "data_available_from": "2026-07-17"
  },
  "rows": [{
    "timestamp": "2026-07-01T00:00:00Z",
    "metrics": {
      "impressions": 2140,
      "unique_impressions": 1700,
      "interactions": 320,
      "unique_interactions": 290,
      "skips": 95,
      "audience": 1700
    }
  }],
  "impression_duration": [
    { "from_seconds": 0, "to_seconds": 5, "count": 3200 },
    { "from_seconds": 5, "to_seconds": 15, "count": 5400 },
    { "from_seconds": 15, "to_seconds": 30, "count": 4100 },
    { "from_seconds": 30, "to_seconds": 0, "count": 2530 }
  ]
}

impression_duration 按应用内消息在屏幕上停留的时长进行分桶。在最后一个分桶中，to_seconds 为 0，表示“30 秒及以上”。

频率上限

frequency_capping 块报告了被频率上限阻止的应用内消息展示次数，以及受影响的独立用户数量。被阻止的展示不计入 impressions。

阻止数据从 2026 年 7 月 17 日开始记录

在此日期之前，被阻止的展示未被记录。对于在此之前结束的时段，frequency_capping 块将返回 null 而不是零，这样就不会将数据缺失误认为是频率上限未阻止任何展示。响应中的 data_available_from 指明了数据覆盖的起始日期。频率上限没有按平台的细分数据。

数据保留

统计数据保留 365 天，因此对于起始日期更早的时段，未覆盖的天数将不返回数据。

响应代码

代码	含义
200	成功。
400	无效请求：date_range 缺失或格式错误、时段超过 366 天、按小时间隔的时段超过 31 天，或 inapp_codes 超过 100 个。
401	API 令牌缺失或无效。
404	在此应用中未找到应用内消息代码。