Analytics Suite (Jun 26, 2024, 2:54:36 PM)

Download OpenAPI specification:Download

Welcome to Synerise API Reference! We hope that you'll enjoy your stay here.

If you need help with our services, feel free to contact us at support@synerise.com.

Authentication

JWT

Synerise uses JSON Web Token (JWT) as the authorization method. The token is generated by the auth/login endpoint. You need to include it in the Authorization header of your requests, with a Bearer prefix. See this simplified example of a call:

curl -X GET https://api.synerise.com/v4/clients \
-H 'Accept: application/json' \
-H 'Api-Version: 4.4' \
-H 'Authorization: Bearer eyJhbGciOiJSzZXIiLCJjdGQiOjE1NTI0NjMzMjg4NjIsImF1dGgiOiJINHNJQUFBQUFBQUFBSXVPQlFBcHUwd05BZ0FBQUE9PSIsIm5tZSI' \
-H 'Content-Type: application/json'

Remember to include a space between Bearer and the token.

The token is valid for one hour (unless configured differently). You can request a refreshed key for the session by using the auth/refresh endpoint before the current token expires.

You can verify your JWT signature by using the public key.

Security Scheme Type HTTP
HTTP Authorization Scheme bearer

TrackerKey

Authorization by tracker key sent in a token query parameter. This may be the same key as used in the tracking code of the website. For details, see this article: https://help.synerise.com/developers/web/installation-and-configuration/#creating-a-tracking-code.

Security Scheme Type API Key
Query parameter name: token

Authorization

Methods to authorize and obtain JWT token required by our API endpoints

Refresh a Profile token

Retrieve a refreshed JWT Token to prolong the session.

The current token must still be active at the time of the request.


  • API consumers who can use this method: Profile (formerly client), Anonymous profile (formerly client)

  • This method does not require a Synerise authorization token.

Authorizations:
Request Body schema: application/json
apiKey
required
string

Profile API key

Responses

Request samples

Content type
application/json
{
  • "apiKey": "string"
}

Response samples

Content type
application/json
{
  • "token": "eyJhbGciOiinvalidI6IkFQSSIsInJsbSI6ImNsaWVudCIsImN0ZCI6MTUyODM1NTgzMjEzOCwiZW1sIjoia3J6eXN6dG9mLmN6ZXJlcGFrQGdtYWlsLmNvbSIsImlzcyI6IlN5bmVyaXNlIiwiYnBpIjo1OTQsImNsSWQiOjUyNTQ0NjU3NCwinvalidx2XwJp-QBZ94d_EEKf41KtDCE33KhP_vTAYrs-JzbnIHgKRvG6ZRwsNOL8OTnbfbUZH4XYaqBB_tZTPPKfzHutP6GEGp7PLtu2E92JbChkVyrn8VCQ5v4z2e1-zsdgbmWcQk2g9RydaydO6NYO55suT3Hz2ZRv0AYLsG8rM1biZGdREWx9OaknVVuIo2ivehBiukL7VQ6Bu8ugjep3mn-z666a-nCMh6ZuASiQ6Geq0NSWmdDQIoCa5Hg44KzMfGRlCR2uKBXeHTD0SkwJ1VJM0sHNKwSfMXKpaX8OJ5wUJpgCzDzQwKVgxgWFp4eO_sbcvxWrpI7W0lfdCy1WKirnZ6Uh3uJ06v97GQDAQqVgBZFEpS47MrGZhTNuAG4ZbfYO7yyxVO8AHQbEC-UvZ-8DC1XZjvQ6S1uNqQIlVGcthnrxg8K6vKVhNzu6ifQI0bbsCl8bGsKkXOEK1pKR3ekckcSjNeeY2LrcdXs8F2gtkm0TjXU"
}

Authenticate as Profile

Obtain a new JWT token for a Profile. If an account for the Profile does not exist and the identityProvider is different than SYNERISE, this request creates an account.

  • This method does not require a Synerise authorization token.
Request Body schema: application/json
apiKey
required
string

Profile API key

identityProvider
required
string
Enum: "SYNERISE" "FACEBOOK" "OAUTH" "APPLE" "GOOGLE" "UNKNOWN"

The identity provider.

identityProviderToken
string

Third-party authentication token used to authenticate with the Identity Provider. Required if identityProvider is different than SYNERISE.

email
string

Profile email. Required if identityProvider is SYNERISE and email is the unique identifier (default setting).

customId
any

Profile customId. Required if identityProvider is SYNERISE and customId is the unique identifier (see https://help.synerise.com/docs/settings/configuration/non-unique-emails/).

password
string

Profile password. Required if identityProvider is SYNERISE.

uuid
string

Profile UUID. Required if identityProvider is SYNERISE.

deviceId
string

Unique Android or iOS device ID

object

This object contains the marketing agreements of the Profile.

You can also pass the values as strings ("true";"True"/"false";"False") or integers (1 for true and 0 for false).

object

This object contains custom attributes that can have any name (except for reserved attributes, see warning below) and data type, as required by your integration.

The attribute names can't include any characters that match the patternn (ECMA flavor): /[\r\n\u2028\u2029\u00AD]/

If you want to send a date/time attribute for use in analytics, take the following into account:

  • The date/time should be formatted according to ISO 8601.
  • The time zone of the workspace affects dates/times in the attributes that DON'T have a defined timezone. Example:
    • 2023-10-09T12:00:00 doesn't have a timezone indicator and will be considered as a time in the workspace's time zone.
    • 2023-10-09T12:00:00+02:00 has a timezone indicator (+02:00), so the timezone of the workspace doesn't affect it.
    • 2023-10-09T12:00:00Z is a time in the UTC time zone (denoted by the Z at the end), so the timezone of the workspace doesn't affect it.

WARNING: Some attributes are reserved and cannot be sent. If you send them, they are ignored.

Click to expand the list of reserved attributes email
clientId
phone
customId
uuid
firstName
lastName
displayName
company
address
city
province
zipCode
countryCode
birthDate
sex
avatarUrl
anonymous
agreements
tags
businessProfileId
time
ip
source
newsletter_agreement
custom_identify
firstname
lastname
created
updated
last_activity_date
birthdate
external_avatar_url
displayname
receive_smses
receive_push_messages
receive_webpush_messages
receive_btooth_messages
receive_rfid_messages
receive_wifi_messages
confirmation_hash
ownerId
zipCode
anonymous_type
country_id
geo_loc_city
geo_loc_country
geo_loc_as
geo_loc_country_code
geo_loc_isp
geo_loc_lat
geo_loc_lon
geo_loc_org
geo_loc_query
geo_loc_region
geo_loc_region_name
geo_loc_status
geo_loc_timezone
geo_loc_zip
club_card_id
type
confirmed
facebookId
status
tags
Array of strings

Tags can be used to group profiles.

Responses

Request samples

Content type
application/json
{
  • "apiKey": "string",
  • "identityProvider": "SYNERISE",
  • "identityProviderToken": "string",
  • "email": "string",
  • "customId": null,
  • "password": "string",
  • "uuid": "string",
  • "deviceId": "string",
  • "agreements": {
    },
  • "attributes": {
    },
  • "tags": [
    ]
}

Response samples

Content type
application/json
{
  • "token": "eyJhbGciOiJSUzUxMiJ9.eyJzdinvalidwYmZkM2FkNDg2ZjQ3ZGRiMjE5MSIsImF1ZCI6IkFQSSIsInJsbSI6ImFub255bW91c19jbGllbnQiLCJjdGQiOjE1NTMwMDQxNTkxNTEsImVtbCI6IjYyMjM3NmY4LTAwMDAtMjIyMi1kN2Y5LTA3MGZhOTU2ZTk2M0Bhbm9ueW1vdXMuaW52YWxpZCIsImF1dGgiOiJINHNJQUFBQUFBQUFBSXVPQlFBcHUwd05BZ0FBQUE9PSIsImlzcyI6IlN5bmVyaXNlIiwiYnBpIjo0OCwiY2xJZCI6NDMzMjMwMjg4LCJleHAiOjE1NTMwMDcxNTksImFwayI6IjVBRUFBM0Q1LUUxNDctQzdFQi1ENTlFLUJDRjUwMTA5QTNEMSJ9.QOmSqrneR4mJFv4JdxTYsw_wGcDawDsVQuB-GVTcPPwijiP7lQ_Jzqq2Mypg1BS6WFlfGB8fzqCY9iMF_TdtjmoB4xBrY95ylU8L9qto-9Cw5x5TURkfxq31eryiHe2IteRAEtoVzYg2_s9QhlH6ANVcFOVp8dMno0V9bfMYfeSQa3FkjEbxFsseHkMOiADmp9-tOGtLXO942Ir-2W_Hz3Utlpt4erz0dVJBw8a-mFavPA8EEDWR7ACJNocrVHFkS3wFISh3LqLn6KkXiowaynKlJOEHGctuahzKmF3ZOJ1BvGgKohxF9OXvQs9IdmCfWhYsLr5Q2p04TJJ-MyvTipuggKVioh8mHmOFdfnN-Zused6tXzhZtKPUWTmM8cBKoAOBHExxcMQ8SVSjxnw_7_eLKm7S2wNpu0V-tiPZPCH4wYZXtWBYjmfy0V9ydjXnNunXfgxKixLeFNnONUXxEuqPLvM_xAuonQBXVN4nYrgJv8p8U6_ZlGMPjJq1szfcuBZnzI34LSEWx_nSof0XC5Czm8iG_ihG8naivNWS8h-Q-qKMP_3PPFsLSH4Egh03pH93EJUuNAeSO4RGfUX1wzMvrv1nBC1SM660uFMbq-wkplFBbKnHKMYe-qRs1-lZPG5PwPWJJdpGqOUzbnoMOJYmiq06OHHVQyJSkcEHLCk"
}

Authenticate as Profile (conditional)

Obtain a new JWT token for a Profile.

  • If the account does not exist, an account is not created.

  • If any additional conditions are required for logging in, the response is HTTP200 and lists the conditions.

  • Note that using this endpoint requires authenticating as an anonymous Profile first.

  • This method does not require a Synerise authorization token.

Authorizations:
Request Body schema: application/json
apiKey
required
string

Profile API key

identityProvider
required
string
Enum: "SYNERISE" "FACEBOOK" "OAUTH" "APPLE" "GOOGLE" "UNKNOWN"

The identity provider.

identityProviderToken
string

Third-party authentication token used to authenticate with the Identity Provider. Required if identityProvider is different than SYNERISE.

email
string

Profile email. Required if identityProvider is SYNERISE and email is the unique identifier (default setting).

customId
any

Profile customId. Required if identityProvider is SYNERISE and customId is the unique identifier (see https://help.synerise.com/docs/settings/configuration/non-unique-emails/).

password
string

Profile password. Required if identityProvider is SYNERISE.

uuid
string

Profile UUID. Required if identityProvider is SYNERISE.

deviceId
string

Unique Android or iOS device ID

object

This object contains the marketing agreements of the Profile.

You can also pass the values as strings ("true";"True"/"false";"False") or integers (1 for true and 0 for false).

object

This object contains custom attributes that can have any name (except for reserved attributes, see warning below) and data type, as required by your integration.

The attribute names can't include any characters that match the patternn (ECMA flavor): /[\r\n\u2028\u2029\u00AD]/

If you want to send a date/time attribute for use in analytics, take the following into account:

  • The date/time should be formatted according to ISO 8601.
  • The time zone of the workspace affects dates/times in the attributes that DON'T have a defined timezone. Example:
    • 2023-10-09T12:00:00 doesn't have a timezone indicator and will be considered as a time in the workspace's time zone.
    • 2023-10-09T12:00:00+02:00 has a timezone indicator (+02:00), so the timezone of the workspace doesn't affect it.
    • 2023-10-09T12:00:00Z is a time in the UTC time zone (denoted by the Z at the end), so the timezone of the workspace doesn't affect it.

WARNING: Some attributes are reserved and cannot be sent. If you send them, they are ignored.

Click to expand the list of reserved attributes email
clientId
phone
customId
uuid
firstName
lastName
displayName
company
address
city
province
zipCode
countryCode
birthDate
sex
avatarUrl
anonymous
agreements
tags
businessProfileId
time
ip
source
newsletter_agreement
custom_identify
firstname
lastname
created
updated
last_activity_date
birthdate
external_avatar_url
displayname
receive_smses
receive_push_messages
receive_webpush_messages
receive_btooth_messages
receive_rfid_messages
receive_wifi_messages
confirmation_hash
ownerId
zipCode
anonymous_type
country_id
geo_loc_city
geo_loc_country
geo_loc_as
geo_loc_country_code
geo_loc_isp
geo_loc_lat
geo_loc_lon
geo_loc_org
geo_loc_query
geo_loc_region
geo_loc_region_name
geo_loc_status
geo_loc_timezone
geo_loc_zip
club_card_id
type
confirmed
facebookId
status
tags
Array of strings

Tags can be used to group profiles.

Responses

Request samples

Content type
application/json
{
  • "apiKey": "string",
  • "identityProvider": "SYNERISE",
  • "identityProviderToken": "string",
  • "email": "string",
  • "customId": null,
  • "password": "string",
  • "uuid": "string",
  • "deviceId": "string",
  • "agreements": {
    },
  • "attributes": {
    },
  • "tags": [
    ]
}

Response samples

Content type
application/json
{
  • "conditions": [
    ],
  • "status": "SUCCESS",
  • "token": "string"
}

Authenticate anonymously

Obtain a new JWT for an anonymous Profile. The token can be used and refreshed in the same way as tokens of registered Profiles.

  • This method does not require a Synerise authorization token.
Request Body schema: application/json
apiKey
string

Profile API key (same as for Profile login)

deviceId
string

Unique Android or iOS device ID

uuid
string

UUID of the Profile. It is a unique identifier.

The value can't include any characters that match the patternn (ECMA flavor): /([\uD800-\uDBFF][\uDC00-\uDFFF])|([\r\n\u2028\u2029\u00AD])/

Responses

Request samples

Content type
application/json
{
  • "apiKey": "string",
  • "deviceId": "string",
  • "uuid": "07243772-008a-42e1-ba37-c3807cebde8f"
}

Response samples

Content type
application/json
{
  • "token": "eyJhbGciOiJSUzUxMiJ9.eyJzdinvalidwYmZkM2FkNDg2ZjQ3ZGRiMjE5MSIsImF1ZCI6IkFQSSIsInJsbSI6ImFub255bW91c19jbGllbnQiLCJjdGQiOjE1NTMwMDQxNTkxNTEsImVtbCI6IjYyMjM3NmY4LTAwMDAtMjIyMi1kN2Y5LTA3MGZhOTU2ZTk2M0Bhbm9ueW1vdXMuaW52YWxpZCIsImF1dGgiOiJINHNJQUFBQUFBQUFBSXVPQlFBcHUwd05BZ0FBQUE9PSIsImlzcyI6IlN5bmVyaXNlIiwiYnBpIjo0OCwiY2xJZCI6NDMzMjMwMjg4LCJleHAiOjE1NTMwMDcxNTksImFwayI6IjVBRUFBM0Q1LUUxNDctQzdFQi1ENTlFLUJDRjUwMTA5QTNEMSJ9.QOmSqrneR4mJFv4JdxTYsw_wGcDawDsVQuB-GVTcPPwijiP7lQ_Jzqq2Mypg1BS6WFlfGB8fzqCY9iMF_TdtjmoB4xBrY95ylU8L9qto-9Cw5x5TURkfxq31eryiHe2IteRAEtoVzYg2_s9QhlH6ANVcFOVp8dMno0V9bfMYfeSQa3FkjEbxFsseHkMOiADmp9-tOGtLXO942Ir-2W_Hz3Utlpt4erz0dVJBw8a-mFavPA8EEDWR7ACJNocrVHFkS3wFISh3LqLn6KkXiowaynKlJOEHGctuahzKmF3ZOJ1BvGgKohxF9OXvQs9IdmCfWhYsLr5Q2p04TJJ-MyvTipuggKVioh8mHmOFdfnN-Zused6tXzhZtKPUWTmM8cBKoAOBHExxcMQ8SVSjxnw_7_eLKm7S2wNpu0V-tiPZPCH4wYZXtWBYjmfy0V9ydjXnNunXfgxKixLeFNnONUXxEuqPLvM_xAuonQBXVN4nYrgJv8p8U6_ZlGMPjJq1szfcuBZnzI34LSEWx_nSof0XC5Czm8iG_ihG8naivNWS8h-Q-qKMP_3PPFsLSH4Egh03pH93EJUuNAeSO4RGfUX1wzMvrv1nBC1SM660uFMbq-wkplFBbKnHKMYe-qRs1-lZPG5PwPWJJdpGqOUzbnoMOJYmiq06OHHVQyJSkcEHLCk"
}

Log in as User

Authenticate as a User.

Note: To perform operations within a Workspace, you must select a Workspace.

  • This method does not require a Synerise authorization token.
Request Body schema: application/json
username
required
string

The login (email address) of the user

password
required
string

The user's password

deviceId
string

Identifier of user's current device

externalProviderToken
string
externalProviderType
string
Value: "GOOGLE"

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "password": "string",
  • "deviceId": "string",
  • "externalProviderToken": "string",
  • "externalProviderType": "GOOGLE"
}

Response samples

Content type
application/json
{
  • "consumer": {
    },
  • "token": "string"
}

Verify User multi-factor authentication

Authenticate as a User with multi-factor authentication.

Note: To perform operations within a Workspace, you must select a Workspace.


  • API consumer who can use this method: Synerise User

  • This method is available to all authenticated users, before and after multi-factor authentication is confirmed.

Authorizations:
query Parameters
mfaType
required
string
Enum: "TOTP_AUTHENTICATOR" "EMAIL"

Type of multi-factor authentication

Request Body schema: application/json
verificationCode
required
string

Multi-factor verification code

deviceId
string
externalProviderToken
string
externalProviderType
string
Value: "GOOGLE"

Responses

Request samples

Content type
application/json
{
  • "verificationCode": "string",
  • "deviceId": "string",
  • "externalProviderToken": "string",
  • "externalProviderType": "GOOGLE"
}

Response samples

Content type
application/json
{
  • "consumer": {
    },
  • "token": "string"
}

Select Workspace

After logging in as a User, select a Workspace where you want to perform operations.


  • API consumer who can use this method: Synerise User

  • This method is available to all fully-authenticated users (multifactor confirmation required, if enabled).

Authorizations:
path Parameters
businessProfileUUID
required
string <uuid>

UUID of the workspace

Responses

Request samples

curl --request POST 
  --url https://api.synerise.com/uauth/auth/login/user/profile/%7BbusinessProfileUUID%7D 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

Content type
application/json
{
  • "consumer": {
    },
  • "token": "string"
}

Get Workspaces

Retrieve a list of Workspaces available to the user.


  • API consumer who can use this method: Synerise User

  • This method is available to all fully-authenticated users (multifactor confirmation required, if enabled).

Authorizations:

Responses

Request samples

curl --request GET 
  --url https://api.synerise.com/uauth/business-profile/ 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

Content type
application/json
[
  • {
    }
]

Get current Workspace

Retrieve information about the currently selected workspace.


  • API consumer who can use this method: Synerise User

  • This method is available to all fully-authenticated users (multifactor confirmation required, if enabled).

Authorizations:

Responses

Request samples

curl --request GET 
  --url https://api.synerise.com/uauth/business-profile/current 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

Content type
application/json
{
  • "selected": true,
  • "data": {
    }
}

Log in as Workspace

Obtain a new Workspace JWT Token.

  • This method does not require a Synerise authorization token.
Request Body schema: application/json
apiKey
required
string

Workspace API key

WARNING: Workspace API keys can be used to access all customer data and manage the workspace. They should only be used for server-to-server communication in integrations. DO NOT use workspace API keys in your mobile applications or websites.

Responses

Request samples

Content type
application/json
{
  • "apiKey": "64c09614-1b2a-42f7-804d-f647243eb1ab"
}

Response samples

Content type
application/json
{
  • "token": "string"
}

Aggregates

Analyze event occurrences in a Profile context

Get aggregates

Retrieve a list of all aggregates in the Workspace.


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_LIST_AGGREGATE_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission groups which allow access to this method: ANALYTICS, CLIENT_ANALYTICS_PREVIEW

Authorizations:
query Parameters
offset
integer <int64>

Offset for pagination. The first item of the first page has the offset of 0.

page
integer <int32>

The number of the page to retrieve. The first page has the index 0. The indexes of the retrieved items are calculated from this parameter and the page size sent in size.

size
integer <int32>
Default: 20

The size of a page. The indexes of the retrieved items are calculated from this parameter and the page number sent in page.

sort
string
Enum: "name,asc" "name,desc" "isPredefinedAnalytic,asc" "isPredefinedAnalytic,desc" "isDynamicAnalytic,asc" "isDynamicAnalytic,desc" "created,asc" "created,desc" "title,asc" "title,desc"

Sorting order

namespaceName
string

Currently unused

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Responses

Request samples

curl --request GET 
  --url 'https://api.synerise.com/analytics-backend/analytics/definitions-manager/aggregates?offset=SOME_INTEGER_VALUE&page=SOME_INTEGER_VALUE&size=SOME_INTEGER_VALUE&sort=SOME_STRING_VALUE&namespaceName=SOME_STRING_VALUE' 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_' 
  --header 'Content-Type: SOME_STRING_VALUE'

Response samples

Content type
application/json;charset=UTF-8
{
  • "content": [
    ],
  • "pagination": {
    }
}

Add aggregate

Create a new aggregate analysis.


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_AGGREGATE_CREATE

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
query Parameters
namespaceName
string

Currently unused

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Request Body schema: application/json
required
object (Aggregate)

Structure of the analysis

isVisibleForClientProfile
required
boolean

When set to true, information about this analysis can be shown in a profile's card. In the Synerise CRM, only aggregates, segmentations, and expressions can be shown.

Responses

Request samples

Content type
application/json
{
  • "aggregate": {
    },
  • "isVisibleForClientProfile": true
}

Response samples

Content type
application/json
{
  • "httpStatus": 0,
  • "errorCode": "string",
  • "message": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "traceId": "string",
  • "help": "string"
}

Delete aggregates

Delete a number of aggregates. This operation is irreversible.


  • API consumer who can use this method: Synerise User

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_AGGREGATE_DELETE

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
query Parameters
ids
required
string <uuid>

A list of aggregates to delete, identified by UUID

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Responses

Request samples

curl --request DELETE 
  --url 'https://api.synerise.com/analytics-backend/analytics/definitions-manager/aggregates?ids=SOME_STRING_VALUE' 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_' 
  --header 'Content-Type: SOME_STRING_VALUE'

Response samples

Content type
application/json
{
  • "httpStatus": 0,
  • "errorCode": "string",
  • "message": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "traceId": "string",
  • "help": "string"
}

Search aggregates

Retrieve a list of aggregates that include a specified string in the title. Note that this is a POST request.


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_AGGREGATE_FILTER_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
query Parameters
offset
integer <int64>

Offset for pagination. The first item of the first page has the offset of 0.

page
integer <int32>

The number of the page to retrieve. The first page has the index 0. The indexes of the retrieved items are calculated from this parameter and the page size sent in size.

size
integer <int32>
Default: 20

The size of a page. The indexes of the retrieved items are calculated from this parameter and the page number sent in page.

sort
string
Enum: "name,asc" "name,desc" "isPredefinedAnalytic,asc" "isPredefinedAnalytic,desc" "isDynamicAnalytic,asc" "isDynamicAnalytic,desc" "created,asc" "created,desc" "title,asc" "title,desc"

Sorting order

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Request Body schema: application/json
title
required
string

A string to search for in the titles of analytics

Responses

Request samples

Content type
application/json
{
  • "title": "string"
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "content": [
    ],
  • "pagination": {
    }
}

Get aggregate projections

Retrieve a summary of all aggregates in the Workspace.


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_AGGREGATE_PROJECTION_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission groups which allow access to this method: ANALYTICS, CAMPAIGNS_RECOMMENDATIONS

Authorizations:
query Parameters
namespaceName
string

Currently unused

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Responses

Request samples

curl --request GET 
  --url 'https://api.synerise.com/analytics-backend/analytics/definitions-manager/aggregates/projections?namespaceName=SOME_STRING_VALUE' 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_' 
  --header 'Content-Type: SOME_STRING_VALUE'

Response samples

Content type
application/json;charset=UTF-8
[
  • {
    }
]

Get aggregate

Retrieve the details of a single aggregate.


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_AGGREGATE_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
UUID
required
string <uuid>

UUID of the analysis

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Responses

Request samples

curl --request GET 
  --url https://api.synerise.com/analytics-backend/analytics/definitions-manager/aggregates/%7BUUID%7D 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_' 
  --header 'Content-Type: SOME_STRING_VALUE'

Response samples

Content type
application/json;charset=UTF-8
{
  • "createdBy": {
    },
  • "modifiedBy": {
    },
  • "aggregate": {
    },
  • "name": "string",
  • "description": "string",
  • "deleted": true,
  • "isVisibleForClientProfile": true,
  • "variables": [
    ],
  • "isDynamicAnalytic": true,
  • "isPredefinedAnalytic": true,
  • "analyticVersion": "string"
}

Update aggregate

Update an existing aggregate.

WARNING: The aggregate object sent in this call overwrites the existing one. Any values (including params and filters) that are not included in the request body are deleted or set to default values.


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_AGGREGATE_UPDATE

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
UUID
required
string <uuid>

UUID of the analysis

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Request Body schema: application/json
required
object (Aggregate)

Structure of the analysis

isVisibleForClientProfile
required
boolean

When set to true, information about this analysis can be shown in a profile's card. In the Synerise CRM, only aggregates, segmentations, and expressions can be shown.

Responses

Request samples

Content type
application/json
{
  • "aggregate": {
    },
  • "isVisibleForClientProfile": true
}

Response samples

Content type
application/json
{
  • "httpStatus": 0,
  • "errorCode": "string",
  • "message": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "traceId": "string",
  • "help": "string"
}

Delete aggregate

Delete an aggregate. This operation is irreversible.


  • API consumer who can use this method: Synerise User

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_AGGREGATE_DELETE

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
UUID
required
string <uuid>

UUID of the analysis

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Responses

Request samples

curl --request DELETE 
  --url https://api.synerise.com/analytics-backend/analytics/definitions-manager/aggregates/%7BUUID%7D 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_' 
  --header 'Content-Type: SOME_STRING_VALUE'

Response samples

Content type
application/json
{
  • "httpStatus": 0,
  • "errorCode": "string",
  • "message": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "traceId": "string",
  • "help": "string"
}

Duplicate aggregate

Create a copy of an existing aggregate.


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_AGGREGATE_UPDATE

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
UUID
required
string <uuid>

UUID of the analysis

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Responses

Request samples

curl --request POST 
  --url https://api.synerise.com/analytics-backend/analytics/definitions-manager/aggregates/%7BUUID%7D/duplicate 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_' 
  --header 'Content-Type: SOME_STRING_VALUE'

Response samples

Content type
application/json
{
  • "httpStatus": 0,
  • "errorCode": "string",
  • "message": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "traceId": "string",
  • "help": "string"
}

Preview aggregate for profile

Preview the result of an aggregate in context of a single profile. This request does not save the analysis in the database.


  • API consumer who can use this method: Synerise User

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_AGGREGATE_FOR_CLIENT_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
clientId
required
integer

Profile ID

query Parameters
namespaceName
string

Currently unused

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Request Body schema: application/json
required
object (Aggregate)

Structure of the analysis

isVisibleForClientProfile
required
boolean

When set to true, information about this analysis can be shown in a profile's card. In the Synerise CRM, only aggregates, segmentations, and expressions can be shown.

Responses

Request samples

Content type
application/json
{
  • "aggregate": {
    },
  • "isVisibleForClientProfile": true
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "aggregateId": "71d8973e-d665-45f6-9260-c96cc190809b",
  • "aggregateUuid": "0beb7c8a-c781-42f8-b3ae-f2a33b0e6342",
  • "clientId": 0,
  • "title": "string",
  • "result": "string",
  • "variables": [
    ],
  • "dateFilter": {
    }
}

Calculate profile card aggregates

Calculate the results of aggregates visible on a profile card.


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_AGGREGATE_FOR_CLIENT_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission groups which allow access to this method: ANALYTICS, CLIENT_ANALYTICS_PREVIEW

Authorizations:
path Parameters
clientId
required
integer

Profile ID

query Parameters
namespaceName
string

Currently unused

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Responses

Request samples

curl --request GET 
  --url 'https://api.synerise.com/analytics-backend/analytics/definitions-manager/aggregates/clients/%7BclientId%7D/calculate?namespaceName=SOME_STRING_VALUE' 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_' 
  --header 'Content-Type: SOME_STRING_VALUE'

Response samples

Content type
application/json;charset=UTF-8
{
  • "content": [
    ],
  • "pagination": {
    }
}

Calculate Profile card aggregates as Profile

Calculate the results of aggregates visible on a profile card in context of the currently authenticated profile


  • API consumer who can use this method: Profile (formerly client)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_AGGREGATE_FOR_CLIENT_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission groups which allow access to this method: ANALYTICS, CLIENT_ANALYTICS_PREVIEW

Authorizations:
query Parameters
namespaceName
string

Currently unused

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Responses

Request samples

curl --request GET 
  --url 'https://api.synerise.com/analytics-backend/analytics/definitions-manager/aggregates/clients/calculate?namespaceName=SOME_STRING_VALUE' 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_' 
  --header 'Content-Type: SOME_STRING_VALUE'

Response samples

Content type
application/json;charset=UTF-8
{
  • "content": [
    ],
  • "pagination": {
    }
}

Calculate aggregate for profile

Calculate the results of an existing aggregate in context of a single profile.


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_AGGREGATE_FOR_CLIENT_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
UUID
required
string <uuid>

UUID of the analysis

clientId
required
integer

Profile ID

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Responses

Request samples

curl --request POST 
  --url https://api.synerise.com/analytics-backend/analytics/definitions-manager/aggregates/%7BUUID%7D/client/%7BclientId%7D/calculate 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_' 
  --header 'Content-Type: SOME_STRING_VALUE'

Response samples

Content type
application/json;charset=UTF-8
{
  • "aggregateId": "71d8973e-d665-45f6-9260-c96cc190809b",
  • "aggregateUuid": "0beb7c8a-c781-42f8-b3ae-f2a33b0e6342",
  • "clientId": 0,
  • "title": "string",
  • "result": "string",
  • "variables": [
    ],
  • "dateFilter": {
    }
}

Calculate aggregate for profile with period conditions

Calculate the results of an aggregate in context of a single profile. The results can be date-filtered and aggregated in time periods.


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_AGGREGATE_HISTOGRAM_FOR_CLIENT_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
UUID
required
string <uuid>

UUID of the analysis

clientId
required
integer

Profile ID

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Request Body schema: application/json
Array of objects[ items ]

A list of dynamically modifiable variables that occur in this analysis

Absolute (object) or Relative to current (object) or Relative/patterned (object) or Absolute/patterned (object)

Details of the date filter. The analysis results are calculated from data that matches the filter.

object

This object defines how to aggregate the data in an analysis.

Responses

Request samples

Content type
application/json
{
  • "variables": [
    ],
  • "dateFilter": {
    },
  • "aggregateDataBy": {
    }
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "items": [
    ],
  • "metadata": {
    }
}

Calculate aggregate as profile with period conditions

Calculate the results of an aggregate in context of the currently authenticated profile. The results can be date-filtered and aggregated in time periods.


  • API consumer who can use this method: Profile (formerly client)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_AGGREGATE_HISTOGRAM_FOR_CLIENT_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
UUID
required
string <uuid>

UUID of the analysis

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Request Body schema: application/json
Array of objects[ items ]

A list of dynamically modifiable variables that occur in this analysis

Absolute (object) or Relative to current (object) or Relative/patterned (object) or Absolute/patterned (object)

Details of the date filter. The analysis results are calculated from data that matches the filter.

object

This object defines how to aggregate the data in an analysis.

Responses

Request samples

Content type
application/json
{
  • "variables": [
    ],
  • "dateFilter": {
    },
  • "aggregateDataBy": {
    }
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "items": [
    ],
  • "metadata": {
    }
}

Calculate aggregate for profile with parameter override

In context of a single profile, calculate the results of a previously defined aggregate with custom filters.

This operation does not modify the original aggregate in any way.


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_AGGREGATE_FOR_CLIENT_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
UUID
required
string <uuid>

UUID of the analysis

clientId
required
integer

Profile ID

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Request Body schema: application/json
Absolute (object) or Relative to current (object) or Relative/patterned (object) or Absolute/patterned (object)

Details of the date filter. The analysis results are calculated from data that matches the filter.

object

This object defines how to aggregate the data in an analysis.

object

Profile filter. This allows you to limit the calculation to profiles which match certain criteria.

Array of objects[ items ]

A list of dynamically modifiable variables that occur in this analysis

Responses

Request samples

Content type
application/json
{
  • "dateFilter": {
    },
  • "aggregateDataBy": {
    },
  • "filter": {
    },
  • "variables": [
    ]
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "aggregateId": "71d8973e-d665-45f6-9260-c96cc190809b",
  • "aggregateUuid": "0beb7c8a-c781-42f8-b3ae-f2a33b0e6342",
  • "clientId": 0,
  • "title": "string",
  • "result": "string",
  • "variables": [
    ],
  • "dateFilter": {
    }
}

Calculate aggregate as profile

Calculate the results of an aggregate in context of the currently authenticated profile.


  • API consumer who can use this method: Profile (formerly client)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_AGGREGATE_FOR_CLIENT_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
UUID
required
string <uuid>

UUID of the analysis

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Responses

Request samples

curl --request POST 
  --url https://api.synerise.com/analytics-backend/analytics/definitions-manager/aggregates/%7BUUID%7D/client/calculate 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_' 
  --header 'Content-Type: SOME_STRING_VALUE'

Response samples

Content type
application/json;charset=UTF-8
{
  • "aggregateId": "71d8973e-d665-45f6-9260-c96cc190809b",
  • "aggregateUuid": "0beb7c8a-c781-42f8-b3ae-f2a33b0e6342",
  • "clientId": 0,
  • "title": "string",
  • "result": "string",
  • "variables": [
    ],
  • "dateFilter": {
    }
}

Calculate aggregate as profile with parameter override

Calculate the results of a previously defined aggregate with custom filters.

This operation does not modify the original aggregate in any way.


  • API consumer who can use this method: Profile (formerly client)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_AGGREGATE_FOR_CLIENT_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
UUID
required
string <uuid>

UUID of the analysis

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Request Body schema: application/json
Absolute (object) or Relative to current (object) or Relative/patterned (object) or Absolute/patterned (object)

Details of the date filter. The analysis results are calculated from data that matches the filter.

object

This object defines how to aggregate the data in an analysis.

object

Profile filter. This allows you to limit the calculation to profiles which match certain criteria.

Array of objects[ items ]

A list of dynamically modifiable variables that occur in this analysis

Responses

Request samples

Content type
application/json
{
  • "dateFilter": {
    },
  • "aggregateDataBy": {
    },
  • "filter": {
    },
  • "variables": [
    ]
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "aggregateId": "71d8973e-d665-45f6-9260-c96cc190809b",
  • "aggregateUuid": "0beb7c8a-c781-42f8-b3ae-f2a33b0e6342",
  • "clientId": 0,
  • "title": "string",
  • "result": "string",
  • "variables": [
    ],
  • "dateFilter": {
    }
}

Expressions

Create your own indicators based on mathematical formulas or calculations for profiles and events and use them as derived attributes

Get expressions

Retrieve a list of all expressions in the workspace.


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_LIST_EXPRESSION_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission groups which allow access to this method: ANALYTICS, CLIENT_ANALYTICS_PREVIEW

Authorizations:
query Parameters
filter
string
Default: "NONE"
Enum: "NONE" "CLIENT" "EVENT"

You can filter the results by expression type. NONE equals to "no filter".

offset
integer <int64>

Offset for pagination. The first item of the first page has the offset of 0.

page
integer <int32>

The number of the page to retrieve. The first page has the index 0. The indexes of the retrieved items are calculated from this parameter and the page size sent in size.

size
integer <int32>
Default: 20

The size of a page. The indexes of the retrieved items are calculated from this parameter and the page number sent in page.

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Responses

Request samples

curl --request GET 
  --url 'https://api.synerise.com/analytics-backend/analytics/definitions-manager/expressions?filter=SOME_STRING_VALUE&offset=SOME_INTEGER_VALUE&page=SOME_INTEGER_VALUE&size=SOME_INTEGER_VALUE' 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_' 
  --header 'Content-Type: SOME_STRING_VALUE'

Response samples

Content type
application/json;charset=UTF-8
{
  • "content": [
    ],
  • "pagination": {
    }
}

Add expression

Create a new expression.


  • API consumer who can use this method: Synerise User

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_EXPRESSION_CREATE

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
query Parameters
namespaceName
string

Currently unused

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Request Body schema: application/json
required
Event expression (object) or Profile attribute expression (object) (Expression)

Structure of the analysis

isVisibleForClientProfile
required
boolean

When set to true, information about this analysis can be shown in a profile's card. In the Synerise CRM, only aggregates, segmentations, and expressions can be shown.

Responses

Request samples

Content type
application/json
{
  • "analysis": {
    },
  • "isVisibleForClientProfile": true
}

Response samples

Content type
application/json
{
  • "httpStatus": 0,
  • "errorCode": "string",
  • "message": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "traceId": "string",
  • "help": "string"
}

Delete expressions

Delete a number of expressions. This operation is irreversible.


  • API consumer who can use this method: Synerise User

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_EXPRESSION_DELETE

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
query Parameters
ids
required
string <uuid>

A list of expressions to delete, identified by UUID

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Responses

Request samples

curl --request DELETE 
  --url 'https://api.synerise.com/analytics-backend/analytics/definitions-manager/expressions?ids=SOME_STRING_VALUE' 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_' 
  --header 'Content-Type: SOME_STRING_VALUE'

Response samples

Content type
application/json
{
  • "httpStatus": 0,
  • "errorCode": "string",
  • "message": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "traceId": "string",
  • "help": "string"
}

Search expressions

Retrieve a list of expressions that include a specified string in the title. Note that this is a POST request.


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_EXPRESSION_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
query Parameters
offset
integer <int64>

Offset for pagination. The first item of the first page has the offset of 0.

page
integer <int32>

The number of the page to retrieve. The first page has the index 0. The indexes of the retrieved items are calculated from this parameter and the page size sent in size.

size
integer <int32>
Default: 20

The size of a page. The indexes of the retrieved items are calculated from this parameter and the page number sent in page.

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Request Body schema: application/json
title
required
string

A string to search for in the titles of analytics

Responses

Request samples

Content type
application/json
{
  • "title": "string"
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "content": [
    ],
  • "pagination": {
    }
}

Get expression projections

Retrieve a summary of all expressions in the Workspace.


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_EXPRESSION_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission groups which allow access to this method: ANALYTICS, CAMPAIGNS_RECOMMENDATIONS

Authorizations:
query Parameters
filter
string
Default: "NONE"
Enum: "NONE" "CLIENT" "EVENT"

You can filter the results by expression type. NONE equals to "no filter".

namespaceName
string

Currently unused

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Responses

Request samples

curl --request GET 
  --url 'https://api.synerise.com/analytics-backend/analytics/definitions-manager/expressions/projections?filter=SOME_STRING_VALUE&namespaceName=SOME_STRING_VALUE' 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_' 
  --header 'Content-Type: SOME_STRING_VALUE'

Response samples

Content type
application/json;charset=UTF-8
[
  • {
    }
]

Get expression

Retrieve the details of a single expression.


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_EXPRESSION_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
UUID
required
string <uuid>

UUID of the analysis

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Responses

Request samples

curl --request GET 
  --url https://api.synerise.com/analytics-backend/analytics/definitions-manager/expressions/%7BUUID%7D 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_' 
  --header 'Content-Type: SOME_STRING_VALUE'

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "payload": {
    }
}

Update expression

Update an existing expression.

WARNING: The analysis object sent in this call overwrites the existing one. Any values (including params and filters) that are not included in the request body are deleted or set to default values.


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_EXPRESSION_UPDATE

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
UUID
required
string <uuid>

UUID of the analysis

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Request Body schema: application/json
required
Event expression (object) or Profile attribute expression (object) (Expression)

Structure of the analysis

isVisibleForClientProfile
required
boolean

When set to true, information about this analysis can be shown in a profile's card. In the Synerise CRM, only aggregates, segmentations, and expressions can be shown.

Responses

Request samples

Content type
application/json
{
  • "analysis": {
    },
  • "isVisibleForClientProfile": true
}

Response samples

Content type
application/json
{
  • "httpStatus": 0,
  • "errorCode": "string",
  • "message": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "traceId": "string",
  • "help": "string"
}

Delete expression

Delete an expression. This operation is irreversible.


  • API consumer who can use this method: Synerise User

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_EXPRESSION_DELETE

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
UUID
required
string <uuid>

UUID of the analysis

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Responses

Request samples

curl --request DELETE 
  --url https://api.synerise.com/analytics-backend/analytics/definitions-manager/expressions/%7BUUID%7D 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_' 
  --header 'Content-Type: SOME_STRING_VALUE'

Response samples

Content type
application/json
{
  • "httpStatus": 0,
  • "errorCode": "string",
  • "message": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "traceId": "string",
  • "help": "string"
}

Duplicate expression

Create a copy of an existing expression.


  • API consumer who can use this method: Synerise User

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_EXPRESSION_UPDATE

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
UUID
required
string <uuid>

UUID of the analysis

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Responses

Request samples

curl --request POST 
  --url https://api.synerise.com/analytics-backend/analytics/definitions-manager/expressions/%7BUUID%7D/duplicate 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_' 
  --header 'Content-Type: SOME_STRING_VALUE'

Response samples

Content type
application/json
{
  • "httpStatus": 0,
  • "errorCode": "string",
  • "message": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "traceId": "string",
  • "help": "string"
}

Preview expression

Preview the result of an expression in context of a profile. This request does not save the analysis in the database.


  • API consumer who can use this method: Synerise User

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_EXPRESSION_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
clientId
required
integer

Profile ID

query Parameters
namespaceName
string

Currently unused

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Request Body schema: application/json
required
Event expression (object) or Profile attribute expression (object) (Expression)

Structure of the analysis

isVisibleForClientProfile
required
boolean

When set to true, information about this analysis can be shown in a profile's card. In the Synerise CRM, only aggregates, segmentations, and expressions can be shown.

Responses

Request samples

Content type
application/json
{
  • "analysis": {
    },
  • "isVisibleForClientProfile": true
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "clientId": 0,
  • "expressionId": "98a623dd-0690-4acb-bbad-b1eda4955cc3",
  • "result": "string",
  • "title": "string",
  • "variables": [
    ]
}

Calculate profile card expressions

Calculate the results of expressions visible on a profile card.


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_EXPRESSION_FOR_CLIENT_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission groups which allow access to this method: ANALYTICS, CLIENT_ANALYTICS_PREVIEW

Authorizations:
path Parameters
clientId
required
integer

Profile ID

query Parameters
namespaceName
string

Currently unused

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Responses

Request samples

curl --request GET 
  --url 'https://api.synerise.com/analytics-backend/analytics/definitions-manager/expressions/clients/%7BclientId%7D/calculate?namespaceName=SOME_STRING_VALUE' 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_' 
  --header 'Content-Type: SOME_STRING_VALUE'

Response samples

Content type
application/json;charset=UTF-8
{
  • "content": [
    ],
  • "pagination": {
    }
}

Calculate expressions from card as profile

Calculate the results of expressions visible on a profile card in context of the currently authenticated profile.


  • API consumer who can use this method: Profile (formerly client)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_EXPRESSION_FOR_CLIENT_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission groups which allow access to this method: ANALYTICS, CLIENT_ANALYTICS_PREVIEW

Authorizations:
query Parameters
namespaceName
string

Currently unused

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Responses

Request samples

curl --request GET 
  --url 'https://api.synerise.com/analytics-backend/analytics/definitions-manager/expressions/clients/calculate?namespaceName=SOME_STRING_VALUE' 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_' 
  --header 'Content-Type: SOME_STRING_VALUE'

Response samples

Content type
application/json;charset=UTF-8
{
  • "content": [
    ],
  • "pagination": {
    }
}

Calculate expression for profile

Calculate the results of an existing expression in context of a single profile.


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_EXPRESSION_FOR_CLIENT_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
clientId
required
integer

Profile ID

UUID
required
string <uuid>

UUID of the analysis

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Responses

Request samples

curl --request GET 
  --url https://api.synerise.com/analytics-backend/analytics/definitions-manager/expressions/%7BUUID%7D/client/%7BclientId%7D/calculate 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_' 
  --header 'Content-Type: SOME_STRING_VALUE'

Response samples

Content type
application/json;charset=UTF-8
{
  • "clientId": 0,
  • "expressionId": "98a623dd-0690-4acb-bbad-b1eda4955cc3",
  • "result": "string",
  • "title": "string",
  • "variables": [
    ]
}

Calculate expression for profile with parameter override


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_EXPRESSION_FOR_CLIENT_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
clientId
required
integer

Profile ID

UUID
required
string <uuid>

UUID of the analysis

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Request Body schema: application/json
Absolute (object) or Relative to current (object) or Relative/patterned (object) or Absolute/patterned (object)

Details of the date filter. The analysis results are calculated from data that matches the filter.

object

This object defines how to aggregate the data in an analysis.

object

Profile filter. This allows you to limit the calculation to profiles which match certain criteria.

Array of objects[ items ]

A list of dynamically modifiable variables that occur in this analysis

Responses

Request samples

Content type
application/json
{
  • "dateFilter": {
    },
  • "aggregateDataBy": {
    },
  • "filter": {
    },
  • "variables": [
    ]
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "clientId": 0,
  • "expressionId": "98a623dd-0690-4acb-bbad-b1eda4955cc3",
  • "result": "string",
  • "title": "string",
  • "variables": [
    ]
}

Calculate expression as profile

Calculate the results of an expression in context of the currently authenticated profile.


  • API consumer who can use this method: Profile (formerly client)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_EXPRESSION_FOR_CLIENT_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
UUID
required
string <uuid>

UUID of the analysis

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Responses

Request samples

curl --request GET 
  --url https://api.synerise.com/analytics-backend/analytics/definitions-manager/expressions/%7BUUID%7D/client/calculate 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_' 
  --header 'Content-Type: SOME_STRING_VALUE'

Response samples

Content type
application/json;charset=UTF-8
{
  • "clientId": 0,
  • "expressionId": "98a623dd-0690-4acb-bbad-b1eda4955cc3",
  • "result": "string",
  • "title": "string",
  • "variables": [
    ]
}

Calculate expression as profile with parameter override

Calculate the results of a previously defined expression with custom filters.

This operation does not modify the original expression in any way.


  • API consumer who can use this method: Profile (formerly client)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_EXPRESSION_FOR_CLIENT_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
UUID
required
string <uuid>

UUID of the analysis

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Request Body schema: application/json
Absolute (object) or Relative to current (object) or Relative/patterned (object) or Absolute/patterned (object)

Details of the date filter. The analysis results are calculated from data that matches the filter.

object

This object defines how to aggregate the data in an analysis.

object

Profile filter. This allows you to limit the calculation to profiles which match certain criteria.

Array of objects[ items ]

A list of dynamically modifiable variables that occur in this analysis

Responses

Request samples

Content type
application/json
{
  • "dateFilter": {
    },
  • "aggregateDataBy": {
    },
  • "filter": {
    },
  • "variables": [
    ]
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "clientId": 0,
  • "expressionId": "98a623dd-0690-4acb-bbad-b1eda4955cc3",
  • "result": "string",
  • "title": "string",
  • "variables": [
    ]
}

Funnels

Follow a Profile journey step by step

Preview funnel

Preview the results of a funnel, with detailed information about transitions between steps. This request does not save the analysis in the database.


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_FUNNEL_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
query Parameters
namespaceName
string

Currently unused

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Request Body schema: application/json
required
object (Funnel)

Analytical conditions

Responses

Request samples

Content type
application/json
{
  • "analysis": {
    }
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "calculationResults": [
    ],
  • "metadata": {
    },
  • "timeBetweenSteps": [
    ]
}

Recalculate funnel with parameter override


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_FUNNEL_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
funnelId
required
string <uuid>

Funnel UUID

Request Body schema: application/json
title
string
dateFilter
string
object
filter
object
required
Array of objects[ items ]

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "dateFilter": "string",
  • "aggregateDataBy": {
    },
  • "filter": { },
  • "variables": [
    ]
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "calculationResults": [
    ],
  • "metadata": {
    },
  • "timeBetweenSteps": [
    ]
}

Get funnel


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_FUNNEL_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
funnelId
required
string <uuid>

Funnel UUID

Responses

Request samples

curl --request GET 
  --url https://api.synerise.com/analytics/analytics/v2/funnels/%7BfunnelId%7D 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "payload": {
    }
}

Delete funnel


  • API consumer who can use this method: Synerise User

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_FUNNEL_DELETE

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
funnelId
required
string <uuid>

Funnel UUID

Responses

Request samples

curl --request DELETE 
  --url https://api.synerise.com/analytics/analytics/v2/funnels/%7BfunnelId%7D 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

Content type
application/json
{
  • "path": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "errorCode": "string",
  • "status": 0,
  • "message": "string",
  • "traceId": "string"
}

Get funnels

Retrieve all funnels from the workspace.


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_FUNNELS_LIST_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
query Parameters
page
integer <int32>

The number of the page to retrieve. The first page has the index 0. The indexes of the retrieved items are calculated from this parameter and the page size sent in size.

size
integer <int32>
Default: 20

The size of a page. The indexes of the retrieved items are calculated from this parameter and the page number sent in page.

sort
string
Enum: "name,asc" "name,desc" "isPredefinedAnalytic,asc" "isPredefinedAnalytic,desc" "isDynamicAnalytic,asc" "isDynamicAnalytic,desc" "created,asc" "created,desc" "title,asc" "title,desc"

Sorting order

namespaceName
string

Currently unused

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Responses

Request samples

curl --request GET 
  --url 'https://api.synerise.com/analytics-backend/analytics/v2/funnels?page=SOME_INTEGER_VALUE&size=SOME_INTEGER_VALUE&sort=SOME_STRING_VALUE&namespaceName=SOME_STRING_VALUE' 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_' 
  --header 'Content-Type: SOME_STRING_VALUE'

Response samples

Content type
application/json;charset=UTF-8
{
  • "content": [
    ],
  • "pagination": {
    }
}

Add funnel

Create a new funnel.


  • API consumer who can use this method: Synerise User

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_FUNNEL_CREATE

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
query Parameters
namespaceName
string

Currently unused

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Request Body schema: application/json
required
object (Funnel)

Analytical conditions

Responses

Request samples

Content type
application/json
{
  • "analysis": {
    }
}

Response samples

Content type
application/json
{
  • "httpStatus": 0,
  • "errorCode": "string",
  • "message": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "traceId": "string",
  • "help": "string"
}

Get funnel projections

Retrieve a summary of all funnels in the Workspace.


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_FUNNEL_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
query Parameters
mergeParams
boolean
Default: false

When true, the information about variables in a dynamic analysis is more detailed (if additional information is available for the analysis) and all dynamic parameters are listed separately. When false, repeating parameters are grouped into one instance.

namespaceName
string

Currently unused

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Responses

Request samples

curl --request GET 
  --url 'https://api.synerise.com/analytics-backend/analytics/v2/funnels/projections?mergeParams=SOME_BOOLEAN_VALUE&namespaceName=SOME_STRING_VALUE' 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_' 
  --header 'Content-Type: SOME_STRING_VALUE'

Response samples

Content type
application/json;charset=UTF-8
[
  • {
    }
]

Search funnels

Retrieve a list of funnels that include a specified string in the title. Note that this is a POST request.


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_FUNNEL_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
query Parameters
page
integer <int32>

The number of the page to retrieve. The first page has the index 0. The indexes of the retrieved items are calculated from this parameter and the page size sent in size.

size
integer <int32>
Default: 20

The size of a page. The indexes of the retrieved items are calculated from this parameter and the page number sent in page.

sort
string
Enum: "name,asc" "name,desc" "isPredefinedAnalytic,asc" "isPredefinedAnalytic,desc" "isDynamicAnalytic,asc" "isDynamicAnalytic,desc" "created,asc" "created,desc" "title,asc" "title,desc"

Sorting order

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Request Body schema: application/json
title
required
string

A string to search for in the titles of analytics

Responses

Request samples

Content type
application/json
{
  • "title": "string"
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "content": [
    ],
  • "pagination": {
    }
}

Get funnel

Retrieve the details of a single funnel.


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_FUNNEL_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
UUID
required
string <uuid>

UUID of the analysis

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Responses

Request samples

curl --request GET 
  --url https://api.synerise.com/analytics-backend/analytics/v2/funnels/%7BUUID%7D 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_' 
  --header 'Content-Type: SOME_STRING_VALUE'

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "string",
  • "payload": {
    }
}

Update funnel

Update an existing funnel.

WARNING: The analysis object sent in this call overwrites the existing one. Any values (including steps and filters) that are not included in the request body are deleted or set to default values.


  • API consumer who can use this method: Synerise User

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_FUNNEL_UPDATE

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
UUID
required
string <uuid>

UUID of the analysis

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Request Body schema: application/json
required
object (Funnel)

Analytical conditions

Responses

Request samples

Content type
application/json
{
  • "analysis": {
    }
}

Response samples

Content type
application/json
{
  • "httpStatus": 0,
  • "errorCode": "string",
  • "message": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "traceId": "string",
  • "help": "string"
}

Delete funnel

Delete a funnel. This operation is irreversible.


  • API consumer who can use this method: Synerise User

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_FUNNEL_DELETE

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
UUID
required
string <uuid>

UUID of the analysis

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Responses

Request samples

curl --request DELETE 
  --url https://api.synerise.com/analytics-backend/analytics/v2/funnels/%7BUUID%7D 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_' 
  --header 'Content-Type: SOME_STRING_VALUE'

Response samples

Content type
application/json
{
  • "httpStatus": 0,
  • "errorCode": "string",
  • "message": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "traceId": "string",
  • "help": "string"
}

Duplicate funnel

Create a copy of an existing funnel.


  • API consumer who can use this method: Synerise User

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_FUNNEL_UPDATE

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
UUID
required
string <uuid>

UUID of the analysis

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Responses

Request samples

curl --request POST 
  --url https://api.synerise.com/analytics-backend/analytics/v2/funnels/%7BUUID%7D/duplicate 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_' 
  --header 'Content-Type: SOME_STRING_VALUE'

Response samples

Content type
application/json
{
  • "httpStatus": 0,
  • "errorCode": "string",
  • "message": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "traceId": "string",
  • "help": "string"
}

Calculate dynamic funnel

Calculate the results of a funnel by applying new values to dynamic variables in the funnel. This operation does not modify the original funnel in any way.


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_FUNNEL_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
UUID
required
string <uuid>

UUID of the analysis

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Request Body schema: application/json
Array of objects[ items ]

A list of dynamically modifiable variables that occur in this analysis

Responses

Request samples

Content type
application/json
{
  • "variables": [
    ]
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "calculationResults": [
    ],
  • "metadata": {
    },
  • "timeBetweenSteps": [
    ]
}

Recalculate funnel

Use this endpoint to quickly retrieve the results of a previously defined funnel.


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_FUNNEL_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
UUID
required
string <uuid>

UUID of the analysis

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Responses

Request samples

curl --request POST 
  --url https://api.synerise.com/analytics-backend/analytics/v2/funnels/%7BUUID%7D/recalculate 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_' 
  --header 'Content-Type: SOME_STRING_VALUE'

Response samples

Content type
application/json;charset=UTF-8
{
  • "calculationResults": [
    ],
  • "metadata": {
    },
  • "timeBetweenSteps": [
    ]
}

Recalculate funnel with parameter override

Calculate the results of a previously defined funnel with custom date and/or profile filters.

This operation does not modify the original funnel in any way.


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_FUNNEL_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
UUID
required
string <uuid>

UUID of the analysis

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Request Body schema: application/json
Absolute (object) or Relative to current (object) or Relative/patterned (object) or Absolute/patterned (object)

Details of the date filter. The analysis results are calculated from data that matches the filter.

object

This object defines how to aggregate the data in an analysis.

object

Profile filter. This allows you to limit the calculation to profiles which match certain criteria.

Array of objects[ items ]

A list of dynamically modifiable variables that occur in this analysis

Responses

Request samples

Content type
application/json
{
  • "dateFilter": {
    },
  • "aggregateDataBy": {
    },
  • "filter": {
    },
  • "variables": [
    ]
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "calculationResults": [
    ],
  • "metadata": {
    },
  • "timeBetweenSteps": [
    ]
}

Histograms

Used to compare the values of different metrics within specific time intervals

Get histograms

Retrieve a list of all histograms in the workspace


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_HISTOGRAMS_LIST_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
query Parameters
asProjections
boolean
Default: false

When set to true, the histograms are retrieved in a simplified form (the analysis object is null).

offset
integer <int64>

Offset for pagination. The first item of the first page has the offset of 0.

page
integer <int32>

The number of the page to retrieve. The first page has the index 0. The indexes of the retrieved items are calculated from this parameter and the page size sent in size.

size
integer <int32>
Default: 20

The size of a page. The indexes of the retrieved items are calculated from this parameter and the page number sent in page.

sort
string
Enum: "name,asc" "name,desc" "isPredefinedAnalytic,asc" "isPredefinedAnalytic,desc" "isDynamicAnalytic,asc" "isDynamicAnalytic,desc" "created,asc" "created,desc" "title,asc" "title,desc"

Sorting order

namespaceName
string

Currently unused

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Responses

Request samples

curl --request GET 
  --url 'https://api.synerise.com/analytics-backend/analytics/v2/metrics/histograms?asProjections=SOME_BOOLEAN_VALUE&offset=SOME_INTEGER_VALUE&page=SOME_INTEGER_VALUE&size=SOME_INTEGER_VALUE&sort=SOME_STRING_VALUE&namespaceName=SOME_STRING_VALUE' 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_' 
  --header 'Content-Type: SOME_STRING_VALUE'

Response samples

Content type
application/json;charset=UTF-8
{
  • "content": [
    ],
  • "pagination": {
    }
}

Create histogram

Create a new histogram.


  • API consumer who can use this method: Synerise User

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_HISTOGRAM_CREATE

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
query Parameters
namespaceName
string

Currently unused

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Request Body schema: application/json
required
object (Histogram)

Structure of the analysis

Responses

Request samples

Content type
application/json
{
  • "analysis": {
    }
}

Response samples

Content type
application/json
{
  • "httpStatus": 0,
  • "errorCode": "string",
  • "message": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "traceId": "string",
  • "help": "string"
}

Search histograms

Retrieve a list of histograms that include a specified string in the title. Note that this is a POST request.


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_HISTOGRAM_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
query Parameters
offset
integer <int64>

Offset for pagination. The first item of the first page has the offset of 0.

page
integer <int32>

The number of the page to retrieve. The first page has the index 0. The indexes of the retrieved items are calculated from this parameter and the page size sent in size.

size
integer <int32>
Default: 20

The size of a page. The indexes of the retrieved items are calculated from this parameter and the page number sent in page.

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Request Body schema: application/json
title
required
string

A string to search for in the titles of analytics

Responses

Request samples

Content type
application/json
{
  • "title": "string"
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "content": [
    ],
  • "pagination": {
    }
}

Preview histogram

Preview the results of a histogram. This request does not save the analysis in the database.


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_HISTOGRAM_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
query Parameters
namespaceName
string

Currently unused

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Request Body schema: application/json
required
object (Histogram)

Structure of the analysis

Responses

Request samples

Content type
application/json
{
  • "analysis": {
    }
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "items": [
    ],
  • "legends": [
    ],
  • "metadata": {
    }
}

Get histogram

Retrieve the details of a single histogram.


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_HISTOGRAM_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
UUID
required
string <uuid>

UUID of the analysis

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Responses

Request samples

curl --request GET 
  --url https://api.synerise.com/analytics-backend/analytics/v2/metrics/histograms/%7BUUID%7D 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_' 
  --header 'Content-Type: SOME_STRING_VALUE'

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "payload": {
    }
}

Update histogram

Update an existing histogram.

WARNING: The analysis object sent in this call overwrites the existing one. Any values (including analytical conditions and filters) that are not included in the request body are deleted or set to default values.


  • API consumer who can use this method: Synerise User

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_HISTOGRAM_UPDATE

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
UUID
required
string <uuid>

UUID of the analysis

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Request Body schema: application/json
required
object (Histogram)

Structure of the analysis

Responses

Request samples

Content type
application/json
{
  • "analysis": {
    }
}

Response samples

Content type
application/json
{
  • "httpStatus": 0,
  • "errorCode": "string",
  • "message": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "traceId": "string",
  • "help": "string"
}

Delete histogram

Delete a histogram. This operation is irreversible.


  • API consumer who can use this method: Synerise User

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_HISTOGRAM_DELETE

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
UUID
required
string <uuid>

UUID of the analysis

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Responses

Request samples

curl --request DELETE 
  --url https://api.synerise.com/analytics-backend/analytics/v2/metrics/histograms/%7BUUID%7D 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_' 
  --header 'Content-Type: SOME_STRING_VALUE'

Response samples

Content type
application/json
{
  • "httpStatus": 0,
  • "errorCode": "string",
  • "message": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "traceId": "string",
  • "help": "string"
}

Duplicate histogram

Create a copy of an existing histogram.


  • API consumer who can use this method: Synerise User

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_HISTOGRAM_UPDATE

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
UUID
required
string <uuid>

UUID of the analysis

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Responses

Request samples

curl --request POST 
  --url https://api.synerise.com/analytics-backend/analytics/v2/metrics/histograms/%7BUUID%7D/duplicate 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_' 
  --header 'Content-Type: SOME_STRING_VALUE'

Response samples

Content type
application/json
{
  • "httpStatus": 0,
  • "errorCode": "string",
  • "message": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "traceId": "string",
  • "help": "string"
}

Recalculate histogram

Use this endpoint to quickly retrieve the results of a previously defined histogram.


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_HISTOGRAM_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
UUID
required
string <uuid>

UUID of the analysis

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Responses

Request samples

curl --request POST 
  --url https://api.synerise.com/analytics-backend/analytics/v2/metrics/histograms/%7BUUID%7D/recalculate 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_' 
  --header 'Content-Type: SOME_STRING_VALUE'

Response samples

Content type
application/json;charset=UTF-8
{
  • "items": [
    ],
  • "legends": [
    ],
  • "metadata": {
    }
}

Recalculate histogram with parameter override

Calculate the results of a previously defined histogram with custom date and/or profile filters.

This operation does not modify the original histogram in any way.


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_HISTOGRAM_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
UUID
required
string <uuid>

UUID of the analysis

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Request Body schema: application/json
Absolute (object) or Relative to current (object) or Relative/patterned (object) or Absolute/patterned (object)

Details of the date filter. The analysis results are calculated from data that matches the filter.

object

This object defines how to aggregate the data in an analysis.

object

Profile filter. This allows you to limit the calculation to profiles which match certain criteria.

Array of objects[ items ]

A list of dynamically modifiable variables that occur in this analysis

Responses

Request samples

Content type
application/json
{
  • "dateFilter": {
    },
  • "aggregateDataBy": {
    },
  • "filter": {
    },
  • "variables": [
    ]
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "items": [
    ],
  • "legends": [
    ],
  • "metadata": {
    }
}

Metrics

Metrics let you create your own indicators based on mathematical formulas or calculations of the events you analyze in Synerise

Get metrics


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_METRICS_LIST_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
query Parameters
page
integer <int32>

The number of the page to retrieve. The first page has the index 0. The indexes of the retrieved items are calculated from this parameter and the page size sent in size.

size
integer <int32>
Default: 20

The size of a page. The indexes of the retrieved items are calculated from this parameter and the page number sent in page.

namespaceName
string

Currently unused

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Responses

Request samples

curl --request GET 
  --url 'https://api.synerise.com/analytics-backend/analytics/v3/metrics?page=SOME_INTEGER_VALUE&size=SOME_INTEGER_VALUE&namespaceName=SOME_STRING_VALUE' 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_' 
  --header 'Content-Type: SOME_STRING_VALUE'

Response samples

Content type
application/json;charset=UTF-8
{
  • "content": [
    ],
  • "pagination": {
    }
}

Add metric

Create a new metric.


  • API consumer who can use this method: Synerise User

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_METRIC_CREATE

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
query Parameters
namespaceName
string

Currently unused

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Request Body schema: application/json
required
object (Metric)

Structure of the analytical query

Responses

Request samples

Content type
application/json
{
  • "analysis": {
    }
}

Response samples

Content type
application/json
{
  • "httpStatus": 0,
  • "errorCode": "string",
  • "message": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "traceId": "string",
  • "help": "string"
}

Calculate all metrics

Calculate all metrics from the workspace


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_METRICS_LIST_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
query Parameters
page
integer <int32>

The number of the page to retrieve. The first page has the index 0. The indexes of the retrieved items are calculated from this parameter and the page size sent in size.

size
integer <int32>
Default: 20

The size of a page. The indexes of the retrieved items are calculated from this parameter and the page number sent in page.

namespaceName
string

Currently unused

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Responses

Request samples

curl --request GET 
  --url 'https://api.synerise.com/analytics-backend/analytics/v3/metrics/calculate?page=SOME_INTEGER_VALUE&size=SOME_INTEGER_VALUE&namespaceName=SOME_STRING_VALUE' 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_' 
  --header 'Content-Type: SOME_STRING_VALUE'

Response samples

Content type
application/json;charset=UTF-8
{
  • "content": [
    ],
  • "pagination": {
    }
}

Search metrics

Retrieve a list of metrics that include a specified string in the title. Note that this is a POST request.


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_METRIC_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
query Parameters
page
integer <int32>

The number of the page to retrieve. The first page has the index 0. The indexes of the retrieved items are calculated from this parameter and the page size sent in size.

size
integer <int32>
Default: 20

The size of a page. The indexes of the retrieved items are calculated from this parameter and the page number sent in page.

sort
string
Enum: "name,asc" "name,desc" "isPredefinedAnalytic,asc" "isPredefinedAnalytic,desc" "isDynamicAnalytic,asc" "isDynamicAnalytic,desc" "created,asc" "created,desc" "title,asc" "title,desc"

Sorting order

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Request Body schema: application/json
title
required
string

A string to search for in the titles of analytics

Responses

Request samples

Content type
application/json
{
  • "title": "string"
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "content": [
    ],
  • "pagination": {
    }
}

Preview metric

Preview the results of a metric. This request does not save the analysis in the database.


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_METRIC_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
query Parameters
namespaceName
string

Currently unused

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Request Body schema: application/json
required
object (Metric)

Structure of the analytical query

Responses

Request samples

Content type
application/json
{
  • "analysis": {
    }
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "result": 0,
  • "metricData": {
    }
}

Get metric projections

Retrieve a summary of all metrics in the Workspace


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_METRIC_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
query Parameters
mergeParams
boolean
Default: false

When true, the information about variables in a dynamic analysis is more detailed (if additional information is available for the analysis) and all dynamic parameters are listed separately. When false, repeating parameters are grouped into one instance.

namespaceName
string

Currently unused

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Responses

Request samples

curl --request GET 
  --url 'https://api.synerise.com/analytics-backend/analytics/v3/metrics/projections?mergeParams=SOME_BOOLEAN_VALUE&namespaceName=SOME_STRING_VALUE' 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_' 
  --header 'Content-Type: SOME_STRING_VALUE'

Response samples

Content type
application/json;charset=UTF-8
[
  • {
    }
]

Get social proof metrics

Retrieve a list of metrics that include exactly one dynamic variable.


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_METRIC_SOCIAL_PROOF_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Responses

Request samples

curl --request GET 
  --url https://api.synerise.com/analytics-backend/analytics/v3/metrics/social-proof 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_' 
  --header 'Content-Type: SOME_STRING_VALUE'

Response samples

Content type
application/json;charset=UTF-8
[
  • {
    }
]

Get metric query

Retrieve an escaped analytical query that can be used in requests to other services.


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_METRIC_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
UUID
required
string <uuid>

UUID of the analysis

query Parameters
mustContainSingleVariable
boolean
Default: false

You can use this parameter to check if the requested analysis contains exactly one variable (such a metric can be used for social proof analytics). If set to true and the requested analysis contains more than one variable (or zero variables), the response is an error 404 with a message informing you that the number of variables is other than one.

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Responses

Request samples

curl --request GET 
  --url 'https://api.synerise.com/analytics-backend/analytics/v3/metrics/translated/%7BUUID%7D?mustContainSingleVariable=SOME_BOOLEAN_VALUE' 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_' 
  --header 'Content-Type: SOME_STRING_VALUE'

Response samples

Content type
application/json;charset=UTF-8
{
  • "query": "{\"businessProfileId\":48,\"runningAggregates\":[],\"segmentations\":[],\"variables\":[],\"aggregates\":[],\"clientExpressions\":[],\"eventExpressions\":[],\"dateFilters\":[],\"timeZone\":\"Europe/Warsaw\",\"clientMetrics\":[{\"type\":\"COUNT\",\"attribute\":{\"type\":\"EMPTY\"},\"filter\":{\"matching\":true,\"expression\":null}},{\"type\":\"COUNT\",\"attribute\":{\"type\":\"EMPTY\"},\"filter\":{\"matching\":true,\"expression\":null}}],\"eventMetrics\":[{\"type\":\"COUNT\",\"attribute\":{\"type\":\"EMPTY\"},\"filter\":{\"matching\":true,\"expression\":null},\"dateFilter\":{\"type\":\"ABSOLUTE\",\"from\":\"2019-08-25T08:35:29.066Z\",\"to\":\"2019-09-25T08:35:29.066Z\"},\"expressions\":[],\"actionId\":0,\"occurrenceType\":\"ALL\"}]}"
}

Get metric

Retrieve the details of a single metric.


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_METRIC_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
UUID
required
string <uuid>

UUID of the analysis

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Responses

Request samples

curl --request GET 
  --url https://api.synerise.com/analytics-backend/analytics/v3/metrics/%7BUUID%7D 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_' 
  --header 'Content-Type: SOME_STRING_VALUE'

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "payload": {
    }
}

Update metric

Update an existing metric.

WARNING: The analysis object sent in this call overwrites the existing one. Any values (including expressions and filters) that are not included in the request body are deleted or set to default values.


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_METRIC_UPDATE

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
UUID
required
string <uuid>

UUID of the analysis

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Request Body schema: application/json
required
object (Metric)

Structure of the analytical query

Responses

Request samples

Content type
application/json
{
  • "analysis": {
    }
}

Response samples

Content type
application/json
{
  • "httpStatus": 0,
  • "errorCode": "string",
  • "message": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "traceId": "string",
  • "help": "string"
}

Delete metric

Delete a metric. This operation is irreversible.


  • API consumer who can use this method: Synerise User

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_METRIC_DELETE

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
UUID
required
string <uuid>

UUID of the analysis

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Responses

Request samples

curl --request DELETE 
  --url https://api.synerise.com/analytics-backend/analytics/v3/metrics/%7BUUID%7D 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_' 
  --header 'Content-Type: SOME_STRING_VALUE'

Response samples

Content type
application/json
{
  • "httpStatus": 0,
  • "errorCode": "string",
  • "message": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "traceId": "string",
  • "help": "string"
}

Duplicate metric

Create a copy of an existing metric.


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_METRIC_UPDATE

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
UUID
required
string <uuid>

UUID of the analysis

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Responses

Request samples

curl --request POST 
  --url https://api.synerise.com/analytics-backend/analytics/v3/metrics/%7BUUID%7D/duplicate 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_' 
  --header 'Content-Type: SOME_STRING_VALUE'

Response samples

Content type
application/json
{
  • "httpStatus": 0,
  • "errorCode": "string",
  • "message": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "traceId": "string",
  • "help": "string"
}

Calculate dynamic metric

Calculate the results of a metric by applying new values to dynamic variables in the metric. This operation does not modify the original metric in any way.


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_METRIC_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
UUID
required
string <uuid>

UUID of the analysis

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Request Body schema: application/json
Array of objects[ items ]

A list of dynamically modifiable variables that occur in this analysis

Responses

Request samples

Content type
application/json
{
  • "variables": [
    ]
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "result": 0,
  • "metricData": {
    }
}

Recalculate metric

Use this endpoint to quickly retrieve the results of a previously defined metric.


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_METRIC_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
UUID
required
string <uuid>

UUID of the analysis

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Responses

Request samples

curl --request POST 
  --url https://api.synerise.com/analytics-backend/analytics/v3/metrics/%7BUUID%7D/recalculate 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_' 
  --header 'Content-Type: SOME_STRING_VALUE'

Response samples

Content type
application/json;charset=UTF-8
{
  • "result": 0,
  • "metricData": {
    }
}

Recalculate metric with parameter override

Calculate the results of a previously defined metric with custom date and/or profile filters.

This operation does not modify the original metric in any way.


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_METRIC_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
UUID
required
string <uuid>

UUID of the analysis

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Request Body schema: application/json
Absolute (object) or Relative to current (object) or Relative/patterned (object) or Absolute/patterned (object)

Details of the date filter. The analysis results are calculated from data that matches the filter.

object

This object defines how to aggregate the data in an analysis.

object

Profile filter. This allows you to limit the calculation to profiles which match certain criteria.

Array of objects[ items ]

A list of dynamically modifiable variables that occur in this analysis

Responses

Request samples

Content type
application/json
{
  • "dateFilter": {
    },
  • "aggregateDataBy": {
    },
  • "filter": {
    },
  • "variables": [
    ]
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "result": 0,
  • "metricData": {
    }
}

Metrics for recommendations

Endpoints useful when including metrics in AI requests

Check available metrics (recommendations)

Returns metrics available for the Workspace. The metrics can be used when defining boostMetric and sortMetric query parameters in recommendations and in metric-based recommendations.


  • API consumers who can use this method: Workspace (formerly Business Profile), Synerise User

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: METRICS_RECOMMENDATIONS_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: CAMPAIGNS_RECOMMENDATIONS

Authorizations:

Responses

Request samples

curl --request GET 
  --url https://api.synerise.com/metrics/v2/available 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve IDs of available metrics (recommendations)

Returns IDs of metrics that are available for the Workspace. The metrics can be used when defining boostMetric and sortMetric query parameters in recommendations and in metric-based recommendations.


  • API consumers who can use this method: Workspace (formerly Business Profile), Synerise User

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: METRICS_RECOMMENDATIONS_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: CAMPAIGNS_RECOMMENDATIONS

Authorizations:

Responses

Request samples

curl --request GET 
  --url https://api.synerise.com/metrics/v2/available-ids 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

Content type
application/json
[
  • "string"
]

Reports

A report is a visual presentation of data aspects contained in metrics

Get reports

Retrieve all reports from the workspace.


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_REPORTS_LIST_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
query Parameters
offset
integer <int64>

Offset for pagination. The first item of the first page has the offset of 0.

page
integer <int32>

The number of the page to retrieve. The first page has the index 0. The indexes of the retrieved items are calculated from this parameter and the page size sent in size.

size
integer <int32>
Default: 20

The size of a page. The indexes of the retrieved items are calculated from this parameter and the page number sent in page.

sort
string
Enum: "name,asc" "name,desc" "isPredefinedAnalytic,asc" "isPredefinedAnalytic,desc" "isDynamicAnalytic,asc" "isDynamicAnalytic,desc" "created,asc" "created,desc" "title,asc" "title,desc"

Sorting order

namespaceName
string

Currently unused

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Responses

Request samples

curl --request GET 
  --url 'https://api.synerise.com/analytics-backend/analytics/v4/reports?offset=SOME_INTEGER_VALUE&page=SOME_INTEGER_VALUE&size=SOME_INTEGER_VALUE&sort=SOME_STRING_VALUE&namespaceName=SOME_STRING_VALUE' 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_' 
  --header 'Content-Type: SOME_STRING_VALUE'

Response samples

Content type
application/json;charset=UTF-8
{
  • "content": [
    ],
  • "pagination": {
    }
}

Create report

Create a new report.


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_REPORT_CREATE

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
query Parameters
namespaceName
string

Currently unused

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Request Body schema: application/json
required
object (Report v2)

Structure of the analytical query

Responses

Request samples

Content type
application/json
{
  • "analysis": {
    }
}

Response samples

Content type
application/json
{
  • "httpStatus": 0,
  • "errorCode": "string",
  • "message": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "traceId": "string",
  • "help": "string"
}

Search reports

Retrieve a list of reports that include a specified string in the title. Note that this is a POST request.


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_REPORT_FILTERED_LIST_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
query Parameters
page
integer <int32>

The number of the page to retrieve. The first page has the index 0. The indexes of the retrieved items are calculated from this parameter and the page size sent in size.

size
integer <int32>
Default: 20

The size of a page. The indexes of the retrieved items are calculated from this parameter and the page number sent in page.

sort
string
Enum: "name,asc" "name,desc" "isPredefinedAnalytic,asc" "isPredefinedAnalytic,desc" "isDynamicAnalytic,asc" "isDynamicAnalytic,desc" "created,asc" "created,desc" "title,asc" "title,desc"

Sorting order

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Request Body schema: application/json
title
required
string

A string to search for in the titles of analytics

Responses

Request samples

Content type
application/json
{
  • "title": "string"
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "content": [
    ],
  • "pagination": {
    }
}

Preview report

Preview the results of a report. This request does not save the analysis in the database.


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_REPORT_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
query Parameters
namespaceName
string

Currently unused

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Request Body schema: application/json
required
object (Report v2)

Structure of the analytical query

allowNull
boolean
Default: true

If false, groupings that include any null results are not included in the response.

Responses

Request samples

Content type
application/json
{
  • "analysis": {
    },
  • "allowNull": true
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "data": [
    ]
}

Preview report as CSV

Retrieve the results of a report as a CSV file.


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_REPORT_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
query Parameters
namespaceName
string

Currently unused

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Request Body schema: application/json
required
object (Report v2)

Structure of the analytical query

allowNull
boolean
Default: true

If false, groupings that include any null results are not included in the response.

Responses

Request samples

Content type
application/json
{
  • "analysis": {
    },
  • "allowNull": true
}

Get report projections

Retrieve a summary of all reports in the Workspace.


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_REPORT_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
query Parameters
namespaceName
string

Currently unused

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Responses

Request samples

curl --request GET 
  --url 'https://api.synerise.com/analytics-backend/analytics/v4/reports/projections?namespaceName=SOME_STRING_VALUE' 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_' 
  --header 'Content-Type: SOME_STRING_VALUE'

Response samples

Content type
application/json;charset=UTF-8
[
  • {
    }
]

Get report

Retrieve the details of a single report.


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_REPORT_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
UUID
required
string <uuid>

UUID of the analysis

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Responses

Request samples

curl --request GET 
  --url https://api.synerise.com/analytics-backend/analytics/v4/reports/%7BUUID%7D 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_' 
  --header 'Content-Type: SOME_STRING_VALUE'

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "payload": {
    }
}

Update report

Update an existing report.

WARNING: The analysis object sent in this call overwrites the existing one. Any values (including groupings and filters) that are not included in the request body are deleted or set to default values.


  • API consumer who can use this method: Synerise User

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_REPORT_UPDATE

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
UUID
required
string <uuid>

UUID of the analysis

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Request Body schema: application/json
required
object (Report v2)

Structure of the analytical query

Responses

Request samples

Content type
application/json
{
  • "analysis": {
    }
}

Response samples

Content type
application/json
{
  • "httpStatus": 0,
  • "errorCode": "string",
  • "message": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "traceId": "string",
  • "help": "string"
}

Delete report

Delete a report. This operation is irreversible.


  • API consumer who can use this method: Synerise User

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_REPORT_DELETE

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
UUID
required
string <uuid>

UUID of the analysis

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Responses

Request samples

curl --request DELETE 
  --url https://api.synerise.com/analytics-backend/analytics/v4/reports/%7BUUID%7D 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_' 
  --header 'Content-Type: SOME_STRING_VALUE'

Response samples

Content type
application/json
{
  • "httpStatus": 0,
  • "errorCode": "string",
  • "message": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "traceId": "string",
  • "help": "string"
}

Duplicate report

Create a copy of an existing report.


  • API consumer who can use this method: Synerise User

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_REPORT_UPDATE

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
UUID
required
string <uuid>

UUID of the analysis

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Responses

Request samples

curl --request POST 
  --url https://api.synerise.com/analytics-backend/analytics/v4/reports/%7BUUID%7D/duplicate 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_' 
  --header 'Content-Type: SOME_STRING_VALUE'

Response samples

Content type
application/json
{
  • "httpStatus": 0,
  • "errorCode": "string",
  • "message": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "traceId": "string",
  • "help": "string"
}

Recalculate report

Use this endpoint to quickly retrieve the results of a previously defined report.


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_REPORT_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
UUID
required
string <uuid>

UUID of the analysis

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Responses

Request samples

curl --request POST 
  --url https://api.synerise.com/analytics-backend/analytics/v4/reports/%7BUUID%7D/recalculate 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_' 
  --header 'Content-Type: SOME_STRING_VALUE'

Response samples

Content type
application/json;charset=UTF-8
{
  • "data": [
    ]
}

Recalculate report with parameter override

Calculate the results of a previously defined report with custom date and/or profile filters.

This operation does not modify the original report in any way.


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_REPORT_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
UUID
required
string <uuid>

UUID of the analysis

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Request Body schema: application/json
Absolute (object) or Relative to current (object) or Relative/patterned (object) or Absolute/patterned (object)

Details of the date filter. The analysis results are calculated from data that matches the filter.

object

This object defines how to aggregate the data in an analysis.

object

Profile filter. This allows you to limit the calculation to profiles which match certain criteria.

Array of objects[ items ]

A list of dynamically modifiable variables that occur in this analysis

Responses

Request samples

Content type
application/json
{
  • "dateFilter": {
    },
  • "aggregateDataBy": {
    },
  • "filter": {
    },
  • "variables": [
    ]
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "data": [
    ]
}

Sankeys

Sankey charts in Synerise let users reconstruct the flow of Profile actions before or after an occurrence of a particular event

Preview Sankey analysis

Preview the result of a Sankey analysis. This request does not save the analysis in the database.


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_SANKEY_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
query Parameters
namespaceName
string

Currently unused

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Request Body schema: application/json
required
object (Sankey chart)

Structure of the analysis

Responses

Request samples

Content type
application/json
{
  • "analysis": {
    }
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "results": [
    ]
}

Get sankey


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_SANKEY_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
sankeyId
required
string <uuid>

Sankey UUID

Responses

Request samples

curl --request GET 
  --url https://api.synerise.com/analytics/analytics/v1/sankeys/%7BsankeyId%7D 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "payload": {
    }
}

Update Sankey


  • API consumer who can use this method: Synerise User

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_SANKEY_UPDATE

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
sankeyId
required
string <uuid>

Sankey UUID

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{
  • "analysis": {
    }
}

Response samples

Content type
application/json
{
  • "path": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "errorCode": "string",
  • "status": 0,
  • "message": "string",
  • "traceId": "string"
}

Delete sankey


  • API consumer who can use this method: Synerise User

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_SANKEY_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
sankeyId
required
string <uuid>

Sankey UUID

Responses

Request samples

curl --request DELETE 
  --url https://api.synerise.com/analytics/analytics/v1/sankeys/%7BsankeyId%7D 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

Content type
application/json;charset=UTF-8
{ }

Get Sankey analyses

Retrieve a list of all Sankey analyses in the workspace


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_SANKEYS_LIST_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
query Parameters
offset
integer <int64>

Offset for pagination. The first item of the first page has the offset of 0.

page
integer <int32>

The number of the page to retrieve. The first page has the index 0. The indexes of the retrieved items are calculated from this parameter and the page size sent in size.

size
integer <int32>
Default: 20

The size of a page. The indexes of the retrieved items are calculated from this parameter and the page number sent in page.

sort
string
Enum: "name,asc" "name,desc" "isPredefinedAnalytic,asc" "isPredefinedAnalytic,desc" "isDynamicAnalytic,asc" "isDynamicAnalytic,desc" "created,asc" "created,desc" "title,asc" "title,desc"

Sorting order

namespaceName
string

Currently unused

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Responses

Request samples

curl --request GET 
  --url 'https://api.synerise.com/analytics-backend/analytics/v1/sankeys?offset=SOME_INTEGER_VALUE&page=SOME_INTEGER_VALUE&size=SOME_INTEGER_VALUE&sort=SOME_STRING_VALUE&namespaceName=SOME_STRING_VALUE' 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_' 
  --header 'Content-Type: SOME_STRING_VALUE'

Response samples

Content type
application/json;charset=UTF-8
{
  • "content": [
    ],
  • "pagination": {
    }
}

Add Sankey analysis

Create a new Sankey analysis


  • API consumer who can use this method: Synerise User

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_SANKEY_CREATE

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
query Parameters
namespaceName
string

Currently unused

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Request Body schema: application/json
required
object (Sankey chart)

Structure of the analysis

Responses

Request samples

Content type
application/json
{
  • "analysis": {
    }
}

Response samples

Content type
application/json
{
  • "httpStatus": 0,
  • "errorCode": "string",
  • "message": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "traceId": "string",
  • "help": "string"
}

Search Sankey analyses

Retrieve a list of Sankey analyses that include a specified string in the title. Note that this is a POST request.


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_SANKEYS_LIST_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
query Parameters
offset
integer <int64>

Offset for pagination. The first item of the first page has the offset of 0.

page
integer <int32>

The number of the page to retrieve. The first page has the index 0. The indexes of the retrieved items are calculated from this parameter and the page size sent in size.

size
integer <int32>
Default: 20

The size of a page. The indexes of the retrieved items are calculated from this parameter and the page number sent in page.

sort
string
Enum: "name,asc" "name,desc" "isPredefinedAnalytic,asc" "isPredefinedAnalytic,desc" "isDynamicAnalytic,asc" "isDynamicAnalytic,desc" "created,asc" "created,desc" "title,asc" "title,desc"

Sorting order

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Request Body schema: application/json
title
required
string

A string to search for in the titles of analytics

Responses

Request samples

Content type
application/json
{
  • "title": "string"
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "content": [
    ],
  • "pagination": {
    }
}

Preview Sankey analysis

Preview the result of a Sankey analysis. This request does not save the analysis in the database.


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_SANKEY_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
query Parameters
namespaceName
string

Currently unused

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Request Body schema: application/json
required
object (Sankey chart)

Structure of the analysis

Responses

Request samples

Content type
application/json
{
  • "analysis": {
    }
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "results": [
    ]
}

Get Sankey analysis

Retrieve the details of a single Sankey analysis.


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_SANKEY_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
UUID
required
string <uuid>

UUID of the analysis

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Responses

Request samples

curl --request GET 
  --url https://api.synerise.com/analytics-backend/analytics/v1/sankeys/%7BUUID%7D 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_' 
  --header 'Content-Type: SOME_STRING_VALUE'

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "payload": {
    }
}

Update Sankey analysis

Update an existing Sankey analysis.

WARNING: The analysis object sent in this call overwrites the existing one. Any values that are not included in the request body are deleted or set to default values.


  • API consumer who can use this method: Synerise User

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_SANKEY_UPDATE

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
UUID
required
string <uuid>

UUID of the analysis

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Request Body schema: application/json
required
object (Sankey chart)

Structure of the analysis

Responses

Request samples

Content type
application/json
{
  • "analysis": {
    }
}

Response samples

Content type
application/json
{
  • "httpStatus": 0,
  • "errorCode": "string",
  • "message": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "traceId": "string",
  • "help": "string"
}

Delete Sankey analysis

Delete a Sankey analysis. This operation is irreversible.


  • API consumer who can use this method: Synerise User

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_SANKEY_DELETE

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
UUID
required
string <uuid>

UUID of the analysis

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Responses

Request samples

curl --request DELETE 
  --url https://api.synerise.com/analytics-backend/analytics/v1/sankeys/%7BUUID%7D 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_' 
  --header 'Content-Type: SOME_STRING_VALUE'

Response samples

Content type
application/json
{
  • "httpStatus": 0,
  • "errorCode": "string",
  • "message": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "traceId": "string",
  • "help": "string"
}

Duplicate Sankey analysis

Create a copy of an existing Sankey analysis.


  • API consumer who can use this method: Synerise User

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_SANKEY_UPDATE

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
UUID
required
string <uuid>

UUID of the analysis

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Responses

Request samples

curl --request POST 
  --url https://api.synerise.com/analytics-backend/analytics/v1/sankeys/%7BUUID%7D/duplicate 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_' 
  --header 'Content-Type: SOME_STRING_VALUE'

Response samples

Content type
application/json
{
  • "httpStatus": 0,
  • "errorCode": "string",
  • "message": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "traceId": "string",
  • "help": "string"
}

Recalculate Sankey analysis

Use this endpoint to quickly retrieve the results of a previously defined Sankey analysis.


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_SANKEY_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
UUID
required
string <uuid>

UUID of the analysis

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Responses

Request samples

curl --request POST 
  --url https://api.synerise.com/analytics-backend/analytics/v1/sankeys/%7BUUID%7D/recalculate 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_' 
  --header 'Content-Type: SOME_STRING_VALUE'

Response samples

Content type
application/json;charset=UTF-8
{
  • "results": [
    ]
}

Recalculate sankey with parameter override

Calculate the results of a previously defined sankey with custom date and/or profile filters.

This operation does not modify the original sankey in any way.


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_SANKEY_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
UUID
required
string <uuid>

UUID of the analysis

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Request Body schema: application/json
Absolute (object) or Relative to current (object) or Relative/patterned (object) or Absolute/patterned (object)

Details of the date filter. The analysis results are calculated from data that matches the filter.

object

This object defines how to aggregate the data in an analysis.

object

Profile filter. This allows you to limit the calculation to profiles which match certain criteria.

Array of objects[ items ]

A list of dynamically modifiable variables that occur in this analysis

Responses

Request samples

Content type
application/json
{
  • "dateFilter": {
    },
  • "aggregateDataBy": {
    },
  • "filter": {
    },
  • "variables": [
    ]
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "results": [
    ]
}

Recalculate Sankey analysis

Use this endpoint to quickly retrieve the results of a previously defined Sankey analysis.


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_SANKEY_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
UUID
required
string <uuid>

UUID of the analysis

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Responses

Request samples

curl --request POST 
  --url https://api.synerise.com/analytics-backend/analytics/v2/sankeys/%7BUUID%7D/recalculate 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_' 
  --header 'Content-Type: SOME_STRING_VALUE'

Response samples

Content type
application/json;charset=UTF-8
{
  • "results": [
    ]
}

Segmentations

Segmentation is a method of organizing Profiles into groups that share the same characteristics

Get segmentations

Retrieve all segmentations from the workspace.


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_SEGMENTATIONS_LIST_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
query Parameters
page
integer <int32>

The number of the page to retrieve. The first page has the index 0. The indexes of the retrieved items are calculated from this parameter and the page size sent in size.

size
integer <int32>
Default: 20

The size of a page. The indexes of the retrieved items are calculated from this parameter and the page number sent in page.

sort
string
Enum: "name,asc" "name,desc" "isPredefinedAnalytic,asc" "isPredefinedAnalytic,desc" "isDynamicAnalytic,asc" "isDynamicAnalytic,desc" "created,asc" "created,desc" "title,asc" "title,desc"

Sorting order

namespaceName
string

Currently unused

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Responses

Request samples

curl --request GET 
  --url 'https://api.synerise.com/analytics-backend/analytics/v2/segmentations?page=SOME_INTEGER_VALUE&size=SOME_INTEGER_VALUE&sort=SOME_STRING_VALUE&namespaceName=SOME_STRING_VALUE' 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_' 
  --header 'Content-Type: SOME_STRING_VALUE'

Response samples

Content type
application/json;charset=UTF-8
{
  • "content": [
    ],
  • "pagination": {
    }
}

Add segmentation

Create a new segmentation.


  • API consumer who can use this method: Synerise User

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_SEGMENTATION_CREATE

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
query Parameters
namespaceName
string

Currently unused

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Request Body schema: application/json
required
object (Segmentation)

Analytical conditions

isVisibleForClientProfile
boolean

When set to true, information about this analysis can be shown in a profile's card. In the Synerise CRM, only aggregates, segmentations, and expressions can be shown.

Responses

Request samples

Content type
application/json
{
  • "analysis": {
    },
  • "isVisibleForClientProfile": true
}

Response samples

Content type
application/json
{
  • "httpStatus": 0,
  • "errorCode": "string",
  • "message": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "traceId": "string",
  • "help": "string"
}

Check profile's presence in segmentations

Retrieve a summary of a profile's presence in segmentations. The response includes all segmentations from the workspace and information if the profile belongs to them.

IMPORTANT: This endpoint is limited to:

  • 500 requests per second
  • 10 requests per second per profile

  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_CHECK_CLIENT_SEGMENTATION_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
clientId
required
integer

Profile ID

query Parameters
page
integer <int32>

The number of the page to retrieve. The first page has the index 0. The indexes of the retrieved items are calculated from this parameter and the page size sent in size.

size
integer <int32>
Default: 20

The size of a page. The indexes of the retrieved items are calculated from this parameter and the page number sent in page.

sort
string
Enum: "name,asc" "name,desc" "isPredefinedAnalytic,asc" "isPredefinedAnalytic,desc" "isDynamicAnalytic,asc" "isDynamicAnalytic,desc" "created,asc" "created,desc" "title,asc" "title,desc"

Sorting order

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Responses

Request samples

curl --request GET 
  --url 'https://api.synerise.com/analytics-backend/analytics/v2/segmentations/clients/%7BclientId%7D/check?page=SOME_INTEGER_VALUE&size=SOME_INTEGER_VALUE&sort=SOME_STRING_VALUE' 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_' 
  --header 'Content-Type: SOME_STRING_VALUE'

Response samples

Content type
application/json;charset=UTF-8
{
  • "content": [
    ],
  • "pagination": {
    }
}

Search segmentations

Retrieve a list of segmentations that include a specified string in the title. Note that this is a POST request.


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_SEGMENTATION_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
query Parameters
page
integer <int32>

The number of the page to retrieve. The first page has the index 0. The indexes of the retrieved items are calculated from this parameter and the page size sent in size.

size
integer <int32>
Default: 20

The size of a page. The indexes of the retrieved items are calculated from this parameter and the page number sent in page.

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Request Body schema: application/json
title
required
string

A string to search for in the titles of analytics

Responses

Request samples

Content type
application/json
{
  • "title": "string"
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "content": [
    ],
  • "pagination": {
    }
}

Preview segmentation

Preview the results of a segmentation, with information about the results of each segment. This request does not save the analysis in the database.


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_SEGMENTATION_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
query Parameters
namespaceName
string

Currently unused

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Request Body schema: application/json
required
object (Segmentation)

Analytical conditions

isVisibleForClientProfile
boolean

When set to true, information about this analysis can be shown in a profile's card. In the Synerise CRM, only aggregates, segmentations, and expressions can be shown.

Responses

Request samples

Content type
application/json
{
  • "analysis": {
    },
  • "isVisibleForClientProfile": true
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "calculationResults": [
    ],
  • "excludedContacts": 0,
  • "totalContacts": 0,
  • "metadata": {
    }
}

Get profiles segmentation preview

Retrieve a list of profiles which belong to a segmentation defined in the request body. The response is an array of segments that contain arrays of profile IDs.


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_SEGMENTATION_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Request Body schema: application/json
required
object (Segmentation)

Analytical conditions

isVisibleForClientProfile
boolean

When set to true, information about this analysis can be shown in a profile's card. In the Synerise CRM, only aggregates, segmentations, and expressions can be shown.

Responses

Request samples

Content type
application/json
{
  • "analysis": {
    },
  • "isVisibleForClientProfile": true
}

Response samples

Content type
application/json;charset=UTF-8
[
  • [
    ]
]

Get segmentation projections

Retrieve a summary of all segmentations in the Workspace.


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_LIST_SEGMENTATION_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission groups which allow access to this method: ANALYTICS, CLIENT_ANALYTICS_PREVIEW, CAMPAIGNS_RECOMMENDATIONS

Authorizations:
query Parameters
mergeParams
boolean
Default: false

When true, the information about variables in a dynamic analysis is more detailed (if additional information is available for the analysis) and all dynamic parameters are listed separately. When false, repeating parameters are grouped into one instance.

namespaceName
string

Currently unused

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Responses

Request samples

curl --request GET 
  --url 'https://api.synerise.com/analytics-backend/analytics/v2/segmentations/projections?mergeParams=SOME_BOOLEAN_VALUE&namespaceName=SOME_STRING_VALUE' 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_' 
  --header 'Content-Type: SOME_STRING_VALUE'

Response samples

Content type
application/json;charset=UTF-8
[
  • {
    }
]

Get segmentations for profile's card

Retrieve a list of segmentations that are set as visible on profile cards in CRM.

The list includes ALL CRM-visible segmentations, even if the profile does not belong to them. The isLocatedIn parameters informs about a profile's inclusion in each segmentation.

IMPORTANT: This endpoint is limited to:

  • 500 requests per second
  • 10 requests per second per profile

  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_SEGMENTATIONS_FOR_CLIENT_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission groups which allow access to this method: ANALYTICS, CLIENT_ANALYTICS_PREVIEW

Authorizations:
path Parameters
clientId
required
integer

Profile ID

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Responses

Request samples

curl --request GET 
  --url https://api.synerise.com/analytics-backend/analytics/v2/segmentations/visible-for-client/%7BclientId%7D 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_' 
  --header 'Content-Type: SOME_STRING_VALUE'

Response samples

Content type
application/json;charset=UTF-8
{
  • "result": [
    ]
}

Get segmentation

Retrieve the details of a single segmentation.


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_SEGMENTATION_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
UUID
required
string <uuid>

UUID of the analysis

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Responses

Request samples

curl --request GET 
  --url https://api.synerise.com/analytics-backend/analytics/v2/segmentations/%7BUUID%7D 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_' 
  --header 'Content-Type: SOME_STRING_VALUE'

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "payload": {
    }
}

Update segmentation

Update an existing segmentation.

WARNING: The analysis object sent in this call overwrites the existing one. Any values (including segments and filters) that are not included in the request body are deleted or set to default values.


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_SEGMENTATION_UPDATE

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
UUID
required
string <uuid>

UUID of the analysis

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Request Body schema: application/json
required
object (Segmentation)

Analytical conditions

isVisibleForClientProfile
boolean

When set to true, information about this analysis can be shown in a profile's card. In the Synerise CRM, only aggregates, segmentations, and expressions can be shown.

Responses

Request samples

Content type
application/json
{
  • "analysis": {
    },
  • "isVisibleForClientProfile": true
}

Response samples

Content type
application/json
{
  • "httpStatus": 0,
  • "errorCode": "string",
  • "message": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "traceId": "string",
  • "help": "string"
}

Delete segmentation

Delete a segmentation. This operation is irreversible.


  • API consumer who can use this method: Synerise User

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_SEGMENTATION_DELETE

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
UUID
required
string <uuid>

UUID of the analysis

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Responses

Request samples

curl --request DELETE 
  --url https://api.synerise.com/analytics-backend/analytics/v2/segmentations/%7BUUID%7D 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_' 
  --header 'Content-Type: SOME_STRING_VALUE'

Response samples

Content type
application/json
{
  • "httpStatus": 0,
  • "errorCode": "string",
  • "message": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "traceId": "string",
  • "help": "string"
}

Get Profiles from existing segmentation

Retrieve a list of profiles which belong to an existing segmentation. The response is an array of segments that contain arrays of profile IDs.


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_SEGMENTATION_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
UUID
required
string <uuid>

UUID of the analysis

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Responses

Request samples

curl --request GET 
  --url https://api.synerise.com/analytics-backend/analytics/v2/segmentations/%7BUUID%7D/clients 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_' 
  --header 'Content-Type: SOME_STRING_VALUE'

Response samples

Content type
application/json;charset=UTF-8
[
  • [
    ]
]

Duplicate segmentation

Create a copy of an existing segmentation.


  • API consumer who can use this method: Synerise User

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_SEGMENTATION_UPDATE

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
UUID
required
string <uuid>

UUID of the analysis

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Responses

Request samples

curl --request POST 
  --url https://api.synerise.com/analytics-backend/analytics/v2/segmentations/%7BUUID%7D/duplicate 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_' 
  --header 'Content-Type: SOME_STRING_VALUE'

Response samples

Content type
application/json
{
  • "httpStatus": 0,
  • "errorCode": "string",
  • "message": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "traceId": "string",
  • "help": "string"
}

Calculate dynamic segmentation

Calculate the results of a segmentation by applying new values to dynamic variables in the segmentation. This operation does not modify the original segmentation in any way.


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_SEGMENTATION_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
UUID
required
string <uuid>

UUID of the analysis

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Request Body schema: application/json
Array of objects[ items ]

A list of dynamically modifiable variables that occur in this analysis

Responses

Request samples

Content type
application/json
{
  • "variables": [
    ]
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "calculationResults": [
    ],
  • "excludedContacts": 0,
  • "totalContacts": 0,
  • "metadata": {
    }
}

Recalculate segmentation

Use this endpoint to quickly retrieve the results of a previously defined segmentation.


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_SEGMENTATION_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
UUID
required
string <uuid>

UUID of the analysis

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Responses

Request samples

curl --request POST 
  --url https://api.synerise.com/analytics-backend/analytics/v2/segmentations/%7BUUID%7D/recalculate 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_' 
  --header 'Content-Type: SOME_STRING_VALUE'

Response samples

Content type
application/json;charset=UTF-8
{
  • "calculationResults": [
    ],
  • "excludedContacts": 0,
  • "totalContacts": 0,
  • "metadata": {
    }
}

Trends

A trend is a presentation of event occurrences over time on a chart

Get trend analyses

Retrieve a list of all trend analyses in the workspace.


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_TRENDS_LIST_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
query Parameters
page
integer <int32>

The number of the page to retrieve. The first page has the index 0. The indexes of the retrieved items are calculated from this parameter and the page size sent in size.

size
integer <int32>
Default: 20

The size of a page. The indexes of the retrieved items are calculated from this parameter and the page number sent in page.

sort
string
Enum: "name,asc" "name,desc" "isPredefinedAnalytic,asc" "isPredefinedAnalytic,desc" "isDynamicAnalytic,asc" "isDynamicAnalytic,desc" "created,asc" "created,desc" "title,asc" "title,desc"

Sorting order

namespaceName
string

Currently unused

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Responses

Request samples

curl --request GET 
  --url 'https://api.synerise.com/analytics-backend/analytics/v2/trends?page=SOME_INTEGER_VALUE&size=SOME_INTEGER_VALUE&sort=SOME_STRING_VALUE&namespaceName=SOME_STRING_VALUE' 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_' 
  --header 'Content-Type: SOME_STRING_VALUE'

Response samples

Content type
application/json;charset=UTF-8
{
  • "content": [
    ],
  • "pagination": {
    }
}

Create trend analysis

Create a new trend analysis.


  • API consumer who can use this method: Synerise User

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_TREND_CREATE

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
query Parameters
namespaceName
string

Currently unused

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Request Body schema: application/json
required
object

Analytical conditions

Responses

Request samples

Content type
application/json
{
  • "analysis": {
    }
}

Response samples

Content type
application/json
{
  • "httpStatus": 0,
  • "errorCode": "string",
  • "message": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "traceId": "string",
  • "help": "string"
}

Search trend analyses

Retrieve a list of trend analyses that include a specified string in the title. Note that this is a POST request.


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_TREND_FILTERED_LIST_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
query Parameters
page
integer <int32>

The number of the page to retrieve. The first page has the index 0. The indexes of the retrieved items are calculated from this parameter and the page size sent in size.

size
integer <int32>
Default: 20

The size of a page. The indexes of the retrieved items are calculated from this parameter and the page number sent in page.

sort
string
Enum: "name,asc" "name,desc" "isPredefinedAnalytic,asc" "isPredefinedAnalytic,desc" "isDynamicAnalytic,asc" "isDynamicAnalytic,desc" "created,asc" "created,desc" "title,asc" "title,desc"

Sorting order

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Request Body schema: application/json
title
required
string

A string to search for in the titles of analytics

Responses

Request samples

Content type
application/json
{
  • "title": "string"
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "content": [
    ],
  • "pagination": {
    }
}

Preview trend analysis


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_TREND_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
query Parameters
namespaceName
string

Currently unused

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Request Body schema: application/json
required
object

Analytical conditions

Responses

Request samples

Content type
application/json
{
  • "analysis": {
    }
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "items": [
    ],
  • "legends": [
    ],
  • "metadata": {
    },
  • "name": "string"
}

Get trend analysis projections

Retrieve a summary of all trend analyses in the Workspace.


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_TREND_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
query Parameters
mergeParams
boolean
Default: false

When true, the information about variables in a dynamic analysis is more detailed (if additional information is available for the analysis) and all dynamic parameters are listed separately. When false, repeating parameters are grouped into one instance.

namespaceName
string

Currently unused

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Responses

Request samples

curl --request GET 
  --url 'https://api.synerise.com/analytics-backend/analytics/v2/trends/projections?mergeParams=SOME_BOOLEAN_VALUE&namespaceName=SOME_STRING_VALUE' 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_' 
  --header 'Content-Type: SOME_STRING_VALUE'

Response samples

Content type
application/json;charset=UTF-8
[
  • {
    }
]

Get trend analysis

Retrieve the details of a single trend analysis.


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_TREND_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
UUID
required
string <uuid>

UUID of the analysis

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Responses

Request samples

curl --request GET 
  --url https://api.synerise.com/analytics-backend/analytics/v2/trends/%7BUUID%7D 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_' 
  --header 'Content-Type: SOME_STRING_VALUE'

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "payload": {
    }
}

Update trend analysis

Update an existing trend analysis.

WARNING: The analysis object sent in this call overwrites the existing one. Any values (including trends and filters) that are not included in the request body are deleted or set to default values.


  • API consumer who can use this method: Synerise User

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_TREND_UPDATE

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
UUID
required
string <uuid>

UUID of the analysis

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Request Body schema: application/json
required
object

Analytical conditions

Responses

Request samples

Content type
application/json
{
  • "analysis": {
    }
}

Response samples

Content type
application/json
{
  • "httpStatus": 0,
  • "errorCode": "string",
  • "message": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "traceId": "string",
  • "help": "string"
}

Delete trend analysis


  • API consumer who can use this method: Synerise User

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_TREND_DELETE

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
UUID
required
string <uuid>

UUID of the analysis

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Responses

Request samples

curl --request DELETE 
  --url https://api.synerise.com/analytics-backend/analytics/v2/trends/%7BUUID%7D 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_' 
  --header 'Content-Type: SOME_STRING_VALUE'

Response samples

Content type
application/json
{
  • "httpStatus": 0,
  • "errorCode": "string",
  • "message": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "traceId": "string",
  • "help": "string"
}

Duplicate trend analysis

Create a copy of an existing trend analysis.


  • API consumer who can use this method: Synerise User

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_TREND_UPDATE

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
UUID
required
string <uuid>

UUID of the analysis

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Responses

Request samples

curl --request POST 
  --url https://api.synerise.com/analytics-backend/analytics/v2/trends/%7BUUID%7D/duplicate 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_' 
  --header 'Content-Type: SOME_STRING_VALUE'

Response samples

Content type
application/json
{
  • "httpStatus": 0,
  • "errorCode": "string",
  • "message": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "traceId": "string",
  • "help": "string"
}

Calculate dynamic trend analysis

Calculate the results of a trend analysis by applying new values to dynamic variables in the analysis. This operation does not modify the original analysis in any way.


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_TREND_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
UUID
required
string <uuid>

UUID of the analysis

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Request Body schema: application/json
Array of objects[ items ]

A list of dynamically modifiable variables that occur in this analysis

Responses

Request samples

Content type
application/json
{
  • "variables": [
    ]
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "items": [
    ],
  • "legends": [
    ],
  • "metadata": {
    },
  • "name": "string"
}

Recalculate trend analysis

Use this endpoint to quickly retrieve the results of a previously defined trend analysis.


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_TREND_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
UUID
required
string <uuid>

UUID of the analysis

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Responses

Request samples

curl --request POST 
  --url https://api.synerise.com/analytics-backend/analytics/v2/trends/%7BUUID%7D/recalculate 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_' 
  --header 'Content-Type: SOME_STRING_VALUE'

Response samples

Content type
application/json;charset=UTF-8
{
  • "items": [
    ],
  • "legends": [
    ],
  • "metadata": {
    },
  • "name": "string"
}

Recalculate trend analysis with parameter override

Calculate the results of a previously defined trend analysis with custom date and/or profile filters.

This operation does not modify the original trend analysis in any way.


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_TREND_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
UUID
required
string <uuid>

UUID of the analysis

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Request Body schema: application/json
Absolute (object) or Relative to current (object) or Relative/patterned (object) or Absolute/patterned (object)

Details of the date filter. The analysis results are calculated from data that matches the filter.

object

This object defines how to aggregate the data in an analysis.

object

Profile filter. This allows you to limit the calculation to profiles which match certain criteria.

Array of objects[ items ]

A list of dynamically modifiable variables that occur in this analysis

Responses

Request samples

Content type
application/json
{
  • "dateFilter": {
    },
  • "aggregateDataBy": {
    },
  • "filter": {
    },
  • "variables": [
    ]
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "items": [
    ],
  • "legends": [
    ],
  • "metadata": {
    },
  • "name": "string"
}

Analysis versions

Manage the versions of your analyses

Save version

Save a new version of an analysis.


  • API consumer who can use this method: Synerise User

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_VERSIONS_CREATE

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
query Parameters
publish
boolean
Default: false

When true, the created version will be published immediately.

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Request Body schema: application/json
type
required
string
Enum: "FUNNEL" "TREND" "SEGMENTATION" "METRIC" "HISTOGRAM" "REPORT" "REPORT_V2" "AGGREGATE" "EXPRESSION" "SANKEY"

Defines the type of the analysis.

analyticId
required
string <uuid>

UUID of the analysis

required
Funnel (object) or Trend (object) or Segmentation (object) or Metric (object) or Histogram (object) or Report v2 (object) or Aggregate (object) or (Expression (Event expression (object) or Profile attribute expression (object))) or Sankey chart (object)

New structure of the analysis

Responses

Request samples

Content type
application/json
{
  • "type": "FUNNEL",
  • "analyticId": "ed7ea341-8ad5-4b51-ab54-fa323bd4556c",
  • "analysis": {
    }
}

Response samples

Content type
application/json
{
  • "httpStatus": 0,
  • "errorCode": "string",
  • "message": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "traceId": "string",
  • "help": "string"
}

Publish version

Publish a version of an analysis.


  • API consumer who can use this method: Synerise User

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_VERSIONS_CREATE

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Request Body schema: application/json
type
required
string
Enum: "FUNNEL" "TREND" "SEGMENTATION" "METRIC" "HISTOGRAM" "REPORT" "REPORT_V2" "AGGREGATE" "EXPRESSION" "SANKEY"

Defines the type of the analysis.

analyticId
required
string <uuid>

UUID of the analysis

versionId
required
string <uuid>

UUID of the version

Responses

Request samples

Content type
application/json
{
  • "type": "FUNNEL",
  • "analyticId": "ed7ea341-8ad5-4b51-ab54-fa323bd4556c",
  • "versionId": "14707576-2549-4848-82ed-f68f8a1b47c7"
}

Response samples

Content type
application/json
{
  • "httpStatus": 0,
  • "errorCode": "string",
  • "message": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "traceId": "string",
  • "help": "string"
}

Check changes

You can check if analytics nested in your analysis (for example, in filters) have recently been modified.


  • API consumer who can use this method: Synerise User

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_VERSIONS_CREATE

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Request Body schema: application/json
type
string
Enum: "FUNNEL" "TREND" "SEGMENTATION" "METRIC" "HISTOGRAM" "REPORT" "REPORT_V2" "AGGREGATE" "EXPRESSION" "SANKEY"

Defines the type of the analysis.

Funnel (object) or Trend (object) or Segmentation (object) or Metric (object) or Histogram (object) or Report v2 (object) or Aggregate (object) or (Expression (Event expression (object) or Profile attribute expression (object))) or Sankey chart (object)

The structure of your analysis

since
string <date-time>

The start date for the check

Responses

Request samples

Content type
application/json
{
  • "type": "FUNNEL",
  • "analysis": {
    },
  • "since": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "since": "2019-08-24T14:15:22Z",
  • "analytics": [
    ]
}

Get versions

Retrieve all versions of an analysis.


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_VERSIONS_LIST_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
UUID
required
string <uuid>

UUID of the analysis

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Responses

Request samples

curl --request GET 
  --url https://api.synerise.com/analytics-backend/analytics/versions/%7BUUID%7D 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_' 
  --header 'Content-Type: SOME_STRING_VALUE'

Response samples

Content type
application/json;charset=UTF-8
{
  • "type": "FUNNEL",
  • "analyticId": "ed7ea341-8ad5-4b51-ab54-fa323bd4556c",
  • "versions": [
    ]
}

Analysis relations

Examine the dependencies between different types of analyses

Get relations

You can use this method to check if other analyses use the requested analysis in their calculations.


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_RELATIONS_LIST_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
UUID
required
string <uuid>

UUID of the analysis

header Parameters
Content-Type
required
string
Value: "application/json"

Mandatory header

Responses

Request samples

curl --request GET 
  --url https://api.synerise.com/analytics-backend/relations/%7BUUID%7D 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_' 
  --header 'Content-Type: SOME_STRING_VALUE'

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "type": "FUNNEL",
  • "usedIn": [
    ]
}

Analytics v2

New endpoints for analytics

Get histogram projections

Retrieve a summary of all histograms in the Workspace


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_METRIC_HISTOGRAM_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
query Parameters
namespaceName
string

Responses

Request samples

curl --request GET 
  --url 'https://api.synerise.com/analytics/analytics/v2/metrics/histograms/projections?namespaceName=SOME_STRING_VALUE' 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

Content type
application/json
[
  • {
    }
]

Get metrics usable in histograms

Retrieve a list of metrics that can be used in histograms.


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_METRIC_HISTOGRAM_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:

Responses

Request samples

curl --request GET 
  --url https://api.synerise.com/analytics/analytics/v3/metrics/histogram-metrics 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

Content type
application/json;charset=UTF-8
[
  • {
    }
]

Get first matching segmentation for profile from provided list

Check a number of segmentations and return the first one that matches the selected profile. Note that segmentations is a list of objects to check, and each object can also refer to multiple segmentations.


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_SEGMENTATIONS_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
identifierType
required
string
Enum: "id" "uuid" "email" "custom_identify"

Profile identifier type

Request Body schema: application/json
identifierValue
required
string

Value of the selected identifier. Note that IDs must also be sent as strings.

required
Array of objects[ items ]

An array of objects. The objects are checked in the order from the array, and when a segmentation from an object matches the profile, the value of that object's id is returned in the response. Note that each object can check multiple segmentations - in such cases, only one of those segmentation needs to match for the object to be considered a match.

Responses

Request samples

Content type
application/json
{
  • "identifierValue": "string",
  • "segmentations": [
    ]
}

Response samples

Content type
application/json
"497f6eca-6276-4993-bfeb-53cbbbba6f08"

List segmentations

Returns a paginated list of segmentations.


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_SEGMENTATIONS_LIST_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
namespace
required
string
Value: "profiles"

Namespace. Currently, only profiles is available.

query Parameters
page
integer <int32> >= 1
Default: 1
limit
integer <int32>
Default: 50

Limit of items per page

search
string
sortBy
string
directoryId
string <uuid>
ids
string

Comma-separated list of ids (in UUID format) to filter results through

Responses

Request samples

curl --request GET 
  --url 'https://api.synerise.com/analytics/%7Bnamespace%7D/segmentations?page=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE&search=SOME_STRING_VALUE&sortBy=SOME_STRING_VALUE&directoryId=SOME_STRING_VALUE&ids=SOME_STRING_VALUE' 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ]
}

Create segmentation

Returns an id of created segmentation.


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_SEGMENTATIONS_CREATE

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
namespace
required
string
Value: "profiles"

Namespace. Currently, only profiles is available.

Request Body schema: application/json
required
object
isVisibleForClientProfile
required
boolean

Responses

Request samples

Content type
application/json
{
  • "analysis": {
    },
  • "isVisibleForClientProfile": true
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Get segmentation analysis


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_SEGMENTATIONS_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
segmentationId
required
string <uuid>

Segmentation UUID

namespace
required
string
Value: "profiles"

Namespace. Currently, only profiles is available.

Responses

Request samples

curl --request GET 
  --url https://api.synerise.com/analytics/%7Bnamespace%7D/segmentations/%7BsegmentationId%7D 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "businessProfileId": 48,
  • "name": "string",
  • "description": "string",
  • "author": 0,
  • "modifier": 0,
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "analysis": {
    },
  • "isPredefinedAnalytic": true,
  • "isVisibleForClientProfile": true,
  • "isDynamicAnalytic": true,
  • "isDeleted": true,
  • "namespace": "string",
  • "directoryId": "786c2ec1-fb9a-4593-b705-005b34c18c18"
}

Update segmentation


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_SEGMENTATIONS_UPDATE

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
segmentationId
required
string <uuid>

Segmentation UUID

namespace
required
string
Value: "profiles"

Namespace. Currently, only profiles is available.

Request Body schema: application/json
required
object
isVisibleForClientProfile
required
boolean

Responses

Request samples

Content type
application/json
{
  • "analysis": {
    },
  • "isVisibleForClientProfile": true
}

Response samples

Content type
application/json
{
  • "path": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "errorCode": "string",
  • "status": 0,
  • "message": "string",
  • "traceId": "string"
}

Delete segmentation analysis


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_SEGMENTATIONS_DELETE

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
segmentationId
required
string <uuid>

Segmentation UUID

namespace
required
string
Value: "profiles"

Namespace. Currently, only profiles is available.

Responses

Request samples

curl --request DELETE 
  --url https://api.synerise.com/analytics/%7Bnamespace%7D/segmentations/%7BsegmentationId%7D 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

Content type
application/json
{
  • "path": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "errorCode": "string",
  • "status": 0,
  • "message": "string",
  • "traceId": "string"
}

Get expressions for profile card

Retrieve expressions to display on a profile's card in the Profiles module ("isVisibleForClientProfile": true in the expression config).


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_EXPRESSION_FOR_CLIENT_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission groups which allow access to this method: ANALYTICS, CLIENT_ANALYTICS_PREVIEW

Authorizations:
path Parameters
identifierType
required
string
Enum: "id" "uuid" "email" "custom_identify"

Profile identifier type

namespace
required
string
Value: "profiles"

Namespace. Currently, only profiles is available.

Request Body schema: application/json
identifierValue
required
string

Value of the selected identifier. Note that IDs must also be sent as strings.

Responses

Request samples

Content type
application/json
{
  • "identifierValue": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Check if profile in segmentations

Check if a profile is in a number of segmentations.

IMPORTANT: This endpoint is limited to:

  • 10 segmentations per request
  • 500 requests per second
  • 10 requests per second per profile

  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_SEGMENTATIONS_LIST_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
identifierType
required
string
Enum: "id" "uuid" "email" "custom_identify"

Profile identifier type

namespace
required
string
Value: "profiles"

Namespace. Currently, only profiles is available.

Request Body schema: application/json
identifierValue
required
string

Value of the selected identifier. Note that IDs must also be sent as strings.

segmentationIds
required
Array of strings <uuid> <= 10 items

UUIDs of the segmentations to check

Responses

Request samples

Content type
application/json
{
  • "identifierValue": "string",
  • "segmentationIds": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Calculate expression for profile

Calculate the result of an expressions in context of a single profile.


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_EXPRESSION_FOR_CLIENT_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
namespace
required
string
Value: "profiles"

Namespace. Currently, only profiles is available.

expressionId
required
string <uuid>

Expression ID

identifierType
required
string
Enum: "id" "uuid" "email" "custom_identify"

Profile identifier type

Request Body schema: application/json
identifierValue
required
string

Value of the selected identifier. Note that IDs must also be sent as strings.

Responses

Request samples

Content type
application/json
{
  • "identifierValue": "string"
}

Response samples

Content type
application/json
{ }

List histograms

Returns a paginated list of histograms.


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_HISTOGRAMS_LIST_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
namespace
required
string
Value: "profiles"

Namespace. Currently, only profiles is available.

query Parameters
page
integer <int32> >= 1
Default: 1
limit
integer <int32>
Default: 50

Limit of items per page

search
string
sortBy
string
directoryId
string <uuid>
ids
string

Comma-separated list of ids (in UUID format) to filter results through

Responses

Request samples

curl --request GET 
  --url 'https://api.synerise.com/analytics/%7Bnamespace%7D/histograms?page=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE&search=SOME_STRING_VALUE&sortBy=SOME_STRING_VALUE&directoryId=SOME_STRING_VALUE&ids=SOME_STRING_VALUE' 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ]
}

Create histogram analysis


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_HISTOGRAMS_CREATE

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
namespace
required
string
Value: "profiles"

Namespace. Currently, only profiles is available.

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{
  • "analysis": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Get histogram analysis details


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_HISTOGRAMS_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
namespace
required
string
Value: "profiles"

Namespace. Currently, only profiles is available.

histogramId
required
string <uuid>

Histogram ID

Responses

Request samples

curl --request GET 
  --url https://api.synerise.com/analytics/%7Bnamespace%7D/histograms/%7BhistogramId%7D 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "businessProfileId": 0,
  • "name": "string",
  • "author": 0,
  • "modifier": 0,
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "analysis": {
    },
  • "isPredefinedAnalytic": true,
  • "isDynamicAnalytic": true,
  • "isDeleted": true,
  • "namespace": "48_p_clients",
  • "directoryId": "786c2ec1-fb9a-4593-b705-005b34c18c18"
}

Update analysis histogram


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_HISTOGRAMS_UPDATE

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
namespace
required
string
Value: "profiles"

Namespace. Currently, only profiles is available.

histogramId
required
string <uuid>

Histogram ID

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{
  • "analysis": {
    }
}

Response samples

Content type
application/json
{
  • "path": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "errorCode": "string",
  • "status": 0,
  • "message": "string",
  • "traceId": "string"
}

Delete analysis histogram


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_HISTOGRAMS_DELETE

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
namespace
required
string
Value: "profiles"

Namespace. Currently, only profiles is available.

histogramId
required
string <uuid>

Histogram ID

Responses

Request samples

curl --request DELETE 
  --url https://api.synerise.com/analytics/%7Bnamespace%7D/histograms/%7BhistogramId%7D 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

Content type
application/json
{
  • "path": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "errorCode": "string",
  • "status": 0,
  • "message": "string",
  • "traceId": "string"
}

List reports

Returns a paginated list of reports.


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_REPORTS_LIST_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
namespace
required
string
Value: "profiles"

Namespace. Currently, only profiles is available.

query Parameters
page
integer <int32> >= 1
Default: 1
limit
integer <int32>
Default: 50

Limit of items per page

search
string
sortBy
string
directoryId
string <uuid>
ids
string

Comma-separated list of ids (in UUID format) to filter results through

Responses

Request samples

curl --request GET 
  --url 'https://api.synerise.com/analytics/%7Bnamespace%7D/reports?page=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE&search=SOME_STRING_VALUE&sortBy=SOME_STRING_VALUE&directoryId=SOME_STRING_VALUE&ids=SOME_STRING_VALUE' 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ]
}

Create report analysis


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_REPORTS_CREATE

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
namespace
required
string
Value: "profiles"

Namespace. Currently, only profiles is available.

Request Body schema: application:json
object
allowNull
boolean

Responses

Request samples

Content type
application:json
{
  • "analysis": {
    },
  • "allowNull": true
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Get report analysis details


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_REPORTS_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
reportId
required
string <uuid>

Report ID

namespace
required
string
Value: "profiles"

Namespace. Currently, only profiles is available.

Responses

Request samples

curl --request GET 
  --url https://api.synerise.com/analytics/%7Bnamespace%7D/reports/%7BreportId%7D 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "businessProfileId": 48,
  • "name": "string",
  • "description": "string",
  • "author": 0,
  • "modifier": 0,
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "analysis": {
    },
  • "isPredefinedAnalytic": true,
  • "isDynamicAnalytic": true,
  • "allowNull": true,
  • "isDeleted": true,
  • "namespace": "48_p_clients",
  • "directoryId": "786c2ec1-fb9a-4593-b705-005b34c18c18"
}

Update report analysis


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_REPORTS_UPDATE

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
reportId
required
string <uuid>

Report ID

namespace
required
string
Value: "profiles"

Namespace. Currently, only profiles is available.

Request Body schema: application/json
object
allowNull
boolean

Responses

Request samples

Content type
application/json
{
  • "analysis": {
    },
  • "allowNull": true
}

Response samples

Content type
application/json
{
  • "path": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "errorCode": "string",
  • "status": 0,
  • "message": "string",
  • "traceId": "string"
}

Delete report analysis


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_REPORTS_DELETE

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
reportId
required
string <uuid>

Report ID

namespace
required
string
Value: "profiles"

Namespace. Currently, only profiles is available.

Responses

Request samples

curl --request DELETE 
  --url https://api.synerise.com/analytics/%7Bnamespace%7D/reports/%7BreportId%7D 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

Content type
application/json
{
  • "path": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "errorCode": "string",
  • "status": 0,
  • "message": "string",
  • "traceId": "string"
}

List aggregates

Returns a paginated list of aggregates.


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_AGGREGATES_LIST_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
namespace
required
string
Value: "profiles"

Namespace. Currently, only profiles is available.

query Parameters
page
integer <int32> >= 1
Default: 1
limit
integer <int32>
Default: 50

Limit of items per page

search
string
sortBy
string
directoryId
string <uuid>
ids
string

Comma-separated list of ids (in UUID format) to filter results through

Responses

Request samples

curl --request GET 
  --url 'https://api.synerise.com/analytics/%7Bnamespace%7D/aggregates?page=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE&search=SOME_STRING_VALUE&sortBy=SOME_STRING_VALUE&directoryId=SOME_STRING_VALUE&ids=SOME_STRING_VALUE' 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ]
}

List expressions

Returns a paginated list of expressions.


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_EXPRESSIONS_LIST_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
namespace
required
string
Value: "profiles"

Namespace. Currently, only profiles is available.

query Parameters
page
integer <int32> >= 1
Default: 1
limit
integer <int32>
Default: 50

Limit of items per page

search
string
sortBy
string
directoryId
string <uuid>
ids
string

Comma-separated list of ids (in UUID format) to filter results through

Responses

Request samples

curl --request GET 
  --url 'https://api.synerise.com/analytics/%7Bnamespace%7D/expressions?page=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE&search=SOME_STRING_VALUE&sortBy=SOME_STRING_VALUE&directoryId=SOME_STRING_VALUE&ids=SOME_STRING_VALUE' 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ]
}

Create expression entity


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_EXPRESSIONS_CREATE

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
namespace
required
string
Value: "profiles"

Namespace. Currently, only profiles is available.

Responses

Request samples

curl --request POST 
  --url https://api.synerise.com/analytics/%7Bnamespace%7D/expressions 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Get expression details


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_EXPRESSIONS_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
namespace
required
string
Value: "profiles"

Namespace. Currently, only profiles is available.

expressionId
required
string <uuid>

Expression ID

Responses

Request samples

curl --request GET 
  --url https://api.synerise.com/analytics/%7Bnamespace%7D/expressions/%7BexpressionId%7D 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "businessProfileId": 0,
  • "name": "string",
  • "description": "string",
  • "author": 0,
  • "modifier": 0,
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "analysis": {
    },
  • "isPredefinedAnalytic": true,
  • "isVisibleForClientProfile": true,
  • "isDynamicAnalytic": true,
  • "isDeleted": true,
  • "analyticVersion": "b7fef916-6206-4574-baf5-7763ce0ade4d",
  • "namespace": "48_p_clients",
  • "directoryId": "786c2ec1-fb9a-4593-b705-005b34c18c18"
}

Update expression


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_EXPRESSIONS_UPDATE

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
namespace
required
string
Value: "profiles"

Namespace. Currently, only profiles is available.

expressionId
required
string <uuid>

Expression ID

Responses

Request samples

curl --request PUT 
  --url https://api.synerise.com/analytics/%7Bnamespace%7D/expressions/%7BexpressionId%7D 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

Content type
application/json
{
  • "path": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "errorCode": "string",
  • "status": 0,
  • "message": "string",
  • "traceId": "string"
}

Delete expression


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_EXPRESSIONS_DELETE

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
namespace
required
string
Value: "profiles"

Namespace. Currently, only profiles is available.

expressionId
required
string <uuid>

Expression ID

Responses

Request samples

curl --request DELETE 
  --url https://api.synerise.com/analytics/%7Bnamespace%7D/expressions/%7BexpressionId%7D 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

Content type
application/json
{
  • "path": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "errorCode": "string",
  • "status": 0,
  • "message": "string",
  • "traceId": "string"
}

List funnels

Returns a paginated list of funnels.


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_FUNNELS_LIST_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
namespace
required
string
Value: "profiles"

Namespace. Currently, only profiles is available.

query Parameters
page
integer <int32> >= 1
Default: 1
limit
integer <int32>
Default: 50

Limit of items per page

search
string
sortBy
string
directoryId
string <uuid>
ids
string

Comma-separated list of ids (in UUID format) to filter results through

Responses

Request samples

curl --request GET 
  --url 'https://api.synerise.com/analytics/%7Bnamespace%7D/funnels?page=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE&search=SOME_STRING_VALUE&sortBy=SOME_STRING_VALUE&directoryId=SOME_STRING_VALUE&ids=SOME_STRING_VALUE' 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ]
}

Create a funnel analysis.

Create a funnel analysis.


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_FUNNELS_CREATE

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
namespace
required
string
Value: "profiles"

Namespace. Currently, only profiles is available.

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "analysis": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Get funnel details


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_FUNNELS_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
namespace
required
string
Value: "profiles"

Namespace. Currently, only profiles is available.

funnelId
required
string <uuid>

Funnel UUID

Responses

Request samples

curl --request GET 
  --url https://api.synerise.com/analytics/%7Bnamespace%7D/funnels/%7BfunnelId%7D 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "businessProfileId": 0,
  • "name": "string",
  • "description": "string",
  • "author": 0,
  • "modifier": 0,
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "analysis": {
    },
  • "isPredefinedAnalytic": true,
  • "isDynamicAnalytic": true,
  • "isDeleted": true,
  • "namespace": "48_p_clients",
  • "directoryId": "786c2ec1-fb9a-4593-b705-005b34c18c18"
}

Update funnel analysis


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_FUNNELS_UPDATE

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
namespace
required
string
Value: "profiles"

Namespace. Currently, only profiles is available.

funnelId
required
string <uuid>

Funnel UUID

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "analysis": {
    }
}

Response samples

Content type
application/json
{
  • "path": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "errorCode": "string",
  • "status": 0,
  • "message": "string",
  • "traceId": "string"
}

Delete funnel analysis


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_FUNNELS_DELETE

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
namespace
required
string
Value: "profiles"

Namespace. Currently, only profiles is available.

funnelId
required
string <uuid>

Funnel UUID

Responses

Request samples

curl --request DELETE 
  --url https://api.synerise.com/analytics/%7Bnamespace%7D/funnels/%7BfunnelId%7D 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

Content type
application/json
{
  • "path": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "errorCode": "string",
  • "status": 0,
  • "message": "string",
  • "traceId": "string"
}

List metrics

Returns a paginated list of metrics.


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_METRICS_LIST_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
namespace
required
string
Value: "profiles"

Namespace. Currently, only profiles is available.

query Parameters
page
integer <int32> >= 1
Default: 1
limit
integer <int32>
Default: 50

Limit of items per page

search
string
sortBy
string
directoryId
string <uuid>
ids
string

Comma-separated list of ids (in UUID format) to filter results through

Responses

Request samples

curl --request GET 
  --url 'https://api.synerise.com/analytics/%7Bnamespace%7D/metrics?page=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE&search=SOME_STRING_VALUE&sortBy=SOME_STRING_VALUE&directoryId=SOME_STRING_VALUE&ids=SOME_STRING_VALUE' 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ]
}

Create metric analysis


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_METRICS_CREATE

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
namespace
required
string
Value: "profiles"

Namespace. Currently, only profiles is available.

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "analysis": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Get analysis metric details


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_METRICS_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

path Parameters
metricId
required
string <uuid>

Metric UUID

namespace
required
string
Value: "profiles"

Namespace. Currently, only profiles is available.

Responses

Request samples

curl --request GET 
  --url https://api.synerise.com/analytics/%7Bnamespace%7D/metrics/%7BmetricId%7D

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "businessProfileId": 0,
  • "name": "string",
  • "author": 0,
  • "modifier": 0,
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "analysis": {
    },
  • "isPredefinedAnalytic": true,
  • "isDynamicAnalytic": true,
  • "isMetricHistogram": true,
  • "isDeleted": true,
  • "namespace": "48_p_clients",
  • "directoryId": "786c2ec1-fb9a-4593-b705-005b34c18c18"
}

Update metric analysis


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_METRICS_UPDATE

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
metricId
required
string <uuid>

Metric UUID

namespace
required
string
Value: "profiles"

Namespace. Currently, only profiles is available.

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "analysis": {
    }
}

Response samples

Content type
application/json
{
  • "path": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "errorCode": "string",
  • "status": 0,
  • "message": "string",
  • "traceId": "string"
}

Delete metric analysis


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_METRICS_DELETE

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
metricId
required
string <uuid>

Metric UUID

namespace
required
string
Value: "profiles"

Namespace. Currently, only profiles is available.

Responses

Request samples

curl --request DELETE 
  --url https://api.synerise.com/analytics/%7Bnamespace%7D/metrics/%7BmetricId%7D 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

Content type
application/json
{
  • "path": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "errorCode": "string",
  • "status": 0,
  • "message": "string",
  • "traceId": "string"
}

List sankeys

Returns a paginated list of sankeys.


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_SANKEYS_LIST_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
namespace
required
string
Value: "profiles"

Namespace. Currently, only profiles is available.

query Parameters
page
integer <int32> >= 1
Default: 1
limit
integer <int32>
Default: 50

Limit of items per page

search
string
sortBy
string
directoryId
string <uuid>
ids
string

Comma-separated list of ids (in UUID format) to filter results through

Responses

Request samples

curl --request GET 
  --url 'https://api.synerise.com/analytics/%7Bnamespace%7D/sankeys?page=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE&search=SOME_STRING_VALUE&sortBy=SOME_STRING_VALUE&directoryId=SOME_STRING_VALUE&ids=SOME_STRING_VALUE' 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": [
    ]
}

Create sankey analysis

Create sankey analysis


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_SANKEYS_CREATE

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
namespace
required
string
Value: "profiles"

Namespace. Currently, only profiles is available.

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "analysis": {
    }
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Sankey analysis details

Sankey details


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_SANKEYS_LIST_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
namespace
required
string
Value: "profiles"

Namespace. Currently, only profiles is available.

sankeyId
required
string <uuid>

Sankey UUID

Responses

Request samples

curl --request GET 
  --url https://api.synerise.com/analytics/%7Bnamespace%7D/sankeys/%7BsankeyId%7D 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "businessProfileId": 48,
  • "name": "9ffa9185-7453-4fb2-aa6a-3105a6ae83a8",
  • "description": "string",
  • "author": 0,
  • "modifier": 0,
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "createdAt": 0,
  • "analysis": {
    },
  • "isPredefinedAnalytic": true,
  • "isDynamicAnalytic": true,
  • "isDeleted": true,
  • "namespace": "48_p_clients",
  • "directoryId": "786c2ec1-fb9a-4593-b705-005b34c18c18"
}

Sankey analysis details

Update sankey analysis


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_SANKEYS_UPDATE

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
namespace
required
string
Value: "profiles"

Namespace. Currently, only profiles is available.

sankeyId
required
string <uuid>

Sankey UUID

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "analysis": {
    }
}

Response samples

Content type
application/json
{
  • "path": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "errorCode": "string",
  • "status": 0,
  • "message": "string",
  • "traceId": "string"
}

Delete sankey analysis

Sankey details


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_SANKEYS_DELETE

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
namespace
required
string
Value: "profiles"

Namespace. Currently, only profiles is available.

sankeyId
required
string <uuid>

Sankey UUID

Responses

Request samples

curl --request DELETE 
  --url https://api.synerise.com/analytics/%7Bnamespace%7D/sankeys/%7BsankeyId%7D 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

Content type
application/json
{
  • "path": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "errorCode": "string",
  • "status": 0,
  • "message": "string",
  • "traceId": "string"
}

List directories

Returns a list of directories of given analytic type.


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_DESCRIPTION_ANALYTICS_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
query Parameters
analyticType
required
string
Enum: "EXPRESSION" "AGGREGATE" "SEGMENTATION" "METRIC" "FUNNEL" "SANKEY" "TREND" "HISTOGRAM" "REPORT" "ANALYTICS_QUERY" "ANALYTICS_DASHBOARD"

Type of object

Responses

Request samples

curl --request GET 
  --url 'https://api.synerise.com/analytics/directories?analyticType=SOME_STRING_VALUE' 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

Content type
application/json
[
  • {
    }
]

Create Directory

Creates a new directory


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_DESCRIPTION_ANALYTICS_CREATE

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
Request Body schema: application/json
name
required
string
analyticType
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "analyticType": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Delete Directory

Deletes a directory


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_DESCRIPTION_ANALYTICS_DELETE

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
directoryId
required
string <uuid>

Id of a directory

Responses

Request samples

curl --request DELETE 
  --url https://api.synerise.com/analytics/directories/%7BdirectoryId%7D 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Rename Directory

Renames a directory


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_DESCRIPTION_ANALYTICS_UPDATE

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
directoryId
required
string <uuid>

Id of a directory

Request Body schema: application/json
newName
required
string

Responses

Request samples

Content type
application/json
{
  • "newName": "string"
}

Response samples

Content type
application/json
{
  • "path": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "errorCode": "string",
  • "status": 0,
  • "message": "string",
  • "traceId": "string"
}

Change Directory

Changes the directory of the analytic


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_DESCRIPTION_ANALYTICS_UPDATE

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
analyticId
required
string <uuid>

Id of the analytic

Request Body schema: application/json
newDir
required
string <uuid>
analyticType
required
string

Responses

Request samples

Content type
application/json
{
  • "newDir": "927cf82e-bfcc-4026-ba0d-96408cda03cb",
  • "analyticType": "string"
}

Response samples

Content type
application/json
{
  • "path": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "errorCode": "string",
  • "status": 0,
  • "message": "string",
  • "traceId": "string"
}

getHistogram

Get histogram with given uuid


  • API consumers who can use this method: Synerise User, Workspace (formerly Business Profile)

  • API key Permissions are assigned to API keys (for Profile and Workspace scopes) and dictate which operations are available when using a particular API key. In the application, you can manage those permissions in Settings > API Keys. Remember that Profile and Workspace API keys are separate entities.permission required: ANALYTICS_BACKEND_METRIC_HISTOGRAM_READ

  • User permissions are grouped and assigned to user roles. For each group, you can set separate permissions for the following operations: read, execute, create, edit, delete. In the application, they are available in Settings > Roles. To edit a role's permissions, hover over the role and click the "Permissions" button.User role permission group which allows access to this method: ANALYTICS

Authorizations:
path Parameters
histogramId
required
string <uuid>

Histogram ID

Responses

Request samples

curl --request GET 
  --url https://api.synerise.com/analytics/anaytics/v2/metric/histograms/%7BhistogramId%7D 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

Content type
application/json;charset=UTF-8
{
  • "title": "string",
  • "description": "string",
  • "histogram": {
    }
}