Publisher Revenue Audit API-এর ডকুমেন্টেশন

প্রকাশকদের আয়ের সর্বজনীন পরীক্ষা চালান, Sulvo রিপোর্ট আনুন এবং CLI ও MCP সার্ভারের ব্যবহৃত একই API দিয়ে অনুমোদিত প্রকাশক ইনভেন্টরি পরিচালনা করুন।

হোস্ট করা বেস URL

https://publisher-revenue-audit.sulvo.com/v1/publisher-revenue-auditsCLI ও MCP সেটআপ

মৌলিক বিষয়

বেস URL

সর্বজনীন অডিট এন্ডপয়েন্টে ইচ্ছাকৃতভাবেই অথেনটিকেশন লাগে না। Sulvo অ্যাকাউন্টের রিপোর্ট ও ইনভেন্টরি কল ড্যাশবোর্ডে তৈরি API কী ব্যবহার করে।

সর্বজনীন অডিট API

POST

https://publisher-revenue-audit.sulvo.com/v1/publisher-revenue-audits

Sulvo অ্যাকাউন্ট API

Bearer API কী

https://surge.sulvo.com/api

হোস্ট করা MCP এন্ডপয়েন্ট

MCP

https://publisher-revenue-audit.sulvo.com/mcp

সর্বজনীন এন্ডপয়েন্ট

আয়ের অডিট চালান

প্রকাশকের ডোমেইনে সর্বজনীন তথ্যের ভিত্তিতে প্রাথমিক পরীক্ষা চালাতে এই এন্ডপয়েন্ট ব্যবহার করুন। উত্তরটি আয় হারানোর প্রমাণ বা নিশ্চিত বৃদ্ধির নিশ্চয়তা নয়। প্রকাশক-পক্ষের রিপোর্টিংয়ের সঙ্গে ফলাফল যাচাই করুন।

cURL

curl -X POST https://publisher-revenue-audit.sulvo.com/v1/publisher-revenue-audits \
  -H "content-type: application/json" \
  -d '{
    "tool": "run_publisher_revenue_audit",
    "input": {
      "domain": "example.com",
      "vertical": "news",
      "options": {
        "format": "json",
        "compact": true,
        "maxPages": 2,
        "enablePageSpeed": true
      }
    }
  }'

ফিল্ড	নোট
input.domain	প্রকাশকের ডোমেইন বা সর্বজনীন হোস্ট আবশ্যক। প্রোটোকলবিহীন ডোমেইন স্বয়ংক্রিয়ভাবে HTTPS-এ রূপান্তরিত হয়। ব্যক্তিগত লক্ষ্য, কাঁচা IP, অভ্যন্তরীণ হোস্ট এবং অপ্রচলিত পোর্ট প্রত্যাখ্যান করা হয়।
input.vertical	ঐচ্ছিক। news, sports, entertainment, technology, education, gaming অথবা other গ্রহণ করে।
input.metrics	প্রকাশকের ড্যাশবোর্ড থেকে ঐচ্ছিক প্রেক্ষাপট, যেমন ফিল রেট, ভিউয়েবিলিটি, গড় CPM, প্রতি সেশনে আয়, মাসিক পেজভিউ অথবা মাসিক সেশন।
input.options	আউটপুট ও তথ্য সংগ্রহের ঐচ্ছিক নিয়ন্ত্রণ, যেমন format, compact, maxPages, includeEvidence, enableBrowser, includeScreenshots, enablePageSpeed, pageSpeedStrategy, concurrency, whiteLabel এবং partnerId।

অথেনটিকেশন

অ্যাকাউন্ট API-এর জন্য Sulvo API কী ব্যবহার করুন

Sulvo ড্যাশবোর্ডের Account Settings-এ API কী তৈরি করুন। Sulvo অ্যাকাউন্ট API অনুরোধে এটি Bearer টোকেন হিসেবে পাঠান।

Authorization হেডার

Authorization: Bearer $SULVO_API_KEY

reports:read

রিপোর্ট এক্সপোর্ট এবং সংরক্ষিত রিপোর্টের তালিকা দেখতে আবশ্যক।

reports:write

উন্নত রিপোর্ট তৈরি, হালনাগাদ, চালানো বা মুছতে আবশ্যক।

inventory:write

বিজ্ঞাপন ইউনিট তৈরি ও মুছতে আবশ্যক। অ্যাকাউন্ট অনুমোদিত হতে হবে এবং ইনভেন্টরির মালিক হতে হবে।

রিপোর্ট

রিপোর্ট এন্ডপয়েন্ট পড়ুন

রিপোর্ট পড়ার অনুরোধ Sulvo অ্যাকাউন্ট API বেসে GET পদ্ধতি ব্যবহার করে। শুধু তারিখ দেওয়া হলে সেটি UTC দিনের শুরু ও শেষ হিসেবে ধরা হয়।

রিপোর্ট অনুরোধ

curl "https://surge.sulvo.com/api/v1/reports/by-date?start=2026-06-01&end=2026-06-07&domains=example.com" \
  -H "authorization: Bearer $SULVO_API_KEY" \
  -H "accept: application/json"

Method	Path	Notes
GET	/api/v1/reports/by-date	দৈনিক পারফরম্যান্সের সারাংশ। তারিখ, ডোমেইন, ad root এবং provider দিয়ে ফিল্টার করা যায়।
GET	/api/v1/reports/by-date-and-ad-unit	বিজ্ঞাপন ইউনিট অনুযায়ী গোষ্ঠীবদ্ধ দৈনিক পারফরম্যান্স।
GET	/api/v1/reports/by-domain-and-ad-unit	ডোমেইন ও বিজ্ঞাপন ইউনিট অনুযায়ী পারফরম্যান্সের বিবরণ।
GET	/api/v1/reports/bot-filtering	অ্যাকাউন্টের ট্রাফিকের মান পর্যালোচনার জন্য বট ফিল্টারিং রিপোর্ট।
GET	/api/v1/reports/bot-scores	তারিখ ও সংশ্লিষ্ট মাত্রা অনুযায়ী বট স্কোর রিপোর্টিং।
GET	/api/v1/reports/invalid-activity	অবৈধ কার্যকলাপের রিপোর্ট। তারিখ বা ডোমেইনভিত্তিক সাধারণ কোয়েরি লাগে না।
GET	/api/v1/reports/direct-bidder-analysis	সরাসরি বিডারের রিপোর্ট। directBidder আবশ্যক, সঙ্গে start/end থাকতে পারে।
GET	/api/v1/inventory/ad-units-by-domain	ডোমেইন অনুযায়ী গোষ্ঠীবদ্ধ বিজ্ঞাপন ইউনিটের ইনভেন্টরি।

সাধারণ কোয়েরি প্যারামিটার: start, end, পুনরাবৃত্তিযোগ্য domains, পুনরাবৃত্তিযোগ্য adRoots এবং adProvider। সরাসরি বিডার বিশ্লেষণে directBidder-ও আবশ্যক।

উন্নত রিপোর্ট

সময়সূচি অনুযায়ী বা তাৎক্ষণিক ইমেইল রিপোর্ট তৈরি করুন

উন্নত রিপোর্ট সঙ্গে সঙ্গে চালানো যায়, অথবা নির্দিষ্ট সময়সূচিতে পুনরাবৃত্তি করা যায়। এগুলো সরাসরি ফেরত না দিয়ে ইমেইলে পাঠানো হয়।

উন্নত রিপোর্ট সংরক্ষণ করুন

curl -X POST https://surge.sulvo.com/api/v2/reports/save-advanced-report \
  -H "authorization: Bearer $SULVO_API_KEY" \
  -H "content-type: application/json" \
  -d '{
    "reportType": "dimensions",
    "toAddress": "publisher@example.com",
    "immediateRun": true,
    "domains": ["example.com"],
    "dimensions": ["country", "device"],
    "start": "2026-06-01",
    "end": "2026-06-07"
  }'

Method	Path	Notes
GET	/api/v2/reports/advanced-reports	অথেনটিকেট করা অ্যাকাউন্টের সংরক্ষিত উন্নত রিপোর্টের তালিকা দেখুন।
POST	/api/v2/reports/save-advanced-report	উন্নত রিপোর্ট তৈরি বা হালনাগাদ করুন। reportType, toAddress, immediateRun এবং অন্তত একটি adRoots বা domains লক্ষ্য আবশ্যক।
DELETE	/api/v2/reports/delete-advanced-report/{reportId}	id দিয়ে সংরক্ষিত উন্নত রিপোর্ট মুছুন।

রিপোর্টের ধরন

adUnit, dimensions, customData

মাত্রা

country, device, os

পুনরাবৃত্তি

daily, weekly, biweekly, monthly

ইনভেন্টরি

অনুমোদিত বিজ্ঞাপন ইউনিট তৈরি ও মুছুন

ইনভেন্টরিতে লিখতে অনুমোদিত Sulvo অ্যাকাউন্ট এবং inventory:write স্কোপসহ মালিকের তৈরি API কী দরকার।

বিজ্ঞাপন ইউনিট তৈরি করুন

curl -X PUT https://surge.sulvo.com/api/v2/inventory/unit \
  -H "authorization: Bearer $SULVO_API_KEY" \
  -H "content-type: application/json" \
  -d '{
    "domain": "example.com",
    "type": "display",
    "size": { "width": 300, "height": 250 }
  }'

Method	Path	Notes
PUT	/api/v2/inventory/unit	domain, type, ঐচ্ছিক size, placement, custom name এবং focusedAd সেটিং দিয়ে একটি বিজ্ঞাপন ইউনিট তৈরি করুন।
PUT	/api/v2/inventory/interstitial-units	একটি ডোমেইনের জন্য ডেস্কটপ এবং/অথবা মোবাইল ইন্টারস্টিশিয়াল ইউনিট তৈরি করুন।
PUT	/api/v2/inventory/auto-sticky-units	একটি ডোমেইনের জন্য স্টিকি ডিসপ্লে এবং/অথবা স্টিকি মোবাইল ইউনিট তৈরি করুন।
DELETE	/api/v2/inventory/unit/{adId}	অথেনটিকেট করা অ্যাকাউন্টের মালিকানাধীন বিজ্ঞাপন ইউনিট মুছুন।

সমর্থিত বিজ্ঞাপন ইউনিটের ধরন

displaynative_multisticky_displaysticky_mobilesticky_display_customsticky_mobile_customsticky_videointerstitial_desktopinterstitial_mobileofferwall

ত্রুটি

ত্রুটি পরিচালনা

2xx নয় এমন অডিট উত্তর এবং Sulvo অ্যাকাউন্ট API ব্যর্থতায় এজেন্ট ও CLI ক্লায়েন্টের উপযোগী JSON বডি ফেরত আসে।

401

অ্যাকাউন্ট API কলের জন্য API কী নেই, অবৈধ অথবা মেয়াদোত্তীর্ণ। সর্বজনীন অডিট এন্ডপয়েন্টে কী লাগে না।

403

কী দিয়ে অথেনটিকেশন হয়েছে, কিন্তু প্রয়োজনীয় স্কোপ নেই, অ্যাকাউন্ট অনুমোদিত নয়, অথবা রিসোর্স অন্য অ্যাকাউন্টের।

503 / 504

সর্বজনীন অডিট পরিষেবা ব্যস্ত অথবা অডিটের সময়সীমা পেরিয়ে গেছে। পরে আবার চেষ্টা করুন এবং Retry-After থাকলে তা মেনে চলুন।

অডিট ত্রুটির কাঠামো

{
  "error": {
    "code": "audit_capacity_exceeded",
    "message": "Audit capacity is currently exhausted. Retry later."
  }
}

আপনি কি একটি প্যাকেজ করা ক্লায়েন্ট পছন্দ করবেন?

npm প্যাকেজ ও MCP সেটআপ আপনার হয়ে এসব এন্ডপয়েন্ট কল করে এবং সামঞ্জস্যপূর্ণ AI ক্লায়েন্টে একই অডিট, রিপোর্ট ও ইনভেন্টরি কাজের ধারা দেয়।

সেটআপ দেখুন