Our link API lets you easily and quickly integrate Insites into your CRM or other existing tool.
Simply add a button onto your customer record that when clicked, redirects the agent to the Insites platform and passes the customer details to Insites as query parameters in the URL.
If the agent is logged in, the Insites audit will begin. If they are not, they will be prompted to sign in before the audit starts.
This is a great way to save agents time since they no longer have to use the search functionality within Insites or copy the business details over manually.
Options
Insites supports 3 integration methods:
Instantly start the audit running, using the exact details from the CRM
Give the agent opportunity to validate and edit details from the CRM before starting the audit
Automatically initiate a search within Insites, so the agent can pick the relevant business and start the audit running
Find instructions for each method below.
Method 1 - Instantly starting an audit
Building a link to run a report is trivial. Here’s one that should work straight away if you're logged in:
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.
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.
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 |
on_completion | String – Insites will make a POST callback to this URL with the JSON report data. | 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. 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 a page with a progress bar, so the user can wait while Insites generates the SEO audit.
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. Only logged in users can use this functionality.
Method 2 - Pre-filling business information
Simply build a link to app.insites.com, with the relevant query parameters appended on the end. For example, here's a basic link which should work to pre-fill the name, phone number and address:
https://app.insites.com/?name=Insites&phone=01332%20460%20400&city=Derby&url=insites.com&address=Brunel%20Parkway&sublocality=Pride%20Park&zip=DE24%208HR
Available parameters
Method: GET
Endpoint: https://app.insites.com or https://[YOUR CUSTOM HOSTNAME].com/
These parameters should be passed as standard GET parameters:
Property | Definition | Required |
url | String – URL to analyze | No |
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 pop-up with all the details provided pre-filled.
Authentication
If the user is already logged in, the pop-up will appear straight away. If the user is not logged in, they will be prompted to log in before the pop-up appears. Only logged in users can use this functionality.
Method 3 - Automatically triggering a search
Simply build a link to app.insites.com, with the query parameter auto-search, set to the value you want the platform to search for:
https://app.insites.com/?auto-search=chartwells,%20derby
Available parameters
Method: GET
Endpoint: https://app.insites.com or https://[YOUR CUSTOM HOSTNAME].com/
These parameters should be passed as standard GET parameters:
Property | Definition | Required |
auto-search | String – Search term | No |
Expected response
If successful, you would expect the platform to automatically search for the term provided in the URL.
Authentication
If the user is already logged in, the search will begin straight away. If the user is not logged in, they will be prompted to log in before the search is conducted. Only logged in users can use this functionality.