Work with the Sitefinity Insight API

To use Sitefinity Insight API, perform the following:

1. Ensure you have a Microsoft account, which is provisioned in Insight.
   NOTE: If you do not have a Sitefinity Insight account, contact sitefinitysales@progress.com.
2. Choose the Sitefinity Insight API server depending on the region where your Sitefinity Insight account is provisioned.
   For more information about available Insight regional deployments, see Sitefinity Insight deployment options » Sitefinity CMS and Sitefinity Insight deployments.
   This article assumes the US deployment - https://api.insight.sitefinity.com.
3. 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 see this key again. Make sure you have a copy of the key in a secure place.
4. 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.
5. Use the obtained access token in subsequent API calls.

Authorization token with access key

To use the secured Insight endpoints, you need to obtain an authorization token. The recommended way of 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, issue a POST request to https://api.insight.sitefinity.com/admin/v1/access-keys/issue-access-token, providing your access key in the request's body. If the authorization is successful, you will get the access token in the response.

You can learn the full details how to use this request using the dedicated API browser:

Go to API server docs

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

1. Log into Sitefinity Insight.
2. Open the Administration panel.
3. Select the data center whose API key you want to obtain.
4. Open the API key tab.

Insight API

Use the GET admin/v1/users/mydatacenters API resource to obtain the API keys of the data centers you need access to.

You can learn the full details how to use this request using the dedicated API browser:

Go to API server docs

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

Go to API server docs