বিষয়বস্তুতে যান

মেসেজ পরিসংখ্যান

messages:list

Anchor link to

পাঠানো মেসেজগুলোর তালিকা প্রদর্শন করে।

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

হেডারসমূহ
Anchor link to
নাম
আবশ্যক
বিবরণ
Authorizationহ্যাঁServer API token। এটি অবশ্যই নিম্নলিখিত ফরম্যাটে প্রদান করতে হবে: Authorization: Api <Server Key>
রিকোয়েস্ট বডি প্যারামিটার
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নাArrayমেসেজ হিস্ট্রি থেকে প্রাপ্ত মেসেজ আইডি।
paramsনাObjectমেসেজের বিবরণ এবং মেট্রিক্স দেখানো হবে কিনা তা নির্দিষ্ট করুন। রেসপন্সে "details" অবজেক্ট অন্তর্ভুক্ত করতে with_details: true এবং "metrics" অবজেক্ট অন্তর্ভুক্ত করতে with_metrics: true সেট করুন।
applicationহ্যাঁStringPushwoosh অ্যাপ্লিকেশন কোড
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", // Required format: 2000-01-01
"date_to": "string" // Required format: 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", // Campaign code
"messages_ids": [], // Message IDs
"messages_codes": [], // Message codes
"application": "string" // Pushwoosh application code
},
"params": {
"with_details": true, // Add message details to the response ("details" object)
"with_metrics": true // Add message metrics to the response ("metrics" object)
},
"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": [ // tag conditions (see /developer/api-reference/messages-api/#tag-conditions)
TAG_CONDITION1,
TAG_CONDITION2,
...,
TAG_CONDITIONN
],
"conditions_operator": "AND", // logical operator for conditions arrays; possible values: 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": [ // tag conditions (see Messages-api - tag-conditions)
TAG_CONDITION1,
TAG_CONDITION2,
...,
TAG_CONDITIONN
],
"conditions_operator": "AND" // logical operator for conditions arrays; possible values: 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

অথরাইজেশন
Anchor link to

রিকোয়েস্ট হেডারে API Access Token-এর মাধ্যমে অথরাইজেশন পরিচালনা করা হয়।

রিকোয়েস্ট বডি প্যারামিটার
Anchor link to
প্যারামিটারের নাম
ধরণ
বিবরণআবশ্যক
message_codestring/createMessage API রেসপন্স থেকে প্রাপ্ত মেসেজ কোডহ্যাঁ
platforms[int]প্ল্যাটফর্মসমূহনা
রিকোয়েস্টের উদাহরণ
Anchor link to
{
"message_code": "XXXXX-XXXXXXXXX-XXXXXXXX", // required. Unique message identifier
"platforms": [1, 3, 7, 10, 11, 12] // optional. List of platform codes
}
রেসপন্স ফিল্ডসমূহ
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", // Timestamp of the metrics in "YYYY-MM-DD HH:MM:SS" format
"platform": 3, // Platform code
"sends": "55902", // Number of messages sent
"opens": "382", // Number of messages opened
"deliveries": "22931", // Number of messages delivered
"inbox_opens": "0", // Number of messages opened in the inbox
"unshowable_sends": "2", // Number of messages that couldn't be shown
"errors": "0" // Number of errors encountered
}],
"conversion": {
"sends": "55902", // Total number of messages sent
"opens": "772", // Total number of messages opened
"events": [{
"name": "cart_add", // Name of the event
"hits": "96", // Number of hits for the event
"conversion": 0.12, // Conversion rate relative to opens
"revenue": 0 // Revenue generated by the event (only for events with amount/currency attributes)
}]
}
}

getMessageLog

Anchor link to

পাঠানো মেসেজগুলো সম্পর্কে বিস্তারিত তথ্য প্রদর্শন করে।

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

হেডারসমূহ
Anchor link to
নাম
আবশ্যক
বিবরণ
Authorizationআবশ্যকPushwoosh কন্ট্রোল প্যানেল থেকে প্রাপ্ত API access token
রিকোয়েস্ট বডি প্যারামিটার
Anchor link to
নাম
আবশ্যক
ধরণ
বিবরণ
message_idনাIntegerমেসেজ হিস্ট্রি থেকে প্রাপ্ত Message ID দ্বারা মেসেজ ইভেন্ট নির্বাচন করুন। উদাহরণ: 12345678900
message_codeনাString/createMessage API রেসপন্স থেকে প্রাপ্ত মেসেজ কোড দ্বারা মেসেজ ইভেন্ট নির্বাচন করুন। উদাহরণ: "A444-AAABBBCC-00112233"
campaign_codeনাStringআপনার মেসেজ পেলোডে নির্দিষ্ট করা ক্যাম্পেইন কোড দ্বারা মেসেজ ইভেন্ট নির্বাচন করুন। উদাহরণ: "AAAAA-XXXXX"
hwidনাString or ArrayHWID (হার্ডওয়্যার আইডি) বা HWID-এর একটি অ্যারে দ্বারা মেসেজ ইভেন্ট নির্বাচন করুন।
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পূর্ববর্তী /getMessageLog রেসপন্স থেকে প্রাপ্ত পেজিনেশন টোকেন। অতিরিক্ত ফলাফল পুনরুদ্ধার করতে এটি ব্যবহার করুন।
user_idনাStringএকটি কাস্টম User ID দ্বারা মেসেজ ইভেন্ট নির্বাচন করুন। আরও বিস্তারিত জানার জন্য /registerUser দেখুন।
application_codeহ্যাঁStringPushwoosh অ্যাপ্লিকেশন কোড দ্বারা মেসেজ ইভেন্ট নির্বাচন করুন।
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
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", // optional, token for pagination
"limit": 1000, // optional, the max number of entries for a single response
"application_code": "XXXXX-XXXXX", // Pushwoosh app code
"message_code": "A444-AAABBBCC-00112233", // optional, message code obtained from /createMessaage request
"message_id": 1234567890, // optional, message ID obtained from Pushwoosh Control Panel
"campaign_code": "AAAAA-XXXXX", // optional, code of a campaign to get the log for
"hwid": "aaazzzqqqqxxx", // optional, hardware ID of a specific device targeted with a message
"user_id": "user_123", // optional, ID of a user targeted with the message
"date_from": "2000-01-25 00:00:00", // optional, start of the stats period
"date_to": "2000-02-10 23:59:59", // optional, end of the stats period
"actions": ["opened", "inbox_opened"], // optional, used for results filtration. Possible values: "sent", "opened", "delivered", "inbox_delivered", "inbox_read", "inbox_opened", "inbox_deleted". The response will include all the messages with the specified action(s).
"platforms": ["ios", "chrome"] // optional, used for results filtration. Possible values: "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

হেডারসমূহ
Anchor link to
নাম
আবশ্যক
বিবরণ
Authorizationহ্যাঁPushwoosh কন্ট্রোল প্যানেল থেকে প্রাপ্ত API access token
রিকোয়েস্ট বডি প্যারামিটার
Anchor link to
নাম
আবশ্যক
ধরণবিবরণ
date_rangeনাObjectরিপোর্টিং পিরিয়ড সংজ্ঞায়িত করে। date_from এবং date_to ধারণ করে।
filtersহ্যাঁObjectইমেইল ফিল্টার।
applicationহ্যাঁStringPushwoosh অ্যাপ্লিকেশন কোড (বিকল্পভাবে, campaign, messages_ids, বা message_codes উল্লেখ করুন)।
messages_codesহ্যাঁArrayমেসেজ কোড (বিকল্পভাবে, application, campaign, বা messages_ids উল্লেখ করুন)।
campaignহ্যাঁStringক্যাম্পেইন কোড (বিকল্পভাবে, application, messages_ids, বা message_codes উল্লেখ করুন)।
messages_idsহ্যাঁArrayমেসেজ আইডি (বিকল্পভাবে, application, campaign, বা message_codes উল্লেখ করুন)।
link_templateআবশ্যক যদি application বা campaign উল্লেখ করা হয়।Stringকীওয়ার্ড দ্বারা ইমেইল লিঙ্ক ইন্টারঅ্যাকশন ফিল্টার করে। শুধুমাত্র সেই লিঙ্কগুলো API রেসপন্সে ফেরত আসবে যাদের URL-এ নির্দিষ্ট টেক্সট অন্তর্ভুক্ত আছে। উদাহরণস্বরূপ, যদি আপনার ইমেইলে 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
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", // Required format: 2000-01-01
"date_to": "string" // Required format: 2000-01-01
},
"campaign": "string", // Campaign code (you can specify application, messages_ids, or message_codes instead)
"application": "string", // Application code (you can specify campaign, messages_ids, or message_codes instead)
"messages_ids": [], // Message IDs (you can specify application, campaign, or message_codes instead)
"messages_codes": [], // Message codes (you can specify application, campaign, or message_ids instead)
"link_template": "string", // Link template (required if application or campaign is specified)
"email_content_code": "string" // Unique identifier for the email content.
},
"params": {
"with_full_links": true // Specify whether to show detailed statistics. A list of full links with statistics will be passed in the full_links array.
}
}'
রেসপন্স কোড এবং উদাহরণ
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

হেডারসমূহ
Anchor link to
নাম
আবশ্যক
বিবরণ
Authorizationহ্যাঁPushwoosh কন্ট্রোল প্যানেল থেকে প্রাপ্ত API access token
রিকোয়েস্ট বডি প্যারামিটার
Anchor link to
নাম
আবশ্যক
ধরণবিবরণ
date_rangeনাObjectরিপোর্টিং পিরিয়ড সংজ্ঞায়িত করে। date_from এবং date_to ধারণ করে।
filtersহ্যাঁObjectইমেইল ফিল্টার।
applicationহ্যাঁStringPushwoosh অ্যাপ্লিকেশন কোড (বিকল্পভাবে, campaign, messages_ids, বা message_codes উল্লেখ করুন)।
messages_codesহ্যাঁArrayমেসেজ কোড (বিকল্পভাবে, application, campaign, বা messages_ids উল্লেখ করুন)।
campaignহ্যাঁStringক্যাম্পেইন কোড (বিকল্পভাবে, application, messages_ids, বা message_codes উল্লেখ করুন)।
messages_idsহ্যাঁArrayমেসেজ আইডি (বিকল্পভাবে, application, campaign, বা message_codes উল্লেখ করুন)।
link_templateআবশ্যক যদি application বা campaign উল্লেখ করা হয়।Stringকীওয়ার্ড দ্বারা ইমেইল লিঙ্ক ইন্টারঅ্যাকশন ফিল্টার করে। শুধুমাত্র সেই লিঙ্কগুলো API রেসপন্সে ফেরত আসবে যাদের URL-এ নির্দিষ্ট টেক্সট অন্তর্ভুক্ত আছে। উদাহরণস্বরূপ, যদি আপনার ইমেইলে 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
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", // Required format: 2000-01-01
"date_to": "string" // Required format: 2000-01-01
},
"campaign": "string", // Campaign code (you can specify application, messages_ids, or message_codes instead)
"application": "string", // Application code (you can specify campaign, messages_ids, or message_codes instead)
"messages_ids": [], // Message IDs (you can specify application, campaign, or message_codes instead)
"messages_codes": [], // Message codes (you can specify application, campaign, or message_ids instead)
"link_template": "string", // Link template (required if application or campaign is specified)
"email_content_code": "string" // Unique identifier for the email content.
},
"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

ইমেইল অভিযোগ, সফট বাউন্স এবং হার্ড বাউন্স সম্পর্কিত ডেটা প্রদান করে, যার মধ্যে প্রতিটি বাউন্সের তারিখ, ইমেইল ঠিকানা এবং কারণ অন্তর্ভুক্ত থাকে।

অথরাইজেশন
Anchor link to

রিকোয়েস্ট হেডারে API Access Token-এর মাধ্যমে অথরাইজেশন পরিচালনা করা হয়।

রিকোয়েস্ট বডি প্যারামিটার
Anchor link to
প্যারামিটারের নামধরণবিবরণআবশ্যক
applicationstringPushwoosh অ্যাপ্লিকেশন কোডহ্যাঁ
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প্রতি পৃষ্ঠায় সারির সংখ্যা, সর্বোচ্চ ৫০০০।হ্যাঁ
pageintপৃষ্ঠা নম্বর, শূন্য থেকে শুরু।হ্যাঁ
typestringবাউন্সের ধরণ: Complaint, Softbounce, Hardbounce।না
রিকোয়েস্টের উদাহরণ
Anchor link to
{
"application": "XXXXX-XXXXX", // required. Pushwoosh app code
"message_code": "XXXXX-XXXXXXXXX-XXXXXXXX", // required if campaign or date range is not provided.
// Unique message identifier
"campaign": "XXXXX-XXXXX", // required if message_code or date range is not provided.
// Campaign code
"date_from": "2024-07-20T00:00:00.000Z", // required if message_code or campaign is not provided.
// Start date in ISO 8601 format "YYYY-MM-DDTHH:MM:SS.SSSZ"
"date_to": "2024-07-20T00:00:00.000Z", // required if message_code or campaign is not provided.
// End date in ISO 8601 format "YYYY-MM-DDTHH:MM:SS.SSSZ"
"per_page": 1000, // required. Number of results per page, maximum 5000
"page": 5, // optional. Page number, starting from zero
"type": "Softbounce" // optional. The type of bounce: 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, // Total count of rows.
"bounced_emails": [{
"email": "example@example.com", // Email address that bounced
"date": "2024-07-20T00:00:00.000Z", // Bounce date in ISO 8601 format
"reason": "Invalid recipient address", // Reason for the bounce
"type": "Hardbounce" // Type of bounce: Complaint, Softbounce, Hardbounce
}]
}