सामग्री पर जाएं
उपयोगकर्ता गाइड सहायता डेमो अनुरोध करें साइन इन करें
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 को एक ही तिथि पर सेट करने से वह पूरा दिन वापस आ जाता है।
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नहींपूर्णांकपेजिनेशन के लिए शून्य-आधारित पृष्ठ संख्या। नीचे दी गई डीप पेजिनेशन सीमा देखें।
उदाहरण अनुरोध
Anchor link to
{
    "filters": {
      "platforms": [],                  // IOS, ANDROID, OSX, WINDOWS, AMAZON, SAFARI, CHROME, FIREFOX, IE, EMAIL, HUAWEI_ANDROID, SMS
      "date_range": {
        "date_from": "string",          // Required format: 2000-01-01
        "date_to": "string"             // Required format: 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": [],               // Message IDs
      "messages_codes": [],             // Message codes
      "application": "string"           // Pushwoosh application code
    },
    "params": {
      "with_details": true,             // Add message details to the response ("details" object)
      "with_metrics": true              // Add message metrics to the response ("metrics" object)
    },
    "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": [               // tag conditions (see /developer/api-reference/messages-api/#tag-conditions)
            TAG_CONDITION1,
            TAG_CONDITION2,
            ...,
            TAG_CONDITIONN
          ],
          "conditions_operator": "AND", // logical operator for conditions arrays; possible values: 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": [              // tag conditions (see Messages-api - tag-conditions)
          TAG_CONDITION1,
          TAG_CONDITION2,
          ...,
          TAG_CONDITIONN
        ],
        "conditions_operator": "AND" // logical operator for conditions arrays; possible values: 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", // required. Unique message identifier
  "platforms": [1, 3, 7, 10, 11, 12]          // optional. List of platform codes
}
प्रतिक्रिया फ़ील्ड
Anchor link to
नामप्रकारविवरण
metricsऐरेसंदेश मेट्रिक्स का एक ऐरे शामिल है
timestampstringमेट्रिक का समय।
platformintप्लेटफॉर्म कोड (जैसे, iOS, Android)।
sendsstringभेजे गए संदेशों की संख्या।
opensstringखोले गए संदेशों की संख्या।
deliveriesstringवितरित संदेशों की संख्या।
inbox_opensstringइनबॉक्स ओपन की संख्या।
unshowable_sendsstringभेजे गए संदेशों की संख्या जिन्हें दिखाया नहीं जा सका।
errorsstringत्रुटियों की संख्या।
conversionऑब्जेक्टरूपांतरण डेटा शामिल है
sendsstringभेजे गए संदेशों की कुल संख्या।
opensstringखोले गए संदेशों की कुल संख्या।
eventsऐरेउनके आँकड़ों के साथ घटनाओं का एक ऐरे
namestringघटना का नाम (जैसे, कार्ट में जोड़ना)।
hitsstringहिट की संख्या।
conversionfloatओपन के सापेक्ष रूपांतरण दर।
revenuefloatराजस्व (__amount और __currency विशेषताओं वाली घटनाओं के लिए ही)।
प्रतिक्रिया उदाहरण
Anchor link to
{
  "metrics": [{
    "timestamp": "2024-08-03 15:00:00",  // Timestamp of the metrics in "YYYY-MM-DD HH:MM:SS" format
    "platform": 3,                       // Platform code
    "sends": "55902",                    // Number of messages sent
    "opens": "382",                      // Number of messages opened
    "deliveries": "22931",               // Number of messages delivered
    "inbox_opens": "0",                  // Number of messages opened in the inbox
    "unshowable_sends": "2",             // Number of messages that couldn't be shown
    "errors": "0"                        // Number of errors encountered
  }],
  "conversion": {
    "sends": "55902",                    // Total number of messages sent
    "opens": "772",                      // Total number of messages opened
    "events": [{
      "name": "cart_add",                // Name of the event
      "hits": "96",                      // Number of hits for the event
      "conversion": 0.12,                // Conversion rate relative to opens
      "revenue": 0                       // Revenue generated by the event (only for events with amount/currency attributes)
    }]
  }
}

getDeliveryFunnel

Anchor link to

एकल संदेश के लिए डिलीवरी फ़नल लौटाता है, चैनल द्वारा विभाजित: दर्शक → भेजा गया → त्रुटियाँ → डिलीवरी → खोला गया, साथ ही ईमेल प्रसारण के लिए इंटरैक्शन। इसमें प्रत्येक चरण में प्रत्येक चैनल के दर्शकों के खो जाने का विवरण शामिल है।

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

हेडर्स
Anchor link to
नाम
आवश्यक
विवरण
Authorizationआवश्यकPushwoosh कंट्रोल पैनल से API एक्सेस टोकन।
अनुरोध बॉडी पैरामीटर
Anchor link to
नाम
आवश्यक
प्रकार
विवरण
message_codeहाँस्ट्रिंग/createMessage API प्रतिक्रियाओं से प्राप्त संदेश कोड।
platformsनहींपूर्णांक का ऐरेवैकल्पिक प्लेटफॉर्म आईडी फ़िल्टर।

कोई समय-सीमा पैरामीटर नहीं है: फ़नल में कोई समय अक्ष नहीं होता है, इसलिए सर्वर संदेश के अपने भेजने और पुष्टि डेटा से विंडो प्राप्त करता है (जो window_from/window_to के रूप में लौटाया जाता है)।

उदाहरण अनुरोध
Anchor link to
{
  "message_code": "A444-AAABBBCC-00112233",  // required, message code obtained from /createMessage response
  "platforms": [1, 3, 7]                     // optional, list of platform codes
}
प्रतिक्रिया फ़ील्ड
Anchor link to
नामप्रकारविवरण
channelsऐरेइस संदेश के लिए डेटा के साथ प्रति चैनल एक प्रविष्टि। एक चैनल जिसका संदेश ने कभी उपयोग नहीं किया, उसे छोड़ दिया जाता है - इसकी अनुपस्थिति का अर्थ है “कोई डेटा नहीं”, शून्य नहीं।
channels[].channelstringCHANNEL_MOBILE_PUSH (iOS, OSX, Android, Amazon, Huawei), CHANNEL_WEB_PUSH (Safari, Chrome, Firefox), CHANNEL_EMAIL, या CHANNEL_OTHER (SMS, मैसेंजर, वॉलेट, विंडोज, और अन्य प्लेटफॉर्म)।
channels[].funnelarrayइस चैनल के लिए फ़नल चरण, हमेशा इस क्रम में: STAGE_AUDIENCE, STAGE_SENT, STAGE_ERRORS, STAGE_DELIVERIES, STAGE_OPENED, और - केवल ईमेल प्रसारण के लिए, लेन-देन संदेशों के लिए नहीं - STAGE_INTERACTIONS।
channels[].funnel[].stagestringफ़नल चरण का नाम।
channels[].funnel[].countstringचरण के लिए कुल गिनती।
channels[].funnel[].piecesarraycount का श्रेणियों में विभाजन। STAGE_ERRORS पर खाली, जो इसके बजाय errors ले जाता है। शून्य गिनती वाली एक श्रेणी को 0 के रूप में लौटाने के बजाय छोड़ दिया जाता है।
channels[].funnel[].pieces[].kindstringटुकड़ा चरण कुल से कैसे संबंधित है: KIND_PASSED (अगले चरण में चला गया) या KIND_REASON (इस कारण से बाहर हो गया)। प्रत्येक टुकड़ा एक योग है - एक चरण के टुकड़े हमेशा उसकी count तक जुड़ते हैं।
channels[].funnel[].pieces[].categorystringविभाजन श्रेणी, जैसे INVALID_TOKEN, FREQUENCY_CAPPING, ELIGIBLE_AUDIENCE - नीचे चरण तालिका देखें।
channels[].funnel[].pieces[].countstringइस श्रेणी के लिए गिनती।
channels[].funnel[].pieces[].platformsarrayइस श्रेणी का प्रति-प्लेटफॉर्म विभाजन: { "platform": <id>, "count": "<n>" }। रिपोर्ट करने के लिए कुछ भी नहीं वाला एक प्लेटफॉर्म छोड़ दिया जाता है, 0 के रूप में नहीं लौटाया जाता है।
channels[].funnel[].errorsarraySTAGE_ERRORS केवल, pieces के स्थान पर: प्रति ड्रॉप-आउट श्रेणी एक पंक्ति (category, count, platforms) - एक टुकड़े के समान आकार, kind को छोड़कर।
channels[].funnel[].platformsarrayचरण की अपनी count का प्रति-प्लेटफॉर्म विभाजन।
channels[].deliveries_formstringSTAGE_DELIVERIES कौन सा विभाजन करता है: DELIVERIES_FORM_PER_DEVICE (तीन पंक्तियाँ, अलर्ट स्थिति ज्ञात) या DELIVERIES_FORM_BASIC (दो पंक्तियाँ, अलर्ट स्थिति अज्ञात)।
channels[].basic_form_reasonstringकेवल तब सेट करें जब deliveries_form DELIVERIES_FORM_BASIC हो: BASIC_FORM_REASON_RETENTION (संदेश पंक्ति-स्तरीय लॉग से पुराना है), BASIC_FORM_REASON_UNAVAILABLE (इस खाते के लिए कोई प्रति-डिवाइस डेटा नहीं), BASIC_FORM_REASON_NO_DELIVERIES (अभी तक कुछ भी स्वीकार नहीं किया गया), या BASIC_FORM_REASON_NOT_APPLICABLE (इस चैनल में कोई अलर्ट स्थिति नहीं है - गिरावट नहीं)।
channels[].confirmed_deliveriesobject{ "count": "<n>", "platforms": [...] } - अद्वितीय डिवाइस जिन्होंने डिलीवरी की पुष्टि की, deliveries_form से स्वतंत्र। confirmed_deliveries को STAGE_DELIVERIES.count तक क्लैंप नहीं किया गया है, इसलिए यह उस कुल से थोड़ा आगे बढ़ सकता है; विभिन्न आयु के संदेशों में एक सतत डिलीवरी प्रवृत्ति के लिए confirmed_deliveries का उपयोग करें।
window_from, window_tostring (RFC 3339 date-time)समय विंडो जिस पर फ़नल वास्तव में गणना की गई थी, संदेश के अपने डेटा से प्राप्त की गई थी।
funnel_statestringFUNNEL_STATE_READY (channels पॉप्युलेटेड), FUNNEL_STATE_NO_EVENTS (इस संदेश के लिए अभी तक कुछ भी नहीं हुआ है - channels खाली है), या FUNNEL_STATE_EXPIRED (संदेश 365 दिनों से पुराना है, आँकड़े अब संग्रहीत नहीं हैं - channels खाली है)।
फ़नल चरण
Anchor link to
चरणलागू होता हैcount का अर्थ हैpieces / errors
STAGE_AUDIENCEसभी चैनलप्रसंस्करण में लिया गया।KIND_PASSED ELIGIBLE_AUDIENCE; KIND_REASON: FREQUENCY_CAPPING, CONTROL_GROUP (सभी चैनल), UNSUBSCRIBED, BOUNCED, COMPLAINT, FILTERED_BY_CATEGORY (केवल ईमेल)
STAGE_SENTसभी चैनलगेटवे/प्रदाता द्वारा स्वीकृत (ACCEPTED_BY_GATEWAY)।कोई नहीं - चरण पूरी तरह से स्वीकृत कुल है; अस्वीकृतियाँ STAGE_ERRORS के अंतर्गत दिखाई देती हैं
STAGE_ERRORSसभी चैनलप्राप्तकर्ता तक पहुंचने से पहले अस्वीकृत।errors[], pieces नहीं: INTERNAL_ERROR, INVALID_TOKEN, NO_TOKEN, NO_DEVICE, PLATFORM_DISABLED, QUOTA_EXCEEDED, INVALID_CONTENT, INVALID_CONFIGURATION, PROVIDER_ERROR (अवर्गीकृत)
STAGE_DELIVERIESसभी चैनलपुष्टि करने के लिए स्वीकृत भेजे गए - कितने थे, कितने ने पुष्टि की।प्रति-डिवाइस फॉर्म: KIND_PASSED DISPLAYABLE_CONFIRMED; KIND_REASON: DISPLAYABLE_NO_CONFIRMATION, ALERTS_DISABLED। मूल रूप: KIND_PASSED CONFIRMED_BY_DEVICE; KIND_REASON NO_CONFIRMATION
STAGE_OPENEDसभी चैनलअद्वितीय डिवाइस/पते जिन्होंने खोला।केवल ईमेल, और केवल जब संदेश 60 दिनों से कम पुराना हो: KIND_PASSED OPENED_BY_RECIPIENT; KIND_REASON: MACHINE_OPENS_ONLY (स्वचालित ओपन, जैसे मेलबॉक्स पूर्वावलोकन क्लाइंट), OPEN_TYPE_UNKNOWN। अन्य चैनल, और 60 दिनों से अधिक पुराने ईमेल: कोई pieces नहीं।
STAGE_INTERACTIONSकेवल ईमेल प्रसारण (लेन-देन संदेश नहीं)प्राप्तकर्ता ने ईमेल के साथ क्या किया।KIND_PASSED CLICKED_ONLY; KIND_REASON: CLICKED_AND_UNSUBSCRIBED, CLICKED_AND_COMPLAINED, UNSUBSCRIBED_WITHOUT_CLICK, COMPLAINED_WITHOUT_CLICK
प्रतिक्रिया उदाहरण
Anchor link to
{
  "channels": [
    {
      "channel": "CHANNEL_EMAIL",
      "funnel": [
        {
          "stage": "STAGE_AUDIENCE",
          "count": "600000",
          "pieces": [
            { "kind": "KIND_PASSED", "category": "ELIGIBLE_AUDIENCE", "count": "580000" },
            { "kind": "KIND_REASON", "category": "UNSUBSCRIBED", "count": "14000" },
            { "kind": "KIND_REASON", "category": "BOUNCED", "count": "6000" }
          ]
        },
        {
          "stage": "STAGE_SENT",
          "count": "560000",
          "pieces": []
        },
        {
          "stage": "STAGE_ERRORS",
          "count": "20000",
          "errors": [
            { "category": "INVALID_TOKEN", "count": "18000" },
            { "category": "PROVIDER_ERROR", "count": "2000" }
          ]
        },
        {
          "stage": "STAGE_DELIVERIES",
          "count": "560000",
          "pieces": [
            { "kind": "KIND_PASSED", "category": "CONFIRMED_BY_DEVICE", "count": "540000" },
            { "kind": "KIND_REASON", "category": "NO_CONFIRMATION", "count": "20000" }
          ]
        },
        {
          "stage": "STAGE_OPENED",
          "count": "30514",
          "pieces": [
            { "kind": "KIND_PASSED", "category": "OPENED_BY_RECIPIENT", "count": "26102" },
            { "kind": "KIND_REASON", "category": "MACHINE_OPENS_ONLY", "count": "4412" }
          ]
        },
        {
          "stage": "STAGE_INTERACTIONS",
          "count": "1980",
          "pieces": [
            { "kind": "KIND_PASSED", "category": "CLICKED_ONLY", "count": "1820" },
            { "kind": "KIND_REASON", "category": "UNSUBSCRIBED_WITHOUT_CLICK", "count": "140" },
            { "kind": "KIND_REASON", "category": "CLICKED_AND_COMPLAINED", "count": "20" }
          ]
        }
      ],
      "deliveries_form": "DELIVERIES_FORM_BASIC",
      "basic_form_reason": "BASIC_FORM_REASON_NOT_APPLICABLE",
      "confirmed_deliveries": { "count": "540000" }
    },
    {
      "channel": "CHANNEL_MOBILE_PUSH",
      "funnel": [
        {
          "stage": "STAGE_DELIVERIES",
          "count": "168316",
          "pieces": [
            { "kind": "KIND_PASSED", "category": "DISPLAYABLE_CONFIRMED", "count": "89570" },
            { "kind": "KIND_REASON", "category": "DISPLAYABLE_NO_CONFIRMATION", "count": "78746" }
          ]
        },
        { "stage": "STAGE_OPENED", "count": "30514", "pieces": [] }
      ],
      "deliveries_form": "DELIVERIES_FORM_PER_DEVICE",
      "confirmed_deliveries": { "count": "91240" }
    }
  ],
  "window_from": "2026-08-01T00:00:00Z",
  "window_to": "2026-08-04T00:00:00Z",
  "funnel_state": "FUNNEL_STATE_READY"
}
प्रतिक्रिया कोड और उदाहरण 
{
  "channels": [],
  "funnel_state": "FUNNEL_STATE_NO_EVENTS"
}

getMessageLog

Anchor link to

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

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

हेडर्स
Anchor link to
नाम
आवश्यक
विवरण
Authorizationआवश्यकPushwoosh कंट्रोल पैनल से API एक्सेस टोकन।
अनुरोध बॉडी पैरामीटर
Anchor link to
नाम
आवश्यक
प्रकार
विवरण
message_idनहींपूर्णांकसंदेश इतिहास से प्राप्त संदेश आईडी द्वारा संदेश घटनाओं का चयन करें। उदाहरण: 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", "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",  // optional, token for pagination
   "limit": 1000,                                  // optional, the max number of entries for a single response
   "application_code": "XXXXX-XXXXX",              // Pushwoosh app code
   "message_code": "A444-AAABBBCC-00112233",       // optional, message code obtained from /createMessaage request
   "message_id": 1234567890,                       // optional, message ID obtained from Pushwoosh Control Panel
   "campaign_code": "AAAAA-XXXXX",                 // optional, code of a campaign to get the log for
   "hwid": "aaazzzqqqqxxx",                        // optional, hardware ID of a specific device targeted with a message
   "user_id": "user_123",                          // optional, ID of a user targeted with the message
   "date_from": "2000-01-25 00:00:00",             // optional, start of the stats period
   "date_to": "2000-02-10 23:59:59",               // optional, end of the stats period
   "actions": ["opened", "inbox_opened"],          // optional, used for results filtration. Possible values: "sent", "opened", "delivered", "inbox_delivered", "inbox_read", "inbox_opened", "inbox_deleted". The response will include all the messages with the specified action(s).
   "platforms": ["ios", "chrome"]                  // optional, used for results filtration. Possible values: "ios", "android", "osx", "windows", "amazon", "safari", "chrome", "firefox", "ie", "email", "huawei android"
}'
प्रतिक्रिया कोड और उदाहरण 
{
  "pagination_token": "PAGINATION_TOKEN_FOR_NEXT_REQUEST",
  "data": [{
    "timestamp": "2000-01-25T11:18:47Z",
    "application_code": "XXXXX-XXXXX",
    "message_id": 12345678900,
    "message_code": "A444-AAABBBCC-00112233",
    "campaign_code": "AAAAA-XXXXX",
    "hwid": "aaazzzqqqqxxx",
    "user_id": "user_123",
    "platform": "android",
    "action": "sent",
    "status": "success",
    "push_alerts_enabled": "true"
  }, {
    "timestamp": "2000-01-25T11:18:49Z",
    "application_code": "XXXXX-XXXXX",
    "message_id": 12345678900,
    "message_code": "A444-AAABBBCC-00112233",
    "campaign_code": "AAAAA-XXXXX",
    "hwid": "aaazzzqqqqxxx",
    "user_id": "user_123",
    "platform": "android",
    "action": "delivered",
    "push_alerts_enabled": "true"
  }, {
    "timestamp": "2000-01-25T11:19:23Z",
    "application_code": "XXXXX-XXXXX",
    "message_id": 12345678900,
    "message_code": "A444-AAABBBCC-00112233",
    "campaign_code": "AAAAA-XXXXX",
    "hwid": "aaazzzqqqqxxx",
    "user_id": "user_123",
    "platform": "android",
    "action": "opened",
    "push_alerts_enabled": "true"
  }]
}

ईमेल आँकड़े

Anchor link to

linksInteractions

Anchor link to

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

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

हेडर्स
Anchor link to
नाम
आवश्यक
विवरण
AuthorizationहाँPushwoosh कंट्रोल पैनल से API एक्सेस टोकन।
अनुरोध बॉडी पैरामीटर
Anchor link to
नाम
आवश्यक
प्रकारविवरण
date_rangeनहींऑब्जेक्टरिपोर्टिंग अवधि को परिभाषित करता है। इसमें 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",           // Required format: 2000-01-01
         "date_to": "string"              // Required format: 2000-01-01
      },
      "campaign": "string",               // Campaign code (you can specify application, messages_ids, or message_codes instead)
      "application": "string",            // Application code (you can specify campaign, messages_ids, or message_codes instead)
      "messages_ids": [],                 // Message IDs (you can specify application, campaign, or message_codes instead)
      "messages_codes": [],               // Message codes (you can specify application, campaign, or message_ids instead)
      "link_template": "string",          // Link template (required if application or campaign is specified)
      "email_content_code": "string"      // Unique identifier for the email content.
   },
   "params": {
      "with_full_links": true             // Specify whether to show detailed statistics. A list of full links with statistics will be passed in the full_links array.
   }
}'
प्रतिक्रिया कोड और उदाहरण
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",         // Required format: 2000-01-01
         "date_to": "string"            // Required format: 2000-01-01
      },
      "campaign": "string",             // Campaign code (you can specify application, messages_ids, or message_codes instead)
      "application": "string",          // Application code (you can specify campaign, messages_ids, or message_codes instead)
      "messages_ids": [],               // Message IDs (you can specify application, campaign, or message_codes instead)
      "messages_codes": [],             // Message codes (you can specify application, campaign, or message_ids instead)
      "link_template": "string",        // Link template (required if application or campaign is specified)
      "email_content_code": "string"    // Unique identifier for the email content.
   },
   "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बाउंस का प्रकार: शिकायत, सॉफ्टबाउंस, हार्डबाउंस।नहीं
अनुरोध उदाहरण
Anchor link to
{
  "application": "XXXXX-XXXXX",               // required. Pushwoosh app code
  "message_code": "XXXXX-XXXXXXXXX-XXXXXXXX", // required if campaign or date range is not provided.
                                              //          Unique message identifier
  "campaign": "XXXXX-XXXXX",                  // required if message_code or date range is not provided.
                                              //          Campaign code
  "date_from": "2024-07-20T00:00:00.000Z",    // required if message_code or campaign is not provided.
                                              //          Start date in ISO 8601 format "YYYY-MM-DDTHH:MM:SS.SSSZ"
  "date_to": "2024-07-20T00:00:00.000Z",      // required if message_code or campaign is not provided.
                                              //          End date in ISO 8601 format "YYYY-MM-DDTHH:MM:SS.SSSZ"
  "per_page": 1000,                           // required. Number of results per page, maximum 5000
  "page": 5,                                  // optional. Page number, starting from zero
  "type": "Softbounce"                        // optional. The type of bounce: Complaint, Softbounce, Hardbounce
}
प्रतिक्रिया फ़ील्ड
Anchor link to
फ़ील्ड नामप्रकारविवरण
totalintपंक्तियों की कुल संख्या।
bounced_emailsarrayबाउंस हुए ईमेल विवरण का एक ऐरे।
├── emailstringबाउंस हुआ ईमेल पता।
├── datestringबाउंस की तारीख (प्रारूप: YYYY-MM-DDTHH:MM:SS.000Z)।
├── reasonstringबाउंस का कारण।
└── typestringबाउंस का प्रकार: शिकायत, सॉफ्टबाउंस, हार्डबाउंस।
प्रतिक्रिया उदाहरण
Anchor link to
{
  "total": 25,                             // Total count of rows.
  "bounced_emails": [{
    "email": "example@example.com",        // Email address that bounced
    "date": "2024-07-20T00:00:00.000Z",    // Bounce date in ISO 8601 format
    "reason": "Invalid recipient address", // Reason for the bounce
    "type": "Hardbounce"                   // Type of bounce: Complaint, Softbounce, Hardbounce
  }]
}