বার্তা পরিসংখ্যান

messages:list

প্রেরিত বার্তাগুলির তালিকা প্রদর্শন করে।

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

হেডার

নাম	প্রয়োজনীয়	বিবরণ
`Authorization`	হ্যাঁ	সার্ভার API টোকেন। অবশ্যই নিম্নলিখিত ফর্ম্যাটে সরবরাহ করতে হবে: `Authorization: Api <Server Key>`।

অনুরোধের বডি প্যারামিটার

নাম	প্রয়োজনীয়	টাইপ	বিবরণ
`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` একই তারিখে সেট করলে সেই পুরো দিনটি ফেরত আসে। তারিখগুলি আপনার অ্যাকাউন্টের টাইমজোনে নয়, UTC-তে ব্যাখ্যা করা হয়।
`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`	হ্যাঁ	String	Pushwoosh অ্যাপ্লিকেশন কোড।
`per_page`	না	Integer	প্রতি পৃষ্ঠায় ফলাফলের সংখ্যা, `1` থেকে `499`। ডিফল্ট পৃষ্ঠা আকার 500টি ফলাফল পেতে প্যারামিটারটি বাদ দিন; `500` বা তার বেশি স্পষ্টভাবে পাস করলে `400` দিয়ে প্রত্যাখ্যান করা হয়।
`page`	না	Integer	পেজিনেশনের জন্য শূন্য-ভিত্তিক পৃষ্ঠা নম্বর। নীচে গভীর পেজিনেশন সীমা দেখুন।

messages:list সেইসব অনুরোধ প্রত্যাখ্যান করে যেখানে page × per_page 100000 ফলাফলের বেশি হয়। সীমার মধ্যে থাকতে date_range সংকীর্ণ করুন বা একটি ছোট per_page ব্যবহার করুন।

total হল ফিল্টারগুলির সাথে মিলে যাওয়া বার্তাগুলির সঠিক সংখ্যা যখন সেই সংখ্যা 100000 বা তার কম থাকে, এবং এর উপরে 100001-এ থেমে যায় — যা এই এন্ডপয়েন্ট পেজ করতে পারে তার চেয়ে বেশি। সেই সীমার বাইরে একটি পেজ লুপ আকার দেবেন না: এর বাইরের পৃষ্ঠাগুলি খালি নয়, প্রত্যাখ্যান করা হয়। এর চেয়ে বেশি বার্তা ধারণকারী একটি সময়কাল টানতে, প্রতি অনুরোধে date_range সংকীর্ণ করুন, অথবা অ্যাসিঙ্ক্রোনাস এক্সপোর্ট ব্যবহার করুন, যা পেজিং ছাড়াই পুরো সময়কালটি একটি 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": [],               // বার্তা আইডি
      "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 ৩০ দিনের বেশি সময় ধরে:

{
  "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

অনুমোদন

অনুরোধের হেডারে API অ্যাক্সেস টোকেনের মাধ্যমে অনুমোদন পরিচালনা করা হয়।

অনুরোধের বডি প্যারামিটার

প্যারামিটারের নাম	টাইপ	বিবরণ	প্রয়োজনীয়
`message_code`	string	`/createMessage` API প্রতিক্রিয়া থেকে প্রাপ্ত বার্তা কোড।	হ্যাঁ
`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	OS সেটিংসে নোটিফিকেশন বন্ধ থাকা ডিভাইসগুলির জন্য গৃহীত বার্তার সংখ্যা। কোনো ব্যানার দেখানো হয় না, কিন্তু বার্তাটি এখনও অ্যাপে পৌঁছায়, এবং যদি প্রেরণে Save message to Inbox সক্রিয় থাকে তবে এটি Message Inbox-এ প্রদর্শিত হয়। সফল প্রেরণ হিসাবে গণনা করা হয়, ত্রুটি হিসাবে নয়।
`errors`	string	ত্রুটির সংখ্যা।
`conversion`	object	রূপান্তর ডেটা ধারণ করে
`sends`	string	প্রেরিত বার্তার মোট সংখ্যা।
`opens`	string	খোলা বার্তার মোট সংখ্যা।
`events`	array	তাদের পরিসংখ্যান সহ ইভেন্টের একটি অ্যারে
`name`	string	ইভেন্টের নাম (যেমন, কার্টে যোগ করা)।
`hits`	string	হিটের সংখ্যা।
`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",                      // ইভেন্টের জন্য হিটের সংখ্যা
      "conversion": 0.12,                // খোলার সাপেক্ষে রূপান্তর হার
      "revenue": 0                       // ইভেন্ট দ্বারা উৎপন্ন রাজস্ব (শুধুমাত্র পরিমাণ/মুদ্রা অ্যাট্রিবিউট সহ ইভেন্টের জন্য)
    }]
  }
}

getMessageLog

প্রেরিত বার্তা সম্পর্কে বিস্তারিত তথ্য প্রদর্শন করে।

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

হেডার

নাম	প্রয়োজনীয়	বিবরণ
`Authorization`	প্রয়োজনীয়	Pushwoosh কন্ট্রোল প্যানেল থেকে API অ্যাক্সেস টোকেন।

অনুরোধের বডি প্যারামিটার

নাম	প্রয়োজনীয়	টাইপ	বিবরণ
`message_id`	না	Integer	বার্তা ইতিহাস থেকে প্রাপ্ত বার্তা আইডি দ্বারা বার্তা ইভেন্ট নির্বাচন করুন। উদাহরণ: `12345678900`।
`message_code`	না	String	`/createMessage` API প্রতিক্রিয়া থেকে প্রাপ্ত বার্তা কোড দ্বারা বার্তা ইভেন্ট নির্বাচন করুন। উদাহরণ: `"A444-AAABBBCC-00112233"`।
`campaign_code`	না	String	আপনার বার্তা পেলোডে নির্দিষ্ট করা ক্যাম্পেইন কোড দ্বারা বার্তা ইভেন্ট নির্বাচন করুন। উদাহরণ: `"AAAAA-XXXXX"`।
`hwid`	না	String or Array	HWID (হার্ডওয়্যার আইডি) বা 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	একটি কাস্টম ব্যবহারকারী আইডি দ্বারা বার্তা ইভেন্ট নির্বাচন করুন। আরও বিস্তারিত জানতে `/registerUser` দেখুন।
`application_code`	হ্যাঁ	String	Pushwoosh অ্যাপ্লিকেশন কোড দ্বারা বার্তা ইভেন্ট নির্বাচন করুন।
`actions`	না	Array	নির্দিষ্ট বার্তা ক্রিয়া দ্বারা ফলাফল ফিল্টার করুন। সম্ভাব্য মান: `"sent"`, `"delivered"`, `"opened"`, `"reject"`, `"create"`, `"inbox_delivered"`, `"inbox_read"`, `"inbox_opened"`, `"inbox_deleted"`। `"create"` ইভেন্টগুলি ডিফল্টরূপে প্রতিক্রিয়া থেকে বাদ দেওয়া হয়। সেগুলি দেখতে এই অ্যারেতে `"create"` অন্তর্ভুক্ত করুন। `"delivered"` ইভেন্টগুলির জন্য অতিরিক্তভাবে অ্যাকাউন্টে ডেলিভারি পরিসংখ্যান সক্রিয় করা প্রয়োজন।
`platforms`	না	Array	ফলাফল ফিল্টার করার জন্য টার্গেট প্ল্যাটফর্মের অ্যারে। সম্ভাব্য মান: `"unknown"`, `"ios"`, `"blackberry"`, `"android"`, `"windows phone"`, `"osx"`, `"windows"`, `"amazon"`, `"safari"`, `"chrome"`, `"firefox"`, `"ie"`, `"email"`, `"fb messenger"`, `"baidu android"`, `"huawei android"`, `"sms"`, `"xiaomi"`, `"web"`, `"whatsapp"`, `"line"`, `"kakao"`, `"telegram"`, `"apple wallet"`, `"google wallet"`, `"viber"`।
`message_type`	না	String	বার্তা প্রবাহ দ্বারা ফলাফল ফিল্টার করুন। `"all"` (বাদ দিলে ডিফল্ট) সবকিছু ফেরত দেয়, `"broadcast"` শুধুমাত্র গণ বার্তা ফেরত দেয় (`message_id != 0`), `"transactional"` শুধুমাত্র `message_id = 0` সহ বার্তা ফেরত দেয়, যার মধ্যে Customer Journey থেকে পাঠানো বার্তাও অন্তর্ভুক্ত।

অনুরোধের উদাহরণ

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,                       // ঐচ্ছিক, Pushwoosh কন্ট্রোল প্যানেল থেকে প্রাপ্ত বার্তা আইডি
   "campaign_code": "AAAAA-XXXXX",                 // ঐচ্ছিক, লগ পাওয়ার জন্য একটি ক্যাম্পেইনের কোড
   "hwid": "aaazzzqqqqxxx",                        // ঐচ্ছিক, একটি বার্তা দিয়ে লক্ষ্য করা নির্দিষ্ট ডিভাইসের হার্ডওয়্যার আইডি
   "user_id": "user_123",                          // ঐচ্ছিক, বার্তা দিয়ে লক্ষ্য করা একজন ব্যবহারকারীর আইডি
   "date_from": "2000-01-25 00:00:00",             // ঐচ্ছিক, পরিসংখ্যান সময়কালের শুরু
   "date_to": "2000-02-10 23:59:59",               // ঐচ্ছিক, পরিসংখ্যান সময়কালের শেষ
   "actions": ["opened", "inbox_opened"],          // ঐচ্ছিক, ফলাফল ফিল্টার করার জন্য ব্যবহৃত। সম্ভাব্য মান: "sent", "delivered", "opened", "reject", "create", "inbox_delivered", "inbox_read", "inbox_opened", "inbox_deleted"। প্রতিক্রিয়াতে নির্দিষ্ট ক্রিয়া(গুলি) সহ সমস্ত বার্তা অন্তর্ভুক্ত থাকবে।
   "platforms": ["ios", "chrome"],                 // ঐচ্ছিক, ফলাফল ফিল্টার করার জন্য ব্যবহৃত, শুধুমাত্র ছোট হাতের অক্ষর। সম্ভাব্য মান: "unknown", "ios", "blackberry", "android", "windows phone", "osx", "windows", "amazon", "safari", "chrome", "firefox", "ie", "email", "fb messenger", "baidu android", "huawei android", "sms", "xiaomi", "web", "whatsapp", "line", "kakao", "telegram", "apple wallet", "google wallet", "viber"
   "message_type": "broadcast"                     // ঐচ্ছিক, "all" (ডিফল্ট), "broadcast" (message_id != 0), বা "transactional" (message_id = 0, Customer Journey প্রেরণ অন্তর্ভুক্ত)
}'

প্রতিক্রিয়া কোড এবং উদাহরণ

{
  "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"
  }, {
    "timestamp": "2000-01-25T11:19:30Z",
    "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": "reject",
    "status": "failed",
    "error_reason": "invalid device token",
    "payload": "SOME_PAYLOAD_STRING"
  }]
}

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

{
  "error": "account not found"
}

data-এর প্রতিটি এন্ট্রিতে error_reason (স্ট্রিং, status "failed" হলে ব্যর্থতার কারণ দিয়ে পূর্ণ করা হয়) এবং একটি ঐচ্ছিক payload (স্ট্রিং) থাকে।

একটি প্রতিক্রিয়া পৃষ্ঠা অনুরোধ করা limit-এর চেয়ে ছোট হতে পারে। শুধুমাত্র এর মানে এই নয় যে এক্সপোর্ট শেষ হয়ে গেছে।

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

linksInteractions

ইমেলের লিঙ্ক ক্লিকে পরিসংখ্যান প্রদর্শন করে

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

হেডার

নাম	প্রয়োজনীয়	বিবরণ
`Authorization`	হ্যাঁ	Pushwoosh কন্ট্রোল প্যানেল থেকে API অ্যাক্সেস টোকেন।

অনুরোধের বডি প্যারামিটার

নাম	প্রয়োজনীয়	টাইপ	বিবরণ
`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`	হ্যাঁ	Array	বার্তা আইডি (বিকল্পভাবে, `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": [],                 // বার্তা আইডি (আপনি এর পরিবর্তে 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

হেডার

নাম	প্রয়োজনীয়	বিবরণ
`Authorization`	হ্যাঁ	Pushwoosh কন্ট্রোল প্যানেল থেকে API অ্যাক্সেস টোকেন।

অনুরোধের বডি প্যারামিটার

নাম	প্রয়োজনীয়	টাইপ	বিবরণ
`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`	হ্যাঁ	Array	বার্তা আইডি (বিকল্পভাবে, `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": [],               // বার্তা আইডি (আপনি এর পরিবর্তে 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

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

অনুমোদন

অনুরোধের হেডারে API অ্যাক্সেস টোকেনের মাধ্যমে অনুমোদন পরিচালনা করা হয়।

অনুরোধের বডি প্যারামিটার

প্যারামিটারের নাম	টাইপ	বিবরণ	প্রয়োজনীয়
`application`	string	Pushwoosh অ্যাপ্লিকেশন কোড	হ্যাঁ
`message_code`	string	বার্তা কোড।	`date range` বা `campaign` প্রদান না করা হলে প্রয়োজনীয়
`campaign`	string	ক্যাম্পেইন কোড।	`message_code` বা `date range` প্রদান না করা হলে প্রয়োজনীয়
`date_from`	string	`YYYY-MM-DDTHH:MM:SS.000Z` (ISO 8601 standard) ফর্ম্যাটে ডেটার জন্য শুরুর তারিখ।	`message_code` বা `campaign` প্রদান না করা হলে প্রয়োজনীয়
`date_to`	string	`YYYY-MM-DDTHH:MM:SS.000Z` (ISO 8601 standard) ফর্ম্যাটে ডেটার জন্য শেষ তারিখ।	`message_code` বা `campaign` প্রদান না করা হলে প্রয়োজনীয়
`per_page`	int	প্রতি পৃষ্ঠায় সারির সংখ্যা, সর্বোচ্চ 5000।	হ্যাঁ
`page`	int	পৃষ্ঠা নম্বর, শূন্য থেকে শুরু।	হ্যাঁ
`type`	string	বাউন্সের ধরন: 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"                        // ঐচ্ছিক। বাউন্সের ধরন: Complaint, Softbounce, Hardbounce
}

প্রতিক্রিয়া ক্ষেত্র

ফিল্ডের নাম	টাইপ	বিবরণ
`total`	int	সারির মোট সংখ্যা।
`bounced_emails`	array	বাউন্স হওয়া ইমেলের বিবরণের একটি অ্যারে।
├── `email`	string	যে ইমেল ঠিকানাটি বাউন্স হয়েছে।
├── `date`	string	বাউন্সের তারিখ (ফর্ম্যাট: `YYYY-MM-DDTHH:MM:SS.000Z`)।
├── `reason`	string	বাউন্সের কারণ।
└── `type`	string	বাউন্সের ধরন: 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"                   // বাউন্সের ধরন: Complaint, Softbounce, Hardbounce
  }]
}