বিষয়বস্তুতে যান
ব্যবহারকারী গাইড সাপোর্ট ডেমো অনুরোধ করুন সাইন ইন করুন
Pushwoosh.com

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

messages:list

Anchor link to

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

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

হেডার
Anchor link to
নাম
প্রয়োজনীয়
বিবরণ
Authorizationহ্যাঁসার্ভার API টোকেন। অবশ্যই নিম্নলিখিত ফরম্যাটে প্রদান করতে হবে: 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"); উভয় দিনই সম্পূর্ণভাবে অন্তর্ভুক্ত, তাই date_from এবং date_to একই তারিখে সেট করলে সেই পুরো দিনটি ফেরত আসে।
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নাArrayMessage History থেকে প্রাপ্ত বার্তা আইডি
paramsনাObjectবার্তার বিবরণ এবং মেট্রিক্স দেখানো হবে কিনা তা নির্দিষ্ট করুন। প্রতিক্রিয়াতে "details" অবজেক্ট অন্তর্ভুক্ত করতে with_details: true এবং "metrics" অবজেক্ট অন্তর্ভুক্ত করতে with_metrics: true সেট করুন।
applicationহ্যাঁStringPushwoosh অ্যাপ্লিকেশন কোড।
per_pageনাIntegerপ্রতি পৃষ্ঠায় ফলাফলের সংখ্যা, 1 থেকে 499। ডিফল্ট পৃষ্ঠা আকার 500 ফলাফল পেতে প্যারামিটারটি বাদ দিন; 500 বা তার বেশি স্পষ্টভাবে পাস করলে 400 দিয়ে প্রত্যাখ্যান করা হয়।
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": [],               // বার্তা আইডি
      "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
      }]
    }
  }]
}

totalsByIntervals

Anchor link to

বার্তার কোডের উপর ভিত্তি করে মেট্রিক্স এবং কনভার্সন ডেটা প্রদান করে, যা ঘণ্টা অনুসারে একত্রিত করা হয়।

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

অনুমোদন
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ইভেন্টের নাম (যেমন, কার্টে যোগ করা)।
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                       // ইভেন্ট দ্বারা উৎপন্ন রাজস্ব (শুধুমাত্র পরিমাণ/মুদ্রা অ্যাট্রিবিউট সহ ইভেন্টের জন্য)
    }]
  }
}

getDeliveryFunnel

Anchor link to

একটি একক বার্তার জন্য ডেলিভারি ফানেল প্রদান করে, চ্যানেল দ্বারা বিভক্ত: দর্শক → প্রেরিত → ত্রুটি → ডেলিভারি → খোলা, সাথে ইমেল সম্প্রচারের জন্য ইন্টারঅ্যাকশন। প্রতিটি পর্যায়ে প্রতিটি চ্যানেলের দর্শক কোথায় হারিয়েছে তার একটি ব্রেকডাউন অন্তর্ভুক্ত করে।

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

হেডার
Anchor link to
নাম
প্রয়োজনীয়
বিবরণ
Authorizationপ্রয়োজনীয়Pushwoosh কন্ট্রোল প্যানেল থেকে API অ্যাক্সেস টোকেন।
অনুরোধ বডি প্যারামিটার
Anchor link to
নাম
প্রয়োজনীয়
টাইপ
বিবরণ
message_codeহ্যাঁString/createMessage API প্রতিক্রিয়া থেকে প্রাপ্ত বার্তা কোড।
platformsনাArray of Integerঐচ্ছিক প্ল্যাটফর্ম আইডি ফিল্টার।

এখানে কোনো সময়-পরিসীমা প্যারামিটার নেই: ফানেলের কোনো সময় অক্ষ নেই, তাই সার্ভার বার্তার নিজস্ব প্রেরণ এবং নিশ্চিতকরণ ডেটা থেকে উইন্ডোটি নির্ধারণ করে (যা window_from/window_to হিসাবে ফেরত দেওয়া হয়)।

নমুনা অনুরোধ
Anchor link to
{
  "message_code": "A444-AAABBBCC-00112233",  // প্রয়োজনীয়, /createMessage প্রতিক্রিয়া থেকে প্রাপ্ত বার্তা কোড
  "platforms": [1, 3, 7]                     // ঐচ্ছিক, প্ল্যাটফর্ম কোডের তালিকা
}
প্রতিক্রিয়া ক্ষেত্র
Anchor link to
নামটাইপবিবরণ
channelsarrayএই বার্তার জন্য ডেটা সহ প্রতি চ্যানেলে একটি এন্ট্রি। যে চ্যানেলটি বার্তাটি কখনও ব্যবহার করেনি তা বাদ দেওয়া হয়েছে — এর অনুপস্থিতির অর্থ “কোনো ডেটা নেই”, শূন্য নয়।
channels[].channelstringCHANNEL_MOBILE_PUSH (iOS, OSX, Android, Amazon, Huawei), CHANNEL_WEB_PUSH (Safari, Chrome, Firefox), CHANNEL_EMAIL, বা CHANNEL_OTHER (SMS, messengers, Wallet, Windows, এবং অন্যান্য প্ল্যাটফর্ম)।
channels[].funnelarrayএই চ্যানেলের জন্য ফানেল পর্যায়, সর্বদা এই ক্রমে: STAGE_AUDIENCE, STAGE_SENT, STAGE_ERRORS, STAGE_DELIVERIES, STAGE_OPENED, এবং — শুধুমাত্র ইমেল সম্প্রচারের জন্য, লেনদেনমূলক বার্তার জন্য নয় — STAGE_INTERACTIONS।
channels[].funnel[].stagestringফানেল পর্যায়ের নাম।
channels[].funnel[].countstringপর্যায়ের জন্য মোট গণনা।
channels[].funnel[].piecesarraycount-এর বিভাগগুলিতে বিভাজন। STAGE_ERRORS-এ খালি, যা পরিবর্তে errors বহন করে। শূন্য গণনা সহ একটি বিভাগ 0 হিসাবে ফেরত দেওয়ার পরিবর্তে বাদ দেওয়া হয়।
channels[].funnel[].pieces[].kindstringটুকরাটি পর্যায়ের মোটের সাথে কীভাবে সম্পর্কিত: KIND_PASSED (পরবর্তী পর্যায়ে চলে গেছে) বা KIND_REASON (এই কারণে বাদ পড়েছে)। প্রতিটি টুকরা একটি যোগফল — একটি পর্যায়ের টুকরা সবসময় তার count-এর সাথে যোগ হয়।
channels[].funnel[].pieces[].categorystringবিভাজন বিভাগ, যেমন INVALID_TOKEN, FREQUENCY_CAPPING, ELIGIBLE_AUDIENCE — নিচের পর্যায় সারণী দেখুন।
channels[].funnel[].pieces[].countstringএই বিভাগের জন্য গণনা।
channels[].funnel[].pieces[].platformsarrayএই বিভাগের প্রতি-প্ল্যাটফর্ম বিভাজন: { "platform": <id>, "count": "<n>" }। রিপোর্ট করার মতো কিছু না থাকলে একটি প্ল্যাটফর্ম 0 হিসাবে ফেরত দেওয়ার পরিবর্তে বাদ দেওয়া হয়।
channels[].funnel[].errorsarrayশুধুমাত্র STAGE_ERRORS, pieces-এর পরিবর্তে: প্রতি ড্রপ-আউট বিভাগের জন্য একটি সারি (category, count, platforms) — একটি টুকরার মতো একই আকার, kind ছাড়া।
channels[].funnel[].platformsarrayপর্যায়ের নিজস্ব count-এর প্রতি-প্ল্যাটফর্ম বিভাজন।
channels[].deliveries_formstringSTAGE_DELIVERIES কোন বিভাজন বহন করে: DELIVERIES_FORM_PER_DEVICE (তিনটি সারি, সতর্কতা অবস্থা জানা) বা DELIVERIES_FORM_BASIC (দুটি সারি, সতর্কতা অবস্থা অজানা)।
channels[].basic_form_reasonstringশুধুমাত্র যখন deliveries_form DELIVERIES_FORM_BASIC হয় তখন সেট করা হয়: BASIC_FORM_REASON_RETENTION (বার্তা সারি-স্তরের লগের চেয়ে পুরানো), BASIC_FORM_REASON_UNAVAILABLE (এই অ্যাকাউন্টের জন্য কোনো প্রতি-ডিভাইস ডেটা নেই), BASIC_FORM_REASON_NO_DELIVERIES (এখনও কিছু গ্রহণ করা হয়নি), বা BASIC_FORM_REASON_NOT_APPLICABLE (এই চ্যানেলের কোনো সতর্কতা অবস্থা নেই — এটি কোনো অবনতি নয়)।
channels[].confirmed_deliveriesobject{ "count": "<n>", "platforms": [...] } — অনন্য ডিভাইস যা ডেলিভারি নিশ্চিত করেছে, deliveries_form-এর থেকে স্বাধীন। confirmed_deliveries STAGE_DELIVERIES.count-এ সীমাবদ্ধ নয়, তাই এটি সেই মোটের থেকে সামান্য বিচ্যুত হতে পারে; বিভিন্ন বয়সের বার্তা জুড়ে একটি অবিচ্ছিন্ন ডেলিভারি ট্রেন্ডের জন্য confirmed_deliveries ব্যবহার করুন।
window_from, window_tostring (RFC 3339 date-time)যে সময় উইন্ডোতে ফানেলটি আসলে গণনা করা হয়েছিল, তা বার্তার নিজস্ব ডেটা থেকে প্রাপ্ত।
funnel_statestringFUNNEL_STATE_READY (channels জনবহুল), FUNNEL_STATE_NO_EVENTS (এই বার্তার জন্য এখনও কিছু ঘটেনি — channels খালি), বা FUNNEL_STATE_EXPIRED (বার্তা ৩৬৫ দিনের চেয়ে পুরানো, পরিসংখ্যান আর সংরক্ষণ করা হয় না — channels খালি)।
ফানেল পর্যায়
Anchor link to
পর্যায়প্রযোজ্যcount মানেpieces / errors
STAGE_AUDIENCEসব চ্যানেলপ্রক্রিয়াকরণের জন্য নেওয়া হয়েছে।KIND_PASSED ELIGIBLE_AUDIENCE; KIND_REASON: FREQUENCY_CAPPING, CONTROL_GROUP (সব চ্যানেল), UNSUBSCRIBED, BOUNCED, COMPLAINT, FILTERED_BY_CATEGORY (শুধুমাত্র ইমেল)
STAGE_SENTসব চ্যানেলগেটওয়ে/প্রদানকারী দ্বারা গৃহীত (ACCEPTED_BY_GATEWAY)।কোনোটিই নয় — পর্যায়টি সম্পূর্ণরূপে গৃহীত মোট; প্রত্যাখ্যানগুলি STAGE_ERRORS-এর অধীনে দেখানো হয়
STAGE_ERRORSসব চ্যানেলপ্রাপকের কাছে পৌঁছানোর আগে প্রত্যাখ্যান করা হয়েছে।errors[], pieces নয়: INTERNAL_ERROR, INVALID_TOKEN, NO_TOKEN, NO_DEVICE, PLATFORM_DISABLED, QUOTA_EXCEEDED, INVALID_CONTENT, INVALID_CONFIGURATION, PROVIDER_ERROR (অশ্রেণীবদ্ধ)
STAGE_DELIVERIESসব চ্যানেলনিশ্চিত করার জন্য গৃহীত প্রেরণ — কতগুলি ছিল, কতগুলি নিশ্চিত করেছে তা নয়।প্রতি-ডিভাইস ফর্ম: KIND_PASSED DISPLAYABLE_CONFIRMED; KIND_REASON: DISPLAYABLE_NO_CONFIRMATION, ALERTS_DISABLED। বেসিক ফর্ম: KIND_PASSED CONFIRMED_BY_DEVICE; KIND_REASON NO_CONFIRMATION
STAGE_OPENEDসব চ্যানেলঅনন্য ডিভাইস/ঠিকানা যা খুলেছে।শুধুমাত্র ইমেল, এবং শুধুমাত্র যখন বার্তাটি ৬০ দিনের কম বয়সী: KIND_PASSED OPENED_BY_RECIPIENT; KIND_REASON: MACHINE_OPENS_ONLY (স্বয়ংক্রিয় খোলা, যেমন মেইলবক্স প্রিভিউ ক্লায়েন্ট), OPEN_TYPE_UNKNOWN। অন্যান্য চ্যানেল, এবং ৬০ দিনের বেশি পুরানো ইমেল: কোনো pieces নেই।
STAGE_INTERACTIONSশুধুমাত্র ইমেল সম্প্রচার (লেনদেনমূলক বার্তা নয়)প্রাপক ইমেল দিয়ে কী করেছে।KIND_PASSED CLICKED_ONLY; KIND_REASON: CLICKED_AND_UNSUBSCRIBED, CLICKED_AND_COMPLAINED, UNSUBSCRIBED_WITHOUT_CLICK, COMPLAINED_WITHOUT_CLICK
প্রতিক্রিয়া উদাহরণ
Anchor link to
{
  "channels": [
    {
      "channel": "CHANNEL_EMAIL",
      "funnel": [
        {
          "stage": "STAGE_AUDIENCE",
          "count": "600000",
          "pieces": [
            { "kind": "KIND_PASSED", "category": "ELIGIBLE_AUDIENCE", "count": "580000" },
            { "kind": "KIND_REASON", "category": "UNSUBSCRIBED", "count": "14000" },
            { "kind": "KIND_REASON", "category": "BOUNCED", "count": "6000" }
          ]
        },
        {
          "stage": "STAGE_SENT",
          "count": "560000",
          "pieces": []
        },
        {
          "stage": "STAGE_ERRORS",
          "count": "20000",
          "errors": [
            { "category": "INVALID_TOKEN", "count": "18000" },
            { "category": "PROVIDER_ERROR", "count": "2000" }
          ]
        },
        {
          "stage": "STAGE_DELIVERIES",
          "count": "560000",
          "pieces": [
            { "kind": "KIND_PASSED", "category": "CONFIRMED_BY_DEVICE", "count": "540000" },
            { "kind": "KIND_REASON", "category": "NO_CONFIRMATION", "count": "20000" }
          ]
        },
        {
          "stage": "STAGE_OPENED",
          "count": "30514",
          "pieces": [
            { "kind": "KIND_PASSED", "category": "OPENED_BY_RECIPIENT", "count": "26102" },
            { "kind": "KIND_REASON", "category": "MACHINE_OPENS_ONLY", "count": "4412" }
          ]
        },
        {
          "stage": "STAGE_INTERACTIONS",
          "count": "1980",
          "pieces": [
            { "kind": "KIND_PASSED", "category": "CLICKED_ONLY", "count": "1820" },
            { "kind": "KIND_REASON", "category": "UNSUBSCRIBED_WITHOUT_CLICK", "count": "140" },
            { "kind": "KIND_REASON", "category": "CLICKED_AND_COMPLAINED", "count": "20" }
          ]
        }
      ],
      "deliveries_form": "DELIVERIES_FORM_BASIC",
      "basic_form_reason": "BASIC_FORM_REASON_NOT_APPLICABLE",
      "confirmed_deliveries": { "count": "540000" }
    },
    {
      "channel": "CHANNEL_MOBILE_PUSH",
      "funnel": [
        {
          "stage": "STAGE_DELIVERIES",
          "count": "168316",
          "pieces": [
            { "kind": "KIND_PASSED", "category": "DISPLAYABLE_CONFIRMED", "count": "89570" },
            { "kind": "KIND_REASON", "category": "DISPLAYABLE_NO_CONFIRMATION", "count": "78746" }
          ]
        },
        { "stage": "STAGE_OPENED", "count": "30514", "pieces": [] }
      ],
      "deliveries_form": "DELIVERIES_FORM_PER_DEVICE",
      "confirmed_deliveries": { "count": "91240" }
    }
  ],
  "window_from": "2026-08-01T00:00:00Z",
  "window_to": "2026-08-04T00:00:00Z",
  "funnel_state": "FUNNEL_STATE_READY"
}
প্রতিক্রিয়া কোড এবং উদাহরণ 
{
  "channels": [],
  "funnel_state": "FUNNEL_STATE_NO_EVENTS"
}

getMessageLog

Anchor link to

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

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

হেডার
Anchor link to
নাম
প্রয়োজনীয়
বিবরণ
Authorizationপ্রয়োজনীয়Pushwoosh কন্ট্রোল প্যানেল থেকে API অ্যাক্সেস টোকেন।
অনুরোধ বডি প্যারামিটার
Anchor link to
নাম
প্রয়োজনীয়
টাইপ
বিবরণ
message_idনাIntegerবার্তা ইতিহাস থেকে প্রাপ্ত বার্তা আইডি দ্বারা বার্তা ইভেন্ট নির্বাচন করুন। উদাহরণ: 12345678900।
message_codeনাString/createMessage API প্রতিক্রিয়া থেকে প্রাপ্ত বার্তা কোড দ্বারা বার্তা ইভেন্ট নির্বাচন করুন। উদাহরণ: "A444-AAABBBCC-00112233"।
campaign_codeনাStringআপনার বার্তা পেলোডে নির্দিষ্ট করা ক্যাম্পেইন কোড দ্বারা বার্তা ইভেন্ট নির্বাচন করুন। উদাহরণ: "AAAAA-XXXXX"।
hwidনাString or ArrayHWID (হার্ডওয়্যার আইডি) বা HWID-এর একটি অ্যারে দ্বারা বার্তা ইভেন্ট নির্বাচন করুন।
date_frommessage_id, message_code, বা campaign_code প্রদান না করা হলে প্রয়োজনীয়Datetimeবার্তা ফিল্টার করার জন্য শুরুর তারিখ। ফরম্যাট: "YYYY-MM-DD HH:MM:SS"। উদাহরণ: "2000-01-25 00:00:00"।
date_tomessage_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হ্যাঁ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
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,                       // ঐচ্ছিক, 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", "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

হেডার
Anchor link to
নাম
প্রয়োজনীয়
বিবরণ
Authorizationহ্যাঁPushwoosh কন্ট্রোল প্যানেল থেকে API অ্যাক্সেস টোকেন।
অনুরোধ বডি প্যারামিটার
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_templateapplication বা 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 অন্তর্ভুক্ত, যা পরিসংখ্যান সহ সম্পূর্ণ লিঙ্কের একটি তালিকা যোগ করে।
নমুনা অনুরোধ
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": [],                 // বার্তা আইডি (আপনি পরিবর্তে 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

হেডার
Anchor link to
নাম
প্রয়োজনীয়
বিবরণ
Authorizationহ্যাঁPushwoosh কন্ট্রোল প্যানেল থেকে API অ্যাক্সেস টোকেন।
অনুরোধ বডি প্যারামিটার
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_templateapplication বা 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)।
নমুনা অনুরোধ
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": [],               // বার্তা আইডি (আপনি পরিবর্তে 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

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

অনুমোদন
Anchor link to

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

অনুরোধ বডি প্যারামিটার
Anchor link to
প্যারামিটার নামটাইপবিবরণপ্রয়োজনীয়
applicationstringPushwoosh অ্যাপ্লিকেশন কোডহ্যাঁ
message_codestringবার্তা কোড।date range বা campaign প্রদান না করা হলে প্রয়োজনীয়
campaignstringক্যাম্পেইন কোড।message_code বা date range প্রদান না করা হলে প্রয়োজনীয়
date_fromstringYYYY-MM-DDTHH:MM:SS.000Z (ISO 8601 standard) ফরম্যাটে ডেটার জন্য শুরুর তারিখ।message_code বা campaign প্রদান না করা হলে প্রয়োজনীয়
date_tostringYYYY-MM-DDTHH:MM:SS.000Z (ISO 8601 standard) ফরম্যাটে ডেটার জন্য শেষের তারিখ।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
  }]
}