সেগমেন্টেশন (ফিল্টার) এপিআই

createFilter

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

একটি নতুন ফিল্টার তৈরি করে।

অনুরোধের বডি

নাম	প্রয়োজনীয়	টাইপ	বিবরণ
auth*	হ্যাঁ	string	Pushwoosh কন্ট্রোল প্যানেল থেকে এপিআই অ্যাক্সেস টোকেন।
name*	হ্যাঁ	string	ফিল্টারের নাম।
filter_expression*	হ্যাঁ	string	সেগমেন্টেশন ভাষার নিয়ম অনুযায়ী নির্মিত এক্সপ্রেশন। উদাহরণ: T(“City”, eq, “Madrid”) ব্যবহারকারীদের সেগমেন্ট করতে যাদের শহর মাদ্রিদ।
application	না	string	পুশউশ অ্যাপ্লিকেশন কোড। এই প্যারামিটারটি শুধুমাত্র হাই-স্পিড সেটআপের সাথে ব্যবহারযোগ্য; অন্যথায় বাদ দিন।
expiration_date	না	string	ফিল্টারের মেয়াদ শেষ। ফিল্টারটি একটি নির্দিষ্ট তারিখে স্বয়ংক্রিয়ভাবে মুছে ফেলা হবে, যদি না এটি একটি প্রিসেট বা একটি আরএসএস ফিডে ব্যবহৃত হয়।

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

// টাইমজোনের জন্য ফিল্টার তৈরি করা হচ্ছে
{
  "request": {
    "auth": "yxoPUlwqm…………pIyEX4H", // Pushwoosh কন্ট্রোল প্যানেল থেকে এপিআই অ্যাক্সেস টোকেন
    "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*	হ্যাঁ	string	Pushwoosh কন্ট্রোল প্যানেল থেকে এপিআই অ্যাক্সেস টোকেন।
application*	হ্যাঁ	string	পুশউশ অ্যাপ্লিকেশন কোড

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*	string	Pushwoosh কন্ট্রোল প্যানেল থেকে এপিআই অ্যাক্সেস টোকেন।
name*	string	ফিল্টারের নাম।

200

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

উদাহরণ

{
  "request": {
    "auth": "yxoPUlwqm…………pIyEX4H", // Pushwoosh কন্ট্রোল প্যানেল থেকে এপিআই অ্যাক্সেস টোকেন
    "name": "filter name"
  }
}

exportSegment

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

একটি নির্ধারিত অনুরোধ। নির্দিষ্ট ফিল্টার শর্তের অধীনে থাকা সাবস্ক্রাইবারদের তালিকা এক্সপোর্ট করে।

অনুরোধের বডি

নাম	প্রয়োজনীয়	টাইপ	বিবরণ
auth*	হ্যাঁ	string	Pushwoosh কন্ট্রোল প্যানেল থেকে এপিআই অ্যাক্সেস টোকেন।
filterExpression*	হ্যাঁ	string	ফিল্টারের শর্তাবলী
exportData	না	array	এক্সপোর্ট করার জন্য ডেটা। সম্ভাব্য মান: "hwids", "push_tokens", "users", "tags", "location", "ad_identifiers"। "location" অন্তর্ভুক্ত করলে এক্সপোর্ট করা CSV-তে Latitude এবং Longitude কলাম যোগ হয়। যদি exportData বাদ দেওয়া হয়, তবে Latitude এবং Longitude ডিফল্টভাবে এক্সপোর্টে অন্তর্ভুক্ত থাকে। "ad_identifiers" একটি Google Customer Match বা Meta Custom Audience সোর্স ফাইল তৈরির জন্য MADID, Email SHA256, এবং Phone SHA256 কলাম যোগ করে — নিচে বিজ্ঞাপন শনাক্তকারী এক্সপোর্ট নোটটি দেখুন।
filterCode	না	string	আগে থেকে তৈরি করা ফিল্টার কোড, filterExpression-এর পরিবর্তে ব্যবহার করা যেতে পারে। /listFilters এপিআই থেকে বা কন্ট্রোল প্যানেলে ফিল্টার দেখার সময় আপনার ব্রাউজারের অ্যাড্রেস বার থেকে পাওয়া যাবে।
applicationCode	filterExpression বা filterCode ব্যবহার করলে প্রয়োজনীয়।	string	পুশউশ অ্যাপ্লিকেশন কোড
generateExport	না	boolean	ডিফল্টভাবে true তে সেট করা থাকে, এবং একটি প্রতিক্রিয়াতে ফাইলটি ডাউনলোড করার জন্য একটি লিঙ্ক থাকে। যদি false হয়, তবে প্রতিক্রিয়াতে শুধুমাত্র ডিভাইসের সংখ্যা পাঠানো হবে।
format	না	string	এক্সপোর্ট করা ফাইলের ফরম্যাট সেট করে: “csv” বা “json_each_line”। যদি বাদ দেওয়া হয়, তবে CSV ফাইল তৈরি করা হয়।
tagsList	না	array	এক্সপোর্ট করার জন্য ট্যাগ নির্দিষ্ট করে। শুধুমাত্র নির্দিষ্ট ট্যাগগুলি পেতে, “exportData” অ্যারেতে “tags” মানটি থাকা উচিত।
includeWithoutTokens	না	boolean	এক্সপোর্ট করা ফাইলে পুশ টোকেন ছাড়া ব্যবহারকারীদের অন্তর্ভুক্ত করতে true তে সেট করুন। ডিফল্ট হল false।

200 সফল

{
  "task_id": "177458"
}

উদাহরণ

{
  "auth": "yxoPUlwqm…………pIyEX4H",                           // প্রয়োজনীয়। Pushwoosh কন্ট্রোল প্যানেল থেকে এপিআই অ্যাক্সেস টোকেন
  "filterExpression": "AT(\"12345-67890\", \"Name\", any)", // ফিল্টারের শর্তাবলী, সিনট্যাক্সের জন্য সেগমেন্টেশন ল্যাঙ্গুয়েজ গাইড দেখুন
  "filterCode": "12345-67890",                              // আগে থেকে তৈরি ফিল্টার কোড, filterExpression এর পরিবর্তে ব্যবহার করা যেতে পারে
  "applicationCode": "00000-AAAAA",                         // `filterExpression` বা `filterCode` ব্যবহার করলে প্রয়োজনীয়। পুশউশ অ্যাপ কোড। /listFilters API অনুরোধ থেকে বা কন্ট্রোল প্যানেলে ফিল্টার দেখার সময় আপনার ব্রাউজারের অ্যাড্রেস বার থেকে পাওয়া যেতে পারে।
  "generateExport": true,                                   // যদি false হয়, প্রতিক্রিয়াতে শুধুমাত্র ডিভাইসের সংখ্যা পাঠানো হবে; ডিফল্টভাবে, একটি প্রতিক্রিয়াতে CSV ফাইল ডাউনলোড করার জন্য একটি লিঙ্ক থাকে
  "format": "json_each_line",                               // ডেটা উপস্থাপনের জন্য ফাইলের ফরম্যাট: "csv" – .csv ফাইল ডাউনলোড করা হয়; "json" – সমস্ত এক্সপোর্ট করা ডিভাইস সহ একটি JSON ফাইল; বা "json_each_line" – প্রতিটি ডিভাইসের জন্য JSON লাইন। যদি নির্দিষ্ট না করা হয়, CSV ডিফল্ট ফরম্যাট।
  "exportData": ["hwids", "tags"],                          // ঐচ্ছিক। এক্সপোর্ট করার জন্য ডেটা। সম্ভাব্য মান: "hwids", "push_tokens", "users", "tags", "location", "fcm_keys", "web keys", "ad_identifiers"
  "tagsList": ["Name", "Level"],                            // ঐচ্ছিক। এক্সপোর্ট করার জন্য ট্যাগ নির্দিষ্ট করে। শুধুমাত্র নির্দিষ্ট ট্যাগগুলি পেতে, "exportData" অ্যারের মধ্যে "tags" মানটি পাঠানো উচিত বা "exportData" খালি থাকা উচিত।
  "includeWithoutTokens": true                              // ঐচ্ছিক। এক্সপোর্ট করা ফাইলে পুশ টোকেন ছাড়া ব্যবহারকারীদের অন্তর্ভুক্ত করতে true তে সেট করুন। ডিফল্ট হল false।
}

নোট

ফিল্টার এক্সপ্রেশন লেখার জন্য সেগমেন্টেশন ভাষার রেফারেন্স অনুগ্রহ করে এখানে খুঁজুন।

উদাহরণস্বরূপ, একটি নির্দিষ্ট অ্যাপের সমস্ত সাবস্ক্রাইবার এক্সপোর্ট করতে, নিম্নলিখিত ফিল্টার শর্তাবলী ব্যবহার করুন:

{
  "auth": "yxoPUlwqm…………pIyEX4H",            // Pushwoosh কন্ট্রোল প্যানেল থেকে এপিআই অ্যাক্সেস টোকেন
  "filterExpression": "A(\"AAAAA-BBBBB\")",  // অ্যাপ সেগমেন্ট উল্লেখ করে ফিল্টার এক্সপ্রেশন
  "applicationCode": "AAAAA-BBBBB"           // প্রয়োজনীয় পুশউশ অ্যাপ কোড
}

সতর্কতা

প্রতিক্রিয়াতে, আপনি ফলাফল ফাইলটি পাওয়ার জন্য task_id পাবেন। তারপর, ফলাফল ফাইলটি পুনরুদ্ধার করতে অনুরোধের বডিতে সেই task_id সহ /exportSegment/result কল করুন।

exportSegment results

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

/exportSegment ফলাফলের সাথে CSV-এর লিঙ্কটি পুনরুদ্ধার করে।

অনুরোধের বডি

নাম	টাইপ	বিবরণ
auth*	String	Pushwoosh কন্ট্রোল প্যানেল থেকে এপিআই অ্যাক্সেস টোকেন।
task_id*	String	আপনার /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” এর উপর নির্ভর করে) পুনরুদ্ধার করতে আর্কাইভটি আনপ্যাক করুন।

এপ্রিল ৩, ২০২৫ থেকে ফাইলটি ডাউনলোড করার জন্য অনুমোদন প্রয়োজন:

• যদি একটি ব্রাউজারের মাধ্যমে ডাউনলোড করেন, তবে অ্যাক্সেস পেতে কেবল পুশউশ কন্ট্রোল প্যানেলে লগ ইন করুন।
• যদি সার্ভার সফটওয়্যারের মাধ্যমে ডাউনলোড করেন, তবে আপনার অনুরোধে নিম্নলিখিত হেডারটি অন্তর্ভুক্ত করুন: 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	ডিফল্ট Age ট্যাগের মান।	29
ApplicationVersion	ডিফল্ট Application Version ট্যাগের মান।	1.12.0.0
City	ডিফল্ট City ট্যাগের মান।	us, boston
TagName	আপনার অ্যাকাউন্টে তৈরি করা একটি ট্যাগের মান।	TagValue

বিজ্ঞাপন শনাক্তকারী এক্সপোর্ট

exportData-তে "ad_identifiers" যোগ করুন যাতে সরাসরি Google Customer Match বা Meta Custom Audience সোর্স হিসেবে আপলোড করার জন্য ফরম্যাট করা একটি ফাইল পাওয়া যায়। এই মানটি শুধুমাত্র অপ্ট-ইন — এটি ডিফল্টভাবে কখনও অন্তর্ভুক্ত করা হয় না, এমনকি যখন exportData বাদ দেওয়া হয় তখনও। এটি শুধুমাত্র format "csv" তে সেট করা থাকলে কার্যকর হয়। "json" বা "json_each_line" এর সাথে এটি অনুরোধ করলে কোনো ত্রুটি আসে না, তবে নিচের কলামগুলি সেই ফরম্যাটগুলি থেকে নীরবে বাদ দেওয়া হয়।

ক্ষেত্র	বিবরণ
MADID	মোবাইল বিজ্ঞাপন আইডি (GAID বা IDFA), ছোট হাতের অক্ষরে স্বাভাবিক করা।
Email SHA256	ব্যবহারকারীর ইমেইলের SHA-256 হ্যাশ, হ্যাশ করার আগে ছোট হাতের এবং ট্রিম করা।
Phone SHA256	হ্যাশ করার আগে E.164 ফরম্যাটে ব্যবহারকারীর ফোন নম্বরের SHA-256 হ্যাশ।

তিনটি শনাক্তকারীর কোনোটিই নেই এমন একজন ব্যবহারকারীর জন্য একটি সারি এখনও এক্সপোর্ট করা হয়, যেখানে MADID, Email SHA256, এবং Phone 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-তে ফিরে আসে। এক্সপোর্ট আপনাকে জানায় কে ফিল্টার করা উইন্ডোর মধ্যে অ্যাপটি খুলেছে। এটি একটি টাইমস্ট্যাম্প কলাম সহ প্রতি-ওপেন ইভেন্ট লগ নয়, তাই যদি আপনার দিন-প্রতি-দিন গ্রানুলারিটি প্রয়োজন হয় তবে প্রতিদিন (বা উইন্ডো) একটি সেগমেন্ট তৈরি করুন।