Seobility API Documentation


1. Introduction

1.1 Overview

The Seobility SEO API provides access to the Seobility SEO software technology for crawling and SEO analysis of websites. It gives valuable insight into site health and search engine optimization, as well as easy troubleshooting for an entire website.

The functionality of the API allows management of numerous projects with individual crawling settings and the retrieval of in-deep results for different use cases. Use the API to:

  • integrate a Site Auditor into your existing SEO software
  • enhance your CMS or WebHosting Solution with a Site Auditor
  • provide technical SEO insights in reports and dashboards
  • monitor hundreds or thousands of projects
  • create or enhance any individual service

For easy integration of the technology into your individual environment, the API is built as RESTful service and provides JSON-format data.

1.2 API Types: Difference between Site Audit and Single Page Check

Site Audit API

Difference between Site Audit and Single Page Check

This component of the SEO API is built for the analysis of whole websites and allows a project based use of the API. Manage projects with unique IDs and perform aggregated analyses or single URL queries in the context of a whole website. The API covers creation, administration and data retrieval for projects. As such the Site Audit API serves as "Site Audit as a Service".

Single Page Check API

The Single Page Check is another part of the SEO API. It provides the SEO Check and the Keyword Check as both consider only one specific URL for the performed analysis. Use this part of the API either to complement the Site Audit API, or to perform (isolated) single page analyses.

1.3 How to get started

Start working with the SEO API within minutes by using the following PHP code snippet. Simply define your API key and an example domain you wish to crawl and analyze.


<?php
require '../Api.php';

$APIKEY YOURAPIKEY;
$api = new \Seobility\Reseller\Api($APIKEY);

$exampleUrl 'https://www.example.com'//No urlencode() needed
/*
 * Add a new project and start a crawling with the given URL 
 * and 200 ms wait time between page crawls, 
 * one crawler at a time and a limit of 50 crawled URLs. 
 * $id contains the identifier for the added project 
 */
$id $api->addProject($exampleUrl200150);
echo 
'Added Project ID: ' $id PHP_EOL;
echo 
'Waiting for system to start data fetching.' PHP_EOL;

sleep(9);

do {
    
sleep(2);
    
//Request the status data of the crawling to monitor its progress
    
$statusData $api->getProjectStatus($id);
    echo 
'Done Crawls: ' $statusData['donecrawls'] . ' (' $statusData['percent'] . '%) ';

    if (
$statusData['percent'] > 99) {
        echo 
'System ist calculating results';
    }
    echo 
PHP_EOL;
} while (
$statusData['done'] !== true);

echo 
'Crawling Done. Crawled relevant URLs:' PHP_EOL;

//Crawling is finished, fetch a list of all relevant URLs of this crawl
$relevantURLs $api->getProjectResultListData($id'relevantcrawls');
$i 0;
foreach (
$relevantURLs['data'] as $row) {
    
$i++;
    echo 
'#' $i ' ' $row['crawl'] . PHP_EOL;
}

echo 
PHP_EOL;

1.4 Storage of data

We store the Site Audit data for 30 days after the completion of a crawling.

1.5 API credit system

The credit system of the API is based on the metric "crawled URLs".

In all cases concerning the crawling of an entire website, one crawled URL equals one API credit. If the cost of a request is higher than one API credit, it is documented accordingly for each method.

Credit packages are available on a monthly basis. For more information and a price quote based on your individual needs, please contact us here.

1.6 Support

The support for the API is available in English and German.

For technical questions regarding the Seobility SEO API please contact . We also offer direct Dev-to-Dev support to assist you with the implementation of the API in your environment.

For more general questions on the Seobility SEO API or if you would like to receive a price quote based on your individual needs, please contact us here.

2. Site Audit API

2.1 Project Management

2.1.1 Add a new project

addproject - Adds a new domain to be crawled and analyzed. As soon as the project has been added, the crawling starts. Make sure to save the returned project ID as you will need it for other API calls.

Credits: 1 Credit per crawled URL

Example Call:


Request Parameters:

FieldTypeMandatoryExplanation
url string yes Starting URL for the crawling [Required]
waittime int no Delay between each request, in milliseconds [Default: 200ms]
crawleramount int no Amount of crawlers working at the same time (1-5) [Default: 1]
maxcrawls int no Maximum amount of URLs to crawl (10-100,000) [Default: 25,000]
subdomains bool no Specify if subdomains should be crawled (0=No Subdomains [Default], 1= Subdomains)
robotstxt string no Provide a custom Robots.txt for the crawler. If you do so, the normal Robots.txt will be ignored (Please make sure user own the domain).
acceptlanguage string no HTTP Accept-Language parameter passed by the crawler [Default: 'en,de']
httpuser string no HTTP Auth user, if Basic Authentication needed (Requires httppw to be provided as well)
httppw string no HTTP Auth password
ignorenofollow int no Sets behaviour for rel=nofollow links (0=Treat nofollow normal [Default], 1= Ignore internal nofollow links, 2=Ignore external nofollow links, 3=Ignore all nofollow links)
sitemapsfromrobots int no Determines if sitemap.xml URL is parsed from the URL given in the robots.txt (0=Ignore sitemap.xml [Default], 1=Search for sitemap.xml)
sitemapsfromrobots_url string no Enforce crawling a sitemap URL from a specific URL. Must be on the same domain as the URL
maxexternalcrawls int no Maximum external URLs crawled (Default: 5000)

Response Parameters (JSON):

Field Type Explanation
success string This parameter gets returned when the action was successful
projectid int ID of the project that has been added

2.1.2 Delete a project

deleteproject - Deletes a project and all associated data.

Credits: 0

Example Call:


Request Parameters:

FieldTypeMandatoryExplanation
id int yes The ID of the project to delete

Response Parameters (JSON):

Field Type Explanation
success string This parameter gets returned when the action was successful

2.1.3 Status of the project

getprojectstatus - Returns crawling status information during the crawling of a project. This information has no use after the crawling has been completed.

Credits: 0

Example Call:


Request Parameters:

FieldTypeMandatoryExplanation
id int yes The ID of the project you want to receive a status of

Response Parameters (JSON):

Field Type Explanation
- array Various kinds of information about the crawling status:

Parameter Type Description
donecrawls string Amount of URLs that have been crawled
relevantcrawls string Amount of relevant URLs that have been crawled
percent int Crawling progress percentage
latestcrawls array Information about the 10 latest crawls. Contains arrays with the parameters "url" (string) and "crawldate" (string)
done bool Whether the crawling has been finished
completefailure bool Whether the crawling has failed
completefailurereason string Reason why crawling has failed (see table below)
completefailurecode int Error code (see table below)
stopped bool Whether crawling has stopped

Possible Failures:

Code Reason
1 A fatal error occurred while crawling your website.
2 The page returns data that cannot be checked by Seobility.
3 This page is restricted by robots.txt for bots. Seobility can't access this page.
4 We could not retrieve the page. (Timeout)
5 The provided URL redirects to another domain or a sub domain. Please provide the final URL to add a new project.
6 The first page doesn't return a HTTP 200 status code.
7 Seobility received a "Too Many Requests" HTTP status code from the server and therefore canceled the crawling.
8 The domain name was not found.

2.1.4 Stop a project

stopproject - Cancels the crawling of a project

Credits: 0

Example Call:


Request Parameters:

FieldTypeMandatoryExplanation
id int yes The ID of the project, of which you want to cancel the crawling process

2.2 Checks and analyses (list queries)

In this section the checks and analyses of the Site Audit are documented. The queries return lists and there are three different types of lists:

  • Information lists provide neutral informations on a project (mostly statistics). The information is insightful but not necessarily actionable, as no concerning URLs are provided with the data. Instead, the core metric coming with the information is its frequency.
    Example: httpstatuscodeoverview provides an overview on the frequency of different status codes of the project (information).
  • Result lists provide results of performed analyses. The results point to errors or optimization potential of the project. The information is both insightful and actionable, as corresponding URLs are provided with the results.
    Example: technicalproblematic provides all URLs that could not be checked due a technical problem, together with the corresponding problem.
  • Sublists provide URLs which are concerned by a specific parameter. The information is potentially insightful but mostly actionable.
    Example: After httpstatuscodeoverview provided the information that the statuscode 404 occurs 20 times, you can request a sublist of all URLs with the statuscode 404.

2.2.1 Information lists

getprojectinformationlists - Returns all available information lists for a project. See checksandanalyses for a description of information lists.

Credits: 0

Example Call:


Request Parameters:

FieldTypeMandatoryExplanation
id int yes The ID of the project you want to receive the information lists for

Response Parameters (JSON):

Field Type Explanation
- array List of all information lists that are available for this project.

2.2.2 Information list data

getprojectinformationlistdata - Returns the data of a specific information list.

Credits: 0

Example Call:


Request Parameters:

FieldTypeMandatoryExplanation
id int yes The ID of the target project
list string yes Full name of the list to query (see getProjectInformationLists())

Response Parameters (JSON):

Field Type Explanation
- array Data of the specific infolist

Information Lists

2.2.2.1 Most common keywords

competedkeywords - Returns the most common keywords of the crawled project, as well as the number of pages they can be found on.

SEO relevance: the more often a keyword occurs on a website, the more likely the website ranks for the keyword or it is the intention to do so. The information is also of relevance, if a keyword does not occur often on a website but it is the intention to rank for the keyword.

Example Call:

Response Parameters (JSON):

Field Type Explanation
word string The keyword
count string Number of pages the keyword was found on

2.2.2.2 Click distance to homepage

distancestats - Returns the number of pages residing on each page level with distance x to the homepage. Each level oin which pages are found is returned.

SEO relevance: a website’s structure should be rather flat. Deeper page levels are increasingly SEO problematic. See analysis “distancehigh”.

Example Call:

Response Parameters (JSON):

Field Type Explanation
1 string number of pages on page level 1
2 string number of pages on page level 2
3 string number of pages on page level 3
... and so on

2.2.2.3 Number of pages for status codes other than code 200

httpstatuscodeoverview - Returns HTTP status codes other than 200 and their count.

SEO relevance: some HTTP status codes can be highly problematic for SEO, especially 4xx and 5xx.

Example Call:

Response Parameters (JSON):

Field Type Explanation
count string Number of pages found
httpstatus string The HTTP status codes of the pages, e.g. 301, 404 etc.

2.2.2.4 Most frequent link anchor texts

linktextstats - Returns the most frequent link (anchor) anchor texts found throughout the website.

SEO relevance: link texts are important for users and search engine bots to evaluate the links and the content they lead to. Link texts should be descriptive, authentic and stringent (links referring to the same content should have similar or identical texts).

Example Call:

Response Parameters (JSON):

Field Type Explanation
data array List of the most frequent link achors found on the website

2.2.2.5 Page response times

performancestats - Returns the distribution of response times of pages, grouped in steps of 1/10th seconds.

SEO relevance: the response time of a page influences how fast a user is able to navigate, access information or perform transactions. It impacts user experience and by that important metrics such as bounce rate, time on site, conversion rate etc.. Site speed is also an official Google ranking factor.

Example Call:

Response Parameters (JSON):

Field Type Explanation
0 string Amount of pages to respond in 0>0.1 seconds
0.1 string Amount of pages to respond in 0.1>0.2 seconds
0.2 string Amount of pages to respond in 0.2>0.3 seconds
etc.


2.2.3 Result lists

getprojectresults - Returns all the crawling overview data. This can be called while crawling, but will only display the current progress. Some information may only be available after the crawling has been completed. See checksandanalyses for a description of information lists.

Credits: 0

Example Call:


Request Parameters:

FieldTypeMandatoryExplanation
id int yes The ID of the project you want to receive the crawling results

Response Parameters (JSON):

Field Type Explanation
- array List of all analytics and the amount of points found for each category.
The array returned contains the count of URLs with the issue and the impact.
e.g.: "donecrawls" => [count => 50, impact => 0]
Impact defines how badly an issue with the particular analysis impacts the seo negatively. An impact of 0 defines a neutral value, so the count has no seo impact. A high impact defines a big issue and should be fixes immediatly
If you want to get the list of all the data for a specific string (e.g. for "donecrawls"), you can use the getProjectResultListData() function and provide this string as the list parameter. (In our example this will return the list of all crawled URLs)

2.2.4 Result list data

getprojectresultlistdata - Returns the detailed data for a specific analysis (result list), e.g. all the URLs with bad meta titles. Please note that the data returned may vary a lot between different projects.

Credits: 0

Example Call:


Request Parameters:

FieldTypeMandatoryExplanation
id int yes The ID of the target project
list string yes Full name of the list to query (see getProjectResults())
limit int no Maximum amount of rows returned
page int no Page for pagination, pagesize equals "limit"

Response Parameters (JSON):

Field Type Explanation
- array Detailed data of the requested analysis

Project Result Lists

2.2.4.1 Crawling statistics


2.2.4.1.1 Pages crawled

donecrawls - Returns a list of all pages the Seobility crawler found and crawled on the website. This list includes pages that were successfully crawled as well as pages that produced errors when they were crawled. It does not include the pages blocked by robots.txt. It also does not include pages that were found but not crawled due to the “maxcrawls” limit.

Example Call:

Response Parameters (JSON):

Field Type Explanation
crawl string Page URL

2.2.4.1.2 Pages checked

relevantcrawls - Returns a list of all pages that Seobility crawled and found relevant for a more detailed technical and content analysis. Pages that redirect, use a canonical link to another page, disallow being indexed by search engines or produce errors (404 Not found, timeout, etc.) are not in this list.

Example Call:

Response Parameters (JSON):

Field Type Explanation
crawl string Page URL

2.2.4.1.3 Uncheckable pages

nonrelevantcrawls - Returns a list of all pages that Seobility crawled but found not relevant for further technical or content analysis. It includes pages which redirect, use a canonical link to another page, disallow being indexed by search engines or contain an error (404 Not found, timeout, etc.). It does not include pages blocked by robots.txt.

Example Call:

Response Parameters (JSON):

Field Type Explanation
crawl string Page URL
error string Reason of irrelevance

Possible Reasons:

  • HTTP status
  • Bad HTTP status code
  • Unkown error (Robot)
  • Uncheckable data type
  • Restricted by robots.txt
  • Timeout
  • Filesize too big
  • SSL/TLS error
  • Request failed
  • Invalid URL scheme
  • No HTML markup found
  • Noindex
  • No HTML page
  • Internal HTTP redirect
  • Internal canonical link
  • Extern HTTP redirect
  • External canonical link

2.2.4.1.4 Pages detected

foundinternalurls - Returns a list of all pages found by the Seobility crawler, regardless of whether they were crawled or not. This can be a complete list with all pages of a website, e.g. when sitemaps provide a complete list of URLs of a website and a website is not too big. It can also be an incomplete list, e.g. if sitemaps are incomplete and the crawler stops discovering new pages due to the “maxcrawls” limit.

Example Call:

Response Parameters (JSON):

Field Type Explanation
crawl string Page URL

2.2.4.1.5 Pages blocked by robots.txt

robotsblocked - Returns a list of all pages that are linked internally on the website (and as such found by the crawler) but, due to restrictions in the robots.txt file, are not allowed to be crawled or indexed by search engine bots.

Example Call:

Response Parameters (JSON):

Field Type Explanation
crawl string Page URL

2.2.4.1.6 Uncheckable data types

badcontenttype - Returns a list of URLs which return a content type that is is not checkable by our crawler, e.g. image, PDF, etc.

Example Call:

Response Parameters (JSON):

Field Type Explanation
crawl string Page URL
contenttype string Type of uncheckable content (e.g. image/png, application/octet-stream, application/pdf)

2.2.4.1.7 Found external Links

foundexternalurls - Returns a list of all found URLs that the crawled website links to (external links).

Example Call:

Response Parameters (JSON):

Field Type Explanation
link string Link to external site

2.2.4.1.8 Nofollow pages

nofollow - Returns a list of nofollow pages. Nofollow pages instruct search engine bots to not follow any internal or external links on these pages.

Example Call:

Response Parameters (JSON):

Field Type Explanation
crawl string Page URL

2.2.4.1.9 Pages with technical problems

technicalproblematic - Returns a list of pages that could not be checked due to technical problems of the pages.

Example Call:

Response Parameters (JSON):

Field Type Explanation
crawl string Page URL
statuscode string The HTTP status code of the crawled URL
error string The type of error

Possible Error Types:

  • HTTP status
  • Unkown error (Robot)
  • Uncheckable data type
  • Restricted by robots.txt
  • Timeout
  • Filesize too big
  • SSL/TLS error
  • Request failed
  • Invalid URL scheme
  • No HTML markup found

2.2.4.2 Meta tags and page attributes


2.2.4.2.1 Pages with problematic page titles

titlebad - Returns a list of pages with missing or problematic page titles.

Example Call:

Response Parameters (JSON):

Field Type Explanation
crawl string Page URL
message Array The issue concerning the title
message_raw array The issues codes (Same as message)
title string The title itself
length_real string Title length in pixel as displayed by Google
length_min string Minimum title length in pixel
length_max string Maximum title length in pixel

Possible Messages:

MessageExplanation
emptyThe title of the page is empty or not set
missingThe title tag is missing
shortThe title is too short
onlyonewordThe page title consists of only one word
genericwordThe title contains unnecessary words, e.g. 'Welcome to this website' etc.
domaintitleThe domain is used in the page's title
wordrepeatsThere are word repetitions in the title tag, e.g. websitename - lorem ipsum - websitename
longThe title is too long

2.2.4.2.2 Problems with meta descriptions

descriptionbad - Returns a list of pages with missing or bad meta descriptions.

Example Call:

Response Parameters (JSON):

Field Type Explanation
crawl string Page URL
message string The issue concerning the description
message_raw array The issues codes (Same as message)
description string The meta description itself
length_real string Description length in pixel as displayed by Google
length_min string Minimum description length in pixel
length_max string Maximum description length in pixel

Possible Messages:

MessageExplanation
missingThe meta description is missing
emptyThe meta description is empty
shortThe meta description is too short
onlyonewordThe meta description contains only one word
multipleThere are more than one meta descriptions on the page; only one is allowed
longThe meta description is too long

2.2.4.2.3 Duplicate page titles

titledupe - Returns a list of pages with page titles that are identical on several page.

Example Call:

Response Parameters (JSON):

Field Type Explanation
data string The duplicated title itself
urllist array Page URLs

2.2.4.2.4 Duplicate meta descriptions

descriptiondupe - Returns a list of pages with meta descriptions that are identical on several pages.

Example Call:

Response Parameters (JSON):

Field Type Explanation
data string The description itself
urllist array Page URLs

2.2.4.3 Page optimization and guidelines


2.2.4.3.1 Problems with H1 headings

h1problems - Returns a list of pages with problematic H1 headings.

Example Call:

Response Parameters (JSON):

Field Type Explanation
crawl string Page URL
issue Array The issue concerning the h1 heading

Possible Issues:

  • Empty / no text
  • Meaningless word/phrase
  • More than once in H1 heading
  • Missing in h1 heading
  • Missing
  • Only one word
  • Too long
  • Too short
headlinetext string The heading itself
message_raw array The issues codes (Same as issues)

2.2.4.3.2 Problems with headings

headlinestructireissues - Returns a list of pages with problematic headings or problems with the heading structure.

Example Call:

Response Parameters (JSON):

Field Type Explanation
crawl string Page URL
issues Array The issues concerning the headline structure

Possible Issues:

  • Structural problem
  • Duplicate heading
  • Empty heading
  • Keyword used to often in headings
  • Keyword is missing in headings
  • Keyword only once in headings
  • No headings at all
  • Too many headings
message_raw array The issues codes (Same as issues)

2.2.4.3.3 Problems with strong and bold tags

boldtagissues - Returns a list of pages with problems concerning strong and bold tags.

Example Call:

Response Parameters (JSON):

Field Type Explanation
crawl string Page URL
message Array The issues concerning bold and strong tags

Possible Messages:

MessageExplanation
many_tagsThe amount of tags is very high
empty_tagsEmpty tags are present on the site
long_tagsSome tags are too long
dublicated_tagSome tags are repeated too often

2.2.4.3.4 Pages with frames

frameusage - Returns a list of pages with embedded framesets and IFrames.

Example Call:

Response Parameters (JSON):

Field Type Explanation
crawl string Page URL
message string The type of frame used
message_raw array The issues codes (Same as message)

Possible Messages:

MessageExplanation
framesetThe site uses frames; this can cause problems with the crawling and makes linking to the site hard
iframeThe page uses iframes; this could cause crawling problems.

2.2.4.3.5 Pages that contain error reporting

softwareerrors - Returns a list of pages with software error messages that are shown on the page.

Example Call:

Response Parameters (JSON):

Field Type Explanation
crawl string Page URL
message_raw string error message type
message string Error message
errors array The specific error messages (For example PHP Notices)

Possible Messages:

MessageExplanation
ErrormessageThere are PHP errors or warnings on your page

2.2.4.3.6 Images with missing alt attributes

img_altmissing - Returns a list of pages with at least one missing alt attribute for an image.

Example Call:

Response Parameters (JSON):

Field Type Explanation
crawl string Page URL

2.2.4.3.7 Pages with big file size

filesize - Returns a list of pages exceeding a file size of 1 MB.

Example Call:

Response Parameters (JSON):

Field Type Explanation
crawl string Page URL
filesize string File size in KB

2.2.4.3.8 Non HTTPS content on HTTPS pages

httpsissues - Returns a list of HTTPS pages with non HTTPS content.

Example Call:

Response Parameters (JSON):

Field Type Explanation
crawl string Page URL
message string The type of insecure content
message_raw array The issues codes (Same as message)

Possible Messages:

MessageExplanation
media_cssAt least one CSS file was found which is not integrated via HTTPS
media_videosAt least one video file was found which is not integrated via HTTPS
media_imagesAt least one image file was found which is not integrated via HTTPS
media_audiosAt least one audio file was found which is not integrated via HTTPS
media_javascriptAt least one javascript file was found which is not integrated via HTTPS

2.2.4.4 Load times that differ from the average load time


2.2.4.4.1 Fast response time

fastsites - Returns a list of pages loading faster than the average page.

Example Call:

Response Parameters (JSON):

Field Type Explanation
crawl string Page URL
time string Loading time in seconds
diff string The dfference to the average loading time

2.2.4.4.2 Slow response time

slowsites - Returns a list of pages loading slower than the average page.

Example Call:

Response Parameters (JSON):

Field Type Explanation
crawl string Page URL
time string Loading time in seconds
diff string The difference to the average loading time

2.2.4.5 URL details


2.2.4.5.1 URL parameters

url_dynamic_parameters - Returns a list of pages with dynamic parameters in their URL.

Example Call:

Response Parameters (JSON):

Field Type Explanation
crawl string Page URL
anzahl string Amount of parameters

2.2.4.5.2 Session ID in URL

url_dynamic_session - Returns a list of pages with session IDs in their URL.

Example Call:

Response Parameters (JSON):

Field Type Explanation
crawl string Page URL

2.2.4.5.3 Too many subdirectories

url_dynamic_tomanyslashes - Returns a list of pages with too many subdirectories in their URL (4 or more).

Example Call:

Response Parameters (JSON):

Field Type Explanation
crawl string Page URL
slashcount string Amount of subdirectories

2.2.4.5.4 URL too long

url_dynamic_tolong - Returns a list of pages with URLs that are considered too long.

Example Call:

Response Parameters (JSON):

Field Type Explanation
crawl string Page URL
urllength string Length of the URL

2.2.4.5.5 Questionable URLs

url_dynamic_suspicious - Returns a list of pages URLs with questionable content.

Example Call:

Response Parameters (JSON):

Field Type Explanation
crawl string Page URL
message string The issue concerning the URL
message_raw array The issues codes (Same as message)

Possible Messages:

MessageExplanation
linebreakinurlA line break was found in the URL
doubleslashesThe URL contains at least one double slash
trippleslashesThe URL contains at least one triple slash
multiplequestionmarksMore than one ? were found in the URL
invalidpatternIllegal characters were found in the URL
hashtmltagsHTML tags occur in the URL
hostinurlThe domain name appears in the URL path
doubleparamAt least one parameter occurrs multiple times in the URL
paramvaluetolongVery long parameter values were found in the URL
paramtolongVery long parameter keys were found in the URL

2.2.4.6 Problems with anchor texts


badinternallinks - Returns a list of pages with link texts that should be optimized.

Example Call:

Response Parameters (JSON):

Field Type Explanation
crawl string Page URL
message array The issues concerning the internal link
message_raw array The issues codes (Same as message)

Possible Messages:

MessageExplanation
target_emptylinksThe link anchor is empty
tolongSome internal link anchor texts are too long
target_tiviallinksThe link anchor is trivial
target_tolongThe link anchor text is too long

2.2.4.6.2 Identical anchor text for different pages

inboundlinkcompetition - Returns a list of pages with link anchors that are used for different pages.

Example Call:

Response Parameters (JSON):

Field Type Explanation
anchor string The concerning anchor text
url string Page URL

2.2.4.7 Links


2.2.4.7.1 Pages with a lot of internal links

highlinksite - Returns a list of pages pages with a lot of internal links compared to the average amount of links on pages of the website.

Example Call:

Response Parameters (JSON):

Field Type Explanation
crawl string Page URL
count string Number of links

2.2.4.7.2 Pages with only a few internal links

fewlinksite - Returns a list of pages with only a few internal links compared to the average amount of links on pages of the website.

Example Call:

Response Parameters (JSON):

Field Type Explanation
crawl string Page URL
count string Number of links

2.2.4.7.3 Redirects

redirectsites - Returns a list of pages with internal redirects that have been linked.

Example Call:

Response Parameters (JSON):

Field Type Explanation
crawl string Page URL
link string Linked page

2.2.4.7.4 Redirect loops

redirectloops - Returns a list of pages with redirect loops because of HTTP redirects and canonical links.

Example Call:

Response Parameters (JSON):

Field Type Explanation
crawl string Page URL

2.2.4.7.5 Problems with external Links

externallinkissues - Returns a list of external links that are broken or redirect to another page.

Example Call:

Response Parameters (JSON):

Field Type Explanation
url string Linked page
issue string The issues concerning external linking
inboundlinks Array Pages which link to the external page

2.2.4.7.6 Pages with a big distance to the homepage

distancehigh - Returns a list of pages that can only be reached with 4 or more clicks from the homepage.

Example Call:

Response Parameters (JSON):

Field Type Explanation
crawl string Page URL
distance string Number of clicks to reach the page starting from the homepage

2.2.4.7.7 Canonical link errors

canonicalerror - Returns a list of pages with problematic canonical links.

Example Call:

Response Parameters (JSON):

Field Type Explanation
source string Page URL
target string Linked page
message Array The issues concerning the canonical link

Possible Messages:

MessageExplanation
emptyThe canonical link is empty
multipleThere are multiple canonical links on the page
differentdomainThe canonical link points to a different domain
badtargetThe target of the canonical link is broken

alternatelinks - Returns a list of pages with alternate link problems.

Example Call:

Response Parameters (JSON):

Field Type Explanation
crawl string Page URL
message string The issue concerning the alternate link

Possible Messages:

MessageExplanation
linknotreturnedBacklink on target not found
selflinkmissingThe alternate link to the page itself is missing
selflinkconflictThe alternate link to the page itself is invalid
duplicatelangThe href language is specified more than once in alternate links
duplicatelinksAn URL is specified multiple times in alternate links

2.2.4.8 Text quality


2.2.4.8.1 Pages with only a few paragraphs

text_fewblocks - Returns a list of pages with little text or only few paragraphs, whereas the existence of “proper” paragraphs is checked by a specific algorithm.

Example Call:

Response Parameters (JSON):

Field Type Explanation
crawl string Page URL
textblockcount string Number of paragraphs
wordcount string Number of words

2.2.4.8.2 Pages with very much text

text_long - Returns a list of pages with very much text (more than 4000 words).

Example Call:

Response Parameters (JSON):

Field Type Explanation
crawl string Page URL
wordcount string Number of words

2.2.4.8.3 Pages with little text

text_short - Returns a list of pages with little text (less than 500 words).

Example Call:

Response Parameters (JSON):

Field Type Explanation
crawl string Page URL
wordcount string Number of words

2.2.4.8.4 Pages with duplicate paragraphs

duplicateblock - Returns a list of pages which contain at least one paragraph multiple times.

Example Call:

Response Parameters (JSON):

Field Type Explanation
crawl string Page URL
count string Number of duplicates

2.2.4.8.5 Pages using keywords in page title but not in its body text

text_wordsunused_title - Returns a list of pages using keywords in page title but not in body text.

Example Call:

Response Parameters (JSON):

Field Type Explanation
crawl string Page URL
title string The page title itself
missingwords Array The keywords missing in the title

2.2.4.8.6 Pages using keywords in H1 heading but not in its body text

text_wordsunused_h1 - Returns a list of pages using keywords in H1 heading but not in body text.

Example Call:

Response Parameters (JSON):

Field Type Explanation
crawl string Page URL
h1 string The H1 heading itself
missingwords Array The keywords missing in the main H1

2.2.4.8.7 Pages with typos

text_typo - Returns a list of pages with typos.

Example Call:

Response Parameters (JSON):

Field Type Explanation
crawl string Page URL
typolist string The list of typos with correction

2.2.4.9 Duplicate content


2.2.4.9.1 Pages without text or paragraphs

text_noblocks - Returns a list of pages without text or paragraphs.

Example Call:

Response Parameters (JSON):

Field Type Explanation
crawl string Page URL

2.2.4.9.2 Pages without proper keyword optimization

keywordlesspages - Returns a list of pages which are not optimized for at least one keyword.

Example Call:

Response Parameters (JSON):

Field Type Explanation
crawl string Page URL

2.2.4.9.3 Content that appears on several pages

nooriginalcontent - Returns a list of text elements that identically appear on several pages.

Example Call:

Response Parameters (JSON):

Field Type Explanation
textpreview string The content which appears on several pages
crawl string Page URL

2.2.4.9.4 Duplicate Content

duplicate - Returns a list of pages whose complete content appears on other pages.

Example Call:

Response Parameters (JSON):

Field Type Explanation
crawl string First page URL
url string Second page URL
type string The type of duplicate content

Duplicate Content Types:

  • Duplicate
  • No unique content
  • Included

2.2.4.9.5 Competing pages for the same keywords

competingsites - Returns a list of pages with same keyword optimization. This complex analysis helps to tackle the problem “keyword cannibalization”.

Example Call:

Response Parameters (JSON):

Field Type Explanation
origin string First page URL
target string Second page URL with same keyword optimization
keywords Array Array of keywords

2.2.4.9.6 Complete page duplicates

hashduplicate - Returns a list of pages with the same HTML code and content.

Example Call:

Response Parameters (JSON):

Field Type Explanation
group string Group ID (duplicate pages are grouped and receive an ID)
url string Page URL

2.2.4.10 Correct meta and http status code information


2.2.4.10.1 Incorrect language markup

lang_conflictinghtml - Returns a list of pages with conflicting meta data and HTML attributes for language specification.

Example Call:

Response Parameters (JSON):

Field Type Explanation
crawl string Page URL
message string The issue concerning the language specification

Possible Messages:

MessageExplanation
Conflictinginformation There is different language information within the page markup

2.2.4.10.2 Incorrect charset encoding markup

encodingerror - Returns a list of pages that contain problematic encoding information.

Example Call:

Response Parameters (JSON):

Field Type Explanation
headercontenttype string The encoding set in the header
httpequivcontenttype string The encoding set in httpequiv
metacontenttype string The encoding set in the meta

Possible Messages:

MessageExplanation
noneThe character encoding is not specified
httpequivdifferentThe HTTP encoding in the HTTP header and in the HTML HTTP-Equivalent meta attribute differ
httpequivbrokenThe encoding specified in the HTTP-Equivalent meta element is not correct
missmatchThe specified character encodings are different

2.2.4.10.3 URLs not delivered via gzip

gzipmissing - Returns a list of pages that are not compressed by HTTP compression.

Example Call:

Response Parameters (JSON):

Field Type Explanation
crawl string Page URL


2.2.5 Sublists

getprojectsublists - Returns a list of all available sublists. Sublists are detailed lists revolving around a central parameter. They list all URLs affected by this parameter. See checksandanalyses for a description of information lists.

Credits: 0

Example Call:


Request Parameters:

FieldTypeMandatoryExplanation
id int yes The ID of the project you want to receive the sublists for

Response Parameters (JSON):

Field Type Explanation
- array Lists all the sublists; please see getprojectsublistdata()

2.2.6 Sublist data

getprojectsublistdata - Returns the detailed listing for a sublist. Sublists are detailed lists revolving around a central parameter. They list all URLs affected for a specific by this parameter.

Credits: 0

Example Call:


Request Parameters:

FieldTypeMandatoryExplanation
id int yes The ID of the target project
list string yes Full name of the list to query (see getProjectSublists())
word string yes The central parameter to resolve the list around

Response Parameters (JSON):

Field Type Explanation
- array Data list for specific infolist

Sublists

2.2.6.1 Pages containing a specific keyword

competingkeywords - Returns a list of pages that contain the specified keyword and a keyword score that shows how well the page is optimized for that keyword.

Example Call:

Response Parameters (JSON):

Field Type Explanation
crawl string Page URL
keywordscore string Keyword score (0 - 100)

2.2.6.2 Duplicate meta descriptions

descriptiondupedetail - Returns a list of pages that have the specified, identical meta description.

Example Call:

Response Parameters (JSON):

Field Type Explanation
crawl string URL page

2.2.6.3 Page levels

distancestat - Returns a list of pages that are located on the specified page level.

Example Call:

Response Parameters (JSON):

Field Type Explanation
crawl string URL page

2.2.6.4 HTTP status

httpstatus - Returns a list of URLs and linking pages that return the specified HTTP status code.

Example Call:

Response Parameters (JSON):

Field Type Explanation
crawl string Crawled page
link array All linking pages

2.2.6.5 Most frequent link anchor text

linktextstat - Returns a list of pages containing links with the specified link text.

Example Call:

Response Parameters (JSON):

Field Type Explanation
origin string Page URL
target string Linking pages

2.2.6.6 Media duplicates

mediadupes - In the following list, you can find all page URLs that embed the object/image/ etc. specified. Word parameter is a media URL.

Example Call:

Response Parameters (JSON):

Field Type Explanation
crawl string Page URL

2.2.6.7 Pages that contain the specified paragraph

textblockbyhash - Returns a list of pages that contain the specified paragraph.

Example Call:

Response Parameters (JSON):

Field Type Explanation
crawl string URL page


2.3 Single URL Queries

2.3.1 URL details

getprojecturldetail - Returns all available data on a single URL page in the crawled project.

Credits: 0

Example Call:


Request Parameters:

FieldTypeMandatoryExplanation
id int yes The ID of the project
url string yes URL, that has been crawled in the project

Response Parameters (JSON):

Field Type Explanation
- array The available data of the specified page in the crawled project:

Parameter Type Description
urlstringThe URL for which the data is returned
crawldatestringThe date and time of the crawl (when the data was aquired)
was_crawledboolWhether the page has been crawled or not
meta_titlestringThe meta title of the page
meta_descriptionstringThe meta description of the page
robots_noindexboolWether the "nonidex" tag is set on the page
robots_nofollowboolWether the "nofollow" tag is set on the page
langstringThe detected language of the page
statuscodeintThe returned status code
is_httpredirectboolWether the page redirects to another page via HTTP
is_canonicalboolWether a canonical link to another page is set on the page
is_relevantboolWether the page is "relevant" and therefore advanced checks were run
statsarray
filesizedoubleThe file size of the page
wordcountintThe number of words on the page
loadtimedoubleThe time it took the crawler to download the page
incominglinksintThe number of incoming links
outgoinglinks_internalintThe number of outgoing internal links
outgoinglinks_externalintThe number of outgoing external links
mediacountintThe number of found media files on the page
metatagsarrayMeta tags on the page
0arrayIndex
namestringThe name of the meta tag (e.g. "viewport")
valuestringThe value of the meta tag (e.g. "width=device-width, initial-scale=1")
(...)
httpheadersarrayHTTP headers of the page
0arrayIndex
namestringThe name of the HTTP header (e.g. "server")
valuestringThe value of the HTTP header (e.g. "nginx")
(...)
keywordsarrayThe keywords Seobility identified on the page
0arrayIndex
wordstringThe keyword itself (e.g. "building")
scoreintThe calculated optimization score for this keyword
showwordstringHow the keyword is displayed on the page (e.g. "Building")
totalamountintHow often the keyword was found on the page
(...)
headlinesarrayThe headlines found on the page
0arrayIndex
levelintLevel of the headline (e.g. "1" for H1 headlines, "2" for H2 headlines etc.)
textstringThe value of the headline (e.g. "How to do proper Search Engine Optimization")
(...)
textblocksarrayTextblocks found on the page
0arrayIndex
hashstringThe hash value of the textblock
wordcountintThe word count of the textblock
idintThe textblock ID
repeatcountintHow often the textblock occured on the page
textpreviewstringPreview of the textblock
globalcountintHow often the textblock was found on the domain
(...)
duplicatecontentarrayThe duplicate content that was found on the page
fullarrayFull duplicates
(...)URLs of duplicates of this site
includedarrayPartial duplicates (parts of other sites are included)
(...)stringThe URLs that include the content of this site
typosarrayThe spelling errors found on the page
0arrayIndex
wrongtextstringThe erroneous text
righttextstringThe corrected text
(...)
mediaarrayThe media files found on the page
0arrayIndex
srcstringThe URL to the source file
typestringThe type of the file
count_localintHow often the file was found on the page
alttagstringThe alternative text of the media file
(...)
boldtagsarrayThe bold and strong tags on the page
0arrayIndex
contentstringThe text found in the tags
issue_typestringThe issue that has been found (e.g. "tolong"; if none, equals "null")
issue_textstringThe value of the issue (e.g. "Too long"; if none, equals "null")
sizeintThe size of the found text
maxsizeintThe maximum size the text can have
(...)
homepagepatharrayThe click path to this URL beginning at the homepage
distanceintThe number clicks between the page and the homepage (e.g. 2)
patharrayThe path from the homepage to this page
0stringThe URL of the homepage (e.g. "https://www.seobility.net/en/blog/")
1stringThe next path on the way to the page
(...)
nstringThe URL of the page (in this example, n equals (int)1 with value "https://www.seobility.net/en/blog/link-building-tactics-how-to-build-sustainable-backlinks/")
canonical_incomingarrayIncoming canonical links
(...)stringThe page from which the canonical link is issued
redirect_incomingarrayIncoming redirect links
(...)stringThe page from which the redirect is issued
rel_nextstringRel Next URL of the page
rel_prevstringRel Prev URL of the page
linksarrayThe links associated with the page
incomingarrayThe incoming links to the page
0arrayIndex
urlstringThe URL of the incoming link (e.g. "https://www.seobility.net/en/blog/"
anchorsarrayThe anchors of the link
(...)stringThe anchor value (e.g. "link building tactics – how to build sustainable backlinks")
issuesarrayThe issues found with the link
0arrayIndex
levelstringThe level of issue (e.g. "info")
issue_textstringThe printable text of issue (e.g. "Duplicate link anchor")
issuestringThe name of the issue (e.g. "duplicate")
affected_anchorstringThe anchor affected by the issue
(...)
(...)
internalarrayThe internal links of the page
(...)Has identical structure as "incoming"
externalarrayThe external links of the page
(...)Has identical structure as "incoming"
alternatelinksarrayThe alternate links of the page
externalarrayThe alternate external links
0arrayIndex
hreflangstringThe (hreflang) language set on the page,(e.g. "de")
urlstringThe URL of the (hreflang) link
issuesarrayFound issues
0arrayIndex
issue_textstringPrintable text of issue (e.g. "No Backlink")
issuestringThe name of the issue (e.g. "nobacklink")
(...)
(...)
internalarrayThe alternate internal links
(...)Has identical structure as "external"
inboundinternalarrayThe alternate inbound internal links
(...)Has identical structure as "external"
softwareerrorsarrayThe software errors found while calling the page
(...)stringThe plaintext of the error found on the page (Mostly PHP Errors)

3. Single Page Check API

3.1 SEO Check

seocheck - Crawls an URL and returns a broad set of information about the SEO optimization of this page. Please note that the URL is being crawled live, so the response time will may vary.

Credits: 100

Example Call:


Request Parameters:

FieldTypeMandatoryExplanation
url string yes Target URL

Response Parameters (JSON):

Field Type Explanation
- array All onsite information:

Parameter Type Description
scoreintThe SEO score i.e. the overall optimization percentage of the analyzed page
analysedurlstringThe URL that has been analyzed during the SEO check
thumbnailurlstringThe URL to a thumbnail of the analyzed URL's domain (homepage)
quickfactsobjectGeneral information about the analyzed page
loadtimefloatThe load time in seconds
filesizefloatThe page size in kB
wordsintThe word count
mediafilesintThe number of media files on the analyzed page
internallinksintThe number of media files on the analyzed page
externallinksintThe number of external links on the analyzed analyzed page
medialistobjectA list of the media elements found on the analyzed page
imagesarrayAn array of the images
srcstringThe image's path
altstringThe alt value of the image
titlestringThe title of the image
videosarrayAn array of the videos
srcstringThe video's path
widthintThe width of the video
heightintThe height of the video
altstringThe alt value of the video
audioarrayAn array of the audio files
srcstringThe audio file's path
altstringThe alt value of the audio file
linklistarrayA list of the page's links
linkstringThe link's URL
target_blankbooleanWhether it's a link with the target blank
nofollowbooleanWhether it's a nofollow link
internalbooleanWhether it's an internal link
subdomainbooleanWhether the link leads to a subdomain of the website
anchorstringThe link's anchor text
anchortypestringThe link's anchor type
isanchorlinkbooleanWhether the link is an anchor link or not
groupresultsobjectA result list of the analysis categories
metaobjectThe results for the analysis category "meta"
scoreintThe score (percentage) achieved in this category
pointsintThe amount of points that has been achieved in this category
maxpointsintThe maximum amount of points that can be achieved in this category
(...)
hintsarrayA list of hints for improving the page
textstringThe hint text
priorityintThe priority i.e. the importance of the hint
keywordsarrayA list of keywords found on the analyzed page
keywordstringThe keyword
scoreintOptimization score for the keyword on the analyzed page
robotsstringThe website's full robots.txt file
httptagsarrayA list of the HTTP response headers received from the server
typestringThe name of the HTTP header
valuestringThe value of the HTTP header
metatagsarrayA list of all meta tags defined on the analyzed page
namestringThe name of the meta tag
valuestringThe value of the meta tag
headingstructurearrayA list of the headers on the analyzed page (h1, h2, ...)
headinglevelintThe level of the header (h1, h2, h3)
contentstringThe content of the header
duplicatebooleanWhether the header is a duplicate
emptybooleanWhether the header is empty
factorsobjectA list that contains all factors analyzed
metaobjectA factor category that contains all factors belonging to this category
title_contentobjectThe technical name of the factor
factornamestringThe localized factor name
scoreintThe score achieved in this factor (percentage)
impactstringThe impact this factor has i.e. its importance
messagesarrayA list of messages regarding this factor
textstringThe localized message
text_labelstringThe label of the message
priorityintThe priority of the message (0-3)
(...)
(...)

3.2 Keyword Check

keywordcheck - Crawls an URL and returns information about how well the site is optimized for the specified keyword. Please note that the URL is being crawled live, so the response time will may vary.

Credits: 20

Example Call:


Request Parameters:

FieldTypeMandatoryExplanation
url string yes Target URL
keyword string yes Keyword that should be checked

Response Parameters (JSON):

Field Type Explanation
- array All information on the keyword optimization of the page

4. TF*IDF Check API

4.1 TF*IDF Check

tfidfcheck - Performs a TF*IDF check for a given keyword. Several parameters allow individual and localized analysis settings. Returns the complete TF*IDF analysis data and an initial set of term suggestions. Please note that an initial tfidfcheck request will take a moment, as the analysis requires live data from several sources. Consecutive refreshes of an analysis with unchanged parameters will be without delay.

Credits: 175

Example Call:


Request Parameters:

FieldTypeMandatoryExplanation
keyword string yes The target keyword
searchengine string yes The target searchengine (e.g. Google.com, Google.de, Google.com.pk etc.)
platform int no The target platform (1=desktop, 2=mobile; default=1)
city string no The name of the location for the query (requires lat and lon)
lat float no The latitude of the location for the query (requires city and lon)
lon float no The longitude of the location for the query (requires city and lat)
logbase float no The logarithmic base for the calculation of the TF*IDF scoring (default = 1.05185); only change if you know what you are doing
resultamount int no The amount of top SERP results parsed to the TF*IDF check (default=10, Possible: 3, 7, 10, 15 or 20)
url string no The URL with the text to be optimized (use either url, text or textlength)
text string no Text to be optimized (use either url, text or textlength)
textlength int no Number of words of the target text (use either url, text or textlength)

Response Parameters (JSON):

Field Type Explanation
- array Response Array

Parameter Type Description
success boolean Whether the request was successful
request array The provided request information
keyword string The keyword provided in the request
searchengine string The searchengine provided in the request (e.g. Google.com, Google.de, Google.com.pk etc.)
platform string The target platform provided in the request (1=desktop, 2=mobile)
lat int The latitude of the location provided in the request
lon int The longitude of the location provided in the request
city string The name of the location provided in the request
logbase int The logarithmic base used for this calculation of the TF*IDF scoring
resultamount int The amount of top SERP results parsed for this TF*IDF check
url string The given URL used as comparison basis for TF*IDF check
text string The text given for calculation basis for this TF*IDF check
textlength int The textlength given for calculation basis for this TF*IDF check
calltime datetime Time of this request
stats array Relevant Keywords and their statistical data
keyword array Keyword for the corresponding values attached
avgtfidfused int Average TF*IDF value for all results containing this term
avgtfidftotal int Average TF*IDF value for all results
occurrence int The number of occurrences
maxtfidf int Max TF*IDF value for this term
maxtf int Max TF value for this term
(...)
results array The results for the request
Index array Index of the result
link string Result URL as given by Google SERP
title string SERP title
description string SERP title description
rank int Rank in the SERP (1-100)
domain string Result Domain
tfidf array List of keywords with corresponding TF*IDF of this result
keyword int The keyword and its corresponding TF*IDF value
(...)
loadtime int The time it took to load the result
wordcount int The amount of words in the results HTML
crawlerror boolean Errors occured while crawling
(...)
termsuggestions array Term suggestions
more array Words that should be used more
less array Words that should be used less
ok array Perfectly optimized words
text string The text on the page. (only relevant if URL was a part of the request)

5. Term Suggestion API

5.1 TF*IDF Term Suggestion

termsuggestion - Provides term suggestions to optimize a text for a given keyword, e.g. in a text editor. The underlying analysis is based on TF*IDF. Several parameters allow individual and localized analysis settings. Please note that an initial termsuggestion request might take a moment, as the analysis requires live data from several sources. Consecutive refreshes of an analysis with unchanged parameters will be without delay.

Credits: 20

Example Call:


Request Parameters:

FieldTypeMandatoryExplanation
keyword string yes The target keyword
searchengine string yes The target searchengine (e.g. Google.com, Google.de, Google.com.pk etc.)
platform int no The target platform (1=desktop, 2=mobile; default=1)
city string no The name of the location for the query (requires lat and lon)
lat float no The latitude of the location for the query (requires city and lon)
lon float no The longitude of the location for the query (requires city and lat)
logbase float no The logarithmic base for the calculation of the TF*IDF scoring (default = 1.05185); only change if you know what you are doing
resultamount int no The amount of top SERP results parsed to the TF*IDF check (default=10, Possible: 3, 7, 10, 15 or 20)
url string yes The URL with the text to be optimized (use either url or text)
text string yes Text to be optimized (use either url or text)

Response Parameters (JSON):

Field Type Explanation
- array Response Array

Parameter Type Description
success boolean Whether the request was successful
request array The provided request information
keyword string The keyword provided in the request
searchengine string The searchengine provided in the request (e.g. Google.com, Google.de, Google.com.pk etc.)
platform string The target platform provided in the request (1=desktop, 2=mobile)
lat int The latitude of the location provided in the request
lon int The longitude of the location provided in the request
city string The name of the location provided in the request
logbase int The logarithmic base used for this calculation of the TF*IDF scoring
resultamount int The amount of top SERP results parsed for this TF*IDF check
url string The given URL used as comparison basis for TF*IDF check
text string The text given for calculation basis for this TF*IDF check
calltime datetime Time of this request
termsuggestions array Term suggestions
more array Words that should be used more
less array Words that should be used less
ok array Perfectly optimized words
text string The text on the page. (only relevant if URL was a part of the request)

6. Ranking API

6.1 Ranking (Real Time)

ranking - Returns the SERP Rankings (SERP = Search Engine Result Pages) for a given search term or keyword.

This is a synchronous (direct) API. The average response time is 30 seconds.

Credits: 3

Example Call:


Request Parameters:

FieldTypeMandatoryExplanation
keyword string yes The target keyword
searchengine string yes The target searchengine domain (i.e. Google.com or Google.co.uk)
platform int no Target Platform (1=Desktop, 2=Mobile) (Default Desktop)
city string no Name of the location for query (requires city, lat and lon)
lat float no Latitude of the query (requires city, lat and lon)
lon float no Longitude of the query (requires city, lat and lon)
url string no URL which position is to be determined

Response Parameters (JSON):

Field Type Explanation
- array Response Array

Parameter Type Description
success boolean Whether the request was successful
request object The provided request information
keyword string The keyword provided in the request
searchengine string The searchengine provided in the request (e.g. Google.com, Google.de, Google.com.pk etc.)
platform string The type of device i.e. MOBILE
lat int Latitude for Google Maps
lon int Longitude for Google Maps
city string City for Google Maps localisation
targeturl string URL given as target for the results
calltime datetime Time of TF*IDF analysis
targeturlresult array results of the target URL; only provided if target URL is within the top SERPS
rank int The ranking of the target url
link string Link to the target url
description string The meta description of the target url
title string The title of the target url
results array The results for the request
rank int The ranking of the page
link string Link to the page
description string The meta description of the page
title string The title of the page
domain string The domain of the page
(...)

7. Error handling

If an error occurred, or if you made an invalid request, the API will return an error message.

The returned JSON will be structured like this:





© 2018 - Seobility.net Imprint Privacy