ਪ੍ਰਕਾਸ਼ਕ ਆਮਦਨ ਆਡਿਟ API

ਜਨਤਕ ਪ੍ਰਕਾਸ਼ਕ ਆਮਦਨ ਜਾਂਚਾਂ ਚਲਾਓ, Sulvo ਰਿਪੋਰਟਾਂ ਪ੍ਰਾਪਤ ਕਰੋ ਅਤੇ CLI ਅਤੇ MCP ਸਰਵਰ ਵੱਲੋਂ ਵਰਤੇ ਜਾਂਦੇ ਉਸੇ API ਇੰਟਰਫੇਸ ਰਾਹੀਂ ਮਨਜ਼ੂਰਸ਼ੁਦਾ ਪ੍ਰਕਾਸ਼ਕ ਇਨਵੈਂਟਰੀ ਦਾ ਪ੍ਰਬੰਧ ਕਰੋ।

ਹੋਸਟ ਕੀਤਾ ਬੇਸ

https://publisher-revenue-audit.sulvo.com/v1/publisher-revenue-auditsCLI ਅਤੇ MCP ਸੈੱਟਅੱਪ

ਮੁੱਢਲੀਆਂ ਗੱਲਾਂ

ਮੂਲ URLs

ਜਨਤਕ ਆਡਿਟ ਐਂਡਪੌਇੰਟ ਜਾਣ-ਬੁੱਝ ਕੇ ਬਿਨਾਂ ਪ੍ਰਮਾਣੀਕਰਨ ਦੇ ਹੈ। 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

ਵਿਗਿਆਪਨ ਯੂਨਿਟ ਬਣਾਉਣ ਅਤੇ ਮਿਟਾਉਣ ਲਈ ਲਾਜ਼ਮੀ ਹੈ। ਖਾਤਾ ਮਨਜ਼ੂਰਸ਼ੁਦਾ ਹੋਣਾ ਚਾਹੀਦਾ ਹੈ ਅਤੇ ਇਨਵੈਂਟਰੀ ਉਸਦੀ ਆਪਣੀ ਹੋਣੀ ਚਾਹੀਦੀ ਹੈ।

ਰਿਪੋਰਟਾਂ

ਰਿਪੋਰਟਾਂ ਪ੍ਰਾਪਤ ਕਰਨ ਵਾਲੇ ਐਂਡਪੌਇੰਟ

GET ਰਾਹੀਂ ਰਿਪੋਰਟਾਂ ਪੜ੍ਹਨ ਵਾਲੀਆਂ ਬੇਨਤੀਆਂ Sulvo ਖਾਤਾ API ਦੇ ਮੂਲ ਪਤੇ ਹੇਠਾਂ ਕੀਤੀਆਂ ਜਾਂਦੀਆਂ ਹਨ। ਸਿਰਫ਼ ਤਾਰੀਖ ਵਾਲੇ ਮੁੱਲ ਪੂਰੇ 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	ਰੋਜ਼ਾਨਾ ਪ੍ਰਦਰਸ਼ਨ ਦਾ ਸਾਰ। ਤਾਰੀਖ, ਡੋਮੇਨ, ਵਿਗਿਆਪਨ ਰੂਟ ਅਤੇ ਪ੍ਰਦਾਤਾ ਅਨੁਸਾਰ ਫਿਲਟਰ ਲਗਾਏ ਜਾ ਸਕਦੇ ਹਨ।
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, ਆਪਣੀ ਪਸੰਦ ਦਾ ਨਾਮ ਅਤੇ 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 ਦੀਆਂ ਨਾਕਾਮੀਆਂ JSON ਬਾਡੀਆਂ ਵਜੋਂ ਵਾਪਸ ਆਉਂਦੀਆਂ ਹਨ, ਜੋ ਏਜੰਟ ਅਤੇ CLI ਕਲਾਇੰਟਾਂ ਲਈ ਤਿਆਰ ਕੀਤੀਆਂ ਗਈਆਂ ਹਨ।

401

ਖਾਤਾ API ਬੇਨਤੀਆਂ ਵਿੱਚ API ਕੁੰਜੀ ਨਹੀਂ ਦਿੱਤੀ ਗਈ, ਅਵੈਧ ਹੈ ਜਾਂ ਮਿਆਦ ਪੁੱਗ ਚੁੱਕੀ ਹੈ। ਜਨਤਕ ਆਡਿਟ ਐਂਡਪੌਇੰਟ ਲਈ ਕੁੰਜੀ ਦੀ ਲੋੜ ਨਹੀਂ ਹੈ।

403

ਕੁੰਜੀ ਦਾ ਪ੍ਰਮਾਣੀਕਰਨ ਸਫਲ ਹੋਇਆ, ਪਰ ਕੁੰਜੀ ਕੋਲ ਲੋੜੀਂਦਾ ਸਕੋਪ ਨਹੀਂ ਹੈ, ਖਾਤਾ ਮਨਜ਼ੂਰਸ਼ੁਦਾ ਨਹੀਂ ਹੈ ਜਾਂ ਸਰੋਤ ਕਿਸੇ ਹੋਰ ਖਾਤੇ ਦਾ ਹੈ।

503 / 504

ਜਨਤਕ ਆਡਿਟ ਸੇਵਾ 'ਤੇ ਬਹੁਤ ਜ਼ਿਆਦਾ ਬੋਝ ਹੈ ਜਾਂ ਆਡਿਟ ਲਈ ਨਿਰਧਾਰਤ ਸਮਾਂ ਮੁੱਕ ਗਿਆ ਹੈ। ਬਾਅਦ ਵਿੱਚ ਦੁਬਾਰਾ ਕੋਸ਼ਿਸ਼ ਕਰੋ ਅਤੇ ਜੇ Retry-After ਮੌਜੂਦ ਹੋਵੇ ਤਾਂ ਉਸਦੀ ਪਾਲਣਾ ਕਰੋ।

ਆਡਿਟ ਗਲਤੀ ਜਵਾਬ ਫਾਰਮੈਟ

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

ਕੀ ਤੁਸੀਂ ਪੈਕੇਜ ਵਾਲਾ ਕਲਾਇੰਟ ਪਸੰਦ ਕਰਦੇ ਹੋ?

npm ਪੈਕੇਜ ਅਤੇ MCP ਸੈੱਟਅੱਪ ਤੁਹਾਡੇ ਲਈ ਇਨ੍ਹਾਂ ਐਂਡਪੌਇੰਟਾਂ ਨੂੰ ਕਾਲ ਕਰਦੇ ਹਨ ਅਤੇ ਅਨੁਕੂਲ AI ਕਲਾਇੰਟਾਂ ਨੂੰ ਉਹੀ ਆਡਿਟ, ਰਿਪੋਰਟ ਅਤੇ ਇਨਵੈਂਟਰੀ ਕਾਰਜ-ਪ੍ਰਵਾਹ ਵਰਤਣ ਦਿੰਦੇ ਹਨ।

ਸੈੱਟਅੱਪ ਵੇਖੋ