Message statistics

messages:list

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

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

हेडर्स (Headers)

नाम (Name)	आवश्यक (Required)	विवरण (Description)
`Authorization`	हाँ	Server API token. निम्नलिखित प्रारूप में प्रदान किया जाना चाहिए: `Authorization: Api <Server Key>`.

अनुरोध बॉडी पैरामीटर (Request body parameters)

नाम (Name)	आवश्यक (Required)	प्रकार (Type)	विवरण (Description)
`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"`).
`campaign`	नहीं	String	अभियान कोड (Campaign code)
`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 प्रतिक्रियाओं से प्राप्त संदेश कोड (Message codes)।
`messages_ids`	नहीं	Array	Message History (संदेश इतिहास) से प्राप्त संदेश IDs।
`params`	नहीं	Object	निर्दिष्ट करें कि संदेश विवरण और मेट्रिक्स दिखाना है या नहीं। प्रतिक्रिया में `"details"` ऑब्जेक्ट को शामिल करने के लिए `with_details: true` और `"metrics"` ऑब्जेक्ट को शामिल करने के लिए `with_metrics: true` सेट करें।
`application`	हाँ	String	Pushwoosh एप्लिकेशन कोड।
`per_page`	नहीं	Integer	प्रति पृष्ठ परिणामों की संख्या (≤ 1000)।
`page`	नहीं	Integer	पृष्ठांकन (pagination) के लिए पृष्ठ संख्या।

उदाहरण अनुरोध (Example request)

{
    "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",             // अभियान कोड (Campaign code)
      "messages_ids": [],               // संदेश IDs
      "messages_codes": [],             // संदेश कोड (Message codes)
      "application": "string"           // Pushwoosh एप्लिकेशन कोड
    },
    "params": {
      "with_details": true,             // प्रतिक्रिया में संदेश विवरण जोड़ें ("details" ऑब्जेक्ट)
      "with_metrics": true              // प्रतिक्रिया में संदेश मेट्रिक्स जोड़ें ("metrics" ऑब्जेक्ट)
    },
    "per_page": 20,                     // <= 1000
    "page": 0
}

प्रतिक्रिया कोड और उदाहरण (Response codes and examples)

{
  "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", // शर्तों के एरे (arrays) के लिए लॉजिकल ऑपरेटर; संभावित मान: 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" // शर्तों के एरे (arrays) के लिए लॉजिकल ऑपरेटर; संभावित मान: 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
      }]
    }
  }]
}

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

{
  "error": "account not found"
}

totalsByIntervals

संदेश कोड के आधार पर मेट्रिक्स और रूपांतरण डेटा लौटाता है, जो घंटे के हिसाब से समेकित (aggregated) होता है।

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

प्राधिकरण (Authorization)

प्राधिकरण को अनुरोध हेडर में API एक्सेस टोकन के माध्यम से संभाला जाता है।

अनुरोध बॉडी पैरामीटर (Request body parameters)

पैरामीटर का नाम (Parameter Name)	प्रकार (Type)	विवरण (Description)	आवश्यक (Required)
`message_code`	string	`/createMessage` API प्रतिक्रियाओं से प्राप्त संदेश कोड (Message code)।	हाँ
`platforms`	[int]	प्लेटफ़ॉर्म (Platforms)	नहीं

अनुरोध उदाहरण (Request example)

{
  "message_code": "XXXXX-XXXXXXXXX-XXXXXXXX", // आवश्यक। अद्वितीय संदेश पहचानकर्ता
  "platforms": [1, 3, 7, 10, 11, 12]          // वैकल्पिक। प्लेटफ़ॉर्म कोड की सूची
}

प्रतिक्रिया फ़ील्ड्स (Response fields)

नाम (Name)	प्रकार (Type)	विवरण (Description)
`metrics`	array	संदेश मेट्रिक्स का एक एरे (array) शामिल है
`timestamp`	string	मीट्रिक का समय।
`platform`	int	प्लेटफ़ॉर्म कोड (उदाहरण के लिए, iOS, Android)।
`sends`	string	भेजे गए संदेशों की संख्या।
`opens`	string	खोले गए संदेशों की संख्या।
`deliveries`	string	डिलीवर किए गए संदेशों की संख्या।
`inbox_opens`	string	इनबॉक्स ओपन की संख्या।
`unshowable_sends`	string	भेजे गए संदेशों की संख्या जिन्हें दिखाया नहीं जा सका।
`errors`	string	त्रुटियों की संख्या।
`conversion`	object	रूपांतरण डेटा शामिल है
`sends`	string	भेजे गए संदेशों की कुल संख्या।
`opens`	string	खोले गए संदेशों की कुल संख्या।
`events`	array	ईवेंट्स और उनके आँकड़ों का एक एरे (array)
`name`	string	ईवेंट का नाम (उदाहरण के लिए, cart add)।
`hits`	string	हिट्स की संख्या।
`conversion`	float	ओपन के सापेक्ष रूपांतरण दर।
`revenue`	float	राजस्व (केवल `__amount` और `__currency` विशेषताओं वाले ईवेंट्स के लिए)।

प्रतिक्रिया उदाहरण (Response example)

{
  "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                       // ईवेंट द्वारा उत्पन्न राजस्व (केवल amount/currency विशेषताओं वाले ईवेंट्स के लिए)
    }]
  }
}

getMessageLog

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

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

हेडर्स (Headers)

नाम (Name)	आवश्यक (Required)	विवरण (Description)
`Authorization`	आवश्यक (Required)	Pushwoosh कंट्रोल पैनल से API एक्सेस टोकन।

अनुरोध बॉडी पैरामीटर (Request body parameters)

नाम (Name)	आवश्यक (Required)	प्रकार (Type)	विवरण (Description)
`message_id`	नहीं	Integer	संदेश इतिहास से प्राप्त Message ID द्वारा संदेश ईवेंट्स का चयन करें। उदाहरण: `12345678900`.
`message_code`	नहीं	String	`/createMessage` API प्रतिक्रियाओं से प्राप्त संदेश कोड (Message code) द्वारा संदेश ईवेंट्स का चयन करें। उदाहरण: `"A444-AAABBBCC-00112233"`.
`campaign_code`	नहीं	String	आपके संदेश पेलोड में निर्दिष्ट अभियान कोड (Campaign code) द्वारा संदेश ईवेंट्स का चयन करें। उदाहरण: `"AAAAA-XXXXX"`.
`hwid`	नहीं	String or Array	HWID (हार्डवेयर ID) या HWIDs के एरे द्वारा संदेश ईवेंट्स का चयन करें।
`date_from`	आवश्यक यदि `message_id`, `message_code`, या `campaign_code` प्रदान नहीं किया गया है	Datetime	संदेशों को फ़िल्टर करने की प्रारंभिक तिथि। प्रारूप: `"YYYY-MM-DD HH:MM:SS"`. उदाहरण: `"2000-01-25 00:00:00"`.
`date_to`	आवश्यक यदि `message_id`, `message_code`, या `campaign_code` प्रदान नहीं किया गया है	Datetime	संदेशों को फ़िल्टर करने की अंतिम तिथि। प्रारूप: `"YYYY-MM-DD HH:MM:SS"`. उदाहरण: `"2000-01-26 00:00:00"`.
`limit`	नहीं	Integer	एक ही प्रतिक्रिया में लौटाए गए संदेश ईवेंट्स की अधिकतम संख्या। अधिकतम मान: `100000`.
`pagination_token`	नहीं	String	पिछली `/getMessageLog` प्रतिक्रिया से प्राप्त पृष्ठांकन टोकन। अतिरिक्त परिणाम प्राप्त करने के लिए इसका उपयोग करें।
`user_id`	नहीं	String	कस्टम यूज़र ID द्वारा संदेश ईवेंट्स का चयन करें। अधिक विवरण के लिए `/registerUser` देखें।
`application_code`	हाँ	String	Pushwoosh एप्लिकेशन कोड द्वारा संदेश ईवेंट्स का चयन करें
`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"`.

उदाहरण अनुरोध (Example request)

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",       // वैकल्पिक, /createMessage अनुरोध से प्राप्त संदेश कोड
   "message_id": 1234567890,                       // वैकल्पिक, Pushwoosh कंट्रोल पैनल से प्राप्त संदेश ID
   "campaign_code": "AAAAA-XXXXX",                 // वैकल्पिक, लॉग प्राप्त करने के लिए अभियान का कोड
   "hwid": "aaazzzqqqqxxx",                        // वैकल्पिक, संदेश के साथ लक्षित विशिष्ट डिवाइस का हार्डवेयर ID
   "user_id": "user_123",                          // वैकल्पिक, संदेश के साथ लक्षित उपयोगकर्ता का ID
   "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"
}'

प्रतिक्रिया कोड और उदाहरण (Response codes and examples)

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

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

{
  "error": "account not found"
}

Email statistics

linksInteractions

ईमेल में लिंक क्लिक पर आँकड़े प्रदर्शित करता है

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

हेडर्स (Headers)

नाम (Name)	आवश्यक (Required)	विवरण (Description)
`Authorization`	हाँ	Pushwoosh कंट्रोल पैनल से API एक्सेस टोकन।

अनुरोध बॉडी पैरामीटर (Request body parameters)

नाम (Name)	आवश्यक (Required)	प्रकार (Type)	विवरण (Description)
`date_range`	नहीं	Object	रिपोर्टिंग अवधि को परिभाषित करता है। इसमें `date_from` और `date_to` शामिल हैं।
`filters`	हाँ	Object	ईमेल फ़िल्टर।
`application`	हाँ	String	Pushwoosh एप्लिकेशन कोड (वैकल्पिक रूप से, `campaign`, `messages_ids`, या `message_codes` निर्दिष्ट करें)।
`messages_codes`	हाँ	Array	संदेश कोड (Message codes) (वैकल्पिक रूप से, `application`, `campaign`, या `messages_ids` निर्दिष्ट करें)।
`campaign`	हाँ	String	अभियान कोड (Campaign code) (वैकल्पिक रूप से, `application`, `messages_ids`, या `message_codes` निर्दिष्ट करें)।
`messages_ids`	हाँ	Array	संदेश IDs (वैकल्पिक रूप से, `application`, `campaign`, या `message_codes` निर्दिष्ट करें)।
`link_template`	आवश्यक यदि `application` या `campaign` निर्दिष्ट है।	String	कीवर्ड द्वारा ईमेल लिंक इंटरैक्शन को फ़िल्टर करता है। केवल वे लिंक जिनके URL में निर्दिष्ट टेक्स्ट शामिल है, API प्रतिक्रिया में लौटाए जाएंगे। उदाहरण के लिए, यदि आपके ईमेल में `https://example.com/news` और `https://example.com/shop` जैसे लिंक हैं, तो “link_template”: “shop” सेट करने पर केवल `https://example.com/shop` के लिए इंटरैक्शन वापस आएंगे।
`email_content_code`	नहीं	String	ईमेल सामग्री के लिए अद्वितीय पहचानकर्ता।
`params`	नहीं	Object	अतिरिक्त प्रतिक्रिया विकल्प परिभाषित करता है। इसमें `with_full_links` शामिल है, जो आँकड़ों के साथ पूर्ण लिंक की सूची जोड़ता है।

अनुरोध उदाहरण (Request example)

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": [],                 // संदेश 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 एरे में पास की जाएगी।
   }
}'

प्रतिक्रिया कोड और उदाहरण (Response codes and examples)

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

हेडर्स (Headers)

नाम (Name)	आवश्यक (Required)	विवरण (Description)
`Authorization`	हाँ	Pushwoosh कंट्रोल पैनल से API एक्सेस टोकन।

अनुरोध बॉडी पैरामीटर (Request body parameters)

नाम (Name)	आवश्यक (Required)	प्रकार (Type)	विवरण (Description)
`date_range`	नहीं	Object	रिपोर्टिंग अवधि को परिभाषित करता है। इसमें `date_from` और `date_to` शामिल हैं।
`filters`	हाँ	Object	ईमेल फ़िल्टर।
`application`	हाँ	String	Pushwoosh एप्लिकेशन कोड (वैकल्पिक रूप से, `campaign`, `messages_ids`, या `message_codes` निर्दिष्ट करें)।
`messages_codes`	हाँ	Array	संदेश कोड (Message codes) (वैकल्पिक रूप से, `application`, `campaign`, या `messages_ids` निर्दिष्ट करें)।
`campaign`	हाँ	String	अभियान कोड (Campaign code) (वैकल्पिक रूप से, `application`, `messages_ids`, या `message_codes` निर्दिष्ट करें)।
`messages_ids`	हाँ	Array	संदेश IDs (वैकल्पिक रूप से, `application`, `campaign`, या `message_codes` निर्दिष्ट करें)।
`link_template`	आवश्यक यदि `application` या `campaign` निर्दिष्ट है।	String	कीवर्ड द्वारा ईमेल लिंक इंटरैक्शन को फ़िल्टर करता है। केवल वे लिंक जिनके URL में निर्दिष्ट टेक्स्ट शामिल है, API प्रतिक्रिया में लौटाए जाएंगे। उदाहरण के लिए, यदि आपके ईमेल में `https://example.com/news` और `https://example.com/shop` जैसे लिंक हैं, तो “link_template”: “shop” सेट करने पर केवल `https://example.com/shop` के लिए इंटरैक्शन वापस आएंगे।
`email_content_code`	नहीं	String	ईमेल सामग्री के लिए अद्वितीय पहचानकर्ता।
`page`	नहीं	Integer	पृष्ठांकन के लिए पृष्ठ संख्या।
`per_page`	नहीं	Integer	प्रति पृष्ठ परिणामों की संख्या (≤ 1000)।

अनुरोध उदाहरण (Request example)

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": [],               // संदेश 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
}'

प्रतिक्रिया कोड और उदाहरण (Response codes and examples)

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

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

प्राधिकरण (Authorization)

प्राधिकरण को अनुरोध हेडर में API एक्सेस टोकन के माध्यम से संभाला जाता है।

अनुरोध बॉडी पैरामीटर (Request body parameters)

पैरामीटर का नाम (Parameter Name)	प्रकार (Type)	विवरण (Description)	आवश्यक (Required)
`application`	string	Pushwoosh एप्लिकेशन कोड	हाँ
`message_code`	string	संदेश कोड (Message code)।	आवश्यक यदि `date range` या `campaign` प्रदान नहीं किया गया है
`campaign`	string	अभियान कोड (Campaign code)।	आवश्यक यदि `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।	नहीं

अनुरोध उदाहरण (Request example)

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

प्रतिक्रिया फ़ील्ड्स (Response fields)

फ़ील्ड का नाम (Field Name)	प्रकार (Type)	विवरण (Description)
`total`	int	पंक्तियों की कुल संख्या।
`bounced_emails`	array	बाउंस हुए ईमेल विवरणों का एक एरे।
├── `email`	string	ईमेल पता जो बाउंस हुआ।
├── `date`	string	बाउंस की तारीख (प्रारूप: `YYYY-MM-DDTHH:MM:SS.000Z`)।
├── `reason`	string	बाउंस का कारण।
└── `type`	string	बाउंस का प्रकार: Complaint, Softbounce, Hardbounce।

प्रतिक्रिया उदाहरण (Response example)

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