ప్రచురణకర్త ఆదాయ ఆడిట్ API

CLI మరియు MCP సర్వర్ ఉపయోగించే అదే API ద్వారా పబ్లిక్ ప్రచురణకర్త ఆదాయ తనిఖీలను అమలు చేయండి, Sulvo నివేదికలను పొందండి, ఆమోదిత ప్రచురణకర్త ఇన్వెంటరీని నిర్వహించండి.

హోస్ట్ చేసిన బేస్

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	చెల్లని కార్యాచరణ నివేదిక. సాధారణ date/domain క్వెరీ అవసరం లేదు.
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 క్లయింట్‌లకు అదే ఆడిట్, రిపోర్టింగ్ మరియు ఇన్వెంటరీ వర్క్‌ఫ్లోలను అందిస్తాయి.

సెటప్ చూడండి