Back to home
Report link API
Sometimes it’s useful to be able to build a link that triggers a report. For example, you want to build a custom CRM integration where your team can click a link and that triggers an audit to be generated.
How to build a link
Building a link to run a report is trivial. Here’s one that should work straight away:
https://app.insites.com/report/retest?url=insites.com
As you can see, this link simply includes the website to be analysed using the query parameter url. For a full list of possible parameters, see the Detailed specification below.
If you are on an enterprise plan with a custom host name configured, you can swap app.insites.com for your own white-label domain and no other changes are necessary.
This API also works with a POST request containing the same parameters – use this option if it fits your use-case better.
Detailed specification
Method: GET or POST
Endpoint: https://app.insites.com/report/submit or https://[YOUR CUSTOM HOSTNAME].com/report/submit
These parameters should be passed as standard GET parameters, or as form encoded in a POST body:
| Property | Definition | Required |
|---|---|---|
| url | String – URL to analyze | No |
| on_completion | String – Insites will make a POST callback to this URL with the JSON report data. | No |
| allow_path | Boolean – if true, Prospect will run an audit on a subsection of a site, e.g. https://mywebsite.com/part-of-my-site. Note that this feature is currently experimental. | No (defaults to false) |
| name | String – Business name, some checks will not work without this, e.g Local presence, Reviews | No |
| phone | String – Business phone number, some checks will not work without this, e.g Local presence, Reviews | No |
| address | String – First line of business address, some checks will not work without this, e.g Local presence, Reviews | No |
| number | String – Building number, enhances accuracy in some checks, e.g Local presence, Reviews | No |
| street | String – Street, enhances accuracy in some checks, e.g Local presence, Reviews | No |
| city | String – City, enhances accuracy in some checks, e.g Local presence, Reviews | No |
| state | String – State or county, enhances accuracy in some checks, e.g Local presence, Reviews | No |
| zip | String – Zip of postcode, enhances accuracy in some checks, e.g Local presence, Reviews | No |
| country_code | ISO 2 letter code – Country, enhances accuracy in some checks, e.g Local presence, Reviews | No |
| lat | String – Latitude, enhances accuracy in some checks, e.g Local presence, Reviews | No |
| lng | String – Longitude, enhances accuracy in some checks, e.g Local presence, Reviews | No |
| products | String – Products and services this business offers, some checks will not work without this, e.g Content keywords. Note: multiple products and services should be comma separated | No |
| locations | String – Locations served, some checks will not work without this, e.g Content keywords. Note: multiple locations should be comma separated | No |
| _[custom_field_name] | String – Pass values to set as one of your custom report fields. Note: custom report fields must be prefixed with an underscore. | No |
Expected response
If successful, you would expect a 301 redirect to the progress page, so the report can be generated.
Authentication
If the user is already logged in, the report will start running straight away. If the user is not logged in, they will be prompted to log in before the report is generated.