List of broken links
Parameters
|
HTTP method |
Access rights |
URL |
Parameters |
Note |
|---|---|---|---|---|
| GET | broken_links | https://api.admitad.com/broken_links/ |
|
Returns a list of broken links.* |
| GET | broken_links | https://api.admitad.com/broken_links/{id}/ |
Returns information about a broken link, where id is the link identifier.* |
-
* Returns the result in the JSON format.
-
** Sets skipping and the number of records returned. For example limit=5&offset=2.
-
*** Filter by publisher’s ad spaces. For example, &website=12, where the value is the ad space identifier.
-
**** Filter by affiliate programs. For example, &campaign=6, where the value is the program identifier.
-
***** Filter by string occurrence in the referral or the click link &search=test.io
-
****** Filter by error reason &reason=0, where the value is the error reason identifier. (0 - Program suspended 1 - You are not cooperating with the program 2 - Banner deleted)
- start_date
- end_date
Example of use
Example of a request with utility ``curl``
curl -L -H 'Authorization: Bearer access_token' -X GET https://api.admitad.com/broken_links/?limit=2
curl -L -H 'Authorization: Bearer access_token' -X https://api.admitad.com/broken_links/3/
Example of the response from the API server in the JSON format
{
"_meta": {
"count": 3,
"limit": 2,
"offset": 0
},
"results": [
{
"campaign": {
"id": 6,
"name": "AdvCamp 1"
},
"click_link": "http://ad.admitad.com/g/395b832b8259505879f5234642e5a7/?ulp=http%3A%2F%2Fsuvcar.ru%2F",
"clicks": 1,
"datetime": "2015-10-26T12:34:55",
"err_reason": 2,
"id": 20,
"ref_link": "https://www.google.by/?gfe_rd=cr&ei=GfQtVoaSAqKF8QeN_rv4Ag",
"website": {
"id": 22,
"name": "site1_of_webmaster1"
}
},
{
"campaign": {
"id": 6,
"name": "AdvCamp 1"
},
"click_link": "http://ad.admitad.com/g/295b832b8259505879f5234642e5a7/?ulp=http%3A%2F%2Fsuvcar.ru%2F",
"clicks": 1,
"datetime": "2015-10-26T12:34:40",
"err_reason": 2,
"id": 19,
"ref_link": "https://www.google.by/?gfe_rd=cr&ei=GfQtVoaSAqKF8QeN_rv4Ag",
"website": {
"id": 22,
"name": "site1_of_webmaster1"
}
}
]
}
Description of API server response fields
| Name | Description |
| id | Broken link ID |
| website | The ad space that a non-working link belongs to |
| campaign | The program that a non-working link belongs to |
| clicks | Number of clicks on the non-working link |
| err_reason | Error reason (0 — Program suspended, 1 — You are not cooperating with the program, 2 — Banner deleted) |
| click_link | The link used by the visitor |
| ref_link | The link to the page from which the user used a broken link |
| datetime | Date and time of the last visit |
Fixing broken links
Parameters
|
HTTP method |
Access rights |
URL |
Parameters |
Note |
|---|---|---|---|---|
| POST | manage_broken_links | https://api.admitad.com/broken_links/resolve/ |
|
|
-
* Returns a list of identifiers of broken links marked as resolved, in JSON format.
-
- ** identifier of the broken link that needs to be marked as solved
-
&link_id=12, where the value is the broken link identifier.
Example of use
Example of a request with utility ``curl``
curl -L -H 'Authorization: Bearer access_token' -X POST https://api.admitad.com/broken_links/resolve/ -d 'link_id=19&link_id=20'
Example of the response from the API server in the JSON format
{
"marked_as_resolved": [
20,
19
]
}