{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/link","auth":"required","settings":"56f32a60a0de870e003b6e34","results":{"codes":[{"name":"","code":"{\n    \"url\": \"https://www.walmart.com/ip/105218827\",\n    \"optimized\": \"https://redirect.viglink.com?key={YOUR API KEY&u=https%3A%2F%2Fwww.walmart.com%2Fip%2F105218827&prodOvrd=RAL\",\n    \"affiliatable\": false,\n    \"competitive\": null,\n    \"optimizable\": null,\n    \"eepc\": 0.0702\n}","language":"json","status":200},{"name":"","code":"{\n    \"status\": 400,\n    \"message\": \"Parameter 'key' is required.\",\n    \"error\": \"Bad Request\",\n    \"exception\": \"com.viglink.common.exception.ValidationException\",\n    \"timestamp\": 1608665790151\n}","language":"json","status":400}]},"params":[{"name":"out","type":"string","default":"null","desc":"Outgoing url or domain that will be tested","required":true,"in":"query","ref":"","_id":"5fe2453b5a33dd00387e1df4"},{"name":"key","type":"string","default":"null","desc":"Viglink Api Key","required":true,"in":"query","ref":"","_id":"5fe2453b5a33dd00387e1df3"},{"name":"optimize","type":"boolean","default":"true","desc":"Option on if the link can be optimized","required":false,"in":"query","ref":"","_id":"5fe2453b5a33dd00387e1df2"},{"name":"format","type":"string","default":"","desc":"We should always use `json`","required":false,"in":"query","ref":"","_id":"5fe2443b7a7d1e006c924cb7"},{"name":"geo","type":"string","default":"null","desc":"Country code that can be passed in for affiliation testing","required":false,"in":"query","ref":"","_id":"5fe26b6d9dcf2d0039f2f635"},{"name":"fbu","type":"string","default":"null","desc":"Fallback url to go if out url can't beat the bid floor","required":false,"in":"query","ref":"","_id":"606dfbd85aff3f002343c7c9"},{"name":"bf","type":"string","default":"null","desc":"Bid floor for the fallback url","required":false,"in":"query","ref":"","_id":"606dfbd85aff3f002343c7ca"}],"examples":{"codes":[{"code":"<?php\n$ch = curl_init(\"http://api.viglink.com/api/link?out=https://www.walmart.com/ip/105218827&key={YOUR API KEY}\");\n\ncurl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);\n\n$response = curl_exec($ch);\n\ncurl_close($ch);","language":"php"},{"code":"curl -i -X GET 'http://api.viglink.com/api/link?format=json&out=https://www.walmart.com/ip/105218827&key={YOUR API KEY}'","language":"curl"}]},"method":"get"},"next":{"description":"","pages":[]},"title":"Link Monetization","type":"endpoint","slug":"link","excerpt":"Get information on whether a specific URL can be monetized","body":"[block:api-header]\n{\n  \"title\": \"Response:\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"url\",\n    \"1-0\": \"optimized\",\n    \"2-0\": \"affiliatable\",\n    \"3-0\": \"competitive\",\n    \"4-0\": \"eepc\",\n    \"h-0\": \"field\",\n    \"h-1\": \"description\",\n    \"0-1\": \"The original url specified in the API request\",\n    \"1-1\": \"the redirect link generated from the original url\",\n    \"2-1\": \"this will be true if the link is able to be affiliated, or false if it is not\",\n    \"3-1\": \"this will be true if the link is able to be auction, or false if it is not\",\n    \"4-1\": \"the expected Earnings Per Click\"\n  },\n  \"cols\": 2,\n  \"rows\": 5\n}\n[/block]","updates":[],"order":999,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5fe24258385105003aab13f0","createdAt":"2020-12-22T19:00:40.249Z","user":"568af6d197d8960d0012ab7d","category":{"sync":{"isSync":false,"url":""},"pages":["56d9d483aa96cc150020eb35"],"title":"Monetized URLs","slug":"monetized-urls","order":2,"from_sync":false,"reference":false,"_id":"56d9d4287222d50b0070160b","__v":1,"version":"568af725176a6c0d00a29ec7","createdAt":"2016-03-04T18:30:00.578Z","project":"568af724176a6c0d00a29ec4"},"version":{"version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["568af725176a6c0d00a29ec8","56d9d397337fd11300d6a3e3","56d9d4287222d50b0070160b","56f424307ea0091700f63ac5","56f45babcb0dce29005a8e85","5739e5836c5ba134007a197d","57717aee3dd24019004c9122","5771b5d8c755ca0e00617d7d","579639964913990e001a5911","57e57e7df3d7fc0e009c5119","587569b6f4483a0f00d2e6b8","5ca3c2274439e800149daf96","5fd7d79553f64b005e2de7c3","5fe2422ee0a887014f44a422"],"_id":"568af725176a6c0d00a29ec7","project":"568af724176a6c0d00a29ec4","releaseDate":"2016-01-04T22:50:13.289Z","__v":14,"createdAt":"2016-01-04T22:50:13.289Z"},"project":"568af724176a6c0d00a29ec4","__v":23,"parentDoc":null}

getLink Monetization

Get information on whether a specific URL can be monetized

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

out:
required
stringnull
Outgoing url or domain that will be tested
key:
required
stringnull
Viglink Api Key
optimize:
booleantrue
Option on if the link can be optimized
format:
string
We should always use `json`
geo:
stringnull
Country code that can be passed in for affiliation testing
fbu:
stringnull
Fallback url to go if out url can't beat the bid floor
bf:
stringnull
Bid floor for the fallback url

Examples


Result Format


Documentation

[block:api-header] { "title": "Response:" } [/block] [block:parameters] { "data": { "0-0": "url", "1-0": "optimized", "2-0": "affiliatable", "3-0": "competitive", "4-0": "eepc", "h-0": "field", "h-1": "description", "0-1": "The original url specified in the API request", "1-1": "the redirect link generated from the original url", "2-1": "this will be true if the link is able to be affiliated, or false if it is not", "3-1": "this will be true if the link is able to be auction, or false if it is not", "4-1": "the expected Earnings Per Click" }, "cols": 2, "rows": 5 } [/block]

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}