Skip to contentSkip to navigationSkip to topbar
Rate this page:
On this page

Flex Insights API General Usage



Prerequisites

prerequisites page anchor

Before you start exporting data, you will need to have:


The procedure requires 2 API calls.

The first authenticates and returns an SST (Super Secured Token) using your login and password. Once the SST is available, a TT (Temporary Token) must be requested. The TT has to be included in any subsequent API calls.

(warning)

Warning

In order to obtain the password for direct login, please contact the Flex Insights Support Team(link takes you to an external page).

Flex Insights - API Authentication

flex-insights---api-authentication page anchor
curl

_11
curl -X POST https://analytics.ytica.com/gdc/account/login \
_11
-H 'Accept: application/json' \
_11
-H 'Content-Type: application/json' \
_11
-d '{
_11
"postUserLogin":{
_11
"login":"{email_address}",
_11
"password":"{password}",
_11
"remember": 0,
_11
"verify_level": 2
_11
}
_11
}'

Output

_10
{
_10
"userLogin":{
_10
"profile":"/gdc/account/profile/{profile_id}",
_10
"state":"/gdc/account/login/{profile_id}",
_10
"token":"{super_secured_token}"
_10
}
_10
}

SuperSecure Tokens (SST) have a default lifetime of two weeks.

(warning)

Warning

If you received a status code of 429, this means that you made too many invalid login requests. Check your credentials, and look for the Retry-After HTTP header in the response: this specifies the period (in seconds) after which you can attempt to log in again.


Retrieving the Temporary Token

retrieving-the-temporary-token page anchor

You must have a valid Temporary Token (TT) for all subsequent calls to the API. To get a valid TT, use the following API:

Flex Insights - Get Temporary Token

flex-insights---get-temporary-token page anchor
curl

_10
curl -X GET https://analytics.ytica.com/gdc/account/token \
_10
-H 'Accept: application/json' \
_10
-H 'Content-Type: application/json' \
_10
-H 'X-GDC-AuthSST: {super_secured_token}'

Output

_10
{
_10
"userToken":{
_10
"token":"{temporary_token}}"
_10
}
_10
}

If you are using a REST client which supports cookies, on the initial login request you can set "verify_level": 0 and use the returned cookie called GDCAuthTT (which contains the Temporary Token) directly in subsequent API calls. This way, you don't need to adjust the Header manually.

Temporary Token (TT) is valid for 10 minutes. Once the Temporary Token expires, you have to call the Token API to refresh it.


For any subsequent API calls, ensure that the TT is always passed in the headers as a cookie with the name GDCAuthTT

Flex Insights - Usage Example

flex-insights---usage-example page anchor

_10
curl -X GET https://analytics.ytica.com/gdc/{any_api} \
_10
-H 'Accept: application/json' \
_10
-H 'Content-Type: application/json' \
_10
-b '{temporary_token}}; path=/gdc; secure; HttpOnly'

After successful authentication you can Export Data from Flex Insights via API.


After you performed all necessary operations, you should log out to invalidate the SST. For this, you need to know your profile ID which can be found in the API Authentication response. Note the {profile_id} is only the last part (the alphanumeric string) of the userLogin "profile" object: /gdc/account/profile/{profile_id}.

Flex Insights - API Log out

flex-insights---api-log-out page anchor
curl

_10
_10
curl --location --request DELETE 'https://analytics.ytica.com/gdc/account/login/{profile_id}' \
_10
--header 'Accept: application/json' \
_10
--header 'Content-Type: application/json' \
_10
--header 'X-GDC-AuthSST: {super_secured_token}' \
_10
--header 'Cookie: GDCAuthTT=XXXXX-XXXXX-XXXXX'

Output

_10
204 No Content


If you no longer require access to the portal, you can delete your own profile from the Flex Insights Analytics Portal(link takes you to an external page). After that, you will no longer be able to access the Analytics Portal and the Insights API with your direct credentials, and your user account will be removed from all workspaces. To get started, retrieve your profile_id from the profile link in the user login JSON response during authentication:


_10
"profile":"/gdc/account/profile/{profile_id}"

Run the following command to perform the deletion:

Flex Insights - API Delete a User Profile

flex-insights---api-delete-a-user-profile page anchor
curl

_10
curl --location --request DELETE 'https://analytics.ytica.com/gdc/account/profile/{profile_id}' \
_10
--header 'Accept: application/json' \
_10
--header 'Content-Type: application/json' \
_10
--header 'X-GDC-AuthSST: {super_secured_token}' \
_10
--header 'Cookie: GDCAuthTT=XXXXX-XXXXX-XXXXX'

Output

_10
204 No Content

(warning)

Warning

Deleting a profile is only allowed for the currently logged in user. If you need to delete another user's profile, please contact Twilio Support.


Rate this page: