Definition
The getCampaignLinks API Command extracts backlinks from a selected campaign.
Cost
Using this command consumes 1 credit for each extracted backlink
Module
The command is included in the Campaign API Module and will only consume credits assigned for Campaign API Operations.
Parameters
| campaignId | The ID number of the existing campaign. |
| siteId | The ID number of the site. |
| limit | (optional) Limits the extracted links. |
Input URL Example
http://api.cognitiveseo.com/command.php?apiKey=your_api_key&command=getCampaignLinks&campaignId=8&siteId=1&limit=50
Output Example
Running this command will result in the following JSON output:
{
"api": "cognitiveSEO API",
"data": {
"status": "success",
"data": {
"1": {
"fromUrl": "http:\/\/websiteexample.com\/blog",
"toUrl": "http:\/\/www.cognitiveseo.com",
"fromUrlSubdomain": "websiteexample.coom",
"fromUrlDomain": "websiteexample.com",
"toUrlSubdomain": "www.cognitiveseo.com",
"toUrlDomain": "cognitiveseo.com",
"fromUrlRedirect": null,
"fromUrlHttpCode": "200",
"fromUrlPagesize": "18679",
"fromUrlHtmlTitle": "Blog - Seo Services Company in India",
"fromUrlWebpageType": "blog",
"fromUrlWebpageCategory": "tech",
"fromUrlWebpageLanguage": "english",
"fromUrlCitationFlow": "21",
"fromUrlTrustFlow": "0",
"fromUrlDeeplink": "yes",
"toUrlDeeplink": "no",
"fromUrlLinkAuthority": "lowAuthority",
"fromUrlOutboundlinksInternal": "14",
"fromUrlOutboundlinksExternal": "131",
"fromUrlOutboundlinksInternalDofollow": "14",
"fromUrlOutboundlinksInternalNofollow": "0",
"fromUrlOutboundlinksExternalDofollow": "131",
"fromUrlOutboundlinksExternalNofollow": "0",
"fromUrlBacklinks": "0",
"fromUrlNumberOfReferringDomains": "16",
"fromDomainTld": ".co.in",
"fromDomainCitationFlow": "16",
"fromDomainTrustFlow": "1",
"fromDomainAuthority": "lowAuthority",
"fromDomainHostingCountry": "US",
"fromDomainIp": "173.201.243.128",
"importedLink": "no",
"status": "live",
"linkType": "text",
"anchorText": "CognitiveSEO",
"anchorTextType": "brand",
"imageAlt": "",
"linkTitle": "",
"linkTarget": "_self",
"linkNofollow": "no",
"linkInContent": "yes",
"linkInListOfLinks": null,
"linkPositioning": "blogPostForumThread",
"linkVisibility": "body",
"isSitewide": "no",
"linkIgnored": "no",
"linkDissavowed": "no",
"linkNaturalness": null,
"tags": "tag1|tag2",
"cognitiveseoDate": "2015-01-19"
}
},
"credits": 1
},
"time": 0.951
}
Output Details
| status | The status of the command (success or error). |
| fromUrl | The backlink’s URL. |
| toUrl | The targeted website’s URL. |
| fromUrlSubdomain | The backlink’s subdomain. |
| fromUrlDomain | The backlink’s domain. |
| toUrlSubdomain | The targeted website’s subdomain. |
| toUrlDomain | The targeted website’s domain. |
| fromUrlRedirect | Displays if there is a redirect. |
| fromUrlHttpCode | The HTTP status code. |
| fromUrlPagesize | The size of the page in pixels. |
| fromUrlHtmlTitle | Title of the Page. |
| fromUrlWebpagetype | The type of the website
Values: “generic” “socialNetwork” “searchEngine” “portal”, “pressRelease”, “newsSite”, “blog”, “forum”, “wiki”, “ecommerce”, “webDirectory”, “articleDirectory”, “parkedDomain”, “adult”, “gambling”, “warez”, “gov”, “university”, “personalSite”, “corporate” |
| fromUrlWebpageCategory | The Category of the website
Values: “generic” “art” “auto” “business” “careers” “culture” “edu” “fashion” “food” “games” “garden” “health” “hobbies” “home” “pets” “recreation” “relations” “sports” “tech” “travel” “gambling” “warez” “adult” “gov” |
| fromUrlWebpageLanguage | The website’s language Values: “english” “french” “german” “dutch” “italian” “spanish” “swedish” “romanian” “portuguesse” “polish” |
| fromUrlCitationFlow | Majestic Metric |
| fromUrlTrustFlow | Majestic Metric |
| fromUrlDeeplink | Shows if the Backlink is from the homepage or deeper in the website.(Values yes or no) |
| toUrlDeeplink | Shows if the Backlink is pointing to a homepage or a deeper page in the website. (Values yes or no) |
| fromUrlLinkAuthority | The Authority of the Link (CognitiveSEO metric). |
| fromUrlOutboundlinksInternal | Number of internal outbound links from the website. |
| fromUrlOutboundlinksExternal | Number of external outbound links from the website. |
| fromUrlOutboundlinksInternalDofollow | Number of internal outbound links that are Dofollow. |
| fromUrlOutboundlinksInternalNofollow | Number of internal outbound links that are Nofollow. |
| fromUrlOutboundlinksExternalDofollow | Number of external outbound links that are Dofollow. |
| fromUrlOutboundlinksExternalNofollow | Number of external outbound links that are Nofollow. |
| fromUrlBacklinks | Number of URL`s coming from the backlink. |
| fromUrlNumberOfReferringDomains | Number of Referring domains of the URL coming from the backlink. |
| fromDomainTld | The Top Level Domain. |
| fromDomainCitationFlow | Number of referring domains for the URL. |
| fromDomainTrustFlow | Majestic Metric. |
| fromDomainAuthority | The Domain’s Authority (CognitiveSEO Metric). |
| fromDomainHostingCountry | The Hosting Country. |
| fromDomainIp | The Backlink’s domain IP. |
| importedLink | Shows if the link was imported. (Values yes or no) |
| status | The status of the link. (Values live or lost) |
| linkType | The type of the link (Values: text, image, redirect or null if the link is lost) |
| anchorText | The text of the anchor. |
| anchorTextType | The type of text (brand, commercial or misc). |
| imageAlt | Alt of the Image Link. |
| linkTitle | The href title tag of the image. |
| linkTarget | Href Target Tag (Values: frame, _blank, _self, _parent, _top) |
| linkNofollow | If the link is nofollow. (Values yes or no) |
| linkInContent | If the link is found in content.(Values yes or no) |
| linkInListOfLinks | If the link is found in a list of links.(Values yes or no) |
| linkPositioning | The Position of the link:
Values: “other” “groupOfLinks” “blogroll” “videoWidget” “image” “banner” “copyrightParagraph” “blogPostForumThread” “blogComment” “blogComment” “forumSignature” “article” “shortParagraph” “authorSignature” |
| linkVisibility | The page position of the link
Values: “aboveTheFold” “body” “sidebar” “footer” “dynamic” “hidden” |
| isSitewide | If the link is sitewide.(Values yes or no) |
| linkIgnored | If the link is ignored. Values: link – ignored at a link level; domain – ignored at a domain level; no – link is not ignored. |
| linkDissavowed | If the link is disavowed. Values: link – disavowedat a link level; domain – disavowedat a domain level; no – link is not disavowed. |
| linkNaturalness | The health of the link: unnatural – link is unnatural; ok – link is ok; suspect – link could be seen as unnatural. |
| tags | Displays the tags for each link. |
| cognitiveseoDate | Date when the link entered CognitiveSEO. |
| credits | The credit cost of the command. |
| time | The time it took for the command to take place. |