สถิติ In-app

มีสองเมธอดที่ใช้ดึงสถิติสำหรับแคมเปญ In-app แบบทันที ใช้ inapps:totals สำหรับผลรวมในช่วงเวลาของหนึ่งแคมเปญหรือมากกว่า และ inapps:timeline สำหรับอนุกรมเวลาของแคมเปญเดียว ค่าต่างๆ จะตรงกับหน้าจอสถิติ In-app ใน Control Panel

เมตริก

ฟิลด์	ประเภท	คำอธิบาย
`impressions`	number	จำนวนครั้งที่ In-app ถูกแสดงผล มีป้ายกำกับว่า Impressions ใน Control Panel
`unique_impressions`	number	จำนวนอุปกรณ์ที่ไม่ซ้ำกันที่ In-app ถูกแสดงผล
`interactions`	number	การโต้ตอบกับเนื้อหา In-app: การคลิกปุ่ม, การคลิกลิงก์ และการส่งฟอร์ม
`unique_interactions`	number	จำนวนอุปกรณ์ที่ไม่ซ้ำกันที่โต้ตอบกับ In-app
`skips`	number	จำนวนครั้งที่ผู้ใช้ปิด In-app โดยไม่มีการโต้ตอบ
`audience`	number	จำนวนอุปกรณ์ที่ไม่ซ้ำกันที่สร้างเหตุการณ์ In-app ใดๆ ในช่วงเวลาดังกล่าว

inapps:totals

ส่งคืนผลรวมสำหรับช่วงเวลาที่กำหนด ส่ง inapp_codes เพื่อรายงานแคมเปญที่ระบุ หรือละเว้นเพื่อตรวจสอบทุก In-app ของแอปพลิเคชันทีละหน้า นี่คือเมธอดที่ใช้สำหรับการส่งออกตามกำหนดเวลา

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

ส่วนหัว (Headers)

ชื่อ	จำเป็น	คำอธิบาย
`Authorization`	Yes	Server API token ในรูปแบบ `Authorization: Api <Server Key>`

พารามิเตอร์ของเนื้อหาคำขอ (Request body)

ชื่อ	จำเป็น	ประเภท	คำอธิบาย
`application`	Yes	String	Application code
`date_range`	Yes	Object	ช่วงเวลาการรายงาน `date_from` และ `date_to` ใช้รูปแบบ `YYYY-MM-DD` และรวมวันนั้นด้วย ช่วงเวลาจะนับเป็น UTC และต้องไม่เกิน 366 วัน
`inapp_codes`	No	Array	In-app codes สูงสุด 100 รายการต่อคำขอ ละเว้นเพื่อรายงาน In-app ทั้งหมดของแอปพลิเคชัน หากรหัสใดในรายการไม่ได้เป็นของแอปพลิเคชัน คำขอทั้งหมดจะล้มเหลวด้วยรหัส `404`
`platforms`	No	Array	จำกัดเมตริกเฉพาะแพลตฟอร์มเหล่านี้ ค่าที่เป็นไปได้: `"IOS"`, `"ANDROID"`, `"HUAWEI_ANDROID"`, `"AMAZON"`, `"OSX"`, `"WINDOWS"`, `"SAFARI"`, `"CHROME"`, `"FIREFOX"`, `"WEB"`
`with_platforms`	No	Boolean	เพิ่มการแบ่งย่อยตามแพลตฟอร์มให้กับทุกรายการ
`page`	No	Integer	หมายเลขหน้า เริ่มต้นที่ `0` ใช้เมื่อละเว้น `inapp_codes`
`per_page`	No	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 คือจำนวน In-app ที่ตรงกับคำขอ เมื่อละเว้น inapp_codes จะหมายถึง In-app ทั้งหมดของแอปพลิเคชัน ดังนั้นจึงสามารถใช้การแบ่งหน้าเพื่อตรวจสอบได้ 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

ส่งคืนผลรวมในช่วงเวลาและอนุกรมเวลาสำหรับแคมเปญ In-app หนึ่งแคมเปญ

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

พารามิเตอร์ของเนื้อหาคำขอ (Request body)

ชื่อ	จำเป็น	ประเภท	คำอธิบาย
`application`	Yes	String	Application code
`inapp_code`	Yes	String	In-app code
`date_range`	Yes	Object	ช่วงเวลาการรายงาน `date_from` และ `date_to` ใช้รูปแบบ `YYYY-MM-DD` และรวมวันนั้นด้วย ช่วงเวลาจะนับเป็น UTC และต้องไม่เกิน 366 วัน `interval` ที่เลือกได้: `"HOUR"`, `"DAY"` (ค่าเริ่มต้น), `"WEEK"` หรือ `"MONTH"` `"HOUR"` สามารถใช้ได้สำหรับช่วงเวลาสูงสุด 31 วัน
`platforms`	No	Array	จำกัดเมตริกเฉพาะแพลตฟอร์มเหล่านี้
`with_platforms`	No	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 จะจัดกลุ่มระยะเวลาที่ In-app แสดงอยู่บนหน้าจอ ในกลุ่มสุดท้าย to_seconds จะเป็น 0 ซึ่งหมายถึง “30 วินาทีขึ้นไป”

การจำกัดความถี่ (Frequency capping)

บล็อก frequency_capping จะรายงานการแสดงผล In-app ที่ถูกป้องกันโดย frequency capping และจำนวนผู้ใช้ที่ไม่ซ้ำกันที่ได้รับผลกระทบ การระงับจะไม่ถูกนับใน impressions

การระงับไม่ถูกบันทึกก่อนวันดังกล่าว สำหรับช่วงเวลาที่สิ้นสุดก่อนหน้านั้น บล็อก frequency_capping จะส่งคืนค่าเป็น null แทนที่จะเป็นศูนย์ ดังนั้นการไม่มีข้อมูลจะไม่ถูกเข้าใจผิดว่าเป็นการจำกัดความถี่ที่ไม่ได้ระงับอะไรเลย data_available_from ในการตอบกลับจะระบุวันแรกที่ครอบคลุม การจำกัดความถี่ไม่มีการแบ่งย่อยตามแพลตฟอร์ม

การเก็บรักษาข้อมูล

สถิติจะถูกเก็บไว้เป็นเวลา 365 วัน ดังนั้นช่วงเวลาที่เริ่มต้นก่อนหน้านั้นจะไม่มีข้อมูลสำหรับวันที่ไม่ครอบคลุม

รหัสการตอบกลับ

รหัส	ความหมาย
200	สำเร็จ
400	คำขอไม่ถูกต้อง: `date_range` หายไปหรือมีรูปแบบไม่ถูกต้อง, ช่วงเวลานานกว่า 366 วัน, ช่วงเวลารายชั่วโมงนานกว่า 31 วัน, หรือมี `inapp_codes` มากกว่า 100 รายการ
401	API token หายไปหรือไม่ถูกต้อง
404	ไม่พบรหัส In-app ในแอปพลิเคชันนี้