सेगमेंटेशन (फिल्टर्स) API

createFilter

POST https://api.pushwoosh.com/json/1.3/createFilter

एक नया फ़िल्टर बनाता है।

अनुरोध बॉडी

नाम	आवश्यक	प्रकार	विवरण
auth*	हाँ	स्ट्रिंग	Pushwoosh कंट्रोल पैनल से API एक्सेस टोकन।
name*	हाँ	स्ट्रिंग	फ़िल्टर का नाम।
filter_expression*	हाँ	स्ट्रिंग	सेगमेंटेशन भाषा के नियमों के अनुसार बनाया गया एक्सप्रेशन। उदाहरण: T(“City”, eq, “Madrid”) उन उपयोगकर्ताओं को सेगमेंट करने के लिए जिनका शहर मैड्रिड है।
application	नहीं	स्ट्रिंग	Pushwoosh एप्लिकेशन कोड। यह पैरामीटर केवल हाई-स्पीड सेटअप के साथ प्रयोग करने योग्य है; अन्यथा इसे छोड़ दें।
expiration_date	नहीं	स्ट्रिंग	फ़िल्टर की समाप्ति। फ़िल्टर एक निर्दिष्ट तिथि पर स्वचालित रूप से हटा दिया जाएगा, जब तक कि इसका उपयोग किसी प्रीसेट या RSS फ़ीड में न किया जाए।

200

{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "name": "filter name"
  }
}

उदाहरण

{
  "request": {
    "auth": "yxoPUlwqm…………pIyEX4H",
    "name": "City = Madrid",
    "filter_expression": "T(\"City\", eq, \"Madrid\")",
    "application": "B18XX-XXXXX",
    "expiration_date": "2025-01-01"
  }
}

// creating Filters for Timezones
{
  "request": {
    "auth": "yxoPUlwqm…………pIyEX4H", // API access token from Pushwoosh Control Panel
    "name": "Timezone Filter",
    "filter_expression": "T(\"Timezone\", BETWEEN, [\"UTC-12:00\", \"UTC+14:00\"])"
  }
}

listFilters

POST https://api.pushwoosh.com/json/1.3/listFilters

उपलब्ध सेगमेंट (फिल्टर) की सूची उनकी शर्तों के साथ लौटाता है।

अनुरोध बॉडी

नाम	आवश्यक	प्रकार	विवरण
auth*	हाँ	स्ट्रिंग	Pushwoosh कंट्रोल पैनल से API एक्सेस टोकन।
application*	हाँ	स्ट्रिंग	Pushwoosh एप्लिकेशन कोड

200

{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "filters": [{
      "code": "52551-F2F42",
      "name": "City = Madrid",
      "filter_expression": "T(\"City\", eq, \"madrid\")",
      "expiration_date": "2025-01-01",
      "application": "B18XX-XXXXX"
    }]
  }
}

उदाहरण

{
  "request": {
    "auth": "yxoPUlwqm…………pIyEX4H",
    "application": "B18XX-XXXXX"
  }
}

deleteFilter

POST https://api.pushwoosh.com/json/1.3/deleteFilter

एक मौजूदा फ़िल्टर को हटाता है।

अनुरोध बॉडी

नाम	प्रकार	विवरण
auth*	स्ट्रिंग	Pushwoosh कंट्रोल पैनल से API एक्सेस टोकन।
name*	स्ट्रिंग	फ़िल्टर का नाम।

200

{
  "status_code": 200,
  "status_message": "OK",
  "response": null
}

उदाहरण

{
  "request": {
    "auth": "yxoPUlwqm…………pIyEX4H", // API access token from Pushwoosh Control Panel
    "name": "filter name"
  }
}

exportSegment

POST https://api.pushwoosh.com/api/v2/audience/exportSegment

एक अनुसूचित अनुरोध। निर्दिष्ट फ़िल्टर शर्तों के अंतर्गत आने वाले ग्राहकों की सूची निर्यात करता है।

अनुरोध बॉडी

नाम	आवश्यक	प्रकार	विवरण
auth*	हाँ	स्ट्रिंग	Pushwoosh कंट्रोल पैनल से API एक्सेस टोकन।
filterExpression*	हाँ	स्ट्रिंग	फ़िल्टर की शर्तें
exportData	नहीं	ऐरे	निर्यात करने के लिए डेटा। संभावित मान: "hwids", "push_tokens", "users", "tags", "location", "ad_identifiers"। "location" को शामिल करने से निर्यात की गई CSV में Latitude और Longitude कॉलम जुड़ जाते हैं। यदि exportData को छोड़ दिया जाता है, तो Latitude और Longitude डिफ़ॉल्ट रूप से निर्यात में शामिल होते हैं। "ad_identifiers" Google कस्टमर मैच या मेटा कस्टम ऑडियंस स्रोत फ़ाइल बनाने के लिए MADID, ईमेल SHA256, और फ़ोन SHA256 कॉलम जोड़ता है — नीचे विज्ञापन पहचानकर्ता निर्यात नोट देखें।
filterCode	नहीं	स्ट्रिंग	पहले से बना फ़िल्टर कोड, filterExpression के बजाय इस्तेमाल किया जा सकता है। इसे /listFilters API से या कंट्रोल पैनल में फ़िल्टर देखते समय आपके ब्राउज़र के एड्रेस बार से प्राप्त किया जा सकता है।
applicationCode	यदि आप filterExpression या filterCode का उपयोग कर रहे हैं तो आवश्यक है।	स्ट्रिंग	Pushwoosh एप्लिकेशन कोड
generateExport	नहीं	बूलियन	डिफ़ॉल्ट रूप से true पर सेट है, और प्रतिक्रिया में फ़ाइल डाउनलोड करने के लिए एक लिंक होता है। यदि गलत है, तो प्रतिक्रिया में केवल डिवाइस गणना भेजी जाएगी।
format	नहीं	स्ट्रिंग	निर्यात की गई फ़ाइल का प्रारूप सेट करता है: “csv” या “json_each_line”। यदि छोड़ दिया जाता है, तो CSV फ़ाइल उत्पन्न होती है।
tagsList	नहीं	ऐरे	निर्यात करने के लिए टैग निर्दिष्ट करता है। केवल विशिष्ट टैग प्राप्त करने के लिए, “exportData” ऐरे में “tags” मान होना चाहिए।
includeWithoutTokens	नहीं	बूलियन	निर्यात की गई फ़ाइल में पुश टोकन के बिना उपयोगकर्ताओं को शामिल करने के लिए true पर सेट करें। डिफ़ॉल्ट false है।

200 सफल

{
  "task_id": "177458"
}

उदाहरण

{
  "auth": "yxoPUlwqm…………pIyEX4H",                           // required. API access token from Pushwoosh Control Panel
  "filterExpression": "AT(\"12345-67890\", \"Name\", any)", // filter conditions, refer to the Segmentation Language guide for syntax
  "filterCode": "12345-67890",                              // pre-made filter code, can be used instead of filterExpression
  "applicationCode": "00000-AAAAA",                         // Required if you're using either `filterExpression` or `filterCode`. Pushwoosh app code. Can be obtained from /listFilters API request or address bar of your browser while viewing the filter in Control Panel.
  "generateExport": true,                                   // if false, devices count only will be sent in response; by default, a response contains a link to download the CSV file
  "format": "json_each_line",                               // format of the file to present the data in: "csv" – the .csv file is downloaded; "json" – a JSON file with all expored devices; or "json_each_line" – JSON line for each device. If not specified, CSV is the default format.
  "exportData": ["hwids", "tags"],                          // optional. Data to export. Possible values: "hwids", "push_tokens", "users", "tags", "location", "fcm_keys", "web keys", "ad_identifiers"
  "tagsList": ["Name", "Level"],                            // optional. Specifies tags to export. To obtain the specific tags only, the "tags" value should be sent within the "exportData" array or the "exportData" be empty.
  "includeWithoutTokens": true                              // optional. Set to true to include users without push tokens in the exported file. Default is false.
}

नोट

फ़िल्टर एक्सप्रेशन लिखने के लिए सेगमेंटेशन भाषा संदर्भ यहां पाएं।

उदाहरण के लिए, किसी विशेष ऐप के सभी ग्राहकों को निर्यात करने के लिए, निम्नलिखित फ़िल्टर शर्तों का उपयोग करें:

{
  "auth": "yxoPUlwqm…………pIyEX4H",            // API access token from Pushwoosh Control Panel
  "filterExpression": "A(\"AAAAA-BBBBB\")",  // Filter expression referencing app segment
  "applicationCode": "AAAAA-BBBBB"           // Required Pushwoosh app code
}

सावधानी

प्रतिक्रिया में, आपको परिणामी फ़ाइल प्राप्त करने के लिए task_id मिलेगा। फिर, परिणामी फ़ाइल को पुनः प्राप्त करने के लिए अनुरोध बॉडी में उस task_id के साथ /exportSegment/result को कॉल करें।

exportSegment परिणाम

POST https://api.pushwoosh.com/api/v2/audience/exportSegment/result

/exportSegment परिणामों के साथ CSV का लिंक पुनः प्राप्त करता है।

अनुरोध बॉडी

नाम	प्रकार	विवरण
auth*	स्ट्रिंग	Pushwoosh कंट्रोल पैनल से API एक्सेस टोकन।
task_id*	स्ट्रिंग	आपके /exportSegment प्रतिक्रिया में प्राप्त पहचानकर्ता।

200: ठीक है

{
  "devicesCount": "24735",
  "filename": "https://static.pushwoosh.com/segment-export/export_segment_XXXXX_XXXXX_xxxxxxxxxxxxxxxxx.csv.zip",
  "status": "completed"
}

अपने /exportSegment प्रतिक्रिया में प्राप्त “task_id” को /exportSegment/result अनुरोध बॉडी में पास करें।

/exportSegment/result प्रतिक्रिया में, आपको “filename” पैरामीटर प्राप्त होगा। एक ZIP संग्रह को स्वचालित रूप से डाउनलोड करने के लिए उस पैरामीटर मान में दिए गए लिंक का पालन करें। उपकरणों के डेटा वाली CSV या JSON फ़ाइल (आपके अनुरोध में निर्दिष्ट “format” के आधार पर) को पुनः प्राप्त करने के लिए संग्रह को अनपैक करें।

3 अप्रैल, 2025 से फ़ाइल डाउनलोड करने के लिए प्राधिकरण आवश्यक है:

• यदि ब्राउज़र के माध्यम से डाउनलोड कर रहे हैं, तो एक्सेस प्राप्त करने के लिए बस Pushwoosh कंट्रोल पैनल में लॉग इन करें।
• यदि सर्वर सॉफ़्टवेयर के माध्यम से डाउनलोड कर रहे हैं, तो अपने अनुरोध में निम्नलिखित हेडर शामिल करें: Authorization: Token YOUR_API_TOKEN

यदि आप अपने /exportSegment अनुरोध में “exportData” निर्दिष्ट करते हैं, तो डाउनलोड की गई फ़ाइल में केवल अनुरोधित डेटा होगा। डिफ़ॉल्ट रूप से, फ़ाइल में निम्नलिखित उपयोगकर्ता डेटा होता है:

फ़ील्ड	विवरण	मान का उदाहरण
Hwid	डिवाइस की हार्डवेयर आईडी	01D1BA5C-AAAA-0000-BBBB-9B81CD5823C8
User ID	यूज़र आईडी जो किसी डिवाइस को किसी विशेष उपयोगकर्ता के साथ जोड़ता है। यदि कोई यूज़र आईडी नहीं दी गई है, तो HWID का उपयोग किया जाता है।	user8192
Push Token	क्लाउड मैसेजिंग गेटवे द्वारा किसी डिवाइस को दिया गया अद्वितीय पहचानकर्ता। और जानें	eeeb2fd7…0fc3547
Type	प्लेटफ़ॉर्म प्रकार (पूर्णांक)।	1
Type (humanized)	प्लेटफ़ॉर्म प्रकार (स्ट्रिंग)।	iOS
Age	डिफ़ॉल्ट आयु टैग का मान।	29
ApplicationVersion	डिफ़ॉल्ट एप्लिकेशन संस्करण टैग का मान।	1.12.0.0
City	डिफ़ॉल्ट शहर टैग का मान।	us, boston
TagName	आपके खाते में बनाए गए टैग का मान।	TagValue

विज्ञापन पहचानकर्ता निर्यात

exportData में "ad_identifiers" जोड़ें ताकि एक ऐसी फ़ाइल प्राप्त हो जो सीधे Google कस्टमर मैच या मेटा कस्टम ऑडियंस स्रोत के रूप में अपलोड करने के लिए स्वरूपित हो। यह मान केवल ऑप्ट-इन है — यह डिफ़ॉल्ट रूप से कभी शामिल नहीं होता है, तब भी जब exportData को छोड़ दिया जाता है। यह केवल "csv" पर सेट format के साथ प्रभावी होता है। इसे "json" या "json_each_line" के साथ अनुरोध करने पर कोई त्रुटि नहीं होती है, लेकिन नीचे दिए गए कॉलम उन प्रारूपों से चुपचाप हटा दिए जाते हैं।

फ़ील्ड	विवरण
MADID	मोबाइल विज्ञापन आईडी (GAID या IDFA), लोअरकेस में सामान्यीकृत।
Email SHA256	उपयोगकर्ता के ईमेल का SHA-256 हैश, हैशिंग से पहले लोअरकेस और ट्रिम किया गया।
Phone SHA256	हैशिंग से पहले E.164 प्रारूप में उपयोगकर्ता के फ़ोन नंबर का SHA-256 हैश।

तीन पहचानकर्ताओं में से किसी के भी बिना उपयोगकर्ता के लिए एक पंक्ति अभी भी निर्यात की जाती है, जिसमें MADID, ईमेल SHA256, और फ़ोन SHA256 कॉलम खाली छोड़ दिए जाते हैं।

प्रति-उपयोगकर्ता ऐप गतिविधि निर्यात करें

नोट

अभियान आँकड़े घंटे और प्लेटफ़ॉर्म द्वारा एकत्रित खुले/भेजे गए गणना लौटाते हैं। कोई hwid या user_id कॉलम नहीं है। यह देखने के लिए कि किन उपयोगकर्ताओं ने ऐप कब खोला, इसके बजाय PW_ApplicationOpen ईवेंट पर बने सेगमेंट को निर्यात करें।

PW_ApplicationOpen केवल मोबाइल के लिए है। एक वेब प्रोजेक्ट के लिए सेगमेंट निर्यात कोई पंक्ति नहीं लौटाता है, क्योंकि ईवेंट वहां कभी फायर नहीं होता है।

1. PW_ApplicationOpen ईवेंट पर एक फ़िल्टर एक्सप्रेशन बनाएं, जिसे आपकी आवश्यकता की अवधि के लिए स्कोप किया गया हो। ईवेंट दिनांक ऑपरेटरों का उपयोग करें, उदाहरण के लिए “कल खोला गया”:

Event("AAAAA-BBBBB", "PW_ApplicationOpen", date daysago eq 1)

2. उस filterExpression, applicationCode, और exportData: ["hwids", "users"] के साथ /exportSegment को कॉल करें।
3. उस विंडो में ऐप खोलने वाले प्रत्येक डिवाइस के लिए Hwid और User ID कॉलम के साथ CSV डाउनलोड करने के लिए लौटाए गए task_id के साथ /exportSegment/result को कॉल करें।

सावधानी

User ID में वह पहचानकर्ता होता है जो आप किसी डिवाइस को सौंपते हैं। यदि आप कोई नहीं सौंपते हैं, तो यह HWID पर वापस आ जाता है। निर्यात आपको बताता है कि फ़िल्टर की गई विंडो के भीतर किसने ऐप खोला। यह एक टाइमस्टैम्प कॉलम के साथ प्रति-ओपन ईवेंट लॉग नहीं है, इसलिए यदि आपको दिन-प्रतिदिन की ग्रैन्युलैरिटी की आवश्यकता है तो प्रति दिन (या विंडो) एक सेगमेंट बनाएं।