सामग्री पर जाएं
उपयोगकर्ता गाइड कैसे करें गाइड सहायता डेमो अनुरोध करें साइन इन करें
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नहींऐरेसंदेश प्लेटफ़ॉर्म। संभावित मान: "IOS", "ANDROID", "OSX", "WINDOWS", "AMAZON", "SAFARI", "CHROME", "FIREFOX", "IE", "EMAIL", "HUAWEI_ANDROID", "SMS"।
date_rangeनहींऑब्जेक्टरिपोर्टिंग अवधि, संदेश निर्माण तिथि पर फ़िल्टर की गई। date_from और date_to को YYYY-MM-DD प्रारूप का पालन करना चाहिए (उदाहरण के लिए, "2000-01-01"); दोनों दिन पूरी तरह से शामिल हैं, इसलिए date_from और date_to को एक ही तिथि पर सेट करने पर वह पूरा दिन वापस आ जाता है। तिथियों की व्याख्या UTC में की जाती है, आपके खाते के टाइमज़ोन में नहीं।
campaignनहींस्ट्रिंगअभियान कोड
filtersहाँऑब्जेक्टसंदेश फ़िल्टर।
sourceनहींस्ट्रिंगसंदेश स्रोत। उदाहरण के लिए: AB_TEST, API, AUTO_PUSH, CP, CSV, CUSTOMER_JOURNEY, EMAIL_API, EMAIL_CP, GEO_ZONE, PUSH_ON_EVENT, RSS।
messages_codesनहींऐरे/createMessage API प्रतिक्रियाओं से प्राप्त संदेश कोड।
messages_idsनहींऐरेसंदेश इतिहास से प्राप्त संदेश आईडी
message_typeनहींस्ट्रिंगमैसेज फ़्लो फ़िल्टर। संभावित मान: "TRANSACTIONAL", "BROADCAST", "ALL"। छोड़ने पर डिफ़ॉल्ट रूप से "ALL" होता है।
paramsनहींऑब्जेक्टनिर्दिष्ट करें कि संदेश विवरण और मेट्रिक्स दिखाने हैं या नहीं। प्रतिक्रिया में "details" ऑब्जेक्ट को शामिल करने के लिए with_details: true और "metrics" ऑब्जेक्ट को शामिल करने के लिए with_metrics: true सेट करें।
applicationहाँस्ट्रिंगPushwoosh एप्लिकेशन कोड।
per_pageनहींइंटीजरप्रति पृष्ठ परिणामों की संख्या, 1 से 499 तक। 500 परिणामों का डिफ़ॉल्ट पृष्ठ आकार प्राप्त करने के लिए पैरामीटर को छोड़ दें; 500 या अधिक को स्पष्ट रूप से पास करने पर 400 के साथ अस्वीकार कर दिया जाता है।
pageनहींइंटीजरपेजिनेशन के लिए शून्य-आधारित पृष्ठ संख्या। नीचे दी गई डीप पेजिनेशन सीमा देखें।

message_type यह भी तय करता है कि बिना तारीख वाला अनुरोध कितना पीछे तक जाता है।

उदाहरण अनुरोध
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": [],             // संदेश कोड
      "message_type": "ALL",            // TRANSACTIONAL, BROADCAST, ALL (डिफ़ॉल्ट)
      "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
नामप्रकारविवरण
metricsऐरेसंदेश मेट्रिक्स का एक ऐरे होता है
timestampstringमेट्रिक का समय।
platformintप्लेटफ़ॉर्म कोड (जैसे, iOS, Android)।
sendsstringभेजे गए संदेशों की संख्या।
opensstringखोले गए संदेशों की संख्या।
deliveriesstringवितरित संदेशों की संख्या।
inbox_opensstringइनबॉक्स ओपन की संख्या।
unshowable_sendsstringउन डिवाइसों के लिए स्वीकार किए गए संदेशों की संख्या जिनकी सूचनाएं OS सेटिंग्स में बंद हैं। कोई बैनर नहीं दिखाया जाता है, लेकिन संदेश अभी भी ऐप तक पहुंचता है, और यह Message Inbox में दिखाई देता है यदि भेजने में Save message to Inbox सक्षम है। सफल भेजने के रूप में गिना जाता है, त्रुटियों के रूप में नहीं।
errorsstringत्रुटियों की संख्या।
conversionऑब्जेक्टरूपांतरण डेटा होता है
sendsstringभेजे गए संदेशों की कुल संख्या।
opensstringखोले गए संदेशों की कुल संख्या।
eventsऐरेउनके आँकड़ों के साथ घटनाओं का एक ऐरे
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                       // घटना द्वारा उत्पन्न राजस्व (केवल राशि/मुद्रा विशेषताओं वाली घटनाओं के लिए)
    }]
  }
}

डिलीवरी फ़नल

Anchor link to

यह देखने के लिए डिलीवरी फ़नल का उपयोग करें कि किसी संदेश या कैंपेन ने किस चरण में अपनी ऑडियंस खो दी (त्रुटियां, कोई डिलीवरी नहीं, कोई ओपन नहीं) और क्यों। totalsByIntervals के विपरीत, जो प्रति घंटा कुल योग लौटाता है, फ़नल ऑडियंस को चरण और ड्रॉप-आउट कारण के अनुसार विभाजित करता है, प्रति चैनल एक प्रविष्टि, साथ ही प्रति-प्लेटफ़ॉर्म विभाजन के साथ। चरण क्रम चैनल के अनुसार भिन्न होता है: नीचे GetDeliveryFunnelResponse फ़ील्ड्स के तहत stage देखें कि प्रत्येक चैनल में कौन से चरण होते हैं। दोनों विधियों के लिए सर्वर API टोकन आवश्यक है।

दोनों विधियां एक ही रिस्पॉन्स आकार, GetDeliveryFunnelResponse, लौटाती हैं, जिसे नीचे एक बार वर्णित किया गया है।

getDeliveryFunnel

Anchor link to

एक संदेश का फ़नल लौटाता है।

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

हेडर
Anchor link to
नाम
आवश्यक
विवरण
Authorizationहाँसर्वर API टोकन। निम्न प्रारूप में प्रदान किया जाना चाहिए: Authorization: Api <Server Key>।
रिक्वेस्ट बॉडी पैरामीटर
Anchor link to
नाम
आवश्यक
प्रकार
विवरण
message_codeहाँस्ट्रिंग/createMessage API प्रतिक्रियाओं से प्राप्त संदेश कोड।
platformsनहींइंटीजर का ऐरेफ़नल को फ़िल्टर करने के लिए प्लेटफ़ॉर्म कोड। संदेश जिन सभी प्लेटफ़ॉर्म पर भेजा गया था उन्हें लौटाने के लिए छोड़ दें।
उदाहरण अनुरोध
Anchor link to
{
  "message_code": "A444-AAABBBCC-00112233",  // /createMessage से संदेश कोड
  "platforms": [1, 14]                        // वैकल्पिक। iOS, Email
}
GetDeliveryFunnelResponse फ़ील्ड्स
Anchor link to
नाम
प्रकारविवरण
channelsऐरेसंदेश जिन चैनलों पर भेजा गया, उनमें से प्रत्येक के लिए एक प्रविष्टि।
window_from, window_toस्ट्रिंग या nullउपलब्ध डेटा के आधार पर, वह अवधि जिसे फ़नल कवर करता है। जब funnel_state FUNNEL_STATE_READY न हो तो null।
funnel_stateस्ट्रिंगFUNNEL_STATE_READY: नीचे दिया गया फ़नल भरा हुआ है। FUNNEL_STATE_NO_EVENTS: इस संदेश के लिए अभी तक कुछ नहीं हुआ है। FUNNEL_STATE_EXPIRED: संदेश बहुत पहले भेजा गया था। इसके लिए फ़नल डेटा अब उपलब्ध नहीं है। दोनों गैर-READY स्थितियों में channels खाली रहता है। एक अज्ञात, दूसरे खाते का, या हटाया गया message_code इनमें से कोई स्थिति नहीं है, नीचे 404 प्रतिक्रिया देखें।

channels[]

नामप्रकारविवरण
channelस्ट्रिंगCHANNEL_MOBILE_PUSH (iOS, macOS, Android, Amazon, Huawei), CHANNEL_WEB_PUSH (Safari, Chrome, Firefox), CHANNEL_EMAIL, CHANNEL_OTHER (SMS, मैसेंजर, Wallet, Windows, Baidu, Xiaomi), CHANNEL_APP_INBOX।
funnelऐरेइस चैनल के लिए फ़नल चरण, नीचे funnel[] देखें।
deliveries_formस्ट्रिंगSTAGE_DELIVERIES चरण किस विभाजन को वहन करता है: DELIVERIES_FORM_PER_DEVICE (चार असंबद्ध पंक्तियां, इसके अनुसार विभाजित कि डिवाइस अलर्ट दिखाएगा या नहीं और उसने पुष्टि की या नहीं) या DELIVERIES_FORM_BASIC (दो पंक्तियां, अलर्ट-स्थिति विभाजन के बिना)।
basic_form_reasonस्ट्रिंगकेवल तब सार्थक होता है जब deliveries_form DELIVERIES_FORM_BASIC हो: BASIC_FORM_REASON_RETENTION (संदेश प्रति-डिवाइस विभाजन के लिए बहुत पुराना है), BASIC_FORM_REASON_UNAVAILABLE (इस खाते या संदेश के लिए प्रति-डिवाइस विभाजन उपलब्ध नहीं है, उदाहरण के लिए एक सिस्टम संदेश), BASIC_FORM_REASON_NO_DELIVERIES (अभी तक कुछ भी स्वीकार नहीं किया गया), BASIC_FORM_REASON_NOT_APPLICABLE (चैनल में कोई अलर्ट स्थिति ही नहीं है, उदाहरण के लिए email या App Inbox)। अन्यथा BASIC_FORM_REASON_UNSPECIFIED: जब तक deliveries_form DELIVERIES_FORM_BASIC न हो, इस फ़ील्ड को अनदेखा करें।
confirmed_deliveriesऑब्जेक्टपुष्ट डिलीवरी की count और platforms के अनुसार विभाजन। यह STAGE_DELIVERIES की गिनती तक सीमित नहीं है, इसलिए यह उससे भिन्न हो सकता है।

funnel[] (एक चरण)

नामप्रकारविवरण
stageस्ट्रिंगSTAGE_AUDIENCE (जिन सभी को संदेश ने लक्षित किया), STAGE_SENT (पुश सेवा या ईमेल प्रदाता द्वारा स्वीकार किया गया), STAGE_ERRORS (स्वीकार किए जाने से पहले अस्वीकृत), STAGE_DELIVERIES (स्वीकृत, पुष्टिकरण के अनुसार विभाजित), STAGE_OPENED (खोलने वाले अद्वितीय डिवाइस, या App Inbox के लिए वे प्रविष्टियां जिन्हें उपयोगकर्ता ने टैप करके खोला), STAGE_INTERACTIONS (केवल ईमेल: क्लिक किया, अनसब्सक्राइब किया, शिकायत की), STAGE_REACHED/STAGE_READ (केवल App Inbox, STAGE_DELIVERIES को प्रतिस्थापित करते हैं)।
countस्ट्रिंगचरण का कुल योग, एक संख्यात्मक स्ट्रिंग के रूप में।
piecesऐरेचरण का अपना विभाजन। STAGE_ERRORS पर खाली, जो इसके बजाय errors का उपयोग करता है। प्रत्येक भाग में kind (KIND_PASSED अगले चरण में आगे बढ़ा, KIND_REASON नहीं बढ़ा, KIND_SUBSET अन्य दोनों के साथ ओवरलैप करता है और कभी योग नहीं किया जाता), category (नीचे प्रत्येक चरण के लिए मानों की सूची देखें), count, और platforms के अनुसार विभाजन होता है।
errorsऐरेकेवल STAGE_ERRORS: category (नीचे मानों की सूची देखें), count, platforms, और codes: इस श्रेणी में समूहीकृत मूल प्रदाता त्रुटि कोड (platform, code, name, count)। प्रत्येक name का क्या अर्थ है और इसे कैसे ठीक करें, यह जानने के लिए भेजने की त्रुटियाँ देखें।
platformsऐरेचरण का कुल, प्लेटफ़ॉर्म के अनुसार विभाजित।

category मान

STAGE_AUDIENCE:

  • ELIGIBLE_AUDIENCE (उत्तीर्ण): नीचे दिए गए किसी भी कारण से बाहर नहीं रखा गया।
  • FREQUENCY_CAPPING: फ़्रीक्वेंसी कैपिंग द्वारा छोड़ा गया।
  • CONTROL_GROUP: एक कंट्रोल ग्रुप के रूप में रोका गया।
  • UNSUBSCRIBED: प्राप्तकर्ता ने अनसब्सक्राइब कर दिया था।
  • BOUNCED: प्राप्तकर्ता का पता पहले भी बाउंस हो चुका था।
  • COMPLAINT: प्राप्तकर्ता ने पहले किसी संदेश को स्पैम के रूप में चिह्नित किया था।
  • FILTERED_BY_CATEGORY: प्राप्तकर्ता ने इस संदेश की श्रेणी से ऑप्ट-आउट किया था।

STAGE_ERRORS:

  • NO_TOKEN: डिवाइस के पास भेजने के लिए कोई पुश टोकन या पता नहीं था।
  • NO_DEVICE: कोई मेल खाता डिवाइस नहीं मिला।
  • PLATFORM_DISABLED: इस ऐप के लिए प्लेटफ़ॉर्म अक्षम है।
  • INVALID_TOKEN: प्रदाता ने डिवाइस टोकन या पते को अमान्य मानकर अस्वीकार कर दिया।
  • QUOTA_EXCEEDED: प्रदाता ने भेजने की दर सीमित कर दी।
  • INVALID_CONTENT: संदेश को जैसा कंपोज़ किया गया था वैसे भेजा नहीं जा सका। अक्सर टेम्पलेट स्वयं बनने में विफल रहा, उदाहरण के लिए एक टूटा हुआ Connected Content या Liquid ब्लॉक, न कि प्रदाता द्वारा अस्वीकार किया जाना।
  • INVALID_CONFIGURATION: खाते का अपना प्रदाता सेटअप टूटा हुआ है, उदाहरण के लिए गलत क्रेडेंशियल, एक हटाया गया Firebase प्रोजेक्ट, या एक अस्वीकृत APNs topic।
  • PROVIDER_ERROR: प्रदाता ने ऊपर दी गई श्रेणियों से बाहर की त्रुटि लौटाई।
  • INTERNAL_ERROR: Pushwoosh भेजने को प्रोसेस करने में विफल रहा।
  • UNCLASSIFIED_ERROR: एक ड्रॉप-आउट जो ऊपर दी गई किसी भी श्रेणी से मेल नहीं खाता। दुर्लभ होने की उम्मीद है।

STAGE_DELIVERIES, DELIVERIES_FORM_PER_DEVICE:

  • DISPLAYABLE_CONFIRMED (उत्तीर्ण): डिवाइस ने अलर्ट दिखाया और प्राप्ति की पुष्टि की।
  • DISPLAYABLE_NO_CONFIRMATION: डिवाइस अलर्ट दिखाता लेकिन अभी तक प्राप्ति की पुष्टि नहीं की है।
  • NOT_DISPLAYABLE_CONFIRMED (उत्तीर्ण): एक साइलेंट पुश ने प्राप्ति की पुष्टि की।
  • NOT_DISPLAYABLE_NO_CONFIRMATION: एक साइलेंट पुश ने अभी तक प्राप्ति की पुष्टि नहीं की है।

STAGE_DELIVERIES, DELIVERIES_FORM_BASIC:

  • CONFIRMED_BY_DEVICE (उत्तीर्ण): डिवाइस ने प्राप्ति की पुष्टि की।
  • NO_CONFIRMATION: अभी तक पुष्टि नहीं हुई।

ईमेल इसके अतिरिक्त, CONFIRMED_BY_DEVICE के साथ ओवरलैप करने वाले एक सबसेट के रूप में जोड़ता है:

  • BOUNCED_HARD (सबसेट): पता स्थायी रूप से डिलीवर नहीं किया जा सकता।
  • BOUNCED_SOFT (सबसेट): पता अस्थायी रूप से डिलीवर नहीं किया जा सकता, उदाहरण के लिए एक भरा हुआ मेलबॉक्स।

BOUNCED_HARD इन सबसेट पंक्तियों में भी विभाजित हो सकता है:

  • BOUNCED_HARD_GENERAL: स्थायी रूप से डिलीवर नहीं किया जा सकता, कोई अधिक विशिष्ट कारण उपलब्ध नहीं।
  • BOUNCED_HARD_MAILBOX_FULL: प्राप्तकर्ता का मेलबॉक्स भरा हुआ है।
  • BOUNCED_HARD_MAILBOX_INACTIVE: प्राप्तकर्ता का मेलबॉक्स अब मौजूद नहीं है।
  • BOUNCED_HARD_SUPPRESSED: प्रदाता ने पते को ब्लॉकलिस्ट में डाल रखा है।
  • BOUNCED_HARD_UNDETERMINED: स्थायी रूप से डिलीवर नहीं किया जा सकता, कारण निर्धारित नहीं।

BOUNCED_SOFT इन सबसेट पंक्तियों में भी विभाजित हो सकता है:

  • BOUNCED_SOFT_GENERAL: अस्थायी रूप से डिलीवर नहीं किया जा सकता, कोई अधिक विशिष्ट कारण उपलब्ध नहीं।
  • BOUNCED_SOFT_MAILBOX_FULL: उस समय प्राप्तकर्ता का मेलबॉक्स भरा हुआ था।
  • BOUNCED_SOFT_CONTENT_REJECTED: प्राप्तकर्ता के मेल सर्वर ने संदेश की सामग्री को अस्वीकार कर दिया।
  • BOUNCED_SOFT_SPAM: प्राप्तकर्ता के मेल सर्वर ने संदेश को स्पैम के रूप में चिह्नित किया।
  • BOUNCED_SOFT_MESSAGE_TOO_LARGE: संदेश प्राप्तकर्ता के मेलबॉक्स के लिए बहुत बड़ा था।
  • BOUNCED_SOFT_ATTACHMENT_REJECTED: प्राप्तकर्ता के मेल सर्वर ने एक अटैचमेंट अस्वीकार कर दिया।
  • BOUNCED_SOFT_CUSTOM_TIMEOUT_EXCEEDED: प्राप्तकर्ता के मेल सर्वर को जवाब देने में बहुत समय लगा।
  • BOUNCED_SOFT_UNDETERMINED: अस्थायी रूप से डिलीवर नहीं किया जा सकता, कारण निर्धारित नहीं।
  • BOUNCED_UNDETERMINED: प्राप्तकर्ता के सर्वर ने ईमेल स्वीकार किया लेकिन कभी डिलीवरी की पुष्टि नहीं की; परिणाम अज्ञात है और पता सप्रेस नहीं किया गया है। इसे सॉफ्ट बाउंस माना जाता है।

BOUNCED_UNCLASSIFIED एक बाउंस है, हार्ड या सॉफ्ट, जो ऊपर दिए गए किसी भी सबटाइप से मेल नहीं खाता। दुर्लभ होने की उम्मीद है, और इस पर लॉजिक बनाने लायक मान नहीं है।

STAGE_OPENED, केवल ईमेल (अन्य चैनल बिना pieces के चरण की count रिपोर्ट करते हैं):

  • OPENED_BY_RECIPIENT (उत्तीर्ण): किसी व्यक्ति द्वारा खोला गया।
  • MACHINE_OPENS_ONLY: केवल एक स्वचालित स्कैनर द्वारा खोला गया।
  • OPEN_TYPE_UNKNOWN: व्यक्ति या स्कैनर के रूप में वर्गीकृत नहीं किया जा सका।
  • MACHINE_OPENS_AMPP (सबसेट): जब इस संदेश के लिए व्यक्ति/स्कैनर विभाजन उपलब्ध न हो तो ऊपर की तीन पंक्तियों को प्रतिस्थापित करता है। इसके बजाय Apple Mail Privacy Protection की अपनी मशीन-ओपन संख्या गिनता है, और चरण के कुल योग के साथ ओवरलैप करता है।

STAGE_INTERACTIONS, केवल ईमेल:

  • CLICKED_ONLY (उत्तीर्ण): एक लिंक पर क्लिक किया, सब्सक्राइब बना रहा।
  • CLICKED_AND_UNSUBSCRIBED: एक लिंक पर क्लिक किया और अनसब्सक्राइब किया।
  • CLICKED_AND_COMPLAINED: एक लिंक पर क्लिक किया और संदेश को स्पैम के रूप में चिह्नित किया।
  • UNSUBSCRIBED_WITHOUT_CLICK: बिना क्लिक किए अनसब्सक्राइब किया।
  • COMPLAINED_WITHOUT_CLICK: बिना क्लिक किए संदेश को स्पैम के रूप में चिह्नित किया।

STAGE_REACHED, केवल App Inbox:

  • REACHED (उत्तीर्ण): प्रविष्टि को ऐप द्वारा कम से कम एक बार फ़ेच किया गया।
  • NOT_FETCHED_YET: अभी तक फ़ेच नहीं किया गया।

STAGE_READ, केवल App Inbox:

  • READ (उत्तीर्ण): पढ़ा हुआ चिह्नित किया गया।
  • DISMISSED_UNREAD: उपयोगकर्ता द्वारा बिना पढ़े हटा दिया गया।
  • UNREAD: अभी भी इनबॉक्स में अपठित पड़ा हुआ है।
  • EXPIRED_UNREAD: UNREAD के समान, लेकिन प्रविष्टि तब से इनबॉक्स से समाप्त हो गई है।
  • DISMISSED (सबसेट): प्रत्येक हटाई गई प्रविष्टि, पढ़ी गई हो या न हो। READ और DISMISSED_UNREAD के साथ ओवरलैप करता है।
प्रतिक्रिया कोड 
{
  "channels": [{
    "channel": "CHANNEL_MOBILE_PUSH",
    "funnel": [
      { "stage": "STAGE_AUDIENCE", "count": "10000", "pieces": [
        { "kind": "KIND_PASSED", "category": "ELIGIBLE_AUDIENCE", "count": "10000", "platforms": [{ "platform": 1, "count": "10000" }] }
      ], "errors": [], "platforms": [{ "platform": 1, "count": "10000" }] },
      { "stage": "STAGE_SENT", "count": "9820", "pieces": [], "errors": [], "platforms": [{ "platform": 1, "count": "9820" }] },
      { "stage": "STAGE_ERRORS", "count": "180", "pieces": [], "errors": [
        { "category": "INVALID_TOKEN", "count": "180", "platforms": [{ "platform": 1, "count": "180" }], "codes": [
          { "platform": 1, "code": 1002, "name": "BadDeviceToken", "count": "180" }
        ] }
      ], "platforms": [{ "platform": 1, "count": "180" }] },
      { "stage": "STAGE_DELIVERIES", "count": "9820", "pieces": [
        { "kind": "KIND_PASSED", "category": "DISPLAYABLE_CONFIRMED", "count": "8000", "platforms": [{ "platform": 1, "count": "8000" }] },
        { "kind": "KIND_REASON", "category": "DISPLAYABLE_NO_CONFIRMATION", "count": "820", "platforms": [{ "platform": 1, "count": "820" }] },
        { "kind": "KIND_PASSED", "category": "NOT_DISPLAYABLE_CONFIRMED", "count": "900", "platforms": [{ "platform": 1, "count": "900" }] },
        { "kind": "KIND_REASON", "category": "NOT_DISPLAYABLE_NO_CONFIRMATION", "count": "100", "platforms": [{ "platform": 1, "count": "100" }] }
      ], "errors": [], "platforms": [{ "platform": 1, "count": "9820" }] },
      { "stage": "STAGE_OPENED", "count": "3120", "pieces": [], "errors": [], "platforms": [{ "platform": 1, "count": "3120" }] }
    ],
    "deliveries_form": "DELIVERIES_FORM_PER_DEVICE",
    "basic_form_reason": "BASIC_FORM_REASON_UNSPECIFIED",
    "confirmed_deliveries": { "count": "8900", "platforms": [{ "platform": 1, "count": "8900" }] }
  }],
  "window_from": "2026-09-01T00:00:00Z",
  "window_to": "2026-09-01T00:05:00Z",
  "funnel_state": "FUNNEL_STATE_READY"
}

एक खाली channels ऐरे और funnel_state: "FUNNEL_STATE_NO_EVENTS" का मतलब है कि इस संदेश के लिए अभी तक कुछ नहीं हुआ है। यह कोई त्रुटि नहीं है। एक message_code जो फ़नल डेटा उपलब्ध होने के लिए बहुत पहले भेजा गया था, वह भी 200 लौटाता है, एक खाली channels ऐरे और funnel_state: "FUNNEL_STATE_EXPIRED" के साथ।

getCampaignDeliveryFunnel

Anchor link to

एक कैंपेन के संदेशों पर getDeliveryFunnel का योग करता है। अद्वितीय गिनतियों की गणना प्रति संदेश की जाती है: कैंपेन के कई संदेशों द्वारा पहुंचा गया एक सब्सक्राइबर प्रत्येक संदेश के लिए एक बार गिना जाता है।

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

हेडर
Anchor link to
नाम
आवश्यक
विवरण
Authorizationहाँसर्वर API टोकन। निम्न प्रारूप में प्रदान किया जाना चाहिए: Authorization: Api <Server Key>।
रिक्वेस्ट बॉडी पैरामीटर
Anchor link to
नाम
आवश्यक
प्रकार
विवरण
campaign_codeहाँस्ट्रिंगकैंपेन कोड।
platformsनहींइंटीजर का ऐरेफ़नल को फ़िल्टर करने के लिए प्लेटफ़ॉर्म कोड। कैंपेन जिन सभी प्लेटफ़ॉर्म पर भेजा गया था उन्हें लौटाने के लिए छोड़ दें।
उदाहरण अनुरोध
Anchor link to
{
  "campaign_code": "AAAAA-XXXXX",  // कैंपेन कोड
  "platforms": [1, 14]             // वैकल्पिक। iOS, Email
}
प्रतिक्रिया
Anchor link to

ऊपर GetDeliveryFunnelResponse के समान आकार।

प्रतिक्रिया कोड

दिए गए campaign_code और platforms के लिए एक खाली ऑडियंस भी 200 लौटाती है, एक खाली channels ऐरे और funnel_state: "FUNNEL_STATE_NO_EVENTS" के साथ। एक कैंपेन जो फ़नल डेटा उपलब्ध होने के लिए बहुत पहले भेजा गया था, वह भी 200 लौटाता है, एक खाली channels ऐरे और funnel_state: "FUNNEL_STATE_EXPIRED" के साथ। इनमें से कोई भी त्रुटि नहीं है।

getMessageLog

Anchor link to

भेजे गए संदेशों के बारे में विस्तृत जानकारी प्रदर्शित करता है।

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

हेडर्स
Anchor link to
नाम
आवश्यक
विवरण
Authorizationआवश्यकPushwoosh कंट्रोल पैनल से API एक्सेस टोकन।
अनुरोध बॉडी पैरामीटर्स
Anchor link to
नाम
आवश्यक
प्रकार
विवरण
message_idनहींइंटीजरसंदेश इतिहास से प्राप्त संदेश आईडी द्वारा संदेश घटनाओं का चयन करें। उदाहरण: 12345678900।
message_codeनहींस्ट्रिंग/createMessage API प्रतिक्रियाओं से प्राप्त संदेश कोड द्वारा संदेश घटनाओं का चयन करें। उदाहरण: "A444-AAABBBCC-00112233"।
campaign_codeनहींस्ट्रिंगआपके संदेश पेलोड में निर्दिष्ट अभियान कोड द्वारा संदेश घटनाओं का चयन करें। उदाहरण: "AAAAA-XXXXX"।
hwidनहींस्ट्रिंग या ऐरेHWID (हार्डवेयर आईडी) या HWID के एक ऐरे द्वारा संदेश घटनाओं का चयन करें।
date_fromयदि message_id, message_code, या campaign_code प्रदान नहीं किया गया है तो आवश्यकडेटाइमसंदेशों को फ़िल्टर करने के लिए प्रारंभ तिथि। प्रारूप: "YYYY-MM-DD HH:MM:SS"। उदाहरण: "2000-01-25 00:00:00"।
date_toयदि message_id, message_code, या campaign_code प्रदान नहीं किया गया है तो आवश्यकडेटाइमसंदेशों को फ़िल्टर करने के लिए अंतिम तिथि। प्रारूप: "YYYY-MM-DD HH:MM:SS"। उदाहरण: "2000-01-26 00:00:00"।
limitनहींइंटीजरएक ही प्रतिक्रिया में लौटाई गई अधिकतम संदेश घटनाओं की संख्या। अधिकतम मान: 100000।
pagination_tokenनहींस्ट्रिंगपिछली /getMessageLog प्रतिक्रिया से प्राप्त पेजिनेशन टोकन। अतिरिक्त परिणाम प्राप्त करने के लिए इसका उपयोग करें।
user_idनहींस्ट्रिंगएक कस्टम यूज़र आईडी द्वारा संदेश घटनाओं का चयन करें। अधिक विवरण के लिए /registerUser देखें।
application_codeहाँस्ट्रिंगPushwoosh एप्लिकेशन कोड द्वारा संदेश घटनाओं का चयन करें।
actionsनहींऐरेविशिष्ट संदेश क्रियाओं द्वारा परिणामों को फ़िल्टर करें। संभावित मान: "sent", "delivered", "opened", "reject", "create", "inbox_delivered", "inbox_read", "inbox_opened", "inbox_deleted"। "create" घटनाएं डिफ़ॉल्ट रूप से प्रतिक्रिया से बाहर रखी जाती हैं। उन्हें देखने के लिए इस ऐरे में "create" शामिल करें। "delivered" घटनाओं के लिए अतिरिक्त रूप से खाते पर डिलीवरी आँकड़े सक्षम करने की आवश्यकता होती है।
platformsनहींऐरेपरिणामों को फ़िल्टर करने के लिए लक्ष्य प्लेटफ़ॉर्म का ऐरे। संभावित मान: "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नहींस्ट्रिंगसंदेश प्रवाह द्वारा परिणामों को फ़िल्टर करें। "all" (यदि छोड़ा गया तो डिफ़ॉल्ट) सब कुछ लौटाता है, "broadcast" केवल बड़े पैमाने पर संदेश लौटाता है (message_id != 0), "transactional" केवल message_id = 0 वाले संदेश लौटाता है, जिसमें Customer Journey से भेजे गए संदेश भी शामिल हैं।
उदाहरण अनुरोध
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", "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"
  }]
}

data में प्रत्येक प्रविष्टि में error_reason (स्ट्रिंग, विफलता के कारण से भरा होता है जब status "failed" होता है) और एक वैकल्पिक payload (स्ट्रिंग) भी होता है।

एक प्रतिक्रिया पृष्ठ अनुरोधित limit से छोटा वापस आ सकता है। इसका मतलब यह नहीं है कि निर्यात समाप्त हो गया है।

ईमेल आँकड़े

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नहींऑब्जेक्टरिपोर्टिंग अवधि को परिभाषित करता है। इसमें date_from और date_to होते हैं।
filtersहाँऑब्जेक्टईमेल फ़िल्टर।
applicationहाँस्ट्रिंगPushwoosh एप्लिकेशन कोड (वैकल्पिक रूप से, campaign, messages_ids, या message_codes निर्दिष्ट करें)।
messages_codesहाँऐरेसंदेश कोड (वैकल्पिक रूप से, application, campaign, या messages_ids निर्दिष्ट करें)।
campaignहाँस्ट्रिंगअभियान कोड (वैकल्पिक रूप से, application, messages_ids, या message_codes निर्दिष्ट करें)।
messages_idsहाँऐरेसंदेश आईडी (वैकल्पिक रूप से, application, campaign, या message_codes निर्दिष्ट करें)।
link_templateयदि application या campaign निर्दिष्ट है तो आवश्यक।स्ट्रिंगकीवर्ड द्वारा ईमेल लिंक इंटरैक्शन को फ़िल्टर करता है। केवल वे लिंक जिनमें उनके URL में निर्दिष्ट टेक्स्ट शामिल है, API प्रतिक्रिया में लौटाए जाएंगे। उदाहरण के लिए, यदि आपके ईमेल में https://example.com/news और https://example.com/shop जैसे लिंक हैं, तो “link_template”: “shop” सेट करने पर केवल https://example.com/shop के लिए इंटरैक्शन लौटाए जाएंगे।
email_content_codeनहींस्ट्रिंगईमेल सामग्री के लिए अद्वितीय पहचानकर्ता।
paramsनहींऑब्जेक्टअतिरिक्त प्रतिक्रिया विकल्प परिभाषित करता है। इसमें 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नहींऑब्जेक्टरिपोर्टिंग अवधि को परिभाषित करता है। इसमें date_from और date_to होते हैं।
filtersहाँऑब्जेक्टईमेल फ़िल्टर।
applicationहाँस्ट्रिंगPushwoosh एप्लिकेशन कोड (वैकल्पिक रूप से, campaign, messages_ids, या message_codes निर्दिष्ट करें)।
messages_codesहाँऐरेसंदेश कोड (वैकल्पिक रूप से, application, campaign, या messages_ids निर्दिष्ट करें)।
campaignहाँस्ट्रिंगअभियान कोड (वैकल्पिक रूप से, application, messages_ids, या message_codes निर्दिष्ट करें)।
messages_idsहाँऐरेसंदेश आईडी (वैकल्पिक रूप से, application, campaign, या message_codes निर्दिष्ट करें)।
link_templateयदि application या campaign निर्दिष्ट है तो आवश्यक।स्ट्रिंगकीवर्ड द्वारा ईमेल लिंक इंटरैक्शन को फ़िल्टर करता है। केवल वे लिंक जिनमें उनके URL में निर्दिष्ट टेक्स्ट शामिल है, API प्रतिक्रिया में लौटाए जाएंगे। उदाहरण के लिए, यदि आपके ईमेल में https://example.com/news और https://example.com/shop जैसे लिंक हैं, तो “link_template”: “shop” सेट करने पर केवल https://example.com/shop के लिए इंटरैक्शन लौटाए जाएंगे।
email_content_codeनहींस्ट्रिंगईमेल सामग्री के लिए अद्वितीय पहचानकर्ता।
pageनहींइंटीजरपेजिनेशन के लिए पृष्ठ संख्या।
per_pageनहींइंटीजरप्रति पृष्ठ परिणामों की संख्या (≤ 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 मानक) प्रारूप में डेटा के लिए प्रारंभ तिथि।यदि message_code या campaign प्रदान नहीं किया गया है तो आवश्यक
date_tostringYYYY-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": "XXXXX-XXXXX",                  // यदि message_code या दिनांक सीमा प्रदान नहीं की गई है तो आवश्यक।
                                              //          अभियान कोड
  "date_from": "2024-07-20T00:00:00.000Z",    // यदि message_code या अभियान प्रदान नहीं किया गया है तो आवश्यक।
                                              //          ISO 8601 प्रारूप "YYYY-MM-DDTHH:MM:SS.SSSZ" में प्रारंभ तिथि
  "date_to": "2024-07-20T00:00:00.000Z",      // यदि message_code या अभियान प्रदान नहीं किया गया है तो आवश्यक।
                                              //          ISO 8601 प्रारूप "YYYY-MM-DDTHH:MM:SS.SSSZ" में अंतिम तिथि
  "per_page": 1000,                           // आवश्यक। प्रति पृष्ठ परिणामों की संख्या, अधिकतम 5000
  "page": 5,                                  // वैकल्पिक। पृष्ठ संख्या, शून्य से शुरू
  "type": "Softbounce"                        // वैकल्पिक। बाउंस का प्रकार: Complaint, Softbounce, Hardbounce
}
प्रतिक्रिया फ़ील्ड
Anchor link to
फ़ील्ड नामप्रकारविवरण
totalintपंक्तियों की कुल संख्या।
bounced_emailsऐरेबाउंस हुए ईमेल विवरणों का एक ऐरे।
├── 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
  }]
}