สถิติข้อความ

messages:list

แสดงรายการข้อความที่ส่งไปแล้ว

POST https://api.pushwoosh.com/api/v2/messages:list

Headers

ชื่อ	จำเป็น	คำอธิบาย
`Authorization`	ใช่	Server API token ต้องระบุในรูปแบบต่อไปนี้: `Authorization: Api <Server Key>`

พารามิเตอร์ใน Request body

ชื่อ	จำเป็น	ประเภท	คำอธิบาย
`platforms`	ไม่	Array	แพลตฟอร์มข้อความ ค่าที่เป็นไปได้: `"IOS"`, `"ANDROID"`, `"OSX"`, `"WINDOWS"`, `"AMAZON"`, `"SAFARI"`, `"CHROME"`, `"FIREFOX"`, `"IE"`, `"EMAIL"`, `"HUAWEI_ANDROID"`, `"SMS"`
`date_range`	ไม่	Object	ช่วงเวลาการรายงาน กรองตามวันที่สร้างข้อความ `date_from` และ `date_to` ต้องเป็นไปตามรูปแบบ `YYYY-MM-DD` (เช่น `"2000-01-01"`) โดยจะรวมทั้งสองวันเต็มวัน ดังนั้นหากตั้งค่า `date_from` และ `date_to` เป็นวันเดียวกัน จะได้ผลลัพธ์ของทั้งวันนั้น
`campaign`	ไม่	String	รหัสแคมเปญ (Campaign code)
`filters`	ใช่	Object	ตัวกรองข้อความ
`source`	ไม่	String	แหล่งที่มาของข้อความ ตัวอย่างเช่น: `AB_TEST`, `API`, `AUTO_PUSH`, `CP`, `CSV`, `CUSTOMER_JOURNEY`, `EMAIL_API`, `EMAIL_CP`, `GEO_ZONE`, `PUSH_ON_EVENT`, `RSS`
`messages_codes`	ไม่	Array	รหัสข้อความ (Message codes) ที่ได้รับจากการตอบกลับของ API `/createMessage`
`messages_ids`	ไม่	Array	ID ข้อความที่ได้รับจากประวัติข้อความ (Message History)
`params`	ไม่	Object	ระบุว่าจะแสดงรายละเอียดและเมตริกของข้อความหรือไม่ ตั้งค่า `with_details: true` เพื่อรวมอ็อบเจกต์ `"details"` และ `with_metrics: true` เพื่อรวมอ็อบเจกต์ `"metrics"` ในการตอบกลับ
`application`	ใช่	String	รหัสแอปพลิเคชัน Pushwoosh
`per_page`	ไม่	Integer	จำนวนผลลัพธ์ต่อหน้า, `1` ถึง `499` หากไม่ระบุพารามิเตอร์นี้ จะใช้ขนาดหน้าเริ่มต้นที่ 500 ผลลัพธ์ การส่งค่า `500` หรือมากกว่าจะถูกปฏิเสธด้วยรหัส `400`
`page`	ไม่	Integer	หมายเลขหน้าสำหรับการแบ่งหน้า (pagination) โดยเริ่มจากศูนย์ ดูขีดจำกัดการแบ่งหน้าแบบลึกด้านล่าง

messages:list จะปฏิเสธคำขอที่ page × per_page เกิน 100,000 ผลลัพธ์ ให้จำกัด date_range ให้แคบลงหรือใช้ per_page ที่น้อยลงเพื่อให้อยู่ในขีดจำกัด

total คือจำนวนข้อความที่ตรงกับตัวกรองที่แน่นอนตราบใดที่จำนวนนั้นอยู่ที่หรือต่ำกว่า 100,000 และจะหยุดที่ 100001 หากเกินกว่านั้น ซึ่งมากกว่าที่ endpoint นี้จะสามารถแบ่งหน้าได้ อย่าสร้างลูปการแบ่งหน้าเกินขีดจำกัดนั้น: หน้าที่เกินขีดจำกัดจะถูกปฏิเสธ ไม่ใช่หน้าว่าง หากต้องการดึงข้อมูลในช่วงเวลาที่มีข้อความมากกว่านั้น ให้จำกัด date_range ในแต่ละคำขอให้แคบลง หรือใช้ การส่งออกข้อมูลแบบอะซิงโครนัส (asynchronous export) ซึ่งจะเขียนข้อมูลทั้งหมดในช่วงเวลาลงในไฟล์ CSV ไฟล์เดียวโดยไม่ต้องแบ่งหน้า

ตัวอย่างคำขอ

{
    "filters": {
      "platforms": [],                  // IOS, ANDROID, OSX, WINDOWS, AMAZON, SAFARI, CHROME, FIREFOX, IE, EMAIL, HUAWEI_ANDROID, SMS
      "date_range": {
        "date_from": "string",          // รูปแบบที่ต้องการ: 2000-01-01
        "date_to": "string"             // รูปแบบที่ต้องการ: 2000-01-01
      },
      "source": "API",                  // AB_TEST, API, AUTO_PUSH, CP, CSV, CUSTOMER_JOURNEY, EMAIL_API, EMAIL_CP, GEO_ZONE, PUSH_ON_EVENT, RSS
      "campaign": "string",             // รหัสแคมเปญ
      "messages_ids": [],               // ID ข้อความ
      "messages_codes": [],             // รหัสข้อความ
      "application": "string"           // รหัสแอปพลิเคชัน Pushwoosh
    },
    "params": {
      "with_details": true,             // เพิ่มรายละเอียดข้อความในการตอบกลับ (อ็อบเจกต์ "details")
      "with_metrics": true              // เพิ่มเมตริกข้อความในการตอบกลับ (อ็อบเจกต์ "metrics")
    },
    "per_page": 20,                     // <= 499
    "page": 0
}

รหัสการตอบกลับและตัวอย่าง

{
  "total": 0,
  "items": [{
    "id": 0,
    "code": "string",
    "created_date": "string",
    "send_date": "string",
    "status": "string",
    "platforms": [],
    "source": "string",
    "push_info": {
      "details": {
        "title": "string",
        "filter_name": "string",
        "filter_code": "string",
        "content": {
          "key": "value"
        },
        "platform_parameters": {
          "android_header": "string",
          "android_root_params": {
            "key": "value"
          },
          "ios_title": "string",
          "ios_subtitle": "string",
          "ios_root_params": {
            "key": "value"
          },
          "chrome_header": "string",
          "chrome_root_params": {
            "key": "value"
          },
          "firefox_header": "string",
          "firefox_root_params": {
            "key": "value"
          },
          "conditions": [               // เงื่อนไขแท็ก (ดู /developer/api-reference/messages-api/#tag-conditions)
            TAG_CONDITION1,
            TAG_CONDITION2,
            ...,
            TAG_CONDITIONN
          ],
          "conditions_operator": "AND", // ตัวดำเนินการตรรกะสำหรับอาร์เรย์เงื่อนไข; ค่าที่เป็นไปได้: AND, OR
          "data": {
            "key": "value"
          }
        },
        "follow_user_timezone": true
      },
      "metrics": [{
        "sends": 0,
        "opens": 0,
        "deliveries": 0,
        "inbox_opens": 0,
        "unshowable_sends": 0,
        "errors": 0,
        "platform": 0
      }]
    },
    "email_info": {
      "details": {
        "template": "string",
        "filter_name": "string",
        "filter_code": "string",
        "subject": {
          "key": "value"
        },
        "from_name": "string",
        "from_email": "string",
        "reply_name": "string",
        "reply_email": "string",
        "follow_user_timezone": true,
        "conditions": [              // เงื่อนไขแท็ก (ดู Messages-api - tag-conditions)
          TAG_CONDITION1,
          TAG_CONDITION2,
          ...,
          TAG_CONDITIONN
        ],
        "conditions_operator": "AND" // ตัวดำเนินการตรรกะสำหรับอาร์เรย์เงื่อนไข; ค่าที่เป็นไปได้: AND, OR
      },
      "metrics": [{
        "sends": 0,
        "opens": 0,
        "deliveries": 0,
        "hard_bounces": 0,
        "soft_bounces": 0,
        "rejects": 0,
        "confirmed_sends": 0,
        "unsubs": 0,
        "complaints": 0,
        "errors": 0
      }]
    }
  }]
}

date_range ครอบคลุมมากกว่า 30 วัน:

{
  "error": "exceeded the maximum date interval. Max interval: 30 days"
}

page × per_page เกินขีดจำกัดการแบ่งหน้าแบบลึก:

{
  "error": "requested result window is too large, narrow the date range"
}

{
  "error": "account not found"
}

totalsByIntervals

ส่งคืนข้อมูลเมตริกและคอนเวอร์ชันตามรหัสข้อความ โดยรวบรวมเป็นรายชั่วโมง

POST https://api.pushwoosh.com/api/v2/statistics/messages/totalsByIntervals

การให้สิทธิ์ (Authorization)

การให้สิทธิ์ (Authorization) จะจัดการผ่าน API Access Token ในเฮดเดอร์ของคำขอ

พารามิเตอร์ใน Request body

ชื่อพารามิเตอร์	ประเภท	คำอธิบาย	จำเป็น
`message_code`	string	รหัสข้อความ (Message code) ที่ได้รับจากการตอบกลับของ API `/createMessage`	ใช่
`platforms`	[int]	แพลตฟอร์ม	ไม่

ตัวอย่างคำขอ

{
  "message_code": "XXXXX-XXXXXXXXX-XXXXXXXX", // จำเป็น ตัวระบุข้อความที่ไม่ซ้ำกัน
  "platforms": [1, 3, 7, 10, 11, 12]          // ไม่จำเป็น รายการรหัสแพลตฟอร์ม
}

ฟิลด์การตอบกลับ

ชื่อ	ประเภท	คำอธิบาย
`metrics`	array	ประกอบด้วยอาร์เรย์ของเมตริกข้อความ
`timestamp`	string	เวลาของเมตริก
`platform`	int	รหัสแพลตฟอร์ม (เช่น iOS, Android)
`sends`	string	จำนวนข้อความที่ส่ง
`opens`	string	จำนวนข้อความที่เปิด
`deliveries`	string	จำนวนข้อความที่ส่งมอบแล้ว
`inbox_opens`	string	จำนวนการเปิดในกล่องข้อความ
`unshowable_sends`	string	จำนวนข้อความที่ส่งแล้วแต่ไม่สามารถแสดงได้
`errors`	string	จำนวนข้อผิดพลาด
`conversion`	object	ประกอบด้วยข้อมูลคอนเวอร์ชัน
`sends`	string	จำนวนข้อความที่ส่งทั้งหมด
`opens`	string	จำนวนข้อความที่เปิดทั้งหมด
`events`	array	อาร์เรย์ของอีเวนต์พร้อมสถิติ
`name`	string	ชื่อของอีเวนต์ (เช่น cart add)
`hits`	string	จำนวนครั้งที่เกิดขึ้น (hits)
`conversion`	float	อัตราคอนเวอร์ชันเทียบกับการเปิด
`revenue`	float	รายได้ (เฉพาะสำหรับอีเวนต์ที่มีแอตทริบิวต์ `__amount` และ `__currency`)

ตัวอย่างการตอบกลับ

{
  "metrics": [{
    "timestamp": "2024-08-03 15:00:00",  // ประทับเวลาของเมตริกในรูปแบบ "YYYY-MM-DD HH:MM:SS"
    "platform": 3,                       // รหัสแพลตฟอร์ม
    "sends": "55902",                    // จำนวนข้อความที่ส่ง
    "opens": "382",                      // จำนวนข้อความที่เปิด
    "deliveries": "22931",               // จำนวนข้อความที่ส่งมอบแล้ว
    "inbox_opens": "0",                  // จำนวนข้อความที่เปิดในกล่องข้อความ
    "unshowable_sends": "2",             // จำนวนข้อความที่ไม่สามารถแสดงได้
    "errors": "0"                        // จำนวนข้อผิดพลาดที่พบ
  }],
  "conversion": {
    "sends": "55902",                    // จำนวนข้อความที่ส่งทั้งหมด
    "opens": "772",                      // จำนวนข้อความที่เปิดทั้งหมด
    "events": [{
      "name": "cart_add",                // ชื่อของอีเวนต์
      "hits": "96",                      // จำนวนครั้งที่เกิดขึ้น (hits) สำหรับอีเวนต์
      "conversion": 0.12,                // อัตราคอนเวอร์ชันเทียบกับการเปิด
      "revenue": 0                       // รายได้ที่เกิดจากอีเวนต์ (เฉพาะสำหรับอีเวนต์ที่มีแอตทริบิวต์ amount/currency)
    }]
  }
}

getMessageLog

แสดงข้อมูลโดยละเอียดเกี่ยวกับข้อความที่ส่ง

POST https://api.pushwoosh.com/api/v2/statistics/getMessageLog

Headers

ชื่อ	จำเป็น	คำอธิบาย
`Authorization`	จำเป็น	API access token จาก Pushwoosh Control Panel

พารามิเตอร์ใน Request body

ชื่อ	จำเป็น	ประเภท	คำอธิบาย
`message_id`	ไม่	Integer	เลือกอีเวนต์ของข้อความตาม Message ID ที่ได้รับจากประวัติข้อความ ตัวอย่าง: `12345678900`
`message_code`	ไม่	String	เลือกอีเวนต์ของข้อความตาม Message code ที่ได้รับจากการตอบกลับของ API `/createMessage` ตัวอย่าง: `"A444-AAABBBCC-00112233"`
`campaign_code`	ไม่	String	เลือกอีเวนต์ของข้อความตาม Campaign code ที่ระบุใน payload ของข้อความของคุณ ตัวอย่าง: `"AAAAA-XXXXX"`
`hwid`	ไม่	String or Array	เลือกอีเวนต์ของข้อความตาม HWID (Hardware ID) หรืออาร์เรย์ของ HWIDs
`date_from`	จำเป็นหากไม่ได้ระบุ `message_id`, `message_code`, หรือ `campaign_code`	Datetime	วันที่เริ่มต้นสำหรับการกรองข้อความ รูปแบบ: `"YYYY-MM-DD HH:MM:SS"` ตัวอย่าง: `"2000-01-25 00:00:00"`
`date_to`	จำเป็นหากไม่ได้ระบุ `message_id`, `message_code`, หรือ `campaign_code`	Datetime	วันที่สิ้นสุดสำหรับการกรองข้อความ รูปแบบ: `"YYYY-MM-DD HH:MM:SS"` ตัวอย่าง: `"2000-01-26 00:00:00"`
`limit`	ไม่	Integer	จำนวนอีเวนต์ของข้อความสูงสุดที่ส่งคืนในการตอบกลับครั้งเดียว ค่าสูงสุด: `100000`
`pagination_token`	ไม่	String	Pagination token ที่ได้รับจากการตอบกลับของ `/getMessageLog` ก่อนหน้า ใช้เพื่อดึงผลลัพธ์เพิ่มเติม
`user_id`	ไม่	String	เลือกอีเวนต์ของข้อความตาม User ID ที่กำหนดเอง ดู `/registerUser` สำหรับรายละเอียดเพิ่มเติม
`application_code`	ใช่	String	เลือกอีเวนต์ของข้อความตาม รหัสแอปพลิเคชัน Pushwoosh
`actions`	ไม่	Array	กรองผลลัพธ์ตามการกระทำของข้อความที่ระบุ ค่าที่เป็นไปได้: `"sent"`, `"delivered"`, `"opened"`, `"inbox_delivered"`, `"inbox_read"`, `"inbox_opened"`, `"inbox_deleted"`
`platforms`	ไม่	Array	อาร์เรย์ของแพลตฟอร์มเป้าหมายเพื่อกรองผลลัพธ์ ค่าที่เป็นไปได้: `"ios"`, `"android"`, `"osx"`, `"windows"`, `"amazon"`, `"safari"`, `"chrome"`, `"firefox"`, `"ie"`, `"email"`, `"huawei_android"`

ตัวอย่างคำขอ

curl --location --request POST 'https://api.pushwoosh.com/api/v2/statistics/getMessageLog' \
--header 'Authorization: Key API_ACCESS_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
   "pagination_token": "PAGINATION_TOKEN_FROM_PREVIOUS_RESPONSE",  // ไม่จำเป็น, token สำหรับการแบ่งหน้า
   "limit": 1000,                                  // ไม่จำเป็น, จำนวนรายการสูงสุดสำหรับการตอบกลับครั้งเดียว
   "application_code": "XXXXX-XXXXX",              // รหัสแอป Pushwoosh
   "message_code": "A444-AAABBBCC-00112233",       // ไม่จำเป็น, รหัสข้อความที่ได้รับจากคำขอ /createMessaage
   "message_id": 1234567890,                       // ไม่จำเป็น, ID ข้อความที่ได้รับจาก Pushwoosh Control Panel
   "campaign_code": "AAAAA-XXXXX",                 // ไม่จำเป็น, รหัสของแคมเปญที่จะดึงข้อมูลบันทึก
   "hwid": "aaazzzqqqqxxx",                        // ไม่จำเป็น, ID ฮาร์ดแวร์ของอุปกรณ์เฉพาะที่ถูกกำหนดเป้าหมายด้วยข้อความ
   "user_id": "user_123",                          // ไม่จำเป็น, ID ของผู้ใช้ที่ถูกกำหนดเป้าหมายด้วยข้อความ
   "date_from": "2000-01-25 00:00:00",             // ไม่จำเป็น, จุดเริ่มต้นของช่วงเวลาสถิติ
   "date_to": "2000-02-10 23:59:59",               // ไม่จำเป็น, จุดสิ้นสุดของช่วงเวลาสถิติ
   "actions": ["opened", "inbox_opened"],          // ไม่จำเป็น, ใช้สำหรับการกรองผลลัพธ์ ค่าที่เป็นไปได้: "sent", "opened", "delivered", "inbox_delivered", "inbox_read", "inbox_opened", "inbox_deleted" การตอบกลับจะรวมข้อความทั้งหมดที่มีการกระทำที่ระบุ
   "platforms": ["ios", "chrome"]                  // ไม่จำเป็น, ใช้สำหรับการกรองผลลัพธ์ ค่าที่เป็นไปได้: "ios", "android", "osx", "windows", "amazon", "safari", "chrome", "firefox", "ie", "email", "huawei android"
}'

รหัสการตอบกลับและตัวอย่าง

{
  "pagination_token": "PAGINATION_TOKEN_FOR_NEXT_REQUEST",
  "data": [{
    "timestamp": "2000-01-25T11:18:47Z",
    "application_code": "XXXXX-XXXXX",
    "message_id": 12345678900,
    "message_code": "A444-AAABBBCC-00112233",
    "campaign_code": "AAAAA-XXXXX",
    "hwid": "aaazzzqqqqxxx",
    "user_id": "user_123",
    "platform": "android",
    "action": "sent",
    "status": "success",
    "push_alerts_enabled": "true"
  }, {
    "timestamp": "2000-01-25T11:18:49Z",
    "application_code": "XXXXX-XXXXX",
    "message_id": 12345678900,
    "message_code": "A444-AAABBBCC-00112233",
    "campaign_code": "AAAAA-XXXXX",
    "hwid": "aaazzzqqqqxxx",
    "user_id": "user_123",
    "platform": "android",
    "action": "delivered",
    "push_alerts_enabled": "true"
  }, {
    "timestamp": "2000-01-25T11:19:23Z",
    "application_code": "XXXXX-XXXXX",
    "message_id": 12345678900,
    "message_code": "A444-AAABBBCC-00112233",
    "campaign_code": "AAAAA-XXXXX",
    "hwid": "aaazzzqqqqxxx",
    "user_id": "user_123",
    "platform": "android",
    "action": "opened",
    "push_alerts_enabled": "true"
  }]
}

{
  "error": "exceeded the maximum date interval. Max interval: 30 days"
}

{
  "error": "account not found"
}

สถิติอีเมล

linksInteractions

แสดงสถิติการคลิกลิงก์ในอีเมล

POST https://api.pushwoosh.com/api/v2/statistics/emails/linksInteractions

Headers

ชื่อ	จำเป็น	คำอธิบาย
`Authorization`	ใช่	API access token จาก Pushwoosh Control Panel

พารามิเตอร์ใน Request body

ชื่อ	จำเป็น	ประเภท	คำอธิบาย
`date_range`	ไม่	Object	กำหนดช่วงเวลาการรายงาน ประกอบด้วย `date_from` และ `date_to`
`filters`	ใช่	Object	ตัวกรองอีเมล
`application`	ใช่	String	รหัสแอปพลิเคชัน Pushwoosh (หรือระบุ `campaign`, `messages_ids`, หรือ `message_codes` แทน)
`messages_codes`	ใช่	Array	รหัสข้อความ (Message codes) (หรือระบุ `application`, `campaign`, หรือ `messages_ids` แทน)
`campaign`	ใช่	String	รหัสแคมเปญ (Campaign code) (หรือระบุ `application`, `messages_ids`, หรือ `message_codes` แทน)
`messages_ids`	ใช่	Array	ID ข้อความ (หรือระบุ `application`, `campaign`, หรือ `message_codes` แทน)
`link_template`	จำเป็นหากระบุ `application` หรือ `campaign`	String	กรองการโต้ตอบกับลิงก์อีเมลด้วยคีย์เวิร์ด เฉพาะลิงก์ที่มีข้อความที่ระบุใน URL เท่านั้นที่จะถูกส่งคืนในการตอบกลับของ API ตัวอย่างเช่น หากอีเมลของคุณมีลิงก์เช่น `https://example.com/news` และ `https://example.com/shop` การตั้งค่า “link_template”: “shop” จะส่งคืนการโต้ตอบสำหรับ `https://example.com/shop` เท่านั้น
`email_content_code`	ไม่	String	ตัวระบุที่ไม่ซ้ำกันสำหรับเนื้อหาอีเมล
`params`	ไม่	Object	กำหนดตัวเลือกการตอบกลับเพิ่มเติม รวมถึง `with_full_links` ซึ่งจะเพิ่มรายการลิงก์เต็มพร้อมสถิติ

ตัวอย่างคำขอ

curl --location --request POST 'https://api.pushwoosh.com/api/v2/statistics/emails/linksInteractions' \
--header 'Authorization: Api API_ACCESS_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
   "filters": {
      "date_range": {
         "date_from": "string",           // รูปแบบที่ต้องการ: 2000-01-01
         "date_to": "string"              // รูปแบบที่ต้องการ: 2000-01-01
      },
      "campaign": "string",               // รหัสแคมเปญ (สามารถระบุ application, messages_ids, หรือ message_codes แทนได้)
      "application": "string",            // รหัสแอปพลิเคชัน (สามารถระบุ campaign, messages_ids, หรือ message_codes แทนได้)
      "messages_ids": [],                 // ID ข้อความ (สามารถระบุ application, campaign, หรือ message_codes แทนได้)
      "messages_codes": [],               // รหัสข้อความ (สามารถระบุ application, campaign, หรือ message_ids แทนได้)
      "link_template": "string",          // เทมเพลตลิงก์ (จำเป็นหากระบุ application หรือ campaign)
      "email_content_code": "string"      // ตัวระบุที่ไม่ซ้ำกันสำหรับเนื้อหาอีเมล
   },
   "params": {
      "with_full_links": true             // ระบุว่าจะแสดงสถิติโดยละเอียดหรือไม่ รายการลิงก์เต็มพร้อมสถิติจะถูกส่งในอาร์เรย์ full_links
   }
}'

รหัสการตอบกลับและตัวอย่าง

{
  "items": [{
    "template": "string",
    "link": "string",
    "title": "string",
    "clicks": 0,
    "full_links": [{
      "full_link": "string",
      "clicks": 0
    }]
  }]
}

{
  "error": "exceeded the maximum date interval. Max interval: 30 days"
}

{
  "error": "account not found"
}

linksInteractionsDevices

แสดงผู้ใช้ที่คลิกลิงก์ในอีเมล

POST https://api.pushwoosh.com/api/v2/statistics/emails/linksInteractionsDevices

Headers

ชื่อ	จำเป็น	คำอธิบาย
`Authorization`	ใช่	API access token จาก Pushwoosh Control Panel

พารามิเตอร์ใน Request body

ชื่อ	จำเป็น	ประเภท	คำอธิบาย
`date_range`	ไม่	Object	กำหนดช่วงเวลาการรายงาน ประกอบด้วย `date_from` และ `date_to`
`filters`	ใช่	Object	ตัวกรองอีเมล
`application`	ใช่	String	รหัสแอปพลิเคชัน Pushwoosh (หรือระบุ `campaign`, `messages_ids`, หรือ `message_codes` แทน)
`messages_codes`	ใช่	Array	รหัสข้อความ (Message codes) (หรือระบุ `application`, `campaign`, หรือ `messages_ids` แทน)
`campaign`	ใช่	String	รหัสแคมเปญ (Campaign code) (หรือระบุ `application`, `messages_ids`, หรือ `message_codes` แทน)
`messages_ids`	ใช่	Array	ID ข้อความ (หรือระบุ `application`, `campaign`, หรือ `message_codes` แทน)
`link_template`	จำเป็นหากระบุ `application` หรือ `campaign`	String	กรองการโต้ตอบกับลิงก์อีเมลด้วยคีย์เวิร์ด เฉพาะลิงก์ที่มีข้อความที่ระบุใน URL เท่านั้นที่จะถูกส่งคืนในการตอบกลับของ API ตัวอย่างเช่น หากอีเมลของคุณมีลิงก์เช่น `https://example.com/news` และ `https://example.com/shop` การตั้งค่า “link_template”: “shop” จะส่งคืนการโต้ตอบสำหรับ `https://example.com/shop` เท่านั้น
`email_content_code`	ไม่	String	ตัวระบุที่ไม่ซ้ำกันสำหรับเนื้อหาอีเมล
`page`	ไม่	Integer	หมายเลขหน้าสำหรับการแบ่งหน้า
`per_page`	ไม่	Integer	จำนวนผลลัพธ์ต่อหน้า (≤ 1000)

ตัวอย่างคำขอ

curl --location --request POST 'https://api.pushwoosh.com/api/v2/statistics/emails/linksInteractionsDevices' \
--header 'Authorization: Api API_ACCESS_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
   "filters": {
      "date_range": {
         "date_from": "string",         // รูปแบบที่ต้องการ: 2000-01-01
         "date_to": "string"            // รูปแบบที่ต้องการ: 2000-01-01
      },
      "campaign": "string",             // รหัสแคมเปญ (สามารถระบุ application, messages_ids, หรือ message_codes แทนได้)
      "application": "string",          // รหัสแอปพลิเคชัน (สามารถระบุ campaign, messages_ids, หรือ message_codes แทนได้)
      "messages_ids": [],               // ID ข้อความ (สามารถระบุ application, campaign, หรือ message_codes แทนได้)
      "messages_codes": [],             // รหัสข้อความ (สามารถระบุ application, campaign, หรือ message_ids แทนได้)
      "link_template": "string",        // เทมเพลตลิงก์ (จำเป็นหากระบุ application หรือ campaign)
      "email_content_code": "string"    // ตัวระบุที่ไม่ซ้ำกันสำหรับเนื้อหาอีเมล
   },
   "per_page": 100,
   "page": 0
}'

รหัสการตอบกลับและตัวอย่าง

{
  "total": 0,
  "items": [{
    "timestamp": "string",
    "link": "string",
    "hwid": "string"
  }]
}

{
  "error": "exceeded the maximum date interval. Max interval: 30 days"
}

{
  "error": "account not found"
}

bouncedEmails

POST https://api.pushwoosh.com/api/v2/statistics/emails/bouncedEmails

ให้ข้อมูลเกี่ยวกับการร้องเรียนทางอีเมล, soft bounces, และ hard bounces รวมถึงวันที่, ที่อยู่อีเมล, และเหตุผลของแต่ละ bounce

การให้สิทธิ์ (Authorization)

การให้สิทธิ์ (Authorization) จะจัดการผ่าน API Access Token ในเฮดเดอร์ของคำขอ

พารามิเตอร์ใน Request body

ชื่อพารามิเตอร์	ประเภท	คำอธิบาย	จำเป็น
`application`	string	รหัสแอปพลิเคชัน Pushwoosh	ใช่
`message_code`	string	รหัสข้อความ (Message code)	จำเป็นหากไม่ได้ระบุ `date range` หรือ `campaign`
`campaign`	string	รหัสแคมเปญ (Campaign code)	จำเป็นหากไม่ได้ระบุ `message_code` หรือ `date range`
`date_from`	string	วันที่เริ่มต้นสำหรับข้อมูลในรูปแบบ `YYYY-MM-DDTHH:MM:SS.000Z` (มาตรฐาน ISO 8601)	จำเป็นหากไม่ได้ระบุ `message_code` หรือ `campaign`
`date_to`	string	วันที่สิ้นสุดสำหรับข้อมูลในรูปแบบ `YYYY-MM-DDTHH:MM:SS.000Z` (มาตรฐาน ISO 8601)	จำเป็นหากไม่ได้ระบุ `message_code` หรือ `campaign`
`per_page`	int	จำนวนแถวต่อหน้า สูงสุด 5000	ใช่
`page`	int	หมายเลขหน้า เริ่มต้นจากศูนย์	ใช่
`type`	string	ประเภทของ bounce: Complaint, Softbounce, Hardbounce	ไม่

ตัวอย่างคำขอ

{
  "application": "XXXXX-XXXXX",               // จำเป็น รหัสแอป Pushwoosh
  "message_code": "XXXXX-XXXXXXXXX-XXXXXXXX", // จำเป็นหากไม่ได้ระบุ campaign หรือ date range
                                              //          ตัวระบุข้อความที่ไม่ซ้ำกัน
  "campaign": "XXXXX-XXXXX",                  // จำเป็นหากไม่ได้ระบุ message_code หรือ date range
                                              //          รหัสแคมเปญ
  "date_from": "2024-07-20T00:00:00.000Z",    // จำเป็นหากไม่ได้ระบุ message_code หรือ campaign
                                              //          วันที่เริ่มต้นในรูปแบบ ISO 8601 "YYYY-MM-DDTHH:MM:SS.SSSZ"
  "date_to": "2024-07-20T00:00:00.000Z",      // จำเป็นหากไม่ได้ระบุ message_code หรือ campaign
                                              //          วันที่สิ้นสุดในรูปแบบ ISO 8601 "YYYY-MM-DDTHH:MM:SS.SSSZ"
  "per_page": 1000,                           // จำเป็น จำนวนผลลัพธ์ต่อหน้า สูงสุด 5000
  "page": 5,                                  // ไม่จำเป็น หมายเลขหน้า เริ่มต้นจากศูนย์
  "type": "Softbounce"                        // ไม่จำเป็น ประเภทของ bounce: Complaint, Softbounce, Hardbounce
}

ฟิลด์การตอบกลับ

ชื่อฟิลด์	ประเภท	คำอธิบาย
`total`	int	จำนวนแถวทั้งหมด
`bounced_emails`	array	อาร์เรย์ของรายละเอียดอีเมลที่ตีกลับ
├── `email`	string	ที่อยู่อีเมลที่ตีกลับ
├── `date`	string	วันที่ที่ตีกลับ (รูปแบบ: `YYYY-MM-DDTHH:MM:SS.000Z`)
├── `reason`	string	เหตุผลที่ตีกลับ
└── `type`	string	ประเภทของ bounce: Complaint, Softbounce, Hardbounce

ตัวอย่างการตอบกลับ

{
  "total": 25,                             // จำนวนแถวทั้งหมด
  "bounced_emails": [{
    "email": "example@example.com",        // ที่อยู่อีเมลที่ตีกลับ
    "date": "2024-07-20T00:00:00.000Z",    // วันที่ตีกลับในรูปแบบ ISO 8601
    "reason": "Invalid recipient address", // เหตุผลที่ตีกลับ
    "type": "Hardbounce"                   // ประเภทของ bounce: Complaint, Softbounce, Hardbounce
  }]
}