सामग्री पर जाएं
उपयोगकर्ता गाइड सहायता डेमो अनुरोध करें साइन इन करें
Pushwoosh.com

संदेश आँकड़े

messages:list

Anchor link to

भेजे गए संदेशों की सूची प्रदर्शित करता है।

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

हेडर्स
Anchor link to
नाम
आवश्यक
विवरण
Authorizationहाँसर्वर एपीआई टोकन। निम्नलिखित प्रारूप में प्रदान किया जाना चाहिए: 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 को एक ही तिथि पर सेट करने पर वह पूरा दिन वापस आ जाता है।
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 एपीआई प्रतिक्रियाओं से प्राप्त संदेश कोड।
messages_idsनहींऐरेसंदेश इतिहास से प्राप्त संदेश आईडी
paramsनहींऑब्जेक्टनिर्दिष्ट करें कि संदेश विवरण और मेट्रिक्स दिखाने हैं या नहीं। प्रतिक्रिया में "details" ऑब्जेक्ट को शामिल करने के लिए with_details: true और "metrics" ऑब्जेक्ट को शामिल करने के लिए with_metrics: true सेट करें।
applicationहाँस्ट्रिंगपुशवूश एप्लिकेशन कोड।
per_pageनहींइंटीजरप्रति पृष्ठ परिणामों की संख्या, 1 से 499। डिफ़ॉल्ट पृष्ठ आकार 500 परिणाम प्राप्त करने के लिए पैरामीटर को छोड़ दें; 500 या अधिक स्पष्ट रूप से पास करने पर 400 के साथ अस्वीकार कर दिया जाता है।
pageनहींइंटीजरपेजिनेशन के लिए शून्य-आधारित पृष्ठ संख्या। नीचे गहरी पेजिनेशन सीमा देखें।
उदाहरण रिक्वेस्ट
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"           // पुशवूश एप्लिकेशन कोड
    },
    "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

ऑथराइज़ेशन को रिक्वेस्ट हेडर में एपीआई एक्सेस टोकन के माध्यम से संभाला जाता है।

रिक्वेस्ट बॉडी पैरामीटर्स
Anchor link to
पैरामीटर का नाम
प्रकार
विवरणआवश्यक
message_codeस्ट्रिंग/createMessage एपीआई प्रतिक्रियाओं से प्राप्त संदेश कोड।हाँ
platforms[int]प्लेटफॉर्मनहीं
उदाहरण रिक्वेस्ट
Anchor link to
{
  "message_code": "XXXXX-XXXXXXXXX-XXXXXXXX", // आवश्यक। अद्वितीय संदेश पहचानकर्ता
  "platforms": [1, 3, 7, 10, 11, 12]          // वैकल्पिक। प्लेटफॉर्म कोड की सूची
}
रिस्पांस फ़ील्ड्स
Anchor link to
नामप्रकारविवरण
metricsऐरेसंदेश मेट्रिक्स का एक ऐरे होता है
timestampस्ट्रिंगमेट्रिक का समय।
platformintप्लेटफॉर्म कोड (जैसे, iOS, Android)।
sendsस्ट्रिंगभेजे गए संदेशों की संख्या।
opensस्ट्रिंगखोले गए संदेशों की संख्या।
deliveriesस्ट्रिंगवितरित संदेशों की संख्या।
inbox_opensस्ट्रिंगइनबॉक्स ओपन की संख्या।
unshowable_sendsस्ट्रिंगभेजे गए संदेशों की संख्या जो दिखाए नहीं जा सके।
errorsस्ट्रिंगत्रुटियों की संख्या।
conversionऑब्जेक्टरूपांतरण डेटा होता है
sendsस्ट्रिंगभेजे गए संदेशों की कुल संख्या।
opensस्ट्रिंगखोले गए संदेशों की कुल संख्या।
eventsऐरेउनके आँकड़ों के साथ घटनाओं का एक ऐरे
nameस्ट्रिंगघटना का नाम (जैसे, कार्ट में जोड़ें)।
hitsस्ट्रिंगहिट्स की संख्या।
conversionफ्लोटओपन के सापेक्ष रूपांतरण दर।
revenueफ्लोटराजस्व (__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                       // घटना द्वारा उत्पन्न राजस्व (केवल राशि/मुद्रा विशेषताओं वाली घटनाओं के लिए)
    }]
  }
}

getMessageLog

Anchor link to

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

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

हेडर्स
Anchor link to
नाम
आवश्यक
विवरण
Authorizationआवश्यकपुशवूश कंट्रोल पैनल से एपीआई एक्सेस टोकन।
रिक्वेस्ट बॉडी पैरामीटर्स
Anchor link to
नाम
आवश्यक
प्रकार
विवरण
message_idनहींइंटीजरसंदेश इतिहास से प्राप्त संदेश आईडी द्वारा संदेश घटनाओं का चयन करें। उदाहरण: 12345678900।
message_codeनहींस्ट्रिंग/createMessage एपीआई प्रतिक्रियाओं से प्राप्त संदेश कोड द्वारा संदेश घटनाओं का चयन करें। उदाहरण: "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हाँस्ट्रिंगपुशवूश एप्लिकेशन कोड द्वारा संदेश घटनाओं का चयन करें।
actionsनहींऐरेविशिष्ट संदेश क्रियाओं द्वारा परिणामों को फ़िल्टर करें। संभावित मान: "sent", "delivered", "opened", "inbox_delivered", "inbox_read", "inbox_opened", "inbox_deleted"।
platformsनहींऐरेपरिणामों को फ़िल्टर करने के लिए लक्ष्य प्लेटफॉर्म का ऐरे। संभावित मान: "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",              // पुशवूश ऐप कोड
   "message_code": "A444-AAABBBCC-00112233",       // वैकल्पिक, /createMessaage अनुरोध से प्राप्त संदेश कोड
   "message_id": 1234567890,                       // वैकल्पिक, पुशवूश कंट्रोल पैनल से प्राप्त संदेश आईडी
   "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हाँपुशवूश कंट्रोल पैनल से एपीआई एक्सेस टोकन।
रिक्वेस्ट बॉडी पैरामीटर्स
Anchor link to
नाम
आवश्यक
प्रकारविवरण
date_rangeनहींऑब्जेक्टरिपोर्टिंग अवधि को परिभाषित करता है। इसमें date_from और date_to शामिल हैं।
filtersहाँऑब्जेक्टईमेल फ़िल्टर।
applicationहाँस्ट्रिंगपुशवूश एप्लिकेशन कोड (वैकल्पिक रूप से, 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 निर्दिष्ट है तो आवश्यक।स्ट्रिंगकीवर्ड द्वारा ईमेल लिंक इंटरैक्शन को फ़िल्टर करता है। केवल वे लिंक जिनके यूआरएल में निर्दिष्ट टेक्स्ट शामिल है, एपीआई प्रतिक्रिया में लौटाए जाएंगे। उदाहरण के लिए, यदि आपके ईमेल में 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": "string",            // एप्लिकेशन कोड (आप इसके बजाय अभियान, संदेश_आईडी, या संदेश_कोड निर्दिष्ट कर सकते हैं)
      "messages_ids": [],                 // संदेश आईडी (आप इसके बजाय एप्लिकेशन, अभियान, या संदेश_कोड निर्दिष्ट कर सकते हैं)
      "messages_codes": [],               // संदेश कोड (आप इसके बजाय एप्लिकेशन, अभियान, या संदेश_आईडी निर्दिष्ट कर सकते हैं)
      "link_template": "string",          // लिंक टेम्पलेट (यदि एप्लिकेशन या अभियान निर्दिष्ट है तो आवश्यक है)
      "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हाँपुशवूश कंट्रोल पैनल से एपीआई एक्सेस टोकन।
रिक्वेस्ट बॉडी पैरामीटर्स
Anchor link to
नाम
आवश्यक
प्रकारविवरण
date_rangeनहींऑब्जेक्टरिपोर्टिंग अवधि को परिभाषित करता है। इसमें date_from और date_to शामिल हैं।
filtersहाँऑब्जेक्टईमेल फ़िल्टर।
applicationहाँस्ट्रिंगपुशवूश एप्लिकेशन कोड (वैकल्पिक रूप से, 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 निर्दिष्ट है तो आवश्यक।स्ट्रिंगकीवर्ड द्वारा ईमेल लिंक इंटरैक्शन को फ़िल्टर करता है। केवल वे लिंक जिनके यूआरएल में निर्दिष्ट टेक्स्ट शामिल है, एपीआई प्रतिक्रिया में लौटाए जाएंगे। उदाहरण के लिए, यदि आपके ईमेल में 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": "string",          // एप्लिकेशन कोड (आप इसके बजाय अभियान, संदेश_आईडी, या संदेश_कोड निर्दिष्ट कर सकते हैं)
      "messages_ids": [],               // संदेश आईडी (आप इसके बजाय एप्लिकेशन, अभियान, या संदेश_कोड निर्दिष्ट कर सकते हैं)
      "messages_codes": [],             // संदेश कोड (आप इसके बजाय एप्लिकेशन, अभियान, या संदेश_आईडी निर्दिष्ट कर सकते हैं)
      "link_template": "string",        // लिंक टेम्पलेट (यदि एप्लिकेशन या अभियान निर्दिष्ट है तो आवश्यक है)
      "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

ऑथराइज़ेशन को रिक्वेस्ट हेडर में एपीआई एक्सेस टोकन के माध्यम से संभाला जाता है।

रिक्वेस्ट बॉडी पैरामीटर्स
Anchor link to
पैरामीटर का नामप्रकारविवरणआवश्यक
applicationस्ट्रिंगपुशवूश एप्लिकेशन कोडहाँ
message_codeस्ट्रिंगसंदेश कोड।यदि date range या campaign प्रदान नहीं किया गया है तो आवश्यक
campaignस्ट्रिंगअभियान कोड।यदि message_code या date range प्रदान नहीं किया गया है तो आवश्यक
date_fromस्ट्रिंगYYYY-MM-DDTHH:MM:SS.000Z (ISO 8601 मानक) प्रारूप में डेटा के लिए प्रारंभ तिथि।यदि message_code या campaign प्रदान नहीं किया गया है तो आवश्यक
date_toस्ट्रिंगYYYY-MM-DDTHH:MM:SS.000Z (ISO 8601 मानक) प्रारूप में डेटा के लिए अंतिम तिथि।यदि message_code या campaign प्रदान नहीं किया गया है तो आवश्यक
per_pageintप्रति पृष्ठ पंक्तियों की संख्या, अधिकतम 5000।हाँ
pageintपृष्ठ संख्या, शून्य से शुरू होती है।हाँ
typeस्ट्रिंगबाउंस का प्रकार: शिकायत, सॉफ्टबाउंस, हार्डबाउंस।नहीं
उदाहरण रिक्वेस्ट
Anchor link to
{
  "application": "XXXXX-XXXXX",               // आवश्यक। पुशवूश ऐप कोड
  "message_code": "XXXXX-XXXXXXXXX-XXXXXXXX", // यदि अभियान या दिनांक सीमा प्रदान नहीं की गई है तो आवश्यक है।
                                              //          अद्वितीय संदेश पहचानकर्ता
  "campaign": "XXXXX-XXXXX",                  // यदि संदेश_कोड या दिनांक सीमा प्रदान नहीं की गई है तो आवश्यक है।
                                              //          अभियान कोड
  "date_from": "2024-07-20T00:00:00.000Z",    // यदि संदेश_कोड या अभियान प्रदान नहीं किया गया है तो आवश्यक है।
                                              //          ISO 8601 प्रारूप "YYYY-MM-DDTHH:MM:SS.SSSZ" में प्रारंभ तिथि
  "date_to": "2024-07-20T00:00:00.000Z",      // यदि संदेश_कोड या अभियान प्रदान नहीं किया गया है तो आवश्यक है।
                                              //          ISO 8601 प्रारूप "YYYY-MM-DDTHH:MM:SS.SSSZ" में अंतिम तिथि
  "per_page": 1000,                           // आवश्यक। प्रति पृष्ठ परिणामों की संख्या, अधिकतम 5000
  "page": 5,                                  // वैकल्पिक। पृष्ठ संख्या, शून्य से शुरू
  "type": "Softbounce"                        // वैकल्पिक। बाउंस का प्रकार: शिकायत, सॉफ्टबाउंस, हार्डबाउंस
}
रिस्पांस फ़ील्ड्स
Anchor link to
फ़ील्ड का नामप्रकारविवरण
totalintपंक्तियों की कुल संख्या।
bounced_emailsऐरेबाउंस हुए ईमेल विवरणों का एक ऐरे।
├── emailस्ट्रिंगवह ईमेल पता जो बाउंस हो गया।
├── dateस्ट्रिंगबाउंस की तारीख (प्रारूप: YYYY-MM-DDTHH:MM:SS.000Z)।
├── reasonस्ट्रिंगबाउंस का कारण।
└── typeस्ट्रिंगबाउंस का प्रकार: शिकायत, सॉफ्टबाउंस, हार्डबाउंस।
उदाहरण रिस्पांस
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"                   // बाउंस का प्रकार: शिकायत, सॉफ्टबाउंस, हार्डबाउंस
  }]
}