Method: add
Description:
Analyze a new URL under your Lipperhey account.
Requires:
API key, url
Available in:
Version 1.0
Parameters:
apikey: The API key that is provided with your reseller account.
url: The URL of the website that you want to analyze. This can be the host name (http://www.hostname.com) or a page that can be used as a starting point for the analysis (http://www.hostname.com/welcome.html).
searchqueries (optional): The searchquery contains the words and phrases for wich Lipperhey will examine the searchengine positions. Lipperhey also examines how the site is optimized for each word from the searchquery. Several searchqueries can be given at once. Searchqueries should be separated by a comma (,) and spaces in the searchquery must be replaced (escaped) by a '+' sign (searchquery=this+is+a+test,and+another+test).
pages (optional): Maximum number of pages that Lipperhey should analyze (pages=300). The default number of pages is 250 and the maximum is 1000.
linkvalidation (optional): Lipperhey can validate all external links (linkvalidation=true) that it finds on a website. The default value is 'false'.
email (optional): Lipperhey can share an analyses with other user after a subscription is bought. By giving an email address (email=name@domain.com) and a password (password=c533ada01519f35e2b32ff13c88d6a08dff6d61c). Lipperhey will create or update an account and share the analyses.
password (optional, except when email was given): The password is only needed if an email address was given. The password must be encrypted with SHA1.
A simple example to add an analysis without a searchquery looks like this:
http://api.lipperhey.com/1.0/?apikey=[your-api-key]&method=add&url=http://www.demo.com/
If you would like to check the searchengine positions and Lipperhey SEO scores for some words or word combinations you could use the following example:
Response:
If there are no errors, the API will respond with the ID of the new analysis. With this ID you can retrieve the progress, detailed results, order a subscription or download the report.
<!--Lipperhey API Response-->
<response queries="6" time="15 ms" calls-left="9985">
<error/>
<websites offset="0" results="1">
<website domain="lipperhey.com" timestamp="2009-07-07 10:54:21">
<id>1653860</id>
<key />
</website>
</websites>
</response>
If you shared the analysis with a new or existing account (email and password) the API will respond with the ID of the new analysis and the login key of the user. With this key you can redirect the user to directly to his Lipperhey account. The user doesn't have to login, the key will be validated by Lipperhey and the user will be logged in automatically.
The url points to the login page and contains the key with slashes ../login/key/
http://www.lipperhey.com/en/login/19c1aa546fd706753s949b383be245d149c1eb17/
<!--Lipperhey API Response-->
<response queries="6" time="15 ms" calls-left="9985">
<error/>
<websites offset="0" results="1">
<website domain="lipperhey.com" timestamp="2009-07-07 10:54:21">
<id>1653860</id>
<key>19c1aa546fd706753s949b383be245d149c1eb17</key>
</website>
</websites>
</response>
If an error occured a description of the error wil be available in the error field.
Examples:
