Dokumentācija: Publisher Revenue Audit API

Palaidiet publiskas izdevēju ieņēmumu analīzes, izgūstiet Sulvo pārskatus un pārvaldiet apstiprinātu izdevēju inventāru, izmantojot to pašu API saskarni, ko lieto CLI un MCP serveris.

Mitinātā pamata adrese

https://publisher-revenue-audit.sulvo.com/v1/publisher-revenue-auditsCLI un MCP iestatīšana

Pamatinformācija

Pamata URL

Publiskais audita galapunkts apzināti neprasa autentifikāciju. Sulvo konta pārskatiem un inventāra pieprasījumiem izmanto vadības panelī ģenerētu API atslēgu.

Publiskais audita API

POST

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

Sulvo konta API

Bearer API atslēga

https://surge.sulvo.com/api

Mitināts MCP galapunkts

MCP

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

Publiskais galapunkts

Palaidiet ieņēmumu auditu

Izmantojiet šo galapunktu orientējošai publiski pieejamu pierādījumu analīzei par izdevēja domēnu. Atbilde nav pierādījums ieņēmumu zudumam un negarantē pieaugumu. Pārbaudiet konstatējumus, salīdzinot tos ar izdevēja pārskatiem.

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

Lauks	Piezīmes
input.domain	Obligāts izdevēja domēns vai publiska resursdatora adrese. Domēni bez shēmas tiek pārveidoti uz HTTPS. Privāti mērķi, neapstrādātas IP adreses, iekšējie resursdatori un nestandarta porti tiek noraidīti.
input.vertical	Neobligāts. Pieņem news, sports, entertainment, technology, education, gaming vai other.
input.metrics	Neobligāts konteksts no izdevēja vadības paneļa, piemēram, aizpildījuma līmenis, redzamība, vidējais CPM, ieņēmumi sesijā, lapu skatījumi mēnesī vai sesijas mēnesī.
input.options	Neobligātas izvades un datu ieguves vadīklas, tostarp format, compact, maxPages, includeEvidence, enableBrowser, includeScreenshots, enablePageSpeed, pageSpeedStrategy, concurrency, whiteLabel un partnerId.

Autentifikācija

Konta API izmantojiet Sulvo API atslēgu

Ģenerējiet API atslēgu Sulvo vadības panelī, sadaļā Account Settings. Sūtiet to kā Bearer pilnvaru Sulvo konta API pieprasījumos.

Authorization galvene

Authorization: Bearer $SULVO_API_KEY

reports:read

Nepieciešams pārskatu eksportam un saglabāto pārskatu saraksta veidošanai.

reports:write

Nepieciešams, lai izveidotu, atjauninātu, palaistu vai dzēstu izvērstus pārskatus.

inventory:write

Nepieciešams reklāmas vienību izveidei un dzēšanai. Kontam jābūt apstiprinātam, un tam jābūt inventāra īpašniekam.

Pārskati

Pārskatu nolasīšanas galapunkti

Pārskatu nolasīšanai izmanto GET pieprasījumus uz Sulvo konta API pamata adresi. Vērtības, kurās norādīts tikai datums, tiek interpretētas kā pilnas UTC dienas robežas.

Pārskata pieprasījums

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	Ikdienas veiktspējas kopsavilkums. Atbalsta datuma, domēna, reklāmas saknes un pakalpojumu sniedzēja filtrus.
GET	/api/v1/reports/by-date-and-ad-unit	Ikdienas veiktspēja, grupēta pēc reklāmas vienības.
GET	/api/v1/reports/by-domain-and-ad-unit	Veiktspējas sadalījums pēc domēna un reklāmas vienības.
GET	/api/v1/reports/bot-filtering	Bota filtrēšanas pārskats konta datplūsmas kvalitātes izvērtēšanai.
GET	/api/v1/reports/bot-scores	Bota punktu pārskati pēc datuma un saistītajiem rādītājiem.
GET	/api/v1/reports/invalid-activity	Nederīgas darbības pārskati. Standarta datuma vai domēna vaicājums nav nepieciešams.
GET	/api/v1/reports/direct-bidder-analysis	Tiešā solītāja pārskats. Nepieciešams directBidder, un var iekļaut start/end.
GET	/api/v1/inventory/ad-units-by-domain	Reklāmas vienību inventārs, grupēts pēc domēna.

Biežāk lietotie vaicājuma parametri: start, end, atkārtojami domains un adRoots, kā arī adProvider. Tiešā solītāja analīzei nepieciešams arī directBidder.

Izvērsti pārskati

Izveidojiet ieplānotus vai tūlītējus e-pasta pārskatus

Izvērstus pārskatus var palaist nekavējoties vai atkārtot pēc grafika. Tie tiek nosūtīti e-pastā, nevis atgriezti tieši atbildē.

Saglabāt izvērsto pārskatu

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	Uzskaitiet autentificētā konta saglabātos izvērstos pārskatus.
POST	/api/v2/reports/save-advanced-report	Izveidojiet vai atjauniniet izvērstu pārskatu. Nepieciešams reportType, toAddress, immediateRun un vismaz viens adRoots vai domains mērķis.
DELETE	/api/v2/reports/delete-advanced-report/{reportId}	Dzēsiet saglabātu izvērsto pārskatu pēc ID.

Pārskatu veidi

adUnit, dimensions, customData

Dimensijas

country, device, os

Biežums

daily, weekly, biweekly, monthly

Inventārs

Izveidojiet un dzēsiet apstiprinātas reklāmas vienības

Inventāra izmaiņām nepieciešams apstiprināts Sulvo konts un īpašnieka ģenerēta API atslēga ar atļauju tvērumu inventory:write.

Izveidot reklāmas vienību

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	Izveidojiet vienu reklāmas vienību ar domēnu, veidu, neobligātu izmēru, izvietojumu, pielāgotu nosaukumu un focusedAd iestatījumiem.
PUT	/api/v2/inventory/interstitial-units	Izveidojiet interstitial vienības datoram un/vai mobilajām ierīcēm konkrētam domēnam.
PUT	/api/v2/inventory/auto-sticky-units	Izveidojiet Sticky displeja vienības un/vai Sticky mobilās vienības konkrētam domēnam.
DELETE	/api/v2/inventory/unit/{adId}	Dzēsiet autentificētajam kontam piederošu reklāmas vienību.

Atbalstītie reklāmas vienību veidi

displaynative_multisticky_displaysticky_mobilesticky_display_customsticky_mobile_customsticky_videointerstitial_desktopinterstitial_mobileofferwall

Kļūdas

Kļūdu apstrāde

Audita atbildes, kas nav 2xx, un Sulvo konta API kļūmes atgriež JSON pamatdaļas, kas paredzētas aģentu un CLI klientiem.

401

Konta API pieprasījumos trūkst API atslēgas, tā nav derīga vai tās derīguma termiņš ir beidzies. Publiskajam audita galapunktam atslēga nav nepieciešama.

403

Atslēga autentificēja pieprasījumu, taču tai trūkst vajadzīgā atļauju tvēruma, konts nav apstiprināts vai resurss pieder citam kontam.

503 / 504

Publiskais audita pakalpojums ir pārslogots vai auditam beidzies laiks. Mēģiniet vēlāk un ievērojiet Retry-After, ja tas ir norādīts.

Audita kļūdas struktūra

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

Vai dodat priekšroku gatavam klientam?

npm pakotne un MCP iestatīšana izsauc šos galapunktus jūsu vietā un nodrošina saderīgiem MI klientiem tādas pašas audita, pārskatu un inventāra darbplūsmas.

Skatīt iestatīšanu