Method: result
Description:
Retrieve the results or the progression of an analysis carried out under your account.
Requires:
API key, id
Available in:
Version 1.0
Parameters:
apikey: The API key that is provided with your reseller account.
id: The ID under which the analysis is carried out. The ID is given after you added a new analysis. You can also use the ID's that are in the response of the list method.
A simple example to retrieve the results of an analysis looks like this:
http://api.lipperhey.com/1.0/?apikey=[your-api-key]&method=result&id=1653989
option (optional): A subscription for the website must be ordered before you can use this parameter. Several options (dump, scorecard) can be given at once. With the option parameter you can retrieve different kind of the results that Lipperhey has for a website (option=dump,scorecard).
If you want to retrieve all the results of an analysis you can use the following example:
http://api.lipperhey.com/1.0/?apikey=[your-api-key]&method=result&id=1653989&option=dump
Response:
The content of the XML response depends on the status of the analysis. If there are no errors, the API will respond with the a) progression of the analysis or the b) results of the analysis.
The structure of the XML document will always be the same. Remember that fields can be empty <field/> or have results <field>result</field> depending on the status of the analysis.
If the field <finished> contains the value true, then the analysis is finished and the field <results> will contain more values. As long as the field <finished> contains the value false, then the analysis is not finished yet and the field <progress> will contain more values.
Progression of the analysis
<!--Lipperhey API Response-->
<response queries="5" time="5 ms" calls-left="9999">
<error/>
<websites offset="0" results="1">
<website domain="www.cnn.com" timestamp="2009-07-20 14:30:02">
<id>1659254</id>
<url>http://www.cnn.com</url>
<error/>
<queued>False</queued>
<finished>False</finished>
<progress>
<spider>Sadr</spider>
<cpu>10</cpu>
<percentage>4</percentage>
<url compression="base64">aHR0cDud3MvaWXnNz</url>
<pages>
<found>78</found>
<evaluated>3</evaluated>
<maximum>78</maximum>
</pages>
</progress>
<result/>
</website>
</websites>
</response>
Results of the analysis
If the analysis is finished you can retrieve the results. The Lipperhey API will return the same results as under your Lipperhey dashboard. These are:
<!--Lipperhey API Response-->
<response queries="5" time="5 ms" calls-left="9999">
<error/>
<websites offset="0" results="1">
<website domain="www.cnn.com" timestamp="2009-07-20 14:30:02">
<id>1659254</id>
<url>http://www.cnn.com</url>
<error/>
<queued>False</queued>
<finished>True</finished>
<progress/>
<results>
<report>True</report>
<favicon>http://www.cnn.com/favicon.ico</favicon>
<statuscodes>200, 301, </statuscodes>
<quickwincodes>101, 118, 132, 105, 117, </quickwincodes>
<seowords>word1, word2, word3, etc, </seowords>
<report>False</report>
<density>
<code>78%</code>
<link>14%</link>
</density>
<score>
<technical>6.7</technical>
<seo>62%</seo>
<popularity>10.0</popularity>
<overall>7.6</overall>
</score>
<pages>
<found>1342</found>
<evaluated>200</evaluated>
<assessed>1254</assessed>
</pages>
<links>
<incoming>571466</incoming>
<outgoing>391</outgoing>
<directories>DMOZ, Yahoo, DIGG</directories>
</links>
<search>
<queries>sem, seo, internet marketing, </queries>
<positions>15, 87, 0 </positions>
<words>sem, seo, internet, marketing, </words>
<wordscores>1%, 48%, 5%, 0%, </wordscores>
</search>
<seo>
<pagesseowordurl>20%</pagesseowordurl>
<pagesseowordtitle>57%</pagesseowordtitle>
<pagesseowordmd>0%</pagesseowordmd>
<pagesseowordmk>0%</pagesseowordmk>
<pagesseowordh1>87%</pagesseowordh1>
<pagesseowordhx>5%</pagesseowordhx>
<pagesseowordkeyword>21%</pagesseowordkeyword>
<pagesseowordalttext>23%</pagesseowordalttext>
<pagesseowordtitletext>15%</pagesseowordtitletext>
<pagesseowordanchortext>87%</pagesseowordanchortext>
<pagesseowordbold>0%</pagesseowordbold>
<pagesseowordlist>0%</pagesseowordlist>
</seo>
<result/>
</website>
</websites>
</response>
If an error occured a description of the error wil be available in the error field.
Donwload:
