Bespoke lead generation is available to our Enterprise partners. Please contact your Customer Success Manager to find out more. If you're on the Pay-As-You-Go plan, check out our self-serve lead generation widget.
The easiest way to get up and running with our lead generation is to use the pre-made widgets which can be created from within Insites.
However, you may wish to use your own form to capture user information and redirect the user to us to run the scan afterwards.
This article explains how to do this.
How does it work?
Building a link to run a report is trivial. Here’s one that should work straight away if you're logged in:
https://app.insites.com/report/retest?url=insites.com
To run a lead generation audit, just swap the hostname (app.insites.com) for your white-label scan hostname.
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 for this API, see the Detailed specification below.
This API works with a GET request OR a POST request containing the same parameters – use whichever option that fits your use-case.
Available parameters
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 |
allow_path | Boolean – if true, Insites will run an audit on a subsection of a site, e.g. https://mywebsite.com/part-of-my-site | 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 |
inbound_report_view | Enum - Pass either | No |
inbound_detail_sections | String - This option will filter the audit to only show specific sections, and only works when
It should be a comma separated list of audit sections, e.g. Test_Page_GDPR,Test_Page_GoogleAdsReadiness would limit the audit to just the GDPR and Google Ads Readiness tests.
For a full list of Test IDs enabled in your audit, ask your Insites Customer Success Manager. | No |
inbound_summary_view_id | String - This option will use a specific view, and only works when | No |
Expected response
If successful, you would expect a 301 redirect to a page with a progress bar, so the user can wait while Insites generates the SEO audit.
Authentication
The report will start running straight away. If you are concerned about unauthorised usage of the scan, check out our article on preventing abuse of lead generation.