API Data Provider - Online Help

Connecting to Optimizely

To authenticate to Optimizely, you can use either Token authentication or the OAuth standard. Use Token authentication to connect to your own data. Use OAuth to allow other users to connect to their data.

Using Token Authentication

You can connect to Optimizely by simply providing a personal token. Personal access token can be generated at app.optimizely.com/v2/profile/api. Set the API Key to your personal token in the ProfileSettings connection property.

Example connection string

Profile=C:\profiles\Optimizely.apip;ProfileSettings='APIKey=my_api_key';

Using OAuth Authentication

To allow other users to access their data, you'll need to register an OAuth application with Optimizely. To do so, follow the instructions at app.optimizely.com/accountsettings/apps/developers. You app will be assigned an OAuth client ID and secret. After setting the following connection properties, you are ready to connect:

  • AuthScheme: Set this to OAuth.
  • OAuthClientId: Set this to the Client Id that you received upon app registration
  • OAuthClientSecret: Set this to the Client Secret that that you received upon app registration.
  • CallbackURL: Set this to the Redirect URI you specified in your app.
  • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to manage the process to obtain the OAuthAccessToken.
  • OAuthVersion: Set this to 2.0.

Example connection string

Profile=C:\profiles\Optimizely.apip;Authscheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;

Connection Properties

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider.


Property Description
APIKey Your Optimizely Personal Token.
AuthScheme The scheme used for authentication. Accepted entries are None or OAuth.
Allowed values are: BASIC, NONE, NTLM, OAUTH, OAUTH_CLIENT, APIKEY
CallbackURL The URL users return to after authenticating to API via OAuth.
InitiateOAuth Specifies the process for obtaining or refreshing the OAuth access token, which maintains user access while an authenticated, authorized user is working.
Allowed values are: OFF, GETANDREFRESH, REFRESH
OAuthClientId Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
OAuthClientSecret Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server.

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 24.0.9300.0