एसिंक्रोनस संदेश सांख्यिकी निर्यात

exportMessagesStatistics संदेश इतिहास और सांख्यिकी को सर्वर पर एक CSV फ़ाइल में निर्यात करता है। इसका उपयोग बड़े या पूर्ण-खाता पुल के लिए करें जिन्हें messages:list संभाल नहीं सकता।

messages:list के बजाय निर्यात का उपयोग कब करें

एक सीमित अवधि के लाइव, पेजिनेटेड लुकअप के लिए messages:list का उपयोग करें। exportMessagesStatistics का उपयोग तब करें जब परिणाम messages:list की डीप-पेजिनेशन सीमा (page × per_page > 100000) से अधिक हो, या जब लक्ष्य पेजिनेटेड JSON के बजाय एक एकल डाउनलोड करने योग्य फ़ाइल हो। निर्यात में date_range या पंक्ति गणना पर कोई सीमा नहीं है, क्योंकि यह परिणाम को एक प्रतिक्रिया में रखने के बजाय डिस्क पर एक फ़ाइल में स्ट्रीम करता है।

निर्यात प्रवाह कैसे काम करता है

1. messages:list के समान फ़िल्टर के साथ export को कॉल करें। प्रतिक्रिया तुरंत एक uid कार्य पहचानकर्ता लौटाती है, फ़ाइल उत्पन्न होने से पहले।
2. उस uid के साथ status को पोल करें जब तक कि यह STATUS_SUCCESS (या STATUS_FAILED) रिपोर्ट न करे।
3. उत्पन्न file और एक उपयोग के लिए तैयार file_url प्राप्त करने के लिए उसी uid के साथ result को कॉल करें।
4. फ़ाइल डाउनलोड करें। file_url का ज्यों का त्यों उपयोग करें, या यदि यह खाली वापस आया है तो file से URL बनाने के लिए result देखें।

किसी एप्लिकेशन के लिए हाल के निर्यात कार्यों को देखने के लिए lastTasks का उपयोग करें, और किसी कार्य को रद्द करने या उसकी फ़ाइल को जल्दी हटाने के लिए delete का उपयोग करें।

विधियाँ

निर्यात जीवनचक्र में पाँच विधियाँ हैं, साथ ही एक सादा डाउनलोड एंडपॉइंट भी है:

विधि	विवरण
exportMessagesStatistics/export	एक निर्यात को कतार में लगाता है और एक कार्य uid लौटाता है।
exportMessagesStatistics/status	कार्य की प्रगति की जाँच करता है।
exportMessagesStatistics/result	कार्य पूरा होने पर उत्पन्न फ़ाइल का नाम लौटाता है।
exportMessagesStatistics/lastTasks	किसी एप्लिकेशन के लिए हाल के निर्यात कार्यों को सूचीबद्ध करता है।
exportMessagesStatistics/delete	किसी कार्य को रद्द करता है या प्रतिधारण विंडो समाप्त होने से पहले उसकी फ़ाइल को हटा देता है।
डाउनलोड	उत्पन्न CSV फ़ाइल को नाम से डाउनलोड करता है।

export

एक संदेश इतिहास निर्यात को कतार में लगाता है और तुरंत एक कार्य पहचानकर्ता लौटाता है।

POST https://api.pushwoosh.com/api/v2/statistics/exportMessagesStatistics/export

हेडर

अनुरोध के लिए एक सर्वर API टोकन की आवश्यकता है:

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

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

अनुरोध बॉडी निम्नलिखित फ़ील्ड स्वीकार करती है:

नाम	आवश्यक	प्रकार	विवरण
type	हाँ	स्ट्रिंग	”TASK_TYPE_EXPORT_MESSAGES_V2” होना चाहिए।
export_messages_v2	हाँ	ऑब्जेक्ट	निर्यात पैरामीटर, नीचे वर्णित हैं।
export_messages_v2.application_code	नोट देखें	स्ट्रिंग	Pushwoosh एप्लिकेशन कोड। यदि app_group_code सेट नहीं है तो आवश्यक है।
export_messages_v2.app_group_code	नोट देखें	स्ट्रिंग	एप्लिकेशन समूह कोड, समूह में प्रत्येक ऐप में निर्यात करता है। यदि application_code सेट नहीं है तो आवश्यक है।
export_messages_v2.search	नहीं	स्ट्रिंग	संदेश शीर्षक और सामग्री पर मुक्त-पाठ खोज।
export_messages_v2.filters	नहीं	ऑब्जेक्ट	संदेश फ़िल्टर, नीचे वर्णित हैं। पूरे खाता इतिहास को निर्यात करने के लिए छोड़ दें।
export_messages_v2.properties	नहीं	ऐरे	CSV में शामिल किए जाने वाले कॉलम, नीचे वर्णित हैं।

export_messages_v2.filters स्वीकार करता है:

नाम	प्रकार	विवरण
statuses	ऐरे	शामिल किए जाने वाले संदेश की स्थितियाँ। संभावित मान ”MESSAGE_STATUS_CANCELED" "MESSAGE_STATUS_CREATING" "MESSAGE_STATUS_DONE" "MESSAGE_STATUS_FAIL" "MESSAGE_STATUS_PENDING" "MESSAGE_STATUS_PROCESSING" "MESSAGE_STATUS_WAITING”
platforms	ऐरे	प्लेटफ़ॉर्म कोड (संख्यात्मक, जैसे iOS के लिए 1), messages:list द्वारा उपयोग किए जाने वाले प्लेटफ़ॉर्म नाम स्ट्रिंग्स नहीं।
sent_date	ऑब्जेक्ट	भेजने की तारीख पर फ़िल्टर की गई रिपोर्टिंग अवधि: {"date_from": "YYYY-MM-DD", "date_to": "YYYY-MM-DD"}।
created_date	ऑब्जेक्ट	संदेश निर्माण तिथि पर फ़िल्टर की गई रिपोर्टिंग अवधि, sent_date के समान प्रारूप।
created_via	ऐरे	संदेश स्रोत। संभावित मान ”AB_TEST" "API" "AUTO_PUSH" "CP" "CSV" "CUSTOMER_JOURNEY" "EMAIL_API" "EMAIL_CP" "GEO_ZONE" "PUSH_ON_EVENT" "RSS" "SYSTEM”
segments	ऐरे	फ़िल्टर कोड जिन पर संदेश भेजा गया था।
campaigns	ऐरे	अभियान कोड। messages:list के विपरीत, यह एक सूची लेता है, न कि एक एकल कोड।
message_id	स्ट्रिंग (uint64)	एक एकल संख्यात्मक संदेश आईडी, उद्धृत। messages:list के विपरीत, निर्यात एक आईडी लेता है, न कि एक ऐरे।
message_code	स्ट्रिंग	एक एकल संदेश कोड।

export_messages_v2.properties चुनता है कि CSV में कौन से कॉलम होंगे।

संभावित मान

• "EXPORT_MESSAGE_PROPERTY_ID"
• "EXPORT_MESSAGE_PROPERTY_TIMESTAMP"
• "EXPORT_MESSAGE_PROPERTY_CONTENT"
• "EXPORT_MESSAGE_PROPERTY_TITLE"
• "EXPORT_MESSAGE_PROPERTY_APPLICATIONS"
• "EXPORT_MESSAGE_PROPERTY_STATUS"
• "EXPORT_MESSAGE_PROPERTY_PLATFORMS"
• "EXPORT_MESSAGE_PROPERTY_SOURCE"
• "EXPORT_MESSAGE_PROPERTY_FILTER"
• "EXPORT_MESSAGE_PROPERTY_SUBSCRIPTION_SEGMENTS"
• "EXPORT_MESSAGE_PROPERTY_SENT"
• "EXPORT_MESSAGE_PROPERTY_OPENED"
• "EXPORT_MESSAGE_PROPERTY_ERRORS"
• "EXPORT_MESSAGE_PROPERTY_RECIPIENTS"
• "EXPORT_MESSAGE_PROPERTY_DELIVERED"
• "EXPORT_MESSAGE_PROPERTY_TOTAL_DELIVERED"
• "EXPORT_MESSAGE_PROPERTY_TOTAL_OPENED"
• "EXPORT_MESSAGE_PROPERTY_TOTAL_CLICKS"
• "EXPORT_MESSAGE_PROPERTY_CLICKS"
• "EXPORT_MESSAGE_PROPERTY_UNSUBSCRIBED"

properties सिर्फ एक फ़िल्टर नहीं है

properties में सूचीबद्ध नहीं की गई कोई भी प्रॉपर्टी फ़ाइल में बिल्कुल भी दिखाई नहीं देती है, जिसमें आधार कॉलम (आईडी, भेजने की तारीख, सामग्री, स्थिति) भी शामिल हैं। properties को खाली छोड़ने से बिना किसी कॉलम के एक CSV बनता है। निर्यात में शामिल होने वाले प्रत्येक कॉलम को सूचीबद्ध करें, न कि केवल उन मेट्रिक्स को जिन्हें आप एक डिफ़ॉल्ट सेट के ऊपर जोड़ना चाहते हैं।

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

{
  "type": "TASK_TYPE_EXPORT_MESSAGES_V2",
  "export_messages_v2": {
    "application_code": "XXXXX-XXXXX",
    "filters": {
      "created_date": {
        "date_from": "2026-01-01",
        "date_to": "2026-06-30"
      },
      "statuses": ["MESSAGE_STATUS_DONE"],
      "platforms": [1, 3]
    },
    "properties": [
      "EXPORT_MESSAGE_PROPERTY_ID",
      "EXPORT_MESSAGE_PROPERTY_TIMESTAMP",
      "EXPORT_MESSAGE_PROPERTY_STATUS",
      "EXPORT_MESSAGE_PROPERTY_PLATFORMS",
      "EXPORT_MESSAGE_PROPERTY_SENT",
      "EXPORT_MESSAGE_PROPERTY_OPENED"
    ]
  }
}

200: ठीक है

{
  "uid": "177458"
}

401: गलत API एक्सेस टोकन

{
  "error": "account not found"
}

status

एक निर्यात कार्य की प्रगति लौटाता है।

POST https://api.pushwoosh.com/api/v2/statistics/exportMessagesStatistics/status

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

export द्वारा लौटाया गया कार्य पहचानकर्ता पास करें:

नाम	आवश्यक	प्रकार	विवरण
uid	हाँ	स्ट्रिंग (int64)	export प्रतिक्रिया से कार्य पहचानकर्ता, जैसे "177458"।

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

{
  "uid": "177458"
}

200: ठीक है

{
  "status": "STATUS_SUCCESS",
  "progress": 1
}

status "STATUS_PENDING", "STATUS_SUCCESS", या "STATUS_FAILED" में से एक है। progress 0 और 1 के बीच एक भिन्न है; result को कॉल करने से पहले status को तब तक पोल करें जब तक कि यह "STATUS_SUCCESS" तक न पहुंच जाए।

result

कार्य पूरा होने पर उत्पन्न फ़ाइल का नाम लौटाता है।

POST https://api.pushwoosh.com/api/v2/statistics/exportMessagesStatistics/result

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

export द्वारा लौटाया गया वही कार्य पहचानकर्ता पास करें:

नाम	आवश्यक	प्रकार	विवरण
uid	हाँ	स्ट्रिंग (int64)	export प्रतिक्रिया से कार्य पहचानकर्ता, जैसे "177458"।

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

{
  "uid": "177458"
}

200: ठीक है

{
  "export_messages_v2_result": {
    "file": "Export_Messages_v2_12345_20260813120000-a1b2c3d4.csv",
    "file_url": "https://app.pushwoosh.com/api/v2/statistics/exportMessagesStatistics/download/Export_Messages_v2_12345_20260813120000-a1b2c3d4.csv"
  }
}

status के "STATUS_SUCCESS" रिपोर्ट करने से पहले result को कॉल करने पर एक खाली परिणाम मिलता है। file_url खाते के लिए सही डेटा सेंटर पर डाउनलोड एंडपॉइंट का एक उपयोग के लिए तैयार लिंक है — इसे file से URL बनाने के बजाय ज्यों का त्यों उपयोग करें। यदि खाते के डेटा सेंटर में कोई आधार URL कॉन्फ़िगर नहीं है तो file_url खाली होता है। उस स्थिति में, आप केवल file से URL बनाने के लिए फॉलबैक कर सकते हैं यदि खाता डिफ़ॉल्ट app.pushwoosh.com डेटा सेंटर पर है — किसी अन्य डेटा सेंटर या व्हाइटलेबल डोमेन पर एक खाते के पास अकेले file से सही होस्ट प्राप्त करने का कोई तरीका नहीं है।

lastTasks

किसी एप्लिकेशन के लिए हाल के निर्यात कार्यों को सूचीबद्ध करता है, सबसे हाल का पहले।

POST https://api.pushwoosh.com/api/v2/statistics/exportMessagesStatistics/lastTasks

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

प्रत्येक पैरामीटर एक वैकल्पिक फ़िल्टर है; उन सभी कार्यों को सूचीबद्ध करने के लिए उन्हें छोड़ दें जिन तक टोकन की पहुंच है:

नाम	आवश्यक	प्रकार	विवरण
application	नहीं	स्ट्रिंग	Pushwoosh एप्लिकेशन कोड। उन सभी एप्लिकेशनों में कार्यों को सूचीबद्ध करने के लिए छोड़ दें जिन तक टोकन की पहुंच है।
types	नहीं	ऐरे	विशिष्ट कार्य प्रकारों तक सीमित करें। केवल संदेश निर्यात देखने के लिए [“TASK_TYPE_EXPORT_MESSAGES_V2”] का उपयोग करें।
campaign	नहीं	स्ट्रिंग	अभियान कोड द्वारा फ़िल्टर करें।
message_id	नहीं	स्ट्रिंग (uint64)	एक एकल संख्यात्मक संदेश आईडी द्वारा फ़िल्टर करें, उद्धृत।
message_code	नहीं	स्ट्रिंग	एक एकल संदेश कोड द्वारा फ़िल्टर करें।
limit	नहीं	इंटीजर	लौटाए जाने वाले कार्यों की अधिकतम संख्या।
timestamp_from	नहीं	स्ट्रिंग	केवल इस टाइमस्टैम्प (RFC 3339) के बाद बनाए गए कार्यों को लौटाएं।

नोट

कार्यों को 30 दिनों के लिए रखा जाता है, भले ही उनकी फ़ाइल 7-दिवसीय फ़ाइल प्रतिधारण विंडो के बाद पहले ही हटा दी गई हो। lastTasks अभी भी एक ऐसा कार्य दिखा सकता है जिसका result अब डाउनलोड करने योग्य फ़ाइल में हल नहीं होता है।

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

{
  "application": "XXXXX-XXXXX",
  "types": ["TASK_TYPE_EXPORT_MESSAGES_V2"],
  "limit": 10
}

200: ठीक है

{
  "tasks": [
    {
      "id": "177458",
      "timestamp": "2026-08-13T12:00:00Z",
      "status": "STATUS_SUCCESS",
      "requested_by_user": "user@example.com",
      "export_messages_v2": {
        "application_code": "XXXXX-XXXXX"
      },
      "export_messages_v2_result": {
        "file": "Export_Messages_v2_12345_20260813120000-a1b2c3d4.csv",
        "file_url": "https://app.pushwoosh.com/api/v2/statistics/exportMessagesStatistics/download/Export_Messages_v2_12345_20260813120000-a1b2c3d4.csv"
      }
    }
  ]
}

delete

7-दिवसीय प्रतिधारण विंडो समाप्त होने से पहले एक कार्य और उसकी फ़ाइल को हटाता है।

POST https://api.pushwoosh.com/api/v2/statistics/exportMessagesStatistics/delete

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

export द्वारा लौटाया गया कार्य पहचानकर्ता पास करें:

नाम	आवश्यक	प्रकार	विवरण
uid	हाँ	स्ट्रिंग (int64)	export प्रतिक्रिया से कार्य पहचानकर्ता, जैसे "177458"।

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

{
  "uid": "177458"
}

200: ठीक है

{}

डाउनलोड

result द्वारा उत्पन्न CSV फ़ाइल को नाम से डाउनलोड करता है।

GET https://app.pushwoosh.com/api/v2/statistics/exportMessagesStatistics/download/<file>

हेडर

अन्य विधियों की तरह ही प्रमाणित करें, या एक सक्रिय कंट्रोल पैनल सत्र पर निर्भर रहें:

नाम	आवश्यक	विवरण
Authorization	हाँ	सर्वर API टोकन, अन्य exportMessagesStatistics विधियों के समान प्रारूप में: Authorization: Api <Server Key> (Api स्कीम केस-असंवेदनशील है)। बिना Authorization हेडर और बिना लॉग-इन कंट्रोल पैनल सत्र वाले अनुरोध को 401 Unauthorized मिलता है।

<file> को result प्रतिक्रिया से सटीक file मान से बदलें, उदाहरण के लिए:

https://app.pushwoosh.com/api/v2/statistics/exportMessagesStatistics/download/Export_Messages_v2_12345_20260813120000-a1b2c3d4.csv

सावधानी

इस URL को हाथ से बनाना केवल डिफ़ॉल्ट app.pushwoosh.com डेटा सेंटर पर खातों के लिए काम करता है। किसी अन्य डेटा सेंटर (app.wavesend.ru OVB के लिए, app.pushwoosh.us IAD के लिए) या व्हाइटलेबल डोमेन पर एक खाते को एक अलग होस्ट की आवश्यकता होती है, और अकेले file से इसे प्राप्त करने का कोई तरीका नहीं है। इसके बजाय result या lastTasks से file_url का उपयोग करें, क्योंकि यह पहले से ही खाते के लिए सही होस्ट को इंगित करता है। यदि file_url खाली वापस आता है तो क्या करना है, इसके लिए result देखें।

फ़ाइल एक CSV है जिसमें properties में चयनित कॉलम होते हैं। यह निर्यात समाप्त होने के 7 दिनों के लिए उपलब्ध रहती है, फिर क्लीनअप जॉब इसे हटा देती है और URL हल होना बंद हो जाता है।