प्रकाशक राजस्व ऑडिट API

सार्वजनिक प्रकाशक राजस्व जाँच चलाएँ, Sulvo रिपोर्ट प्राप्त करें और CLI तथा MCP सर्वर द्वारा इस्तेमाल किए जाने वाले उसी API से स्वीकृत प्रकाशक inventory प्रबंधित करें।

होस्टेड बेस

https://publisher-revenue-audit.sulvo.com/v1/publisher-revenue-auditsCLI और MCP सेटअप

बुनियादी बातें

बेस URL

सार्वजनिक ऑडिट endpoint जानबूझकर बिना प्रमाणीकरण के उपलब्ध है। Sulvo खाता रिपोर्ट और inventory कॉल के लिए डैशबोर्ड से बनाई गई API key इस्तेमाल होती है।

सार्वजनिक ऑडिट API

POST

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

Sulvo खाता API

Bearer प्रकार की API key

https://surge.sulvo.com/api

होस्टेड MCP endpoint

MCP

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

सार्वजनिक endpoint

राजस्व ऑडिट चलाएँ

प्रकाशक डोमेन के सार्वजनिक प्रमाणों की प्रारंभिक जाँच के लिए इस endpoint का उपयोग करें। जवाब राजस्व हानि या सुनिश्चित बढ़ोतरी का प्रमाण नहीं है; अपनी प्रकाशक-पक्ष की रिपोर्टिंग से नतीजों की पुष्टि करें।

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	ज़रूरी। प्रकाशक डोमेन या सार्वजनिक host। बिना scheme वाले डोमेन को HTTPS में बदला जाता है। निजी लक्ष्य, raw IP, आंतरिक host और गैर-मानक port अस्वीकार किए जाते हैं।
input.vertical	वैकल्पिक। news, sports, entertainment, technology, education, gaming या other स्वीकार करता है।
input.metrics	वैकल्पिक प्रकाशक-प्रदत्त डैशबोर्ड संदर्भ, जैसे fill rate, viewability, औसत CPM, प्रति session राजस्व, मासिक pageviews या मासिक sessions।
input.options	वैकल्पिक आउटपुट और संग्रह नियंत्रण, जिनमें format, compact, maxPages, includeEvidence, enableBrowser, includeScreenshots, enablePageSpeed, pageSpeedStrategy, concurrency, whiteLabel और partnerId शामिल हैं।

प्रमाणीकरण

खाता API के लिए Sulvo API key इस्तेमाल करें

Sulvo डैशबोर्ड के Account Settings में API key बनाएँ। Sulvo खाता API अनुरोधों में इसे Bearer token के रूप में भेजें।

Authorization हेडर

Authorization: Bearer $SULVO_API_KEY

reports:read

रिपोर्ट निर्यात और सहेजी गई रिपोर्ट की सूची के लिए ज़रूरी।

reports:write

उन्नत रिपोर्ट बनाने, अपडेट करने, चलाने या हटाने के लिए ज़रूरी।

inventory:write

विज्ञापन इकाई बनाने और हटाने के लिए ज़रूरी। खाता स्वीकृत होना चाहिए और inventory उसी के स्वामित्व में होनी चाहिए।

रिपोर्ट

रिपोर्ट पढ़ने वाले endpoint

पढ़ने वाली रिपोर्टों के लिए Sulvo खाता API base के अंतर्गत 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	दैनिक प्रदर्शन सारांश। date, domain, 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	खाते की ट्रैफ़िक गुणवत्ता की समीक्षा के लिए bot फ़िल्टरिंग रिपोर्ट।
GET	/api/v1/reports/bot-scores	तारीख और संबंधित आयामों के अनुसार bot स्कोर रिपोर्टिंग।
GET	/api/v1/reports/invalid-activity	अमान्य गतिविधि रिपोर्टिंग। तारीख/डोमेन की मानक query आवश्यक नहीं।
GET	/api/v1/reports/direct-bidder-analysis	सीधे bidder की रिपोर्ट। directBidder ज़रूरी है और start/end शामिल हो सकते हैं।
GET	/api/v1/inventory/ad-units-by-domain	डोमेन के अनुसार समूहित विज्ञापन इकाई inventory।

सामान्य query पैरामीटर: start, end, दोहराए जा सकने वाले domains, दोहराए जा सकने वाले adRoots और adProvider। सीधे bidder विश्लेषण के लिए directBidder भी ज़रूरी है।

उन्नत रिपोर्ट

निर्धारित या तुरंत ईमेल रिपोर्ट बनाएँ

उन्नत रिपोर्ट तुरंत चल सकती हैं या तय समय-सारणी पर दोहराई जा सकती हैं। वे inline लौटाने के बजाय ईमेल से भेजी जाती हैं।

उन्नत रिपोर्ट सहेजें

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

Inventory

स्वीकृत विज्ञापन इकाइयाँ बनाएँ और हटाएँ

Inventory में बदलाव के लिए स्वीकृत Sulvo खाता और owner द्वारा बनाई गई inventory:write scope वाली API key ज़रूरी है।

विज्ञापन इकाई बनाएँ

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	डोमेन के लिए डेस्कटॉप और/या मोबाइल Interstitial इकाइयाँ बनाएँ।
PUT	/api/v2/inventory/auto-sticky-units	डोमेन के लिए Sticky Display और/या Sticky मोबाइल इकाइयाँ बनाएँ।
DELETE	/api/v2/inventory/unit/{adId}	प्रमाणित खाते के स्वामित्व वाली विज्ञापन इकाई हटाएँ।

समर्थित विज्ञापन इकाई प्रकार

displaynative_multisticky_displaysticky_mobilesticky_display_customsticky_mobile_customsticky_videointerstitial_desktopinterstitial_mobileofferwall

त्रुटियाँ

त्रुटि प्रबंधन

गैर-2xx ऑडिट जवाब और Sulvo खाता API विफलताएँ, agent और CLI क्लाइंट के लिए बनाए गए JSON body लौटाती हैं।

401

खाता API कॉल के लिए API key मौजूद नहीं है, अमान्य है या समाप्त हो गई है। सार्वजनिक ऑडिट endpoint को key की ज़रूरत नहीं है।

403

Key से प्रमाणीकरण हुआ, लेकिन उसमें ज़रूरी scope नहीं है, खाता स्वीकृत नहीं है या संसाधन किसी दूसरे खाते का है।

503 / 504

सार्वजनिक ऑडिट सेवा पर बहुत अधिक भार है या ऑडिट की समय-सीमा समाप्त हो गई। बाद में फिर कोशिश करें और Retry-After मौजूद हो तो उसका पालन करें।

ऑडिट त्रुटि envelope

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

क्या आप पैकेज्ड क्लाइंट पसंद करेंगे?

npm पैकेज और MCP सेटअप आपके लिए इन endpoint को कॉल करते हैं और संगत AI क्लाइंट को वही ऑडिट, रिपोर्ट और inventory कार्यप्रवाह उपलब्ध कराते हैं।

सेटअप देखें