Method: edit
Description:
Edit the settings of an existing Lipperhey analysis.
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.
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).
benchmarkurls (optional): Lipperhey can suggest keywords for a website and benchmark a website with 3 other websites. The first 20 pages of the given URLs will be analyzed at the same time. During this benchmark Lipperhey will determin the technology, search engine rankings and most important keywords used by the competitors. Enter a maximum of 3 URLs separated by a comma (http://www.site1.com,http://www.site2.com,http://www.site3.com).
locations (optional): Lipperhey can suggest keywords for a website depending on your service area. To take your service area in the equation locations must be provided. Locations should be separated by a comma (,) and spaces in must be replaced (escaped) by a '+' sign (locations=new+york,amsterdam,paris).
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'.
A simple example to change the search queries of an existing analysis looks like this:
If you would like to increase the number of indexed pages you could use the following example:
http://www.lipperhey.com/api/1.0/?apikey=[your-api-key]&method=edit&id=214788&pages=100
Response:
If there are no errors, the API will respond with the ID of the edited 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>
</website>
</websites>
<users/>
</response>
Examples: