v1

latestOpenAPI 3.1.02026-07-24173271.4 KB

Link check API

Get information on whether a specific URL can be monetized

get/link/

Query parameters

outstring required

The URL to be tested for monetization

keystring required

Commerce Api Key. This is found by logging into your account at https://commerce.sovrn.com and navigating to Sites. The API key field for the domain you wish to use should be entered here.

optimizeboolean

Option on if the link can be optimized

formatstring

We should always use json

geostring

Country code that can be passed in for affiliation testing

fbustring

Fallback url to go if out url can't beat the bid floor

bfstring

Bid floor for the fallback url

Response

200

urlstring

optimizedstring

affiliatableboolean

{"stackTrail":"paths:/link/:get:responses:200:content:application/json:schema:properties:competitive","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/link/:get:responses:200:content:application/json:schema:properties:optimizable","oasType":"schema","type":"unknown"}

eepcnumber

Example response

{
  "url": "https://www.walmart.com/ip/105218827",
  "optimized": "https://redirect.viglink.com?key={YOUR API KEY&u=https%3A%2F%2Fwww.walmart.com%2Fip%2F105218827&prodOvrd=RAL",
  "eepc": 0.0702
}