Väljaandja tuluauditi API

Käivitage väljaandjate avalikud tulukontrollid, hankige Sulvo aruandeid ning hallake heakskiidetud väljaandjate reklaamipinda sama API kaudu, mida kasutavad CLI ja MCP-server.

Majutatud baasaadress

https://publisher-revenue-audit.sulvo.com/v1/publisher-revenue-auditsCLI ja MCP seadistamine

Põhitõed

Baas-URL-id

Avalik auditi lõpp-punkt on teadlikult jäetud autentimiseta. Sulvo konto aruannete ja reklaamipinna päringute jaoks kasutatakse juhtpaneelil loodud API-võtit.

Avalik auditi API

POST

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

Sulvo konto API

Bearer API-võti

https://surge.sulvo.com/api

Majutatud MCP-lõpp-punkt

MCP

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

Avalik lõpp-punkt

Käivitage tuluaudit

Kasutage seda lõpp-punkti väljaandja domeeni avalikel tõenditel põhinevaks orienteeruvaks kontrolliks. Vastus ei tõenda tulukadu ega taga kasvu. Kontrollige leide väljaandjapoolse aruandluse põhjal.

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

Väli	Märkused
input.domain	Nõutav väljaandja domeen või avalik host. Paljad domeeninimed normaliseeritakse HTTPS-iks. Privaatseid sihtmärke, paljaid IP-aadresse, sisehoste ja mittestandardseid porte ei aktsepteerita.
input.vertical	Valikuline. Lubatud väärtused: news, sports, entertainment, technology, education, gaming või other.
input.metrics	Valikulised väljaandja antud juhtpaneeliandmed, näiteks fill rate, viewability, keskmine CPM, tulu seansi kohta, igakuised lehevaatamised või igakuised seansid.
input.options	Valikulised väljundi- ja kogumisseaded, sealhulgas format, compact, maxPages, includeEvidence, enableBrowser, includeScreenshots, enablePageSpeed, pageSpeedStrategy, concurrency, whiteLabel ja partnerId.

Autentimine

Kasutage konto API-de jaoks Sulvo API-võtit

Looge API-võti Sulvo juhtpaneeli konto seadetes. Lisage see Sulvo konto API-päringutele Bearer-tokenina.

Authorization-päis

Authorization: Bearer $SULVO_API_KEY

reports:read

Vajalik aruannete eksportimiseks ja salvestatud aruannete loendi vaatamiseks.

reports:write

Vajalik täpsemate aruannete loomiseks, uuendamiseks, käivitamiseks või kustutamiseks.

inventory:write

Vajalik reklaamiüksuste loomiseks ja kustutamiseks. Konto peab olema heaks kiidetud ja omama reklaamipinda.

Aruanded

Lõpp-punktid aruannete lugemiseks

Aruannete lugemiseks kasutage Sulvo konto API baasaadressi all olevaid GET-päringuid. Ainult kuupäevana esitatud väärtusi käsitletakse kogu UTC-päeva alguse ja lõpuna.

Aruandepäring

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	Päevane tulemuslikkuse kokkuvõte. Toetab kuupäeva, domeeni, reklaamipuu ja pakkuja filtreid.
GET	/api/v1/reports/by-date-and-ad-unit	Päevane tulemuslikkus reklaamiüksuste kaupa.
GET	/api/v1/reports/by-domain-and-ad-unit	Domeeni ja reklaamiüksuse tulemuslikkuse jaotus.
GET	/api/v1/reports/bot-filtering	Boti filtreerimise aruanne konto liikluse kvaliteedi ülevaatamiseks.
GET	/api/v1/reports/bot-scores	Boti skooride aruanne kuupäeva ja seotud mõõtmete kaupa.
GET	/api/v1/reports/invalid-activity	Kehtetu tegevuse aruanne. Tavalist kuupäeva- või domeenipäringut pole vaja.
GET	/api/v1/reports/direct-bidder-analysis	Otsepakkuja aruanne. Vajab parameetrit directBidder ning võib sisaldada parameetreid start ja end.
GET	/api/v1/inventory/ad-units-by-domain	Domeeni kaupa rühmitatud reklaamiüksuste reklaamipind.

Levinud päringuparameetrid: start, end, korduv domains, korduv adRoots ja adProvider. Otsepakkumise analüüs vajab ka parameetrit directBidder.

Täpsemad aruanded

Looge ajastatud või kohe saadetavaid e-posti aruandeid

Täpsemaid aruandeid saab käivitada kohe või korrapäraselt ajakava alusel. Need saadetakse e-postiga, mitte ei tagastata päringu vastusena.

Salvestage täpsem aruanne

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	Loetlege autentitud konto salvestatud täpsemad aruanded.
POST	/api/v2/reports/save-advanced-report	Looge või uuendage täpsem aruanne. Vajab välju reportType, toAddress ja immediateRun ning vähemalt ühte sihtmärki väljadest adRoots või domains.
DELETE	/api/v2/reports/delete-advanced-report/{reportId}	Kustutage salvestatud täpsem aruanne id järgi.

Aruandetüübid

adUnit, dimensions, customData

Mõõtmed

country, device, os

Sagedus

daily, weekly, biweekly, monthly

Reklaamipind

Looge ja kustutage heakskiidetud reklaamiüksusi

Reklaamipinna muutmiseks on vaja heakskiidetud Sulvo kontot ja konto omaniku loodud API-võtit õigusega inventory:write.

Looge reklaamiüksus

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	Looge üks reklaamiüksus parameetritega domain ja type ning valikuliste seadistustega size, placement, custom name ja focusedAd.
PUT	/api/v2/inventory/interstitial-units	Looge domeenile lauaarvutil ja/või mobiilseadmel kasutatavad vahelehereklaamiüksused.
PUT	/api/v2/inventory/auto-sticky-units	Looge domeenile kleepuvad displeiüksused ja/või kleepuvad mobiiliüksused.
DELETE	/api/v2/inventory/unit/{adId}	Kustutage reklaamiüksus, mis kuulub autentitud kontole.

Toetatud reklaamiüksuste tüübid

displaynative_multisticky_displaysticky_mobilesticky_display_customsticky_mobile_customsticky_videointerstitial_desktopinterstitial_mobileofferwall

Vead

Vigade käsitlemine

Auditi mitte-2xx vastused ja Sulvo konto API vead tagastavad JSON-kehad, mis on mõeldud agentidele ja CLI-klientidele.

401

Konto API-päringust puudub API-võti või see on kehtetu või aegunud. Avalik auditi lõpp-punkt võtit ei vaja.

403

Võti autentis päringu, kuid sellel puudub nõutav õigus, konto pole heaks kiidetud või ressurss kuulub teisele kontole.

503 / 504

Avalik audititeenus on ülekoormatud või auditi päring aegus. Proovige hiljem uuesti ja järgige päise Retry-After väärtust, kui see on olemas.

Auditi veaandmete struktuur

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

Eelistate paketina pakutavat klienti?

MCP seadistamine ja npm-pakett teevad need päringud teie eest ning pakuvad ühilduvatele AI-klientidele samu auditi, aruandluse ja reklaamipinna töövooge.

Vaadake seadistust