Summary report (getSummary)

The getSummary method gives you general information about link profile: number of external links, referring IP addresses and subnets, number of referring domains and subdomains, domain authority indicator and types of referring links. The data set is similar to the Overview report.

General request parameters and instructions for using Serpstat API

Request parameters
Parameter		Description
id	required	A request id. Any number or string value is allowed.
method	required	API method name: SerpstatBacklinksProcedure.getSummary
params	required	The array with parameters {...}, it lists all the following parameters and arrays.
query	required	A domain of the analyzed site. Specify the domain without http/ https и "/".
searchType	required	Search type: * domain_with_subdomains - domain with subdomains * domain - only domain

Response parameters
Parameter	Description
id	Request id
result	Contains the answer
data	Array with data
referringDomains	Number of referring domains
referringSubDomains	Number of referring subdomains
referringLinks	Number of external links
totalIndexed	Number of indexed pages on Google
externalDomains	Number of external domain links
noFollowLinks	Number of nofollow backlinks
doFollowLinks	Number of follow backlinks
referringIps	Number of referring IPs
referringSubnets	Number of referring subnets
outlinksTotal	Number of external links
outlinksUnique	Number of unique external links
typeText	Number of text backlinks
typeImg	Number of image backlinks
typeRedirect	Number of referring redirects
typeAlt	Number of links from alt attribute
referringDomainsDynamics	Dynamics of referring domains
referringSubDomainsDynamics	Dynamics of referring subdomains
referringLinksDynamics	Dynamics of backlinks
totalIndexedDynamics	Dynamics of indexed pages on Google
externalDomainsDynamics	Dynamics of external domain links
noFollowLinksDynamics	Dynamics of nofollow backlinks
doFollowLinksDynamics	Dynamics of follow backlinks
referringIpsDynamics	Dynamics of referring IPs
referringSubnetsDynamics	Dynamics of referring subnets
typeTextDynamics	Dynamics of text backlinks
typeImgDynamics	Dynamics of image backlinks
typeRedirectDynamics	Dynamics of referring redirects
typeAltDynamics	Dynamics of links from alt attribute
threats	Number of referring malicious sites
threatsDynamics	Dynamics of referring malicious sites
mainPageLinks	Number of referring homepages
mainPageLinksDynamics	Dynamics of referring home pages
domainRank	Serpstat Domain Rank metric

For 1 request, 1 API limit is spent.

Example PHP Python

Request data:

{
 "id": "any_num_or_string",
 "method": "SerpstatBacklinksProcedure.getSummary",
 "params": {
     "query" : "domain"
  }
}

Response data:

{
    "id": "1",
    "result": {
        "data": {
            "referringDomains": 4545,
            "referringSubDomains": 975,
            "referringLinks": 45333,
            "totalIndexed": 914,
            "externalDomains": 22,
            "noFollowLinks": 17035,
            "doFollowLinks": 80136,
            "referringIps": 3869,
            "referringSubnets": 2261,
            "trustRank": 0,
            "citationRank": 0,
            "domainZoneEdu": 0,
            "domainZoneGov": 0,
            "outlinksTotal": 19760,
            "outlinksUnique": 1284,
            "facebookLinks": 0,
            "pinterestLinks": 0,
            "linkedinLinks": 0,
            "vkLinks": 0,
            "typeText": 84775,
            "typeImg": 11498,
            "typeRedirect": 898,
            "typeAlt": 0,
            "referringDomainsDynamics": 19,
            "referringSubDomainsDynamics": 10,
            "referringLinksDynamics": 142,
            "totalIndexedDynamics": 31,
            "externalDomainsDynamics": 1,
            "noFollowLinksDynamics": 30,
            "doFollowLinksDynamics": 488,
            "referringIpsDynamics": 14,
            "referringSubnetsDynamics": 8,
            "trustRankDynamics": 0,
            "citationRankDynamics": 0,
            "domainZoneEduDynamics": 0,
            "domainZoneGovDynamics": 0,
            "outlinksTotalDynamics": 2224,
            "outlinksUniqueDynamics": 5,
            "facebookLinksDynamics": null,
            "pinterestLinksDynamics": null,
            "linkedinLinksDynamics": null,
            "vkLinksDynamics": null,
            "typeTextDynamics": 513,
            "typeImgDynamics": 3,
            "typeRedirectDynamics": 2,
            "typeAltDynamics": 0,
            "threats": 5,
            "threatsDynamics": 0,
            "mainPageLinks": 3848,
            "mainPageLinksDynamics": 10,
            "domainRank": 57.826405000000001
        },
        "summary_info": {
            "left_lines": 9988762,
            "page": 1,
            "count": null,
            "total": null,
            "sort": null,
            "order": null
        }
    }
}

<?php
$client = new http\Client;
$request = new http\Client\Request;
$request->setRequestUrl('http://api.serpstat.com/v4/?token={{token}}');
$request->setRequestMethod('POST');
$body = new http\Message\Body;
$body->append('{
 "id": "",
 "method": "SerpstatBacklinksProcedure.getSummary",
 "params": {
     "query" : "allo.ua"
  }
}');
$request->setBody($body);
$request->setOptions(array());
$request->setHeaders(array(
  'Content-Type' => 'application/json'
));
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();

import http.client
import mimetypes
conn = http.client.HTTPSConnection("api.serpstat.com")
payload = "{\r\n \"id\": \"\",\r\n \"method\": \"SerpstatBacklinksProcedure.getSummary\",\r\n \"params\": {\r\n     \"query\" : \"allo.ua\"\r\n  }\r\n}"
headers = {
  'Content-Type': 'application/json'
}
conn.request("POST", "/v4/?token={{token}}", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))