ⓘ Contentsquare is deprecating API keys starting July 14th, 2023.
-
API keys will soon no longer be supported
-
Applications that still use API keys will soon no longer be supported.
- Raw Data and Metric APIs
- Looker Studio connector
- Qualtrics extension (embedded Session Replay player)
- J+Report (Reeport)
- Dexem
- Follow the instructions below to replace your API keys with OAuth credentials.
Why migrate?
Security—The OAuth authentication flow is more secure than API keys. It leverages short-lived access tokens instead of non-expiring keys. Deprecation of the API keys reduces potential attack surface (having several authentication alternatives grants potential threats more options and opportunities).
Multi-cloud support—Contentsquare's multi-cloud architecture (Azure or AWS multi-region deployment) has specific API endpoints for each cloud and is therefore better supported by OAuth access token flow. Additionally, migration allows you to leverage an existing OAuth library you may already be familiar with to query APIs.
Migration
APIs
Use the following documentation to complete migration:
Looker Studio connector
Update your credentials to use OAuth in your Chrome extension
1. Open the extension and click 'New API credentials' in the bottom right.
2. Now in the API credentials input, enter your client_id and client_secretseparated by an underscore exactly like in the data source in Step 3.
3. Enter a password of your choice and click 'Save'.
Revoke access to your Contentsquare data source
1. In Looker Studio, go to 'Data Source' > 'Create data source'.
2. Find the Contentsquare data source click '...' options menu > 'Revoke access'.
3. Confirm twice as shown below:
Create a new Contentsquare data source
1. Go to Looker studio '+ Create' > 'Data Source'.
2. Name your new data source "Contentsquare (new)" so you can easily identify the new data source in your report. Select the Contentsquare data source in the list of community connectors.
3. Enter your OAuth credentials, your client_id and client_secret( make sure these are separated by an underscore). Then click 'Submit'.
4. Ensure all the "Allow __ parameter to be modified in reports" checkboxes are checked, and clicked on 'Connect'.
5. Click 'Allow' in the confirmation pop-up:
Make a copy of your existing dashboard and change your Contentsquare data source
Service Notice: Prior to updating your data source you may have already noticed that existing reports using the Contentsquare data source are broken. This is unexpected behavior due to a planned release to update the existing data source. The release had an issue during deployment which prevented recovery of the previous version of the connector. A new data source was submitted that requires the updates described below.
Sorry for any inconvenience this may cause.
1. Go to your existing report and click 'File' > 'Make a copy'.
2. In the pop-up that appears, click 'New Data Source' > select your Contentsquare data report > 'Copy report'.
3. Now you should see your charts are back again:
4. You may still have issues with some charts if those were originally configured without specifying the required parameters, such as the project ID.
- You'll have to update the configuration of the data source for these charts to specify the parameters via the extensions.
Qualtrics extension (embedded Session Replay player)
OAuth credentials are not yet supported, migration protocol coming soon.
Reeport
OAuth credentials are not yet supported, migration protocol coming soon.
Dexem
OAuth credentials are not yet supported, migration protocol coming soon.