Bid Check

get

https://api.viglink.com/api/bid

Get a real-time Sovrn bid on your click traffic.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

key

string

required

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

out

uri

required

Destination URL for the click. This value must be URL-encoded when placed in the query string.

string

required

The real end user's IP address. IPv4 and IPv6 are supported. Pass the end user's actual IP address, not the IP address of your server. This value must match the user who is redirected through Sovrn for the bid to be valid.

userAgent

string

required

The real end user's browser User-Agent string. Pass the end user's actual User-Agent, not the User-Agent of your server. This value must match the user who is redirected through Sovrn for the bid to be valid. This value must be URL-encoded when placed in the query string.

referrerUrl

uri

Page URL where the click originated. This value must be URL-encoded when placed in the query string.

subId

uri

Fully qualified SubID URL used to associate the click with a child campaign, placement, domain, or publisher under the parent API Key. If the SubID does not already exist, Sovrn will create it. This value must be URL-encoded when placed in the query string.

bidFloor

float

Minimum acceptable bid, in USD, expressed as a decimal. For example, 0.01 means one cent. When provided, bids below this value return affiliated: false. If omitted, no minimum bid floor is applied.

includeCpa

boolean

When true, CPA offers are considered alongside CPC bids. If a CPA offer wins, the response pricing will be CPA. If omitted, only CPC bids are considered.

cuid

string

length ≤ 2048

An identifier of your choosing used to associate the click with a user, page, campaign, or event. Use only letters, numbers, hyphens, and underscores. Maximum 2048 characters.

utm_source

string

Identifies the source of the traffic, such as a website, newsletter, or social platform. Use only letters, numbers, hyphens, and underscores.

utm_medium

string

Identifies the marketing medium, such as email, social, or banner. Use only letters, numbers, hyphens, and underscores.

utm_campaign

string

Identifies the campaign name, promotion, or initiative. Use only letters, numbers, hyphens, and underscores.

utm_term

string

Identifies paid search keywords or targeting terms. Use only letters, numbers, hyphens, and underscores.

utm_content

string

Differentiates similar links or placements on the same page. Use only letters, numbers, hyphens, and underscores.

gdprApplies

boolean

Indicates whether GDPR applies to the user. If omitted, Sovrn determines whether GDPR applies based on the user's IP address.

gdprConsent

string

Raw GDPR consent string for the user, when applicable.

ccpaConsent

string

Raw CCPA consent string for the user, when applicable.

gppConsent

string

Raw GPP consent string for the user, when applicable.

Responses

400

Bad Request — one or more required fields are missing or malformed.

401

Unauthorized — the provided key is not a valid Commerce API Key.

500

Internal Server Error.

200Success — bid response returned.