પ્રકાશક આવક ઑડિટ API

સાર્વજનિક પ્રકાશક આવક તપાસ ચલાવો, Sulvo રિપોર્ટ્સ મેળવો અને CLI તથા MCP સર્વર વાપરે છે તે જ API મારફતે મંજૂર પ્રકાશક ઇન્વેન્ટરીનું સંચાલન કરો.

હોસ્ટેડ બેઝ

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 ડેશબોર્ડમાં Account Settings હેઠળ API કી જનરેટ કરો. Sulvo એકાઉન્ટ API વિનંતીઓમાં તેને Bearer token તરીકે મોકલો.

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	એકાઉન્ટ ટ્રાફિક ગુણવત્તાની સમીક્ષા માટે bot ફિલ્ટરિંગ રિપોર્ટ.
GET	/api/v1/reports/bot-scores	તારીખ અને સંબંધિત પરિમાણો મુજબ bot સ્કોર રિપોર્ટિંગ.
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 પણ જરૂરી છે.

અદ્યતન રિપોર્ટ્સ

શેડ્યૂલ કરેલા અથવા તાત્કાલિક ઇમેઇલ રિપોર્ટ્સ બનાવો

અદ્યતન રિપોર્ટ્સ તરત ચાલી શકે છે અથવા શેડ્યૂલ મુજબ ફરી ફરી ચાલી શકે છે. તેઓ 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

ઇન્વેન્ટરી

મંજૂર જાહેરાત યુનિટ બનાવો અને કાઢી નાખો

ઇન્વેન્ટરીમાં ફેરફાર કરવા માટે મંજૂર Sulvo એકાઉન્ટ અને inventory:write scope ધરાવતી માલિક દ્વારા બનાવેલી 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 નિષ્ફળતાઓ, agent અને CLI ક્લાયન્ટ માટે બનાવેલા JSON બૉડીઝ પરત કરે છે.

401

એકાઉન્ટ API કૉલ માટે API કી ગાયબ, અમાન્ય અથવા સમયસમાપ્ત હોઈ શકે છે. સાર્વજનિક ઑડિટ એન્ડપોઇન્ટને કીની જરૂર નથી.

403

કીનું પ્રમાણીકરણ થયું, પરંતુ જરૂરી scope નથી, એકાઉન્ટ મંજૂર નથી અથવા સંસાધન બીજા એકાઉન્ટનું છે.

503 / 504

સાર્વજનિક ઑડિટ સેવા પર વધુ ભાર છે અથવા ઑડિટનો સમય સમાપ્ત થયો છે. પછીથી ફરી પ્રયાસ કરો અને Retry-After હાજર હોય ત્યારે તેનું પાલન કરો.

ઑડિટ ભૂલનું એન્વલપ

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

શું તમને પેકેજ્ડ ક્લાયન્ટ પસંદ પડશે?

npm પેકેજ અને MCP સેટઅપ તમારા માટે આ એન્ડપોઇન્ટ કૉલ કરે છે અને સુસંગત AI ક્લાયન્ટ્સને એ જ ઑડિટ, રિપોર્ટ અને ઇન્વેન્ટરી વર્કફ્લો આપે છે.

સેટઅપ જુઓ