Work with the Sitefinity Insight API

Get started

To use Sitefinity Insight API, perform the following:

Ensure you have a Microsoft account, which is provisioned in Insight.

NOTE: If you do not have a Sitefinity Insight account, contact Sitefinity Sales.

Choose the Sitefinity Insight API server depending on the region where your Sitefinity Insight account is provisioned.
For more information about the available regional deployments, see Sitefinity Insight deployment options » Sitefinity CMS and Sitefinity Insight deployments.
This article assumes the US deployment - https://api.insight.sitefinity.com.
Generate an Access key.
For more information, see Connect your sites to Sitefinity Insight » Access keys.

IMPORTANT: After you close the window, you will not be able to view this key again. Make sure you store a copy of the key in a secure place.

Obtain an ephemeral access token to use in the Authorization header when performing subsequent API calls.
To do this, follow the procedure described in Authorization section below.
Use the obtained access token in subsequent API calls.

To use the secured Insight endpoints, you need to obtain an authorization token. The recommended way for obtaining an authorization token is by using an access key. The token is obtained by calling the endpoint described in this section. The authorization token with access key is valid for 60 minutes.
For more information, see Connect your sites to Sitefinity Insight » Access keys.

To retrieve an authorization token, send a POST request to https://api.insight.sitefinity.com/admin/v1/access-keys/issue-access-token, including your access key in the request body. If the authorization is successful, you will get the access token in the response.

You can learn the full details about this request using the dedicated API browser:

Go to API server docs

Obtain the data center API key

To work with the most of Insight endpoints, you must provide the API key of the data center. The reason is that most of the data related to Insight is bound to a specific data center. The following sections explain the two ways of obtaining the data center API key.

Insight Web App

Log in to Sitefinity Insight.
Open the Administration panel.
Select the data center for which you want to obtain an API key.
Open the API key tab.

Insight API

Use the GET /v3/users/me/datacenters API resource to obtain the API keys of the data centers you need access to.

You can learn the full details about this request using the dedicated API browser:

Go to API server docs

Browse Sitefinity Insight API

You can browse the full Sitefinity Insight API using the dedicated API browser.

Go to API server docs

This section contains

Data collection API endpoints

Report data to in an easy and straightforward way with the Sitefinity Insight API.

Personalization API endpoints

With the Sitefinity Insight API, you can personalize content in an easy and straightforward way.

Management of contact data endpoints

Efficiently manage contact data stored in Sitefinity Insight.

A/B tests data reporting

Once you set up A/B tests in Sitefinity and page variations get any visits, you track and analyze results in detailed reports in Sitefinity Insight.

Sitefinity Insight API data types

Learn the Sitefinity Insight API data types.