ข้ามไปยังเนื้อหา
คู่มือผู้ใช้การสนับสนุน ขอสาธิต เข้าสู่ระบบ
Pushwoosh.com

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

messages:list

Anchor link to

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

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

ส่วนหัว (Headers)
Anchor link to
ชื่อ
จำเป็น
ประเภท
คำอธิบาย
Authorizationใช่Stringโทเค็นการเข้าถึง API จาก Pushwoosh Control Panel
พารามิเตอร์ของคำขอ (Request parameters)
Anchor link to
ชื่อ
จำเป็น
ประเภท
คำอธิบาย
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")
campaignไม่Stringรหัสแคมเปญ
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รหัสข้อความที่ได้รับจากการตอบกลับของ /createMessage API
messages_idsไม่ArrayID ข้อความที่ได้รับจากประวัติข้อความ (Message History)
paramsไม่Objectระบุว่าจะแสดงรายละเอียดข้อความและเมตริกหรือไม่ ตั้งค่า with_details: true เพื่อรวมออบเจกต์ "details" และ with_metrics: true เพื่อรวมออบเจกต์ "metrics" ในการตอบกลับ
applicationใช่Stringรหัสแอปพลิเคชัน Pushwoosh
per_pageไม่Integerจำนวนผลลัพธ์ต่อหน้า (≤ 1000)
pageไม่Integerหมายเลขหน้าสำหรับการแบ่งหน้า
ตัวอย่างคำขอ
Anchor link to
{
    "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,                     // <= 1000
    "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": [              // เงื่อนไขแท็ก (ดู developer/api-reference/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
      }]
    }
  }]
}

totalsByIntervals

Anchor link to

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

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

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

การให้สิทธิ์จะดำเนินการผ่านโทเค็นการเข้าถึง API ในส่วนหัวของคำขอ

พารามิเตอร์ของคำขอ
Anchor link to
ชื่อพารามิเตอร์
ประเภท
คำอธิบายจำเป็น
message_codestringรหัสข้อความที่ได้รับจากการตอบกลับของ /createMessage APIใช่
platforms[int]แพลตฟอร์มไม่
ตัวอย่างคำขอ
Anchor link to
{
  "message_code": "XXXXX-XXXXXXXXX-XXXXXXXX", // จำเป็น ตัวระบุข้อความที่ไม่ซ้ำกัน
  "platforms": [1, 3, 7, 10, 11, 12]          // ไม่บังคับ รายการรหัสแพลตฟอร์ม
}
ฟิลด์การตอบกลับ
Anchor link to
ชื่อประเภทคำอธิบาย
metricsarrayมีอาร์เรย์ของเมตริกข้อความ
timestampstringเวลาของเมตริก
platformintรหัสแพลตฟอร์ม (เช่น iOS, Android)
sendsstringจำนวนข้อความที่ส่ง
opensstringจำนวนข้อความที่เปิด
deliveriesstringจำนวนข้อความที่จัดส่ง
inbox_opensstringจำนวนการเปิดในกล่องจดหมาย
unshowable_sendsstringจำนวนข้อความที่ส่งแล้วแต่ไม่สามารถแสดงได้
errorsstringจำนวนข้อผิดพลาด
conversionobjectมีข้อมูลคอนเวอร์ชัน
sendsstringจำนวนข้อความที่ส่งทั้งหมด
opensstringจำนวนข้อความที่เปิดทั้งหมด
eventsarrayอาร์เรย์ของเหตุการณ์พร้อมสถิติ
namestringชื่อของเหตุการณ์ (เช่น cart add)
hitsstringจำนวนครั้งที่เกิดขึ้น
conversionfloatอัตราคอนเวอร์ชันเมื่อเทียบกับการเปิด
revenuefloatรายได้ (เฉพาะสำหรับเหตุการณ์ที่มีแอตทริบิวต์ __amount และ __currency)
ตัวอย่างการตอบกลับ
Anchor link to
{
  "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",                      // จำนวนครั้งที่เกิดขึ้นสำหรับเหตุการณ์
      "conversion": 0.12,                // อัตราคอนเวอร์ชันเมื่อเทียบกับการเปิด
      "revenue": 0                       // รายได้ที่สร้างโดยเหตุการณ์ (เฉพาะสำหรับเหตุการณ์ที่มีแอตทริบิวต์ amount/currency)
    }]
  }
}

getMessageLog

Anchor link to

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

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

ส่วนหัว (Headers)
Anchor link to
ชื่อ
จำเป็น
ประเภท
คำอธิบาย
Authorizationจำเป็นStringโทเค็นการเข้าถึง API จาก Pushwoosh Control Panel
พารามิเตอร์เนื้อหาคำขอ (Request body parameters)
Anchor link to
ชื่อ
จำเป็น/ไม่บังคับ
ประเภท
คำอธิบาย
message_idไม่บังคับIntegerเลือกเหตุการณ์ข้อความด้วย Message ID ที่ได้รับจากประวัติข้อความ ตัวอย่าง: 12345678900
message_codeไม่บังคับStringเลือกเหตุการณ์ข้อความด้วย Message Code ที่ได้รับจากการตอบกลับของ /createMessage API ตัวอย่าง: "A444-AAABBBCC-00112233"
campaign_codeไม่บังคับStringเลือกเหตุการณ์ข้อความด้วย Campaign Code ที่ระบุในเพย์โหลดข้อความของคุณ ตัวอย่าง: "AAAAA-XXXXX"
hwidไม่บังคับString or Arrayเลือกเหตุการณ์ข้อความด้วย HWID (Hardware ID) หรืออาร์เรย์ของ HWIDs
date_fromจำเป็นหากไม่ได้ระบุ message_id, message_code หรือ campaign_codeDatetimeวันที่เริ่มต้นสำหรับการกรองข้อความ รูปแบบ: "YYYY-MM-DD HH:MM:SS" ตัวอย่าง: "2000-01-25 00:00:00"
date_toจำเป็นหากไม่ได้ระบุ message_id, message_code หรือ campaign_codeDatetimeวันที่สิ้นสุดสำหรับการกรองข้อความ รูปแบบ: "YYYY-MM-DD HH:MM:SS" ตัวอย่าง: "2000-01-26 00:00:00"
limitไม่บังคับIntegerจำนวนสูงสุดของเหตุการณ์ข้อความที่ส่งคืนในการตอบกลับครั้งเดียว ค่าสูงสุด: 100000
pagination_tokenไม่บังคับStringโทเค็นการแบ่งหน้าที่ได้รับจากการตอบกลับ /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"
ตัวอย่างคำขอ
Anchor link to
Terminal window
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",  // ไม่บังคับ, โทเค็นสำหรับการแบ่งหน้า
   "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"
  }]
}

สถิติอีเมล

Anchor link to

linksInteractions

Anchor link to

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

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

ส่วนหัว (Headers)
Anchor link to
ชื่อ
จำเป็น
ประเภทคำอธิบาย
Authorizationใช่Stringโทเค็นการเข้าถึง API จาก Pushwoosh Control Panel
พารามิเตอร์ของคำขอ
Anchor link to
ชื่อ
จำเป็น
ประเภทคำอธิบาย
date_rangeไม่Objectกำหนดช่วงเวลาการรายงาน ประกอบด้วย date_from และ date_to
filtersใช่Objectตัวกรองอีเมล
applicationใช่Stringรหัสแอปพลิเคชัน Pushwoosh (หรือระบุ campaign, messages_ids หรือ message_codes แทน)
messages_codesใช่Arrayรหัสข้อความ (หรือระบุ application, campaign หรือ messages_ids แทน)
campaignใช่Stringรหัสแคมเปญ (หรือระบุ application, messages_ids หรือ message_codes แทน)
messages_idsใช่ArrayID ข้อความ (หรือระบุ application, campaign หรือ message_codes แทน)
link_templateจำเป็นหากระบุ application หรือ campaignStringกรองการโต้ตอบกับลิงก์อีเมลด้วยคีย์เวิร์ด เฉพาะลิงก์ที่มีข้อความที่ระบุใน 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 ซึ่งจะเพิ่มรายการลิงก์ฉบับเต็มพร้อมสถิติ
ตัวอย่างคำขอ
Anchor link to
Terminal window
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
   }
}'
รหัสการตอบกลับและตัวอย่าง
Anchor link to
{
  "items": [{
    "template": "string",
    "link": "string",
    "title": "string",
    "clicks": 0,
    "full_links": [{
      "full_link": "string",
      "clicks": 0
    }]
  }]
}

linksInteractionsDevices

Anchor link to

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

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

ส่วนหัว (Headers)
Anchor link to
ชื่อ
จำเป็น
ประเภทคำอธิบาย
Authorizationใช่Stringโทเค็นการเข้าถึง API จาก Pushwoosh Control Panel
พารามิเตอร์ของคำขอ
Anchor link to
ชื่อ
จำเป็น
ประเภทคำอธิบาย
date_rangeไม่Objectกำหนดช่วงเวลาการรายงาน ประกอบด้วย date_from และ date_to
filtersใช่Objectตัวกรองอีเมล
applicationใช่Stringรหัสแอปพลิเคชัน Pushwoosh (หรือระบุ campaign, messages_ids หรือ message_codes แทน)
messages_codesใช่Arrayรหัสข้อความ (หรือระบุ application, campaign หรือ messages_ids แทน)
campaignใช่Stringรหัสแคมเปญ (หรือระบุ application, messages_ids หรือ message_codes แทน)
messages_idsใช่ArrayID ข้อความ (หรือระบุ application, campaign หรือ message_codes แทน)
link_templateจำเป็นหากระบุ application หรือ campaignStringกรองการโต้ตอบกับลิงก์อีเมลด้วยคีย์เวิร์ด เฉพาะลิงก์ที่มีข้อความที่ระบุใน 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)
ตัวอย่างคำขอ
Anchor link to
Terminal window
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
}'
รหัสการตอบกลับและตัวอย่าง
Anchor link to
{
  "total": 0,
  "items": [{
    "timestamp": "string",
    "link": "string",
    "hwid": "string"
  }]
}

bouncedEmails

Anchor link to

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

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

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

การให้สิทธิ์จะดำเนินการผ่านโทเค็นการเข้าถึง API ในส่วนหัวของคำขอ

พารามิเตอร์ของคำขอ
Anchor link to
ชื่อพารามิเตอร์ประเภทคำอธิบายจำเป็น
applicationstringรหัสแอปพลิเคชัน Pushwooshใช่
message_codestringรหัสข้อความจำเป็นหากไม่ได้ระบุ date range หรือ campaign
campaignstringรหัสแคมเปญจำเป็นหากไม่ได้ระบุ message_code หรือ date range
date_fromstringวันที่เริ่มต้นสำหรับข้อมูลในรูปแบบ YYYY-MM-DDTHH:MM:SS.000Z (มาตรฐาน ISO 8601)จำเป็นหากไม่ได้ระบุ message_code หรือ campaign
date_tostringวันที่สิ้นสุดสำหรับข้อมูลในรูปแบบ YYYY-MM-DDTHH:MM:SS.000Z (มาตรฐาน ISO 8601)จำเป็นหากไม่ได้ระบุ message_code หรือ campaign
per_pageintจำนวนแถวต่อหน้า สูงสุด 5000ใช่
pageintหมายเลขหน้า เริ่มต้นจากศูนย์ใช่
typestringประเภทของการตีกลับ: Complaint, Softbounce, Hardbounceไม่
ตัวอย่างคำขอ
Anchor link to
{
  "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"                        // ไม่บังคับ ประเภทของการตีกลับ: Complaint, Softbounce, Hardbounce
}
ฟิลด์การตอบกลับ
Anchor link to
ชื่อฟิลด์ประเภทคำอธิบาย
totalintจำนวนแถวทั้งหมด
bounced_emailsarrayอาร์เรย์ของรายละเอียดอีเมลที่ตีกลับ
├── emailstringที่อยู่อีเมลที่ตีกลับ
├── datestringวันที่ของการตีกลับ (รูปแบบ: YYYY-MM-DDTHH:MM:SS.000Z)
├── reasonstringเหตุผลของการตีกลับ
└── typestringประเภทของการตีกลับ: Complaint, Softbounce, Hardbounce
ตัวอย่างการตอบกลับ
Anchor link to
{
  "total": 25,                             // จำนวนแถวทั้งหมด
  "bounced_emails": [{
    "email": "example@example.com",        // ที่อยู่อีเมลที่ตีกลับ
    "date": "2024-07-20T00:00:00.000Z",    // วันที่ตีกลับในรูปแบบ ISO 8601
    "reason": "Invalid recipient address", // เหตุผลของการตีกลับ
    "type": "Hardbounce"                   // ประเภทของการตีกลับ: Complaint, Softbounce, Hardbounce
  }]
}