संदेश आँकड़े

messages:list

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

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

हेडर्स

नाम	आवश्यक	विवरण
`Authorization`	हाँ	सर्वर API टोकन। इसे निम्नलिखित प्रारूप में प्रदान किया जाना चाहिए: `Authorization: Api <Server Key>`।

अनुरोध बॉडी पैरामीटर्स

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

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 30 दिनों से अधिक है:

{
  "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`	ऐरे	संदेश मेट्रिक्स का एक ऐरे होता है
`timestamp`	string	मेट्रिक का समय।
`platform`	int	प्लेटफ़ॉर्म कोड (जैसे, iOS, Android)।
`sends`	string	भेजे गए संदेशों की संख्या।
`opens`	string	खोले गए संदेशों की संख्या।
`deliveries`	string	वितरित संदेशों की संख्या।
`inbox_opens`	string	इनबॉक्स ओपन की संख्या।
`unshowable_sends`	string	उन डिवाइसों के लिए स्वीकार किए गए संदेशों की संख्या जिनकी सूचनाएं OS सेटिंग्स में बंद हैं। कोई बैनर नहीं दिखाया जाता है, लेकिन संदेश अभी भी ऐप तक पहुंचता है, और यह Message Inbox में दिखाई देता है यदि भेजने में Save message to Inbox सक्षम है। सफल भेजने के रूप में गिना जाता है, त्रुटियों के रूप में नहीं।
`errors`	string	त्रुटियों की संख्या।
`conversion`	ऑब्जेक्ट	रूपांतरण डेटा होता है
`sends`	string	भेजे गए संदेशों की कुल संख्या।
`opens`	string	खोले गए संदेशों की कुल संख्या।
`events`	ऐरे	उनके आँकड़ों के साथ घटनाओं का एक ऐरे
`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`	नहीं	इंटीजर	संदेश इतिहास से प्राप्त संदेश आईडी द्वारा संदेश घटनाओं का चयन करें। उदाहरण: `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 से भेजे गए संदेश भी शामिल हैं।

उदाहरण अनुरोध

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`	नहीं	ऑब्जेक्ट	रिपोर्टिंग अवधि को परिभाषित करता है। इसमें `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` शामिल है, जो आँकड़ों के साथ पूर्ण लिंक की एक सूची जोड़ता है।

अनुरोध उदाहरण

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`	नहीं	ऑब्जेक्ट	रिपोर्टिंग अवधि को परिभाषित करता है। इसमें `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)।

अनुरोध उदाहरण

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

ईमेल शिकायतों, सॉफ्ट बाउंस और हार्ड बाउंस पर डेटा प्रदान करता है, जिसमें प्रत्येक बाउंस की तारीख, ईमेल पता और कारण शामिल है।

प्रमाणीकरण

अनुरोध बॉडी पैरामीटर्स

पैरामीटर नाम	प्रकार	विवरण	आवश्यक
`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 मानक) प्रारूप में डेटा के लिए प्रारंभ तिथि।	यदि `message_code` या `campaign` प्रदान नहीं किया गया है तो आवश्यक
`date_to`	string	`YYYY-MM-DDTHH:MM:SS.000Z` (ISO 8601 मानक) प्रारूप में डेटा के लिए अंतिम तिथि।	यदि `message_code` या `campaign` प्रदान नहीं किया गया है तो आवश्यक
`per_page`	int	प्रति पृष्ठ पंक्तियों की संख्या, अधिकतम 5000।	हाँ
`page`	int	पृष्ठ संख्या, शून्य से शुरू।	हाँ
`type`	string	बाउंस का प्रकार: Complaint, Softbounce, Hardbounce।	नहीं

अनुरोध उदाहरण

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

प्रतिक्रिया फ़ील्ड

फ़ील्ड नाम	प्रकार	विवरण
`total`	int	पंक्तियों की कुल संख्या।
`bounced_emails`	ऐरे	बाउंस हुए ईमेल विवरणों का एक ऐरे।
├── `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
  }]
}