getDomainTrend
Returns the trend of important figures of one domain.
| Route | /links/getDomainTrend[/:key[/:domain[/:format[/:limit[/:skip[/:cached]]]]]] |
|---|---|
| Necessary parameter | domain |
| Optional parameter | format limit (max:1000) skip |
| Return values | trendDate domainPop webpagePOP backlinkPOP ipPop classCPop |
| Cross references | – |
| Hints | Limit: The maximum limit is 1000. To get more results, please use the parameter skip. cached: If the optional parameter ‚cached‘ is set ‚true‘, the most recent data will be loaded from cache. But the attributes webpagePOP and ClassCPop will always have the value ’n/a‘. resultCount: Shows the amount of the result without limits. Usefull for pagination. |
Parameter
| Labeling | Description | Values margin | Default value |
|---|---|---|---|
| domain | Contains a qualified domain name. | (www.)?(A-Z|a-z|0-9)+. (a-z)+ | – |
| limit | Defines the amount of the returned results. (max:1000) | (0-9)+ | 1 |
| skip | Defines the starting page of the result. One page equals the the value of limit. | (0-9)+ | 0 |
| format | Defines in which format the result will be returned. | json|xml | json |
| cached | If the optional parameter ‚cached‘ is set ‚true‘, the most recent data will be loaded from cache. But the attributes webpagePOP and ClassCPop will always have the value ’n/a‘. | true|false | false |
Return values
A numerical array with the following entries
| Labeling | Description | Values margin |
|---|---|---|
| trendDate | Date of when the data got determined. | Date format yyyy-mm-dd |
| domainPop | Amount of linking domains. | uint |
| webpagePOP | Number of linking websites. | uint |
| backlinkPOP | Amount of backlinks. | uint |
| ipPop | Amount of the unique IP addresses. | uint |
| classCPop | Amount of the unique class C networks. | uint |
Messages
| Message | Description |
|---|---|
| maximum limit exeeded | The maximum limit is reached. |
| no permission | The key has no access to the function. |
| internal error | An internal error occured. |
| param missing | A required parameter is missing. |
| param invalid | The value of a parameter is not valid. |
| result empty | The request was successful, but the result itself is empty. |
| cost error | The current credit amount is not sufficient to handle the request. |
| 0k. | The processing was successful. |
Exemplary code
$root = 'https://suite.xovi.net/api/';
$arrayParams = array(
'service' =>'links',
'method' =>'getDomainTrend',
'key' =>'myPersonalKey',
'domain' => 'www.xovi.de',
'format' =>'xml',
);
$GETparams = implode('/', $arrayParams);
$requestURL = $root.$GETparams;
if (!function_exists('curl_init')) die('cURL not available');
$ch = curl_init();
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 0);
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 0);
curl_setopt($ch, CURLOPT_URL, $requestURL);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
// Download the given URL, and return output
$output = curl_exec($ch);
// Close the cURL resource, and free system resources
curl_close($ch);
echo $output;
?>
Exemplary results
JSON
{
"apiErrorCode":"0",
"apiErrorMessage":"0k.",
"apiResult":[
{
"trendDate":"2013-03-11",
"domainPop":"928",
"webpagePOP":"15095",
"backlinkPOP":"18591",
"ipPop":"989",
"classCPop":"725",
}]
}
XML
<?xml version="1.0"?>
<result>
<apiErrorCode>0</apiErrorCode>
<apiErrorMessage>0k.</apiErrorMessage>
<apiResult>
<domains>
<domain>
<trendDate>2013-03-11</trendDate>
<domainPop>928</domainPop>
<webpagePOP>15095</webpagePOP>
<backlinkPOP>18591</backlinkPOP>
<ipPop>989</ipPop>
<classCPop>725</classCPop>
</domain>
</domains>
</apiResult>
</result>
Amount of the unique class C networks.
