This endpoint is used during the click redirect flow to request a real-time bid from Sovrn for a destination URL. When Sovrn can monetize the click, Bid Check returns a redirect URL that you can use to redirect the user.

Partners typically use Bid Check when comparing offers from multiple affiliate networks in real time. After receiving Sovrn's bid, you can decide whether to route the click through Sovrn or through another network.

For CPC bids, the bid response is valid for a limited time. If you redirect the user through Sovrn before the bid expires, the returned eepc is guaranteed as the rate for that click. If you redirect the user after the bid expires, the click is still tracked and affiliated through standard link optimization at the current market rate.

Use Link Check when you only need to check whether a URL can be monetized, typically at link insertion time.

Use Building Affiliate Links when you need to create Sovrn affiliate links by wrapping destination URLs.

Commerce API Key

To query this endpoint, include your site Commerce API Key as the key query parameter on every request. This key is specific to the site or traffic source where the click originated.

You can find your key in the Sovrn Platform under Commerce Settings, or retrieve it via the Campaign API.

Use the API Key that corresponds to the site, app, or traffic source sending the click so the bid is evaluated and attributed correctly.

Query Params

Optional: Tracking parameters

Use these optional parameters to pass your own tracking values with the click. These values can help you associate click activity with a user, page, campaign, placement, or event.

URL encoding

Some query parameter values must be URL-encoded before they are sent.

Most HTTP clients and the Try It panel on this page handle encoding automatically. If you build the request URL manually, encode these values before sending the request.

Example Request

curl "https://api.viglink.com/api/bid\
?key=YOUR_API_KEY\
&out=https%3A%2F%2Fexample-merchant.com\
&ip=192.0.2.1\
&userAgent=Mozilla%2F5.0+%28Macintosh%3B+Intel+Mac+OS+X+10_15_7%29+AppleWebKit%2F537.36+%28KHTML%2C+like+Gecko%29+Chrome%2F120.0.0.0+Safari%2F537.36\
&referrerUrl=https%3A%2F%2Fexample-publisher.com%2Farticle\
&subId=https%3A%2F%2Fexample-publisher.com%2Fplacement%2Fhomepage\
&bidFloor=0.01\
&includeCpa=false"

Example Response

Winning bid

{
  "affiliated": true,
  "pricing": "CPC",
  "eepc": 0.05725,
  "url": "https://redirect.viglink.com?u=...",
  "expireInMs": 250
}

Redirecting the user

No bid or not monetizable

{
  "affiliated": false
}

Sovrn returns { "affiliated": false } when there is no eligible bid, the destination URL is not monetizable, or the available bid is below the submitted bidFloor.

Status Codes