प्रकाशक महसूल ऑडिट 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 डॅशबोर्डमधील खाते सेटिंग्जमध्ये 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	दैनिक कामगिरीचा सारांश. 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	खात्यातील ट्रॅफिक गुणवत्तेच्या आढाव्यासाठी बॉट फिल्टरिंग रिपोर्ट.
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 क्लायंटना तेच ऑडिट, रिपोर्ट आणि इन्व्हेंटरी कार्यप्रवाह देतात.

सेटअप पहा