Method: download

Description:

Download a website report in PDF, RTF or CSV. A subscription for the website must be ordered before you can download a report.

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 add a new analysis. You can also use the ID's that are in the response of the list method. A subscription for this website must be ordered before you can download a report.

A simple example to download a PDF report:

http://api.lipperhey.com/1.0/?apikey=[your-api-key]&method=download&id=1659

type (optional): Lipperhey can generate the report in 3 different formats. Lipperhey generates reports in PDF and RTF or gives you the page-by-page details in CSV format. Lipperhey will generate a PDF by default if you don't specify a (file) type.

A simple example to download a RTF report:

http://api.lipperhey.com/1.0/?apikey=[your-api-key]&method=download&id=1689&type=rtf

You can download the CSV file with a page-by-page analysis:

http://api.lipperhey.com/1.0/?apikey=[your-api-key]&method=download&id=1689&type=csv

template (optional): Lipperhey can generate the report in English and Dutch. Lipperhey will generate the PDF and RTF reports in English by default if you don't specify a template.

A simple example to download a Dutch RTF report:

http://api.lipperhey.com/1.0/?apikey=[your-api-key]&method=download&id=1659&type=rtf&template=nl

Response:

If there are no errors, the API will not send an XML response but it will send the requested file directly.

Examples:

Download API examples