Analytics Suite (Feb 19, 2025, 10:54:10 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 eyJhbGdiOiJSzZXIaLCJjdGQiOjE1NTI0NjMzMjg4NjIsImF1dGgiOiJINHNJQUFBQUFBQUFBSXVPQlFBcHUwd05BZ0FBQUE9PSIsIm5tZSI' \
-H 'Content-Type: application/json'

Remember to include a space between Bearer and the token.

By default, the token is valid for one week (see workspace settings). 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

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

200

Content type

application/json

{"consumer": {"type": "USER",
"businessProfileId": 0,
"name": "string",
"id": 0,
"authorities": ["string"
],
"roles": "string"
},
"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:

JWT

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

200

Content type

application/json

{"consumer": {"type": "USER",
"businessProfileId": 0,
"name": "string",
"id": 0,
"authorities": ["string"
],
"roles": "string"
},
"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:

JWT

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

200
423

Content type

application/json

{"consumer": {"type": "USER",
"businessProfileId": 0,
"name": "string",
"id": 0,
"authorities": ["string"
],
"roles": "string"
},
"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:

JWT

Responses

Request samples

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

Response samples

200

Content type

application/json

[{"businessProfileGuid": "string",
"logo": "string",
"name": "string",
"id": 0,
"created": "2019-08-24T14:15:22Z",
"subdomain": "string",
"ipRestricted": true,
"mfaRequired": true
}
]

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:

JWT

Responses

Request samples

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

Response samples

200

Content type

application/json

{"selected": true,
"data": {"id": 0,
"name": "string",
"logo": "string",
"businessProfileGuid": "string",
"created": "2019-08-24T14:15:22Z",
"subdomain": "string",
"ipRestriction": "OFF",
"mfaRestriction": "OFF"
}
}

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

200
400
401

Content type

application/json

{"token": "string"
}

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:

JWT

Request Body schema: application/json

apiKey

required

string

Profile (formerly "Client") API key

Responses

Request samples

Content type

application/json

{"apiKey": "string"
}

Response samples

200
401

Content type

application/json

{"token": "string",
"expiration": 1649283173,
"created": 1649277173668,
"origin": "SYNERISE",
"customId": "card123",
"realm": "client"
}

Authenticate as Profile

Obtain a new JWT 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 (formerly "Client") 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://hub.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 pattern (ECMA flavor): `/[\r\n\u2028\u2029\u00AD\u0000\uFE00-\uFE0F]/` String values: can't include variation selectors (`[\uFE00-\uFE0F]`), unless there are other characters in the string. can't include the "null" control character (`\u0000`) 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. Tag names (strings): can't include variation selectors (`[\uFE00-\uFE0F]`), unless there are other characters in the string. can't include the "null" control character (`\u0000`)

Responses

Request samples

Content type

application/json

{"apiKey": "string",
"identityProvider": "SYNERISE",
"identityProviderToken": "string",
"email": "string",
"customId": null,
"password": "string",
"uuid": "string",
"deviceId": "string",
"agreements": {"email": false,
"sms": false,
"push": false,
"webPush": false,
"bluetooth": false,
"rfid": false,
"wifi": false
},
"attributes": {"property1": null,
"property2": null
},
"tags": ["string"
]
}

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 Profile with a server

Obtain a new JWT for a Profile. This method is designed to be used from a backend server that handles login requests and communicates with Synerise to execute them.
If an account for the Profile does not exist and the identityProvider is different than SYNERISE, this request creates an account.

API consumer who can use this method: 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: SAUTH_SERVER_LOGIN_CLIENT_CREATE

Request Body schema: application/json

ipAddress required	string The IP address of the client device that is logging in.
apiKey required	string Profile (formerly "Client") 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://hub.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 pattern (ECMA flavor): `/[\r\n\u2028\u2029\u00AD\u0000\uFE00-\uFE0F]/` String values: can't include variation selectors (`[\uFE00-\uFE0F]`), unless there are other characters in the string. can't include the "null" control character (`\u0000`) 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. Tag names (strings): can't include variation selectors (`[\uFE00-\uFE0F]`), unless there are other characters in the string. can't include the "null" control character (`\u0000`)

Responses

Request samples

Content type

application/json

{"ipAddress": "string",
"apiKey": "string",
"identityProvider": "SYNERISE",
"identityProviderToken": "string",
"email": "string",
"customId": null,
"password": "string",
"uuid": "string",
"deviceId": "string",
"agreements": {"email": false,
"sms": false,
"push": false,
"webPush": false,
"bluetooth": false,
"rfid": false,
"wifi": false
},
"attributes": {"property1": null,
"property2": null
},
"tags": ["string"
]
}

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:

JWT

Request Body schema: application/json

apiKey required	string Profile (formerly "Client") 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://hub.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 pattern (ECMA flavor): `/[\r\n\u2028\u2029\u00AD\u0000\uFE00-\uFE0F]/` String values: can't include variation selectors (`[\uFE00-\uFE0F]`), unless there are other characters in the string. can't include the "null" control character (`\u0000`) 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. Tag names (strings): can't include variation selectors (`[\uFE00-\uFE0F]`), unless there are other characters in the string. can't include the "null" control character (`\u0000`)

Responses

Request samples

Content type

application/json

{"apiKey": "string",
"identityProvider": "SYNERISE",
"identityProviderToken": "string",
"email": "string",
"customId": null,
"password": "string",
"uuid": "string",
"deviceId": "string",
"agreements": {"email": false,
"sms": false,
"push": false,
"webPush": false,
"bluetooth": false,
"rfid": false,
"wifi": false
},
"attributes": {"property1": null,
"property2": null
},
"tags": ["string"
]
}

Response samples

Content type

application/json

{"conditions": ["string"
],
"status": "SUCCESS",
"token": "string",
"expiration": 1649283173,
"created": 1649277173668,
"origin": "SYNERISE",
"customId": "card123",
"realm": "client"
}

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 required	string Profile (formerly "Client") API key
uuid required	string UUID of the Profile. It is a unique identifier. The value can't include any characters that match the pattern (ECMA flavor): `/([\uD800-\uDBFF][\uDC00-\uDFFF])\|([\r\n\u2028\u2029\u00AD]\|[\uFE00-\uFE0F]\|[\u0000])/`
deviceId	string Unique iOS or Android device identifier.

Responses

Request samples

Content type

application/json

{"apiKey": "string",
"uuid": "07243772-008a-42e1-ba37-c3807cebde8f",
"deviceId": "string"
}

Response samples

200
401

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"
}

Aggregates

Analyze event occurrences in a Profile context

Get aggregate preview

Retrieve aggregate preview value. Previews are only available for the AGGREGATE type (profile aggregate). This request doesn't save an aggregate to 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.permissions required: ANALYTICS_BACKEND_AGGREGATES_READ, 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_AGGREGATES

Authorizations:

JWT

path Parameters

namespace required	string Value: "profiles" Namespace. Currently, only `profiles` is available.
identifierType required	string Enum: "id" "uuid" "email" "custom_identify" Profile identifier type

Request Body schema: application/json

required	object Structure of the analysis. For previews, the `oldId` parameter can have any value.
identifierValue required	string Value of the profile identifier selected in `identifierType` (profile ID is sent as a string)

Responses

Request samples

Content type

application/json

{"aggregate": {"oldId": 0,
"aggregateType": "AGGREGATE",
"name": "string",
"description": "string",
"action": {"id": 0,
"name": "page.visit"
},
"attribute": {"type": "PARAM",
"param": "string",
"id": 0
},
"type": "AVG",
"level": 0.01,
"dateFilter": {"type": "ABSOLUTE",
"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"filter": {"type": "DAILY",
"nestingType": "IN_PLACE",
"from": "string",
"to": "string",
"inverted": false
}
},
"size": 0,
"unique": false,
"expressions": [{"attribute": {"type": "PARAM",
"param": "string",
"id": 0
},
"constraint": {"type": "BOOL",
"logic": "IS_TRUE"
}
}
]
},
"identifierValue": "string"
}

Response samples

200
4XX
5XX

Content type

application/json

{"aggregateId": "71d8973e-d665-45f6-9260-c96cc190809b",
"aggregateuuid": "323376c1-402e-474d-99c1-29c85eb6991d",
"clientId": 0,
"title": "string",
"result": { },
"variables": [{"name": "string",
"value": "string"
}
],
"dateFilter": {"type": "ABSOLUTE",
"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"filter": {"type": "DAILY",
"nestingType": "IN_PLACE",
"from": "string",
"to": "string",
"inverted": false
}
},
"analyticVersion": "b7fef916-6206-4574-baf5-7763ce0ade4d"
}

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:

JWT

path Parameters

aggregateId required	string <uuid> Aggregate ID
clientId required	integer <int64> Client ID

Request Body schema: application/json

required	Array of objects[ items ] A list of variable values to use in this calculation
required	Absolute (object) or Relative (object) Definition of a date filter. Only data that meets the result of the filter will be included in the analysis. For no filter, leave this object empty. An absolute date filter lets you define static dates and times that always apply to the analysis. A relative date filter lets you create a date filter that goes back a certain time from the moment of calculating the analysis.
required	object The interval for grouping data

Responses

Request samples

Content type

application/json

{"variables": [{"name": "string",
"value": "string"
}
],
"dateFilter": {"type": "ABSOLUTE",
"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"filter": {"type": "DAILY",
"nestingType": "IN_PLACE",
"from": "string",
"to": "string",
"inverted": false
}
},
"aggregateDataBy": {"type": "YEARS",
"value": 0
}
}

Response samples

200
4XX
5XX

Content type

application/json

{"items": [{"aggregateTimeDescription": "string",
"values": [{"metricId": "c2cc9ad9-a69d-40a3-8e01-a95e09e71978",
"value": 0
}
]
}
],
"metadata": {"period": {"type": "YEARS",
"value": 0
},
"dateFilter": {"type": "ABSOLUTE",
"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"filter": {"type": "DAILY",
"nestingType": "IN_PLACE",
"from": "string",
"to": "string",
"inverted": false
}
}
}
}

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:

JWT

path Parameters

namespace

required

string

Value: "profiles"

Namespace. Currently, only profiles is available.

query Parameters

page	integer <int32> >= 1 Default: 1 The number of the page to retrieve
limit	integer <int32> Default: 50 Limit of items per page
search	string A string to search for in analyses' titles
sortBy	string Default: "updatedAt:desc" Enum: "name:asc" "name:desc" "author:asc" "author:desc" "updatedAt:asc" "updatedAt:desc" "createdAt:asc" "createdAt:desc" "id:asc" "id:desc" "directoryId:asc" "directoryId:desc" Example: sortBy=name:asc You can sort the results. The sorting direction is selected by adding `asc` or `desc`, for example `sortBy=name:desc`.
directoryId	string <uuid> Unique ID of the directory to retrieve analyses from
ids	string Comma-separated list of IDs (in UUID format) to filter results through
aggregateType	string Enum: "AGGREGATE" "RUNNING_AGGREGATE" Filter by aggregate type

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=name%3Aasc&directoryId=SOME_STRING_VALUE&ids=SOME_STRING_VALUE&aggregateType=SOME_STRING_VALUE' 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

200
4XX
5XX

Content type

application/json

{"meta": {"links": [{"url": "string",
"rel": "first"
}
],
"limit": 0,
"count": 0
},
"data": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"author": {"id": 0,
"name": "string",
"iconUrl": "string"
},
"updatedAt": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z",
"directoryId": "786c2ec1-fb9a-4593-b705-005b34c18c18",
"isDynamicAnalytic": true,
"aggregateType": "AGGREGATE",
"variables": [{"name": "event.params.PARAMNAME",
"value": "string"
}
]
}
]
}

Create aggregate

Create an aggregate analysis and save it to 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.permissions required: ANALYTICS_BACKEND_AGGREGATES_CREATE, 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_AGGREGATES

Authorizations:

JWT

path Parameters

namespace

required

string

Value: "profiles"

Namespace. Currently, only profiles is available.

Request Body schema: application/json

required	object or object Definition of the aggregate
isVisibleForClientProfile required	boolean When set to `true`, information about this analysis is shown on a profile's card.
previewDefaultObjectId	number <int64> The ID of the default profile for generating a preview of the results.

Responses

Request samples

Content type

application/json

{"analysis": {"aggregateType": "RUNNING_AGGREGATE",
"excludeCurrent": true,
"name": "string",
"description": "string",
"action": {"id": 0,
"name": "page.visit"
},
"attribute": {"type": "PARAM",
"param": "string",
"id": 0
},
"type": "AVG",
"level": 0.01,
"dateFilter": {"type": "ABSOLUTE",
"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"filter": {"type": "DAILY",
"nestingType": "IN_PLACE",
"from": "string",
"to": "string",
"inverted": false
}
},
"size": 0,
"unique": false,
"expressions": [{"attribute": {"type": "PARAM",
"param": "string",
"id": 0
},
"constraint": {"type": "BOOL",
"logic": "IS_TRUE"
}
}
]
},
"isVisibleForClientProfile": true,
"previewDefaultObjectId": 0
}

Response samples

201
4XX
5XX

Content type

application/json

"497f6eca-6276-4993-bfeb-53cbbbba6f08"

Get aggregates for profile card

Retrieve aggregates 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_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:

JWT

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 profile identifier selected in identifierType (profile ID is sent as a string)

Responses

Request samples

Content type

application/json

{"identifierValue": "string"
}

Response samples

200
4XX
5XX

Content type

application/json

[{"id": "5370bf3c-2dfa-4e89-98ff-07100cffee6c",
"name": "Nice people who read the documentation",
"result": {"success": true,
"value": "123"
}
}
]

Get aggregate details

Retrieve all data about an aggregate definition.

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.permissions required: ANALYTICS_BACKEND_AGGREGATES_READ, 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_AGGREGATES

Authorizations:

JWT

path Parameters

namespace required	string Value: "profiles" Namespace. Currently, only `profiles` is available.
aggregateId required	string <uuid> Aggregate ID

Responses

Request samples

curl --request GET 
  --url https://api.synerise.com/analytics/%7Bnamespace%7D/aggregates/%7BaggregateId%7D 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

200
4XX
5XX

Content type

application/json

{"oldId": 0,
"analysis": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"oldId": 0,
"aggregateType": "RUNNING_AGGREGATE",
"excludeCurrent": true,
"name": "string",
"description": "string",
"action": {"id": 0,
"name": "page.visit"
},
"attribute": {"type": "PARAM",
"param": "string",
"id": 0
},
"type": "AVG",
"level": 0.01,
"dateFilter": {"type": "ABSOLUTE",
"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"filter": {"type": "DAILY",
"nestingType": "IN_PLACE",
"from": "string",
"to": "string",
"inverted": false
}
},
"size": 0,
"unique": false,
"expressions": [{"attribute": {"type": "PARAM",
"param": "string",
"id": 0
},
"constraint": {"type": "BOOL",
"logic": "IS_TRUE"
}
}
]
},
"isVisibleForClientProfile": true,
"aggregateType": "AGGREGATE",
"previewDefaultObjectId": 0,
"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",
"isPredefinedAnalytic": true,
"isDynamicAnalytic": true,
"isDeleted": true,
"namespace": "string",
"directoryId": "786c2ec1-fb9a-4593-b705-005b34c18c18"
}

Update aggregate

Update an 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.permissions required: ANALYTICS_BACKEND_AGGREGATES_UPDATE, 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_AGGREGATES

Authorizations:

JWT

path Parameters

namespace required	string Value: "profiles" Namespace. Currently, only `profiles` is available.
aggregateId required	string <uuid> Aggregate ID

Request Body schema: application/json

required	object or object
isVisibleForClientProfile required	boolean When set to `true`, information about this analysis is shown on a profile's card.
previewDefaultObjectId	number <int64> The ID of the default profile for generating a preview of the results.

Responses

Request samples

Content type

application/json

{"analysis": {"oldId": 0,
"aggregateType": "RUNNING_AGGREGATE",
"excludeCurrent": true,
"name": "string",
"description": "string",
"action": {"id": 0,
"name": "page.visit"
},
"attribute": {"type": "PARAM",
"param": "string",
"id": 0
},
"type": "AVG",
"level": 0.01,
"dateFilter": {"type": "ABSOLUTE",
"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"filter": {"type": "DAILY",
"nestingType": "IN_PLACE",
"from": "string",
"to": "string",
"inverted": false
}
},
"size": 0,
"unique": false,
"expressions": [{"attribute": {"type": "PARAM",
"param": "string",
"id": 0
},
"constraint": {"type": "BOOL",
"logic": "IS_TRUE"
}
}
]
},
"isVisibleForClientProfile": true,
"previewDefaultObjectId": 0
}

Response samples

4XX
5XX

Content type

application/json

{"timestamp": "2019-08-24T14:15:22Z",
"status": 0,
"error": "string",
"message": "string",
"path": "string"
}

Delete 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.permissions required: ANALYTICS_BACKEND_AGGREGATES_DELETE, 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_AGGREGATES

Authorizations:

JWT

path Parameters

namespace required	string Value: "profiles" Namespace. Currently, only `profiles` is available.
aggregateId required	string <uuid> Aggregate ID

Responses

Request samples

curl --request DELETE 
  --url https://api.synerise.com/analytics/%7Bnamespace%7D/aggregates/%7BaggregateId%7D 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

4XX
5XX

Content type

application/json

{"timestamp": "2019-08-24T14:15:22Z",
"status": 0,
"error": "string",
"message": "string",
"path": "string"
}

Calculate aggregate for profile

Calculate the result 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:

JWT

path Parameters

namespace required	string Value: "profiles" Namespace. Currently, only `profiles` is available.
aggregateId required	string <uuid> Aggregate ID
identifierType required	string Enum: "id" "uuid" "email" "custom_identify" Profile identifier type

Request Body schema: application/json

identifierValue

required

string

Value of the profile identifier selected in identifierType (profile ID is sent as a string)

Responses

Request samples

Content type

application/json

{"identifierValue": "string"
}

Response samples

200
4XX
5XX

Content type

application/json

{"clientId": 0,
"aggregateId": "71d8973e-d665-45f6-9260-c96cc190809b",
"name": "string",
"result": "string"
}

Expressions

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

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:

JWT

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 profile identifier selected in identifierType (profile ID is sent as a string)

Responses

Request samples

Content type

application/json

{"identifierValue": "string"
}

Response samples

200
4XX
5XX

Content type

application/json

[{"id": "5370bf3c-2dfa-4e89-98ff-07100cffee6c",
"name": "Nice people who read the documentation",
"result": {"success": true,
"value": "123"
}
}
]

Get expression details

Retrieve information about an expression 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.permissions required: ANALYTICS_BACKEND_EXPRESSIONS_READ, 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:

JWT

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

200
4XX
5XX

Content type

application/json

{"analysis": {"type": "EVENT",
"action": {"id": 0,
"name": "page.visit"
},
"name": "string",
"description": "string",
"expression": {"type": "VALUE",
"title": "string",
"value": {"type": "EVENT",
"attribute": {"type": "PARAM",
"param": "string",
"id": 0
}
}
}
},
"analyticVersion": "b7fef916-6206-4574-baf5-7763ce0ade4d",
"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",
"isPredefinedAnalytic": true,
"isDynamicAnalytic": true,
"isDeleted": true,
"namespace": "string",
"directoryId": "786c2ec1-fb9a-4593-b705-005b34c18c18"
}

Update expression

Update an existing 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.permissions required: ANALYTICS_BACKEND_EXPRESSIONS_UPDATE, 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:

JWT

path Parameters

namespace required	string Value: "profiles" Namespace. Currently, only `profiles` is available.
expressionId required	string <uuid> Expression ID

Request Body schema: application/json

isVisibleForClientProfile required	boolean When set to `true`, information about this analysis is shown on a profile's card.
required	Event expression (object) or Profile expression (object) Details of an expression analysis

Responses

Request samples

Content type

application/json

{"isVisibleForClientProfile": true,
"analysis": {"type": "EVENT",
"action": {"id": 0,
"name": "page.visit"
},
"name": "string",
"description": "string",
"expression": {"type": "VALUE",
"title": "string",
"value": {"type": "EVENT",
"attribute": {"type": "PARAM",
"param": "string",
"id": 0
}
}
}
}
}

Response samples

4XX
5XX

Content type

application/json

{"timestamp": "2019-08-24T14:15:22Z",
"status": 0,
"error": "string",
"message": "string",
"path": "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.permissions required: ANALYTICS_BACKEND_EXPRESSIONS_DELETE, 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:

JWT

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

4XX
5XX

Content type

application/json

{"timestamp": "2019-08-24T14:15:22Z",
"status": 0,
"error": "string",
"message": "string",
"path": "string"
}

Get expression preview

Retrieve expression preview value. Previews are only available for CLIENT-type expressions. This request doesn't save the 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_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:

JWT

path Parameters

namespace required	string Value: "profiles" Namespace. Currently, only `profiles` is available.
identifierType required	string Enum: "id" "uuid" "email" "custom_identify" Profile identifier type

Request Body schema: application/json

identifierValue required	string Value of the profile identifier selected in `identifierType` (profile ID is sent as a string)
required	object (Profile expression) Details of a profile expression. In the Synerise Portal, they are called attribute expressions.

Responses

Request samples

Content type

application/json

{"identifierValue": "string",
"expression": {"type": "CLIENT",
"name": "string",
"description": "string",
"expression": {"type": "VALUE",
"title": "string",
"value": {"type": "CLIENT",
"attribute": {"type": "SEGMENTATION",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
}
}
}

Response samples

200
4XX
5XX

Content type

application/json

{"expressionId": "98a623dd-0690-4acb-bbad-b1eda4955cc3",
"clientId": 0,
"title": "string",
"result": "string",
"variables": [{"name": "event.params.PARAMNAME",
"value": "string"
}
]
}

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:

JWT

path Parameters

namespace

required

string

Value: "profiles"

Namespace. Currently, only profiles is available.

query Parameters

page	integer <int32> >= 1 Default: 1 The number of the page to retrieve
limit	integer <int32> Default: 50 Limit of items per page
search	string A string to search for in analyses' titles
sortBy	string Default: "updatedAt:desc" Enum: "name:asc" "name:desc" "author:asc" "author:desc" "updatedAt:asc" "updatedAt:desc" "createdAt:asc" "createdAt:desc" "id:asc" "id:desc" "directoryId:asc" "directoryId:desc" Example: sortBy=name:asc You can sort the results. The sorting direction is selected by adding `asc` or `desc`, for example `sortBy=name:desc`.
directoryId	string <uuid> Unique ID of the directory to retrieve analyses from
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=name%3Aasc&directoryId=SOME_STRING_VALUE&ids=SOME_STRING_VALUE' 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

200
4XX
5XX

Content type

application/json

{"data": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"author": {"id": 0,
"name": "string",
"icon": "string"
},
"updatedAt": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z",
"isDynamicAnalytic": true,
"variables": [{"name": "event.params.PARAMNAME",
"value": "string"
}
]
}
],
"meta": {"links": [{"url": "string",
"rel": "first"
}
],
"limit": 0,
"count": 0
}
}

Create expression

Create an expression that is saved in the database and can be used in other analyses.

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.permissions required: ANALYTICS_BACKEND_EXPRESSIONS_CREATE, 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:

JWT

path Parameters

namespace

required

string

Value: "profiles"

Namespace. Currently, only profiles is available.

Request Body schema: application/json

isVisibleForClientProfile required	boolean When set to `true`, information about this analysis is shown on a profile's card.
required	Event expression (object) or Profile expression (object) Details of an expression analysis

Responses

Request samples

Content type

application/json

{"isVisibleForClientProfile": true,
"analysis": {"type": "EVENT",
"action": {"id": 0,
"name": "page.visit"
},
"name": "string",
"description": "string",
"expression": {"type": "VALUE",
"title": "string",
"value": {"type": "EVENT",
"attribute": {"type": "PARAM",
"param": "string",
"id": 0
}
}
}
}
}

Response samples

201
4XX
5XX

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Calculate expression for profile

Calculate the result of an 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:

JWT

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 profile identifier selected in identifierType (profile ID is sent as a string)

Responses

Request samples

Content type

application/json

{"identifierValue": "string"
}

Response samples

200
4XX
5XX

Content type

application/json

[ ]

Funnels

Follow a Profile journey step by step

Recalculate funnel with parameter override

Recalculate a funnel with new parameters and/or variable (dynamic key) 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_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:

JWT

path Parameters

funnelId

required

string <uuid>

Funnel UUID

Request Body schema: application/json

	Absolute (object) or Relative (object) Definition of a date filter. Only data that meets the result of the filter will be included in the analysis. For no filter, leave this object empty. An absolute date filter lets you define static dates and times that always apply to the analysis. A relative date filter lets you create a date filter that goes back a certain time from the moment of calculating the analysis.
	object Data aggregation (if applicable for this analysis type)
	object This filter lets you limit the results to profiles that match it. For no filter, leave the object empty.
required	Array of objects[ items ] A list of variable values to use in this calculation

Responses

Request samples

Content type

application/json

{"dateFilter": {"type": "ABSOLUTE",
"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"filter": {"type": "DAILY",
"nestingType": "IN_PLACE",
"from": "string",
"to": "string",
"inverted": false
}
},
"aggregateDataBy": {"type": "YEARS",
"value": 0
},
"filter": {"matching": true,
"expressions": [{"type": "FUNNEL",
"matching": true,
"funnel": {"completedWithin": {"period": "YEARS",
"value": 0
},
"dateFilter": {"type": "ABSOLUTE",
"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"filter": {"type": "DAILY",
"nestingType": "IN_PLACE",
"from": "string",
"to": "string",
"inverted": false
}
},
"exact": false,
"steps": [{"title": "string",
"action": {"id": 0,
"name": "page.visit"
},
"expressions": [{"attribute": {"type": null,
"param": null,
"id": null
},
"constraint": {"type": null,
"logic": null
}
}
]
}
],
"title": "string"
}
}
],
"expression": { }
},
"variables": [{"name": "string",
"value": "string"
}
]
}

Response samples

200
4XX
5XX

Content type

application/json;charset=UTF-8

{"calculationResult": [{"name": "string",
"result": 0
}
],
"metadata": {"source": [0
]
},
"timeBetweenSteps": [{"avg": 0,
"max": 0,
"min": 0
}
]
}

Get funnel details

Retrieve the definition 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.permissions required: ANALYTICS_BACKEND_FUNNELS_READ, 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:

JWT

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

200
4XX
5XX

Content type

application/json

{"analysis": {"title": "string",
"description": "string",
"funnel": {"completedWithin": {"period": "YEARS",
"value": 0
},
"dateFilter": {"type": "ABSOLUTE",
"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"filter": {"type": "DAILY",
"nestingType": "IN_PLACE",
"from": "string",
"to": "string",
"inverted": false
}
},
"exact": false,
"steps": [{"title": "string",
"action": {"id": 0,
"name": "page.visit"
},
"expressions": [{"attribute": {"type": "PARAM",
"param": "string",
"id": 0
},
"constraint": {"type": "BOOL",
"logic": "IS_TRUE"
}
}
]
}
],
"title": "string"
},
"filter": {"matching": true,
"expressions": [{"type": "FUNNEL",
"matching": true,
"funnel": {"completedWithin": {"period": "YEARS",
"value": 0
},
"dateFilter": {"type": "ABSOLUTE",
"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"filter": {"type": "DAILY",
"nestingType": "IN_PLACE",
"from": "string",
"to": "string",
"inverted": false
}
},
"exact": false,
"steps": [{"title": "string",
"action": {"id": 0,
"name": "page.visit"
},
"expressions": [{"attribute": null,
"constraint": null
}
]
}
],
"title": "string"
}
}
],
"expression": { }
}
},
"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",
"isPredefinedAnalytic": true,
"isDynamicAnalytic": true,
"isDeleted": true,
"namespace": "string",
"directoryId": "786c2ec1-fb9a-4593-b705-005b34c18c18"
}

Update funnel

Update a funnel definition

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.permissions required: ANALYTICS_BACKEND_FUNNELS_UPDATE, 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:

JWT

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

Details of the funnel

Responses

Request samples

Content type

application/json

{"analysis": {"title": "string",
"description": "string",
"funnel": {"completedWithin": {"period": "YEARS",
"value": 0
},
"dateFilter": {"type": "ABSOLUTE",
"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"filter": {"type": "DAILY",
"nestingType": "IN_PLACE",
"from": "string",
"to": "string",
"inverted": false
}
},
"exact": false,
"steps": [{"title": "string",
"action": {"id": 0,
"name": "page.visit"
},
"expressions": [{"attribute": {"type": "PARAM",
"param": "string",
"id": 0
},
"constraint": {"type": "BOOL",
"logic": "IS_TRUE"
}
}
]
}
],
"title": "string"
},
"filter": {"matching": true,
"expressions": [{"type": "FUNNEL",
"matching": true,
"funnel": {"completedWithin": {"period": "YEARS",
"value": 0
},
"dateFilter": {"type": "ABSOLUTE",
"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"filter": {"type": "DAILY",
"nestingType": "IN_PLACE",
"from": "string",
"to": "string",
"inverted": false
}
},
"exact": false,
"steps": [{"title": "string",
"action": {"id": 0,
"name": "page.visit"
},
"expressions": [{"attribute": null,
"constraint": null
}
]
}
],
"title": "string"
}
}
],
"expression": { }
}
}
}

Response samples

4XX
5XX

Content type

application/json

{"timestamp": "2019-08-24T14:15:22Z",
"status": 0,
"error": "string",
"message": "string",
"path": "string"
}

Delete funnel

Delete a 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.permissions required: ANALYTICS_BACKEND_FUNNELS_DELETE, 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:

JWT

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

4XX
5XX

Content type

application/json

{"timestamp": "2019-08-24T14:15:22Z",
"status": 0,
"error": "string",
"message": "string",
"path": "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:

JWT

path Parameters

namespace

required

string

Value: "profiles"

Namespace. Currently, only profiles is available.

query Parameters

page	integer <int32> >= 1 Default: 1 The number of the page to retrieve
limit	integer <int32> Default: 50 Limit of items per page
search	string A string to search for in analyses' titles
sortBy	string Default: "updatedAt:desc" Enum: "name:asc" "name:desc" "author:asc" "author:desc" "updatedAt:asc" "updatedAt:desc" "createdAt:asc" "createdAt:desc" "id:asc" "id:desc" "directoryId:asc" "directoryId:desc" Example: sortBy=name:asc You can sort the results. The sorting direction is selected by adding `asc` or `desc`, for example `sortBy=name:desc`.
directoryId	string <uuid> Unique ID of the directory to retrieve analyses from
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=name%3Aasc&directoryId=SOME_STRING_VALUE&ids=SOME_STRING_VALUE' 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

200
4XX
5XX

Content type

application/json

{"data": [{"analysis": {"title": "string",
"description": "string",
"funnel": {"completedWithin": {"period": "YEARS",
"value": 0
},
"dateFilter": {"type": "ABSOLUTE",
"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"filter": {"type": "DAILY",
"nestingType": "IN_PLACE",
"from": "string",
"to": "string",
"inverted": false
}
},
"exact": false,
"steps": [{"title": "string",
"action": {"id": 0,
"name": "page.visit"
},
"expressions": [{"attribute": {"type": null,
"param": null,
"id": null
},
"constraint": {"type": null,
"logic": null
}
}
]
}
],
"title": "string"
},
"filter": {"matching": true,
"expressions": [{"type": "FUNNEL",
"matching": true,
"funnel": {"completedWithin": {"period": "YEARS",
"value": 0
},
"dateFilter": {"type": "ABSOLUTE",
"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"filter": {"type": null,
"nestingType": null,
"from": null,
"to": null,
"inverted": null
}
},
"exact": false,
"steps": [{"title": null,
"action": { },
"expressions": [ ]
}
],
"title": "string"
}
}
],
"expression": { }
}
},
"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",
"isPredefinedAnalytic": true,
"isDynamicAnalytic": true,
"isDeleted": true,
"namespace": "string",
"directoryId": "786c2ec1-fb9a-4593-b705-005b34c18c18"
}
],
"meta": {"links": [{"url": "string",
"rel": "first"
}
],
"limit": 0,
"count": 0
}
}

Create a funnel

Create a 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.permissions required: ANALYTICS_BACKEND_FUNNELS_CREATE, 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:

JWT

path Parameters

namespace

required

string

Value: "profiles"

Namespace. Currently, only profiles is available.

Request Body schema: application/json

object

Details of the funnel

Responses

Request samples

Content type

application/json

{"analysis": {"title": "string",
"description": "string",
"funnel": {"completedWithin": {"period": "YEARS",
"value": 0
},
"dateFilter": {"type": "ABSOLUTE",
"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"filter": {"type": "DAILY",
"nestingType": "IN_PLACE",
"from": "string",
"to": "string",
"inverted": false
}
},
"exact": false,
"steps": [{"title": "string",
"action": {"id": 0,
"name": "page.visit"
},
"expressions": [{"attribute": {"type": "PARAM",
"param": "string",
"id": 0
},
"constraint": {"type": "BOOL",
"logic": "IS_TRUE"
}
}
]
}
],
"title": "string"
},
"filter": {"matching": true,
"expressions": [{"type": "FUNNEL",
"matching": true,
"funnel": {"completedWithin": {"period": "YEARS",
"value": 0
},
"dateFilter": {"type": "ABSOLUTE",
"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"filter": {"type": "DAILY",
"nestingType": "IN_PLACE",
"from": "string",
"to": "string",
"inverted": false
}
},
"exact": false,
"steps": [{"title": "string",
"action": {"id": 0,
"name": "page.visit"
},
"expressions": [{"attribute": null,
"constraint": null
}
]
}
],
"title": "string"
}
}
],
"expression": { }
}
}
}

Response samples

201
4XX
5XX

Content type

application/json

"497f6eca-6276-4993-bfeb-53cbbbba6f08"

Preview funnel calculation

Preview the results of a funnel. This request doesn't save the 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:

JWT

Request Body schema: application/json

object

Details of the funnel

Responses

Request samples

Content type

application/json

{"analysis": {"title": "string",
"description": "string",
"funnel": {"completedWithin": {"period": "YEARS",
"value": 0
},
"dateFilter": {"type": "ABSOLUTE",
"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"filter": {"type": "DAILY",
"nestingType": "IN_PLACE",
"from": "string",
"to": "string",
"inverted": false
}
},
"exact": false,
"steps": [{"title": "string",
"action": {"id": 0,
"name": "page.visit"
},
"expressions": [{"attribute": {"type": "PARAM",
"param": "string",
"id": 0
},
"constraint": {"type": "BOOL",
"logic": "IS_TRUE"
}
}
]
}
],
"title": "string"
},
"filter": {"matching": true,
"expressions": [{"type": "FUNNEL",
"matching": true,
"funnel": {"completedWithin": {"period": "YEARS",
"value": 0
},
"dateFilter": {"type": "ABSOLUTE",
"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"filter": {"type": "DAILY",
"nestingType": "IN_PLACE",
"from": "string",
"to": "string",
"inverted": false
}
},
"exact": false,
"steps": [{"title": "string",
"action": {"id": 0,
"name": "page.visit"
},
"expressions": [{"attribute": null,
"constraint": null
}
]
}
],
"title": "string"
}
}
],
"expression": { }
}
}
}

Response samples

200
4XX
5XX

Content type

application/json

{"calculationResult": [{"name": "string",
"result": 0
}
],
"metadata": {"source": [0
]
},
"timeBetweenSteps": [{"avg": 0,
"max": 0,
"min": 0
}
]
}

Histograms

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

Preview histogram

Preview the results of a histogram. This request doesn't save the 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:

JWT

Request Body schema: application/json

object

Details of a histogram

Responses

Request samples

Content type

application/json

{"analysis": {"title": "string",
"description": "string",
"histogram": {"dateFilter": {"type": "ABSOLUTE",
"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"filter": {"type": "DAILY",
"nestingType": "IN_PLACE",
"from": "string",
"to": "string",
"inverted": false
}
},
"period": {"type": "YEARS",
"value": 0
},
"eventMetrics": [{"metricId": "c2cc9ad9-a69d-40a3-8e01-a95e09e71978",
"chartType": "COLUMN",
"title": "string"
}
]
}
}
}

Response samples

200
4XX
5XX

Content type

application/json

{"metadata": {"period": {"type": "YEARS",
"value": 0
},
"dateFilter": {"type": "ABSOLUTE",
"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"filter": {"type": "DAILY",
"nestingType": "IN_PLACE",
"from": "string",
"to": "string",
"inverted": false
}
}
},
"items": [{"aggregateTimeDescription": "2019-08-24T14:15:22Z",
"values": [{"metricId": "c2cc9ad9-a69d-40a3-8e01-a95e09e71978",
"value": 0
}
]
}
],
"legends": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"title": "string",
"chartType": "COLUMN"
}
]
}

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:

JWT

path Parameters

namespace

required

string

Value: "profiles"

Namespace. Currently, only profiles is available.

query Parameters

page	integer <int32> >= 1 Default: 1 The number of the page to retrieve
limit	integer <int32> Default: 50 Limit of items per page
search	string A string to search for in analyses' titles
sortBy	string Default: "updatedAt:desc" Enum: "name:asc" "name:desc" "author:asc" "author:desc" "updatedAt:asc" "updatedAt:desc" "createdAt:asc" "createdAt:desc" "id:asc" "id:desc" "directoryId:asc" "directoryId:desc" Example: sortBy=name:asc You can sort the results. The sorting direction is selected by adding `asc` or `desc`, for example `sortBy=name:desc`.
directoryId	string <uuid> Unique ID of the directory to retrieve analyses from
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=name%3Aasc&directoryId=SOME_STRING_VALUE&ids=SOME_STRING_VALUE' 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

200
4XX
5XX

Content type

application/json

{"data": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"author": {"id": 0,
"name": "string",
"icon": "string"
},
"updatedAt": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z",
"isDynamicAnalytic": true,
"variables": [{"name": "event.params.PARAMNAME",
"value": "string"
}
]
}
],
"meta": {"links": [{"url": "string",
"rel": "first"
}
],
"limit": 0,
"count": 0
}
}

Create 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.permissions required: ANALYTICS_BACKEND_HISTOGRAMS_CREATE, 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:

JWT

path Parameters

namespace

required

string

Value: "profiles"

Namespace. Currently, only profiles is available.

Request Body schema: application/json

required

object

Details of a histogram

Responses

Request samples

Content type

application/json

{"analysis": {"title": "string",
"description": "string",
"histogram": {"dateFilter": {"type": "ABSOLUTE",
"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"filter": {"type": "DAILY",
"nestingType": "IN_PLACE",
"from": "string",
"to": "string",
"inverted": false
}
},
"period": {"type": "YEARS",
"value": 0
},
"eventMetrics": [{"metricId": "c2cc9ad9-a69d-40a3-8e01-a95e09e71978",
"chartType": "COLUMN",
"title": "string"
}
]
}
}
}

Response samples

200
4XX
5XX

Content type

application/json

"497f6eca-6276-4993-bfeb-53cbbbba6f08"

Get histogram details

Retrieve the details of an existing histogram definition

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.permissions required: ANALYTICS_BACKEND_HISTOGRAMS_READ, 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:

JWT

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

200
4XX
5XX

Content type

application/json

{"analysis": {"title": "string",
"description": "string",
"histogram": {"dateFilter": {"type": "ABSOLUTE",
"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"filter": {"type": "DAILY",
"nestingType": "IN_PLACE",
"from": "string",
"to": "string",
"inverted": false
}
},
"period": {"type": "YEARS",
"value": 0
},
"eventMetrics": [{"metricId": "c2cc9ad9-a69d-40a3-8e01-a95e09e71978",
"chartType": "COLUMN",
"title": "string"
}
]
}
},
"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",
"isPredefinedAnalytic": true,
"isDynamicAnalytic": true,
"isDeleted": true,
"namespace": "string",
"directoryId": "786c2ec1-fb9a-4593-b705-005b34c18c18"
}

Update histogram analysis

Update an existing 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.permissions required: ANALYTICS_BACKEND_HISTOGRAMS_UPDATE, 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:

JWT

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

Details of a histogram

Responses

Request samples

Content type

application/json

{"analysis": {"title": "string",
"description": "string",
"histogram": {"dateFilter": {"type": "ABSOLUTE",
"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"filter": {"type": "DAILY",
"nestingType": "IN_PLACE",
"from": "string",
"to": "string",
"inverted": false
}
},
"period": {"type": "YEARS",
"value": 0
},
"eventMetrics": [{"metricId": "c2cc9ad9-a69d-40a3-8e01-a95e09e71978",
"chartType": "COLUMN",
"title": "string"
}
]
}
}
}

Response samples

4XX
5XX

Content type

application/json

{"timestamp": "2019-08-24T14:15:22Z",
"status": 0,
"error": "string",
"message": "string",
"path": "string"
}

Delete 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.permissions required: ANALYTICS_BACKEND_HISTOGRAMS_DELETE, 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:

JWT

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

4XX
5XX

Content type

application/json

{"timestamp": "2019-08-24T14:15:22Z",
"status": 0,
"error": "string",
"message": "string",
"path": "string"
}

Calculate histogram with parameter override

Calculate a histogram with new parameters and/or variable (dynamic key) 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_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:

JWT

path Parameters

histogramId

required

string <uuid>

Histogram ID

Request Body schema: application/json

	Absolute (object) or Relative (object) Definition of a date filter. Only data that meets the result of the filter will be included in the analysis. For no filter, leave this object empty. An absolute date filter lets you define static dates and times that always apply to the analysis. A relative date filter lets you create a date filter that goes back a certain time from the moment of calculating the analysis.
	object Data aggregation (if applicable for this analysis type)
	object This filter lets you limit the results to profiles that match it. For no filter, leave the object empty.
required	Array of objects[ items ] A list of variable values to use in this calculation

Responses

Request samples

Content type

application/json

{"dateFilter": {"type": "ABSOLUTE",
"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"filter": {"type": "DAILY",
"nestingType": "IN_PLACE",
"from": "string",
"to": "string",
"inverted": false
}
},
"aggregateDataBy": {"type": "YEARS",
"value": 0
},
"filter": {"matching": true,
"expressions": [{"type": "FUNNEL",
"matching": true,
"funnel": {"completedWithin": {"period": "YEARS",
"value": 0
},
"dateFilter": {"type": "ABSOLUTE",
"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"filter": {"type": "DAILY",
"nestingType": "IN_PLACE",
"from": "string",
"to": "string",
"inverted": false
}
},
"exact": false,
"steps": [{"title": "string",
"action": {"id": 0,
"name": "page.visit"
},
"expressions": [{"attribute": {"type": null,
"param": null,
"id": null
},
"constraint": {"type": null,
"logic": null
}
}
]
}
],
"title": "string"
}
}
],
"expression": { }
},
"variables": [{"name": "string",
"value": "string"
}
]
}

Response samples

200
4XX
5XX

Content type

application/json

{"metadata": {"period": {"type": "YEARS",
"value": 0
},
"dateFilter": {"type": "ABSOLUTE",
"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"filter": {"type": "DAILY",
"nestingType": "IN_PLACE",
"from": "string",
"to": "string",
"inverted": false
}
}
},
"items": [{"aggregateTimeDescription": "2019-08-24T14:15:22Z",
"values": [{"metricId": "c2cc9ad9-a69d-40a3-8e01-a95e09e71978",
"value": 0
}
]
}
],
"legends": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"title": "string",
"chartType": "COLUMN"
}
]
}

Metrics

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

Calculate dynamic metric

Calculate a metric that includes variables (dynamic keys).

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:

JWT

path Parameters

metricId

required

string <uuid>

Metric UUID

Request Body schema: application/json

required

Array of objects[ items ]

Dynamic keys used in this analysis

Responses

Request samples

Content type

application/json

{"variables": [{"name": "event.params.PARAMNAME",
"value": "string"
}
]
}

Response samples

200
4XX
5XX

Content type

application/json

{"result": 0,
"metricData": {"name": "string",
"description": "string",
"format": {"compactNumbers": false,
"currency": "EUR",
"dataFormat": "cash",
"fixedLength": 0,
"useSeparator": false
},
"initialDateFilter": {"type": "ABSOLUTE",
"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"filter": {"type": "DAILY",
"nestingType": "IN_PLACE",
"from": "string",
"to": "string",
"inverted": false
}
}
}
}

Preview metric

Get the results of a metric. This request doesn't save the metric to 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:

JWT

Request Body schema: application/json

required

object

Structure of the analytical query

Responses

Request samples

Content type

application/json

{"analysis": {"title": "string",
"description": "string",
"format": {"compactNumbers": false,
"currency": "EUR",
"dataFormat": "cash",
"fixedLength": 0,
"useSeparator": false
},
"comparison": {"dateFilter": {"type": "ABSOLUTE",
"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"filter": {"type": "DAILY",
"nestingType": "IN_PLACE",
"from": "string",
"to": "string",
"inverted": false
}
}
},
"metricType": "SIMPLE",
"expression": {"type": "VALUE",
"value": {"type": "EVENT",
"title": "string",
"occurrenceType": "FIRST",
"aggregation": {"type": "COUNT",
"level": 0.01,
"attribute": {"type": "PARAM",
"param": "string",
"id": 0
}
},
"action": {"id": 0,
"name": "page.visit"
},
"dateFilter": {"type": "ABSOLUTE",
"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"filter": {"type": "DAILY",
"nestingType": "IN_PLACE",
"from": "string",
"to": "string",
"inverted": false
}
},
"filter": {"matching": true,
"expressions": [{"type": "FUNNEL",
"matching": true,
"funnel": {"completedWithin": {"period": "YEARS",
"value": 0
},
"dateFilter": {"type": "ABSOLUTE",
"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"filter": {"type": null,
"nestingType": null,
"from": null,
"to": null,
"inverted": null
}
},
"exact": false,
"steps": [{"title": null,
"action": { },
"expressions": [ ]
}
],
"title": "string"
}
}
],
"expression": { }
},
"expressions": [{"attribute": {"type": "PARAM",
"param": "string",
"id": 0
},
"constraint": {"type": "BOOL",
"logic": "IS_TRUE"
}
}
]
}
},
"isVisibleForClientProfile": true
}
}

Response samples

200
4XX
5XX

Content type

application/json

{"result": 0,
"metricData": {"name": "string",
"description": "string",
"format": {"compactNumbers": false,
"currency": "EUR",
"dataFormat": "cash",
"fixedLength": 0,
"useSeparator": false
},
"initialDateFilter": {"type": "ABSOLUTE",
"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"filter": {"type": "DAILY",
"nestingType": "IN_PLACE",
"from": "string",
"to": "string",
"inverted": false
}
}
}
}

Calculate metric with parameter override

Recalculate a metric with new parameters and/or variable (dynamic key) 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_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:

JWT

path Parameters

metricId

required

string <uuid>

Metric UUID

Request Body schema: application/json

	Absolute (object) or Relative (object) Definition of a date filter. Only data that meets the result of the filter will be included in the analysis. For no filter, leave this object empty. An absolute date filter lets you define static dates and times that always apply to the analysis. A relative date filter lets you create a date filter that goes back a certain time from the moment of calculating the analysis.
	object Data aggregation (if applicable for this analysis type)
	object This filter lets you limit the results to profiles that match it. For no filter, leave the object empty.
required	Array of objects[ items ] A list of variable values to use in this calculation

Responses

Request samples

Content type

application/json

{"dateFilter": {"type": "ABSOLUTE",
"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"filter": {"type": "DAILY",
"nestingType": "IN_PLACE",
"from": "string",
"to": "string",
"inverted": false
}
},
"aggregateDataBy": {"type": "YEARS",
"value": 0
},
"filter": {"matching": true,
"expressions": [{"type": "FUNNEL",
"matching": true,
"funnel": {"completedWithin": {"period": "YEARS",
"value": 0
},
"dateFilter": {"type": "ABSOLUTE",
"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"filter": {"type": "DAILY",
"nestingType": "IN_PLACE",
"from": "string",
"to": "string",
"inverted": false
}
},
"exact": false,
"steps": [{"title": "string",
"action": {"id": 0,
"name": "page.visit"
},
"expressions": [{"attribute": {"type": null,
"param": null,
"id": null
},
"constraint": {"type": null,
"logic": null
}
}
]
}
],
"title": "string"
}
}
],
"expression": { }
},
"variables": [{"name": "string",
"value": "string"
}
]
}

Response samples

200
4XX
5XX

Content type

application/json

{"result": 0,
"metricData": {"name": "string",
"description": "string",
"format": {"compactNumbers": false,
"currency": "EUR",
"dataFormat": "cash",
"fixedLength": 0,
"useSeparator": false
},
"initialDateFilter": {"type": "ABSOLUTE",
"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"filter": {"type": "DAILY",
"nestingType": "IN_PLACE",
"from": "string",
"to": "string",
"inverted": false
}
}
}
}

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:

JWT

path Parameters

namespace

required

string

Value: "profiles"

Namespace. Currently, only profiles is available.

query Parameters

page	integer <int32> >= 1 Default: 1 The number of the page to retrieve
limit	integer <int32> Default: 50 Limit of items per page
search	string A string to search for in analyses' titles
sortBy	string Default: "updatedAt:desc" Enum: "name:asc" "name:desc" "author:asc" "author:desc" "updatedAt:asc" "updatedAt:desc" "createdAt:asc" "createdAt:desc" "id:asc" "id:desc" "directoryId:asc" "directoryId:desc" Example: sortBy=name:asc You can sort the results. The sorting direction is selected by adding `asc` or `desc`, for example `sortBy=name:desc`.
directoryId	string <uuid> Unique ID of the directory to retrieve analyses from
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=name%3Aasc&directoryId=SOME_STRING_VALUE&ids=SOME_STRING_VALUE' 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

200
4XX
5XX

Content type

application/json

{"data": [{"analysis": {"title": "string",
"description": "string",
"format": {"compactNumbers": false,
"currency": "EUR",
"dataFormat": "cash",
"fixedLength": 0,
"useSeparator": false
},
"comparison": {"dateFilter": {"type": "ABSOLUTE",
"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"filter": {"type": "DAILY",
"nestingType": "IN_PLACE",
"from": "string",
"to": "string",
"inverted": false
}
}
},
"metricType": "SIMPLE",
"expression": {"type": "VALUE",
"value": {"type": "EVENT",
"title": "string",
"occurrenceType": "FIRST",
"aggregation": {"type": "COUNT",
"level": 0.01,
"attribute": {"type": "PARAM",
"param": "string",
"id": 0
}
},
"action": {"id": 0,
"name": "page.visit"
},
"dateFilter": {"type": "ABSOLUTE",
"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"filter": {"type": "DAILY",
"nestingType": "IN_PLACE",
"from": "string",
"to": "string",
"inverted": false
}
},
"filter": {"matching": true,
"expressions": [{"type": "FUNNEL",
"matching": true,
"funnel": {"completedWithin": { },
"dateFilter": null,
"exact": null,
"steps": [ ],
"title": null
}
}
],
"expression": { }
},
"expressions": [{"attribute": {"type": "PARAM",
"param": "string",
"id": 0
},
"constraint": {"type": "BOOL",
"logic": "IS_TRUE"
}
}
]
}
},
"isVisibleForClientProfile": true
},
"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",
"isPredefinedAnalytic": true,
"isDynamicAnalytic": true,
"isDeleted": true,
"namespace": "string",
"directoryId": "786c2ec1-fb9a-4593-b705-005b34c18c18"
}
],
"meta": {"links": [{"url": "string",
"rel": "first"
}
],
"limit": 0,
"count": 0
}
}

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.permissions required: ANALYTICS_BACKEND_METRICS_CREATE, 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:

JWT

path Parameters

namespace

required

string

Value: "profiles"

Namespace. Currently, only profiles is available.

Request Body schema: application/json

object

Structure of the analytical query

Responses

Request samples

Content type

application/json

{"analysis": {"title": "string",
"description": "string",
"format": {"compactNumbers": false,
"currency": "EUR",
"dataFormat": "cash",
"fixedLength": 0,
"useSeparator": false
},
"comparison": {"dateFilter": {"type": "ABSOLUTE",
"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"filter": {"type": "DAILY",
"nestingType": "IN_PLACE",
"from": "string",
"to": "string",
"inverted": false
}
}
},
"metricType": "SIMPLE",
"expression": {"type": "VALUE",
"value": {"type": "EVENT",
"title": "string",
"occurrenceType": "FIRST",
"aggregation": {"type": "COUNT",
"level": 0.01,
"attribute": {"type": "PARAM",
"param": "string",
"id": 0
}
},
"action": {"id": 0,
"name": "page.visit"
},
"dateFilter": {"type": "ABSOLUTE",
"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"filter": {"type": "DAILY",
"nestingType": "IN_PLACE",
"from": "string",
"to": "string",
"inverted": false
}
},
"filter": {"matching": true,
"expressions": [{"type": "FUNNEL",
"matching": true,
"funnel": {"completedWithin": {"period": "YEARS",
"value": 0
},
"dateFilter": {"type": "ABSOLUTE",
"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"filter": {"type": null,
"nestingType": null,
"from": null,
"to": null,
"inverted": null
}
},
"exact": false,
"steps": [{"title": null,
"action": { },
"expressions": [ ]
}
],
"title": "string"
}
}
],
"expression": { }
},
"expressions": [{"attribute": {"type": "PARAM",
"param": "string",
"id": 0
},
"constraint": {"type": "BOOL",
"logic": "IS_TRUE"
}
}
]
}
},
"isVisibleForClientProfile": true
}
}

Response samples

200
4XX
5XX

Content type

application/json

"497f6eca-6276-4993-bfeb-53cbbbba6f08"

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:

JWT

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

200
4XX
5XX

Content type

application/json;charset=UTF-8

[{"hashId": "3fcea162-e397-4686-8826-987dbb8f4b18",
"name": "string",
"description": "string",
"action": {"id": 0,
"name": "page.visit"
},
"eventName": "page.visit",
"actionId": 0,
"isNumber": true,
"isDynamicAnalytic": true,
"variables": [{"name": "event.params.PARAMNAME",
"value": "string"
}
],
"createdAt": "2019-08-24T14:15:22Z",
"isMetricHistogram": true
}
]

Calculate metric

Calculate a metric that was created earlier.

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:

JWT

path Parameters

metricId

required

string <uuid>

Metric UUID

Responses

Request samples

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

Response samples

200
4XX
5XX

Content type

application/json

{"result": 0,
"metricData": {"name": "string",
"description": "string",
"format": {"compactNumbers": false,
"currency": "EUR",
"dataFormat": "cash",
"fixedLength": 0,
"useSeparator": false
},
"initialDateFilter": {"type": "ABSOLUTE",
"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"filter": {"type": "DAILY",
"nestingType": "IN_PLACE",
"from": "string",
"to": "string",
"inverted": false
}
}
}
}

Get metric details

Retrieve the details of a metric definition.

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.permissions required: ANALYTICS_BACKEND_METRICS_READ, 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:

JWT

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 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

200
4XX
5XX

Content type

application/json

{"analysis": {"title": "string",
"description": "string",
"format": {"compactNumbers": false,
"currency": "EUR",
"dataFormat": "cash",
"fixedLength": 0,
"useSeparator": false
},
"comparison": {"dateFilter": {"type": "ABSOLUTE",
"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"filter": {"type": "DAILY",
"nestingType": "IN_PLACE",
"from": "string",
"to": "string",
"inverted": false
}
}
},
"metricType": "SIMPLE",
"expression": {"type": "VALUE",
"value": {"type": "EVENT",
"title": "string",
"occurrenceType": "FIRST",
"aggregation": {"type": "COUNT",
"level": 0.01,
"attribute": {"type": "PARAM",
"param": "string",
"id": 0
}
},
"action": {"id": 0,
"name": "page.visit"
},
"dateFilter": {"type": "ABSOLUTE",
"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"filter": {"type": "DAILY",
"nestingType": "IN_PLACE",
"from": "string",
"to": "string",
"inverted": false
}
},
"filter": {"matching": true,
"expressions": [{"type": "FUNNEL",
"matching": true,
"funnel": {"completedWithin": {"period": "YEARS",
"value": 0
},
"dateFilter": {"type": "ABSOLUTE",
"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"filter": {"type": null,
"nestingType": null,
"from": null,
"to": null,
"inverted": null
}
},
"exact": false,
"steps": [{"title": null,
"action": { },
"expressions": [ ]
}
],
"title": "string"
}
}
],
"expression": { }
},
"expressions": [{"attribute": {"type": "PARAM",
"param": "string",
"id": 0
},
"constraint": {"type": "BOOL",
"logic": "IS_TRUE"
}
}
]
}
},
"isVisibleForClientProfile": true
},
"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",
"isPredefinedAnalytic": true,
"isDynamicAnalytic": true,
"isDeleted": true,
"namespace": "string",
"directoryId": "786c2ec1-fb9a-4593-b705-005b34c18c18"
}

Update metric

Update an existing metric definition.

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.permissions required: ANALYTICS_BACKEND_METRICS_UPDATE, 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:

JWT

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

Structure of the analytical query

Responses

Request samples

Content type

application/json

{"analysis": {"title": "string",
"description": "string",
"format": {"compactNumbers": false,
"currency": "EUR",
"dataFormat": "cash",
"fixedLength": 0,
"useSeparator": false
},
"comparison": {"dateFilter": {"type": "ABSOLUTE",
"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"filter": {"type": "DAILY",
"nestingType": "IN_PLACE",
"from": "string",
"to": "string",
"inverted": false
}
}
},
"metricType": "SIMPLE",
"expression": {"type": "VALUE",
"value": {"type": "EVENT",
"title": "string",
"occurrenceType": "FIRST",
"aggregation": {"type": "COUNT",
"level": 0.01,
"attribute": {"type": "PARAM",
"param": "string",
"id": 0
}
},
"action": {"id": 0,
"name": "page.visit"
},
"dateFilter": {"type": "ABSOLUTE",
"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"filter": {"type": "DAILY",
"nestingType": "IN_PLACE",
"from": "string",
"to": "string",
"inverted": false
}
},
"filter": {"matching": true,
"expressions": [{"type": "FUNNEL",
"matching": true,
"funnel": {"completedWithin": {"period": "YEARS",
"value": 0
},
"dateFilter": {"type": "ABSOLUTE",
"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"filter": {"type": null,
"nestingType": null,
"from": null,
"to": null,
"inverted": null
}
},
"exact": false,
"steps": [{"title": null,
"action": { },
"expressions": [ ]
}
],
"title": "string"
}
}
],
"expression": { }
},
"expressions": [{"attribute": {"type": "PARAM",
"param": "string",
"id": 0
},
"constraint": {"type": "BOOL",
"logic": "IS_TRUE"
}
}
]
}
},
"isVisibleForClientProfile": true
}
}

Response samples

200
4XX
5XX

Content type

application/json

{"analysis": {"title": "string",
"description": "string",
"format": {"compactNumbers": false,
"currency": "EUR",
"dataFormat": "cash",
"fixedLength": 0,
"useSeparator": false
},
"comparison": {"dateFilter": {"type": "ABSOLUTE",
"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"filter": {"type": "DAILY",
"nestingType": "IN_PLACE",
"from": "string",
"to": "string",
"inverted": false
}
}
},
"metricType": "SIMPLE",
"expression": {"type": "VALUE",
"value": {"type": "EVENT",
"title": "string",
"occurrenceType": "FIRST",
"aggregation": {"type": "COUNT",
"level": 0.01,
"attribute": {"type": "PARAM",
"param": "string",
"id": 0
}
},
"action": {"id": 0,
"name": "page.visit"
},
"dateFilter": {"type": "ABSOLUTE",
"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"filter": {"type": "DAILY",
"nestingType": "IN_PLACE",
"from": "string",
"to": "string",
"inverted": false
}
},
"filter": {"matching": true,
"expressions": [{"type": "FUNNEL",
"matching": true,
"funnel": {"completedWithin": {"period": "YEARS",
"value": 0
},
"dateFilter": {"type": "ABSOLUTE",
"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"filter": {"type": null,
"nestingType": null,
"from": null,
"to": null,
"inverted": null
}
},
"exact": false,
"steps": [{"title": null,
"action": { },
"expressions": [ ]
}
],
"title": "string"
}
}
],
"expression": { }
},
"expressions": [{"attribute": {"type": "PARAM",
"param": "string",
"id": 0
},
"constraint": {"type": "BOOL",
"logic": "IS_TRUE"
}
}
]
}
},
"isVisibleForClientProfile": true
},
"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",
"isPredefinedAnalytic": true,
"isDynamicAnalytic": true,
"isDeleted": true,
"namespace": "string",
"directoryId": "786c2ec1-fb9a-4593-b705-005b34c18c18"
}

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.permissions required: ANALYTICS_BACKEND_METRICS_DELETE, 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:

JWT

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

4XX
5XX

Content type

application/json

{"timestamp": "2019-08-24T14:15:22Z",
"status": 0,
"error": "string",
"message": "string",
"path": "string"
}

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:

JWT

Responses

Request samples

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

Response samples

200
500

Content type

application/json

[{"metricId": "string",
"title": "string"
}
]

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:

JWT

Responses

Request samples

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

Response samples

200
500

Content type

application/json

["string"
]

Reports

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

Recalculate report

Retrieve the results of a previously-created 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:

JWT

path Parameters

reportId

required

string <uuid>

Report ID

Responses

Request samples

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

Response samples

200
4XX
5XX

Content type

application/json

{"data": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"values": [[{"name": ["string"
],
"value": 0
}
]
],
"groups": ["string"
]
}
]
}

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.permissions required: ANALYTICS_BACKEND_REPORTS_READ, 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:

JWT

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

200
4XX
5XX

Content type

application/json

{"analysis": {"title": "string",
"description": "string",
"filter": {"matching": true,
"expressions": [{"type": "FUNNEL",
"matching": true,
"funnel": {"completedWithin": {"period": "YEARS",
"value": 0
},
"dateFilter": {"type": "ABSOLUTE",
"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"filter": {"type": "DAILY",
"nestingType": "IN_PLACE",
"from": "string",
"to": "string",
"inverted": false
}
},
"exact": false,
"steps": [{"title": "string",
"action": {"id": 0,
"name": "page.visit"
},
"expressions": [{"attribute": null,
"constraint": null
}
]
}
],
"title": "string"
}
}
],
"expression": { }
},
"reportMetrics": [{"metricId": "c2cc9ad9-a69d-40a3-8e01-a95e09e71978",
"dateFilter": {"type": "ABSOLUTE",
"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"filter": {"type": "DAILY",
"nestingType": "IN_PLACE",
"from": "string",
"to": "string",
"inverted": false
}
},
"action": {"id": 0,
"name": "page.visit"
},
"format": {"compactNumbers": false,
"currency": "EUR",
"dataFormat": "cash",
"fixedLength": 0,
"useSeparator": false
},
"grouping": {"type": "TOP",
"top": 0
},
"groups": [{"title": "string",
"format": {"compactNumbers": false,
"currency": "EUR",
"dataFormat": "cash",
"fixedLength": 0,
"useSeparator": false
},
"type": "CLIENT",
"attribute": {"type": "SEGMENTATION",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
]
}
]
},
"allowNull": true,
"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",
"isPredefinedAnalytic": true,
"isDynamicAnalytic": true,
"isDeleted": true,
"namespace": "string",
"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.permissions required: ANALYTICS_BACKEND_REPORTS_UPDATE, 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:

JWT

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 Structure of the report analysis
allowNull	boolean Default: true When `true`, null values can be included in the results.

Responses

Request samples

Content type

application/json

{"analysis": {"title": "string",
"description": "string",
"filter": {"matching": true,
"expressions": [{"type": "FUNNEL",
"matching": true,
"funnel": {"completedWithin": {"period": "YEARS",
"value": 0
},
"dateFilter": {"type": "ABSOLUTE",
"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"filter": {"type": "DAILY",
"nestingType": "IN_PLACE",
"from": "string",
"to": "string",
"inverted": false
}
},
"exact": false,
"steps": [{"title": "string",
"action": {"id": 0,
"name": "page.visit"
},
"expressions": [{"attribute": null,
"constraint": null
}
]
}
],
"title": "string"
}
}
],
"expression": { }
},
"reportMetrics": [{"metricId": "c2cc9ad9-a69d-40a3-8e01-a95e09e71978",
"dateFilter": {"type": "ABSOLUTE",
"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"filter": {"type": "DAILY",
"nestingType": "IN_PLACE",
"from": "string",
"to": "string",
"inverted": false
}
},
"action": {"id": 0,
"name": "page.visit"
},
"format": {"compactNumbers": false,
"currency": "EUR",
"dataFormat": "cash",
"fixedLength": 0,
"useSeparator": false
},
"grouping": {"type": "TOP",
"top": 0
},
"groups": [{"title": "string",
"format": {"compactNumbers": false,
"currency": "EUR",
"dataFormat": "cash",
"fixedLength": 0,
"useSeparator": false
},
"type": "CLIENT",
"attribute": {"type": "SEGMENTATION",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
]
}
]
},
"allowNull": true
}

Response samples

4XX
5XX

Content type

application/json

{"timestamp": "2019-08-24T14:15:22Z",
"status": 0,
"error": "string",
"message": "string",
"path": "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.permissions required: ANALYTICS_BACKEND_REPORTS_DELETE, 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:

JWT

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

4XX
5XX

Content type

application/json

{"timestamp": "2019-08-24T14:15:22Z",
"status": 0,
"error": "string",
"message": "string",
"path": "string"
}

Preview report

Retrieve the results of a report. This request doesn't save the 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:

JWT

Request Body schema: application/json

	object Structure of the report analysis
allowNull	boolean Default: true When `true`, null values can be included in the results.

Responses

Request samples

Content type

application/json

{"analysis": {"title": "string",
"description": "string",
"filter": {"matching": true,
"expressions": [{"type": "FUNNEL",
"matching": true,
"funnel": {"completedWithin": {"period": "YEARS",
"value": 0
},
"dateFilter": {"type": "ABSOLUTE",
"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"filter": {"type": "DAILY",
"nestingType": "IN_PLACE",
"from": "string",
"to": "string",
"inverted": false
}
},
"exact": false,
"steps": [{"title": "string",
"action": {"id": 0,
"name": "page.visit"
},
"expressions": [{"attribute": null,
"constraint": null
}
]
}
],
"title": "string"
}
}
],
"expression": { }
},
"reportMetrics": [{"metricId": "c2cc9ad9-a69d-40a3-8e01-a95e09e71978",
"dateFilter": {"type": "ABSOLUTE",
"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"filter": {"type": "DAILY",
"nestingType": "IN_PLACE",
"from": "string",
"to": "string",
"inverted": false
}
},
"action": {"id": 0,
"name": "page.visit"
},
"format": {"compactNumbers": false,
"currency": "EUR",
"dataFormat": "cash",
"fixedLength": 0,
"useSeparator": false
},
"grouping": {"type": "TOP",
"top": 0
},
"groups": [{"title": "string",
"format": {"compactNumbers": false,
"currency": "EUR",
"dataFormat": "cash",
"fixedLength": 0,
"useSeparator": false
},
"type": "CLIENT",
"attribute": {"type": "SEGMENTATION",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
]
}
]
},
"allowNull": true
}

Response samples

200
4XX
5XX

Content type

application/json

{"data": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"values": [[{"name": ["string"
],
"value": 0
}
]
],
"groups": ["string"
]
}
]
}

Calculate report with override

Calculate a report with new parameters and/or variables (dynamic keys)

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:

JWT

path Parameters

reportId

required

string <uuid>

Report ID

Request Body schema: application/json

	Absolute (object) or Relative (object) Definition of a date filter. Only data that meets the result of the filter will be included in the analysis. For no filter, leave this object empty. An absolute date filter lets you define static dates and times that always apply to the analysis. A relative date filter lets you create a date filter that goes back a certain time from the moment of calculating the analysis.
	object Data aggregation (if applicable for this analysis type)
	object This filter lets you limit the results to profiles that match it. For no filter, leave the object empty.
required	Array of objects[ items ] A list of variable values to use in this calculation

Responses

Request samples

Content type

application/json

{"dateFilter": {"type": "ABSOLUTE",
"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"filter": {"type": "DAILY",
"nestingType": "IN_PLACE",
"from": "string",
"to": "string",
"inverted": false
}
},
"aggregateDataBy": {"type": "YEARS",
"value": 0
},
"filter": {"matching": true,
"expressions": [{"type": "FUNNEL",
"matching": true,
"funnel": {"completedWithin": {"period": "YEARS",
"value": 0
},
"dateFilter": {"type": "ABSOLUTE",
"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"filter": {"type": "DAILY",
"nestingType": "IN_PLACE",
"from": "string",
"to": "string",
"inverted": false
}
},
"exact": false,
"steps": [{"title": "string",
"action": {"id": 0,
"name": "page.visit"
},
"expressions": [{"attribute": {"type": null,
"param": null,
"id": null
},
"constraint": {"type": null,
"logic": null
}
}
]
}
],
"title": "string"
}
}
],
"expression": { }
},
"variables": [{"name": "string",
"value": "string"
}
]
}

Response samples

200
4XX
5XX

Content type

application/json

{"data": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"values": [[{"name": ["string"
],
"value": 0
}
]
],
"groups": ["string"
]
}
]
}

Preview report as CSV

Retrieve the results of a report as CSV. This request doesn't save the 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:

JWT

Request Body schema: application/json

	object Structure of the report analysis
allowNull	boolean Default: true When `true`, null values can be included in the results.

Responses

Request samples

Content type

application/json

{"analysis": {"title": "string",
"description": "string",
"filter": {"matching": true,
"expressions": [{"type": "FUNNEL",
"matching": true,
"funnel": {"completedWithin": {"period": "YEARS",
"value": 0
},
"dateFilter": {"type": "ABSOLUTE",
"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"filter": {"type": "DAILY",
"nestingType": "IN_PLACE",
"from": "string",
"to": "string",
"inverted": false
}
},
"exact": false,
"steps": [{"title": "string",
"action": {"id": 0,
"name": "page.visit"
},
"expressions": [{"attribute": null,
"constraint": null
}
]
}
],
"title": "string"
}
}
],
"expression": { }
},
"reportMetrics": [{"metricId": "c2cc9ad9-a69d-40a3-8e01-a95e09e71978",
"dateFilter": {"type": "ABSOLUTE",
"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"filter": {"type": "DAILY",
"nestingType": "IN_PLACE",
"from": "string",
"to": "string",
"inverted": false
}
},
"action": {"id": 0,
"name": "page.visit"
},
"format": {"compactNumbers": false,
"currency": "EUR",
"dataFormat": "cash",
"fixedLength": 0,
"useSeparator": false
},
"grouping": {"type": "TOP",
"top": 0
},
"groups": [{"title": "string",
"format": {"compactNumbers": false,
"currency": "EUR",
"dataFormat": "cash",
"fixedLength": 0,
"useSeparator": false
},
"type": "CLIENT",
"attribute": {"type": "SEGMENTATION",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
]
}
]
},
"allowNull": true
}

Response samples

4XX
5XX

Content type

application/json

{"timestamp": "2019-08-24T14:15:22Z",
"status": 0,
"error": "string",
"message": "string",
"path": "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:

JWT

path Parameters

namespace

required

string

Value: "profiles"

Namespace. Currently, only profiles is available.

query Parameters

page	integer <int32> >= 1 Default: 1 The number of the page to retrieve
limit	integer <int32> Default: 50 Limit of items per page
search	string A string to search for in analyses' titles
sortBy	string Default: "updatedAt:desc" Enum: "name:asc" "name:desc" "author:asc" "author:desc" "updatedAt:asc" "updatedAt:desc" "createdAt:asc" "createdAt:desc" "id:asc" "id:desc" "directoryId:asc" "directoryId:desc" Example: sortBy=name:asc You can sort the results. The sorting direction is selected by adding `asc` or `desc`, for example `sortBy=name:desc`.
directoryId	string <uuid> Unique ID of the directory to retrieve analyses from
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=name%3Aasc&directoryId=SOME_STRING_VALUE&ids=SOME_STRING_VALUE' 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

200
4XX
5XX

Content type

application/json

{"data": [{"analysis": {"title": "string",
"description": "string",
"filter": {"matching": true,
"expressions": [{"type": "FUNNEL",
"matching": true,
"funnel": {"completedWithin": {"period": "YEARS",
"value": 0
},
"dateFilter": {"type": "ABSOLUTE",
"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"filter": {"type": null,
"nestingType": null,
"from": null,
"to": null,
"inverted": null
}
},
"exact": false,
"steps": [{"title": null,
"action": { },
"expressions": [ ]
}
],
"title": "string"
}
}
],
"expression": { }
},
"reportMetrics": [{"metricId": "c2cc9ad9-a69d-40a3-8e01-a95e09e71978",
"dateFilter": {"type": "ABSOLUTE",
"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"filter": {"type": "DAILY",
"nestingType": "IN_PLACE",
"from": "string",
"to": "string",
"inverted": false
}
},
"action": {"id": 0,
"name": "page.visit"
},
"format": {"compactNumbers": false,
"currency": "EUR",
"dataFormat": "cash",
"fixedLength": 0,
"useSeparator": false
},
"grouping": {"type": "TOP",
"top": 0
},
"groups": [{"title": "string",
"format": {"compactNumbers": false,
"currency": "EUR",
"dataFormat": "cash",
"fixedLength": 0,
"useSeparator": false
},
"type": "CLIENT",
"attribute": {"type": "SEGMENTATION",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
]
}
]
},
"allowNull": true,
"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",
"isPredefinedAnalytic": true,
"isDynamicAnalytic": true,
"isDeleted": true,
"namespace": "string",
"directoryId": "786c2ec1-fb9a-4593-b705-005b34c18c18"
}
],
"meta": {"links": [{"url": "string",
"rel": "first"
}
],
"limit": 0,
"count": 0
}
}

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.permissions required: ANALYTICS_BACKEND_REPORTS_CREATE, 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:

JWT

path Parameters

namespace

required

string

Value: "profiles"

Namespace. Currently, only profiles is available.

Request Body schema: application:json

	object Structure of the report analysis
allowNull	boolean Default: true When `true`, null values can be included in the results.

Responses

Request samples

Content type

application:json

{"analysis": {"title": "string",
"description": "string",
"filter": {"matching": true,
"expressions": [{"type": "FUNNEL",
"matching": true,
"funnel": {"completedWithin": {"period": "YEARS",
"value": 0
},
"dateFilter": {"type": "ABSOLUTE",
"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"filter": {"type": "DAILY",
"nestingType": "IN_PLACE",
"from": "string",
"to": "string",
"inverted": false
}
},
"exact": false,
"steps": [{"title": "string",
"action": {"id": 0,
"name": "page.visit"
},
"expressions": [{"attribute": null,
"constraint": null
}
]
}
],
"title": "string"
}
}
],
"expression": { }
},
"reportMetrics": [{"metricId": "c2cc9ad9-a69d-40a3-8e01-a95e09e71978",
"dateFilter": {"type": "ABSOLUTE",
"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"filter": {"type": "DAILY",
"nestingType": "IN_PLACE",
"from": "string",
"to": "string",
"inverted": false
}
},
"action": {"id": 0,
"name": "page.visit"
},
"format": {"compactNumbers": false,
"currency": "EUR",
"dataFormat": "cash",
"fixedLength": 0,
"useSeparator": false
},
"grouping": {"type": "TOP",
"top": 0
},
"groups": [{"title": "string",
"format": {"compactNumbers": false,
"currency": "EUR",
"dataFormat": "cash",
"fixedLength": 0,
"useSeparator": false
},
"type": "CLIENT",
"attribute": {"type": "SEGMENTATION",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
}
]
}
]
},
"allowNull": true
}

Response samples

200
4XX
5XX

Content type

application/json

"497f6eca-6276-4993-bfeb-53cbbbba6f08"

Sankeys

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

List Sankeys

Returns a paginated list of Sankey analyses.

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:

JWT

path Parameters

namespace

required

string

Value: "profiles"

Namespace. Currently, only profiles is available.

query Parameters

page	integer <int32> >= 1 Default: 1 The number of the page to retrieve
limit	integer <int32> Default: 50 Limit of items per page
search	string A string to search for in analyses' titles
sortBy	string Default: "updatedAt:desc" Enum: "name:asc" "name:desc" "author:asc" "author:desc" "updatedAt:asc" "updatedAt:desc" "createdAt:asc" "createdAt:desc" "id:asc" "id:desc" "directoryId:asc" "directoryId:desc" Example: sortBy=name:asc You can sort the results. The sorting direction is selected by adding `asc` or `desc`, for example `sortBy=name:desc`.
directoryId	string <uuid> Unique ID of the directory to retrieve analyses from
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=name%3Aasc&directoryId=SOME_STRING_VALUE&ids=SOME_STRING_VALUE' 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

200
4XX
5XX

Content type

application/json

{"data": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"author": {"id": 0,
"name": "string",
"icon": "string"
},
"updatedAt": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z",
"isDynamicAnalytic": true,
"variables": [{"name": "event.params.PARAMNAME",
"value": "string"
}
]
}
],
"meta": {"links": [{"url": "string",
"rel": "first"
}
],
"limit": 0,
"count": 0
}
}

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.permissions required: ANALYTICS_BACKEND_SANKEYS_CREATE, 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:

JWT

path Parameters

namespace

required

string

Value: "profiles"

Namespace. Currently, only profiles is available.

Request Body schema: application/json

required

object

Details of a Sankey analysis

Responses

Request samples

Content type

application/json

{"analysis": {"title": "string",
"description": "string",
"sourceEvent": {"action": {"id": 0,
"name": "page.visit"
},
"expressions": [{"attribute": {"type": "PARAM",
"param": "string",
"id": 0
},
"constraint": {"type": "BOOL",
"logic": "IS_TRUE"
}
}
]
},
"reverseOrder": true,
"numberOfSteps": 0,
"numberOfPaths": 0,
"drillDown": [{"eventName": "page.visit",
"attribute": {"type": "PARAM",
"param": "string",
"id": 0
},
"layer": 0
}
],
"drillDownCount": 0,
"dateFilter": {"type": "ABSOLUTE",
"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"filter": {"type": "DAILY",
"nestingType": "IN_PLACE",
"from": "string",
"to": "string",
"inverted": false
}
},
"filter": {"matching": true,
"expressions": [{"type": "FUNNEL",
"matching": true,
"funnel": {"completedWithin": {"period": "YEARS",
"value": 0
},
"dateFilter": {"type": "ABSOLUTE",
"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"filter": {"type": "DAILY",
"nestingType": "IN_PLACE",
"from": "string",
"to": "string",
"inverted": false
}
},
"exact": false,
"steps": [{"title": "string",
"action": {"id": 0,
"name": "page.visit"
},
"expressions": [{"attribute": null,
"constraint": null
}
]
}
],
"title": "string"
}
}
],
"expression": { }
},
"eventFilters": [{"title": "string",
"action": {"id": 0,
"name": "page.visit"
},
"expressions": [{"attribute": {"type": "PARAM",
"param": "string",
"id": 0
},
"constraint": {"type": "BOOL",
"logic": "IS_TRUE"
}
}
]
}
],
"excludeEvents": true,
"firstOccurrenceOnly": true
}
}

Response samples

200
4XX
5XX

Content type

application/json

"497f6eca-6276-4993-bfeb-53cbbbba6f08"

Preview Sankey analysis

Preview the results of a Sankey analysis. This request doesn't save the 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:

JWT

Request Body schema: application/json

required

object

Details of a Sankey analysis

Responses

Request samples

Content type

application/json

{"analysis": {"title": "string",
"description": "string",
"sourceEvent": {"action": {"id": 0,
"name": "page.visit"
},
"expressions": [{"attribute": {"type": "PARAM",
"param": "string",
"id": 0
},
"constraint": {"type": "BOOL",
"logic": "IS_TRUE"
}
}
]
},
"reverseOrder": true,
"numberOfSteps": 0,
"numberOfPaths": 0,
"drillDown": [{"eventName": "page.visit",
"attribute": {"type": "PARAM",
"param": "string",
"id": 0
},
"layer": 0
}
],
"drillDownCount": 0,
"dateFilter": {"type": "ABSOLUTE",
"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"filter": {"type": "DAILY",
"nestingType": "IN_PLACE",
"from": "string",
"to": "string",
"inverted": false
}
},
"filter": {"matching": true,
"expressions": [{"type": "FUNNEL",
"matching": true,
"funnel": {"completedWithin": {"period": "YEARS",
"value": 0
},
"dateFilter": {"type": "ABSOLUTE",
"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"filter": {"type": "DAILY",
"nestingType": "IN_PLACE",
"from": "string",
"to": "string",
"inverted": false
}
},
"exact": false,
"steps": [{"title": "string",
"action": {"id": 0,
"name": "page.visit"
},
"expressions": [{"attribute": null,
"constraint": null
}
]
}
],
"title": "string"
}
}
],
"expression": { }
},
"eventFilters": [{"title": "string",
"action": {"id": 0,
"name": "page.visit"
},
"expressions": [{"attribute": {"type": "PARAM",
"param": "string",
"id": 0
},
"constraint": {"type": "BOOL",
"logic": "IS_TRUE"
}
}
]
}
],
"excludeEvents": true,
"firstOccurrenceOnly": true
}
}

Response samples

200
4XX
5XX

Content type

application/json;charset=UTF-8

{"results": [["string"
]
]
}

Get Sankey details

Retrieve the details of a 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_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:

JWT

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

200
4XX
5XX

Content type

application/json

{"analysis": {"title": "string",
"description": "string",
"sourceEvent": {"action": {"id": 0,
"name": "page.visit"
},
"expressions": [{"attribute": {"type": "PARAM",
"param": "string",
"id": 0
},
"constraint": {"type": "BOOL",
"logic": "IS_TRUE"
}
}
]
},
"reverseOrder": true,
"numberOfSteps": 0,
"numberOfPaths": 0,
"drillDown": [{"eventName": "page.visit",
"attribute": {"type": "PARAM",
"param": "string",
"id": 0
},
"layer": 0
}
],
"drillDownCount": 0,
"dateFilter": {"type": "ABSOLUTE",
"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"filter": {"type": "DAILY",
"nestingType": "IN_PLACE",
"from": "string",
"to": "string",
"inverted": false
}
},
"filter": {"matching": true,
"expressions": [{"type": "FUNNEL",
"matching": true,
"funnel": {"completedWithin": {"period": "YEARS",
"value": 0
},
"dateFilter": {"type": "ABSOLUTE",
"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"filter": {"type": "DAILY",
"nestingType": "IN_PLACE",
"from": "string",
"to": "string",
"inverted": false
}
},
"exact": false,
"steps": [{"title": "string",
"action": {"id": 0,
"name": "page.visit"
},
"expressions": [{"attribute": null,
"constraint": null
}
]
}
],
"title": "string"
}
}
],
"expression": { }
},
"eventFilters": [{"title": "string",
"action": {"id": 0,
"name": "page.visit"
},
"expressions": [{"attribute": {"type": "PARAM",
"param": "string",
"id": 0
},
"constraint": {"type": "BOOL",
"logic": "IS_TRUE"
}
}
]
}
],
"excludeEvents": true,
"firstOccurrenceOnly": true
},
"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",
"isPredefinedAnalytic": true,
"isDynamicAnalytic": true,
"isDeleted": true,
"namespace": "string",
"directoryId": "786c2ec1-fb9a-4593-b705-005b34c18c18"
}

Update Sankey

Update an existing 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.permissions required: ANALYTICS_BACKEND_SANKEYS_UPDATE, 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:

JWT

path Parameters

namespace required	string Value: "profiles" Namespace. Currently, only `profiles` is available.
sankeyId required	string <uuid> Sankey UUID

Request Body schema: application/json

required

object

Details of a Sankey analysis

Responses

Request samples

Content type

application/json

{"analysis": {"title": "string",
"description": "string",
"sourceEvent": {"action": {"id": 0,
"name": "page.visit"
},
"expressions": [{"attribute": {"type": "PARAM",
"param": "string",
"id": 0
},
"constraint": {"type": "BOOL",
"logic": "IS_TRUE"
}
}
]
},
"reverseOrder": true,
"numberOfSteps": 0,
"numberOfPaths": 0,
"drillDown": [{"eventName": "page.visit",
"attribute": {"type": "PARAM",
"param": "string",
"id": 0
},
"layer": 0
}
],
"drillDownCount": 0,
"dateFilter": {"type": "ABSOLUTE",
"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"filter": {"type": "DAILY",
"nestingType": "IN_PLACE",
"from": "string",
"to": "string",
"inverted": false
}
},
"filter": {"matching": true,
"expressions": [{"type": "FUNNEL",
"matching": true,
"funnel": {"completedWithin": {"period": "YEARS",
"value": 0
},
"dateFilter": {"type": "ABSOLUTE",
"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"filter": {"type": "DAILY",
"nestingType": "IN_PLACE",
"from": "string",
"to": "string",
"inverted": false
}
},
"exact": false,
"steps": [{"title": "string",
"action": {"id": 0,
"name": "page.visit"
},
"expressions": [{"attribute": null,
"constraint": null
}
]
}
],
"title": "string"
}
}
],
"expression": { }
},
"eventFilters": [{"title": "string",
"action": {"id": 0,
"name": "page.visit"
},
"expressions": [{"attribute": {"type": "PARAM",
"param": "string",
"id": 0
},
"constraint": {"type": "BOOL",
"logic": "IS_TRUE"
}
}
]
}
],
"excludeEvents": true,
"firstOccurrenceOnly": true
}
}

Response samples

4XX
5XX

Content type

application/json

{"timestamp": "2019-08-24T14:15:22Z",
"status": 0,
"error": "string",
"message": "string",
"path": "string"
}

Delete Sankey

Delete a 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.permissions required: ANALYTICS_BACKEND_SANKEYS_DELETE, 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:

JWT

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

4XX
5XX

Content type

application/json

{"timestamp": "2019-08-24T14:15:22Z",
"status": 0,
"error": "string",
"message": "string",
"path": "string"
}

Segmentations

Segmentation is a method of organizing Profiles into groups that share the same characteristics

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:

JWT

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 profile identifier selected in `identifierType` (profile ID is sent as a string)
segmentationIds required	Array of strings <uuid> <= 10 items UUIDs of the segmentations to check

Responses

Request samples

Content type

application/json

{"identifierValue": "string",
"segmentationIds": ["5370bf3c-2dfa-4e89-98ff-07100cffee6c"
]
}

Response samples

200
4XX
5XX

Content type

application/json

[{"segmentationId": "5370bf3c-2dfa-4e89-98ff-07100cffee6c",
"related": true
}
]

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.permissions required: ANALYTICS_BACKEND_SEGMENTATIONS_READ, 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:

JWT

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 profile identifier selected in `identifierType` (profile ID is sent as a string)
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": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"segmentationIds": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"query": {"analysis": {"title": "string",
"description": "string",
"segments": [{"title": "string",
"description": "string",
"filter": {"matching": true,
"expressions": [{"type": null,
"matching": null,
"funnel": { }
}
],
"expression": { }
}
}
],
"unique": true
}
}
}
]
}

Response samples

200
4XX
5XX

Content type

application/json

"497f6eca-6276-4993-bfeb-53cbbbba6f08"

Get segmentations for profile card

Retrieve segmentations to display on a profile's card in the Profiles module ("isVisibleForClientProfile": true) in the segmentation 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_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:

JWT

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 profile identifier selected in identifierType (profile ID is sent as a string)

Responses

Request samples

Content type

application/json

{"identifierValue": "string"
}

Response samples

200
4XX
5XX

Content type

application/json

[{"id": "5370bf3c-2dfa-4e89-98ff-07100cffee6c",
"name": "Nice people who read the documentation",
"result": {"success": true,
"value": "123"
}
}
]

Get segmentation details

Retrieve the details of a 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.permissions required: ANALYTICS_BACKEND_SEGMENTATIONS_READ, 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:

JWT

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

200
4XX
5XX

Content type

application/json

{"analysis": {"title": "string",
"description": "string",
"segments": [{"title": "string",
"description": "string",
"filter": {"matching": true,
"expressions": [{"type": "FUNNEL",
"matching": true,
"funnel": {"completedWithin": {"period": "YEARS",
"value": 0
},
"dateFilter": {"type": "ABSOLUTE",
"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"filter": {"type": null,
"nestingType": null,
"from": null,
"to": null,
"inverted": null
}
},
"exact": false,
"steps": [{"title": null,
"action": { },
"expressions": [ ]
}
],
"title": "string"
}
}
],
"expression": { }
}
}
],
"unique": true
},
"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",
"isPredefinedAnalytic": true,
"isDynamicAnalytic": true,
"isDeleted": true,
"namespace": "string",
"directoryId": "786c2ec1-fb9a-4593-b705-005b34c18c18"
}

Update segmentation

Update an existing 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.permissions required: ANALYTICS_BACKEND_SEGMENTATIONS_UPDATE, 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:

JWT

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 Definition of the segmentation.
isVisibleForClientProfile required	boolean When set to `true`, information about this analysis is shown on a profile's card.

Responses

Request samples

Content type

application/json

{"analysis": {"title": "string",
"description": "string",
"segments": [{"title": "string",
"description": "string",
"filter": {"matching": true,
"expressions": [{"type": "FUNNEL",
"matching": true,
"funnel": {"completedWithin": {"period": "YEARS",
"value": 0
},
"dateFilter": {"type": "ABSOLUTE",
"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"filter": {"type": null,
"nestingType": null,
"from": null,
"to": null,
"inverted": null
}
},
"exact": false,
"steps": [{"title": null,
"action": { },
"expressions": [ ]
}
],
"title": "string"
}
}
],
"expression": { }
}
}
],
"unique": true
},
"isVisibleForClientProfile": true
}

Response samples

4XX
5XX

Content type

application/json

{"timestamp": "2019-08-24T14:15:22Z",
"status": 0,
"error": "string",
"message": "string",
"path": "string"
}

Delete 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.permissions required: ANALYTICS_BACKEND_SEGMENTATIONS_DELETE, 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:

JWT

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

4XX
5XX

Content type

application/json

{"timestamp": "2019-08-24T14:15:22Z",
"status": 0,
"error": "string",
"message": "string",
"path": "string"
}

Calculate dynamic segmentation

Calculate a segmentation that includes variables (dynamic keys).

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:

JWT

path Parameters

segmentationId

required

string <uuid>

Segmentation UUID

Request Body schema: application/json

required

Array of objects[ items ]

Dynamic keys used in this analysis

Responses

Request samples

Content type

application/json

{"variables": [{"name": "event.params.PARAMNAME",
"value": "string"
}
]
}

Response samples

200
4XX
5XX

Content type

application/json

{"calculationResults": [{"name": "string",
"result": 0
}
],
"totalContacts": 0,
"excludedContacts": 0,
"metadata": {"source": [0
]
}
}

Preview profiles in segmentation

Calculate a segmentation and get a list of profiles in each segment. This request doesn't save the segmentation 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:

JWT

Request Body schema: application/json

required	object Definition of the segmentation.
allowNull	boolean Default: true When `true`, null values can be included in the results.

Responses

Request samples

Content type

application/json

{"analysis": {"title": "string",
"description": "string",
"segments": [{"title": "string",
"description": "string",
"filter": {"matching": true,
"expressions": [{"type": "FUNNEL",
"matching": true,
"funnel": {"completedWithin": {"period": "YEARS",
"value": 0
},
"dateFilter": {"type": "ABSOLUTE",
"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"filter": {"type": null,
"nestingType": null,
"from": null,
"to": null,
"inverted": null
}
},
"exact": false,
"steps": [{"title": null,
"action": { },
"expressions": [ ]
}
],
"title": "string"
}
}
],
"expression": { }
}
}
],
"unique": true
},
"allowNull": true
}

Response samples

200
4XX
5XX

Content type

application/json

[[0
]
]

Preview segmentation

Preview the results of a segmentation, with information about the results of each segment. This request does not save the 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_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:

JWT

Request Body schema: application/json

required	object Definition of the segmentation.
allowNull	boolean Default: true When `true`, null values can be included in the results.

Responses

Request samples

Content type

application/json

{"analysis": {"title": "string",
"description": "string",
"segments": [{"title": "string",
"description": "string",
"filter": {"matching": true,
"expressions": [{"type": "FUNNEL",
"matching": true,
"funnel": {"completedWithin": {"period": "YEARS",
"value": 0
},
"dateFilter": {"type": "ABSOLUTE",
"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"filter": {"type": null,
"nestingType": null,
"from": null,
"to": null,
"inverted": null
}
},
"exact": false,
"steps": [{"title": null,
"action": { },
"expressions": [ ]
}
],
"title": "string"
}
}
],
"expression": { }
}
}
],
"unique": true
},
"allowNull": true
}

Response samples

200
4XX
5XX

Content type

application/json

{"calculationResults": [{"name": "string",
"result": 0
}
],
"totalContacts": 0,
"excludedContacts": 0,
"metadata": {"source": [0
]
}
}

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:

JWT

path Parameters

namespace

required

string

Value: "profiles"

Namespace. Currently, only profiles is available.

query Parameters

page	integer <int32> >= 1 Default: 1 The number of the page to retrieve
limit	integer <int32> Default: 50 Limit of items per page
search	string A string to search for in analyses' titles
sortBy	string Default: "updatedAt:desc" Enum: "name:asc" "name:desc" "author:asc" "author:desc" "updatedAt:asc" "updatedAt:desc" "createdAt:asc" "createdAt:desc" "id:asc" "id:desc" "directoryId:asc" "directoryId:desc" Example: sortBy=name:asc You can sort the results. The sorting direction is selected by adding `asc` or `desc`, for example `sortBy=name:desc`.
directoryId	string <uuid> Unique ID of the directory to retrieve analyses from
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=name%3Aasc&directoryId=SOME_STRING_VALUE&ids=SOME_STRING_VALUE' 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

200
4XX
5XX

Content type

application/json

{"data": [{"starred": true,
"children": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"segmentationId": "b0f2c1c8-dcb3-47f3-9b2a-b12ee00d2142",
"name": "string"
}
],
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"author": {"id": 0,
"name": "string",
"icon": "string"
},
"updatedAt": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z",
"isDynamicAnalytic": true,
"variables": [{"name": "event.params.PARAMNAME",
"value": "string"
}
]
}
],
"meta": {"links": [{"url": "string",
"rel": "first"
}
],
"limit": 0,
"count": 0
}
}

Create segmentation

Create a new 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.permissions required: ANALYTICS_BACKEND_SEGMENTATIONS_CREATE, 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:

JWT

path Parameters

namespace

required

string

Value: "profiles"

Namespace. Currently, only profiles is available.

Request Body schema: application/json

required	object Definition of the segmentation.
isVisibleForClientProfile required	boolean When set to `true`, information about this analysis is shown on a profile's card.

Responses

Request samples

Content type

application/json

{"analysis": {"title": "string",
"description": "string",
"segments": [{"title": "string",
"description": "string",
"filter": {"matching": true,
"expressions": [{"type": "FUNNEL",
"matching": true,
"funnel": {"completedWithin": {"period": "YEARS",
"value": 0
},
"dateFilter": {"type": "ABSOLUTE",
"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"filter": {"type": null,
"nestingType": null,
"from": null,
"to": null,
"inverted": null
}
},
"exact": false,
"steps": [{"title": null,
"action": { },
"expressions": [ ]
}
],
"title": "string"
}
}
],
"expression": { }
}
}
],
"unique": true
},
"isVisibleForClientProfile": true
}

Response samples

200
4XX
5XX

Content type

application/json

"497f6eca-6276-4993-bfeb-53cbbbba6f08"

Trends

A trend is a presentation of event occurrences over time on a chart

Calculate trend with parameter override

Recalculate a trend with new parameters and/or variable (dynamic key) 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_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:

JWT

path Parameters

trendId

required

string <uuid>

Trend UUID

Request Body schema: application/json

	Absolute (object) or Relative (object) Definition of a date filter. Only data that meets the result of the filter will be included in the analysis. For no filter, leave this object empty. An absolute date filter lets you define static dates and times that always apply to the analysis. A relative date filter lets you create a date filter that goes back a certain time from the moment of calculating the analysis.
	object Data aggregation (if applicable for this analysis type)
	object This filter lets you limit the results to profiles that match it. For no filter, leave the object empty.
required	Array of objects[ items ] A list of variable values to use in this calculation

Responses

Request samples

Content type

application/json

{"dateFilter": {"type": "ABSOLUTE",
"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"filter": {"type": "DAILY",
"nestingType": "IN_PLACE",
"from": "string",
"to": "string",
"inverted": false
}
},
"aggregateDataBy": {"type": "YEARS",
"value": 0
},
"filter": {"matching": true,
"expressions": [{"type": "FUNNEL",
"matching": true,
"funnel": {"completedWithin": {"period": "YEARS",
"value": 0
},
"dateFilter": {"type": "ABSOLUTE",
"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"filter": {"type": "DAILY",
"nestingType": "IN_PLACE",
"from": "string",
"to": "string",
"inverted": false
}
},
"exact": false,
"steps": [{"title": "string",
"action": {"id": 0,
"name": "page.visit"
},
"expressions": [{"attribute": {"type": null,
"param": null,
"id": null
},
"constraint": {"type": null,
"logic": null
}
}
]
}
],
"title": "string"
}
}
],
"expression": { }
},
"variables": [{"name": "string",
"value": "string"
}
]
}

Response samples

200
4XX
5XX

Content type

application/json

{"name": "string",
"metadata": {"aggregateDataBy": {"type": "YEARS",
"value": 0
},
"dateFilter": {"type": "ABSOLUTE",
"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"filter": {"type": "DAILY",
"nestingType": "IN_PLACE",
"from": "string",
"to": "string",
"inverted": false
}
}
},
"items": [{"aggregateTimeDescription": "2019-08-24T14:15:22Z",
"values": [{"trendId": "e690f845-235e-49cc-a6ee-5e571e093347",
"countedEvents": 0,
"countedClients": 0
}
]
}
],
"legends": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"title": "string",
"chartType": "COLUMN"
}
]
}

Get trend details

Retrieve the definition of a single trend

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.permissions required: ANALYTICS_BACKEND_TRENDS_READ, 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_TRENDS

Authorizations:

JWT

path Parameters

namespace required	string Value: "profiles" Namespace. Currently, only `profiles` is available.
trendId required	string <uuid> Trend UUID

Responses

Request samples

curl --request GET 
  --url https://api.synerise.com/analytics/%7Bnamespace%7D/trends/%7BtrendId%7D 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

200
4XX
5XX

Content type

application/json

{"analysis": {"title": "string",
"description": "string",
"filter": {"matching": true,
"expressions": [{"type": "FUNNEL",
"matching": true,
"funnel": {"completedWithin": {"period": "YEARS",
"value": 0
},
"dateFilter": {"type": "ABSOLUTE",
"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"filter": {"type": "DAILY",
"nestingType": "IN_PLACE",
"from": "string",
"to": "string",
"inverted": false
}
},
"exact": false,
"steps": [{"title": "string",
"action": {"id": 0,
"name": "page.visit"
},
"expressions": [{"attribute": null,
"constraint": null
}
]
}
],
"title": "string"
}
}
],
"expression": { }
},
"trend": {"aggregateDataBy": {"type": "YEARS",
"value": 0
},
"dateFilter": {"type": "ABSOLUTE",
"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"filter": {"type": "DAILY",
"nestingType": "IN_PLACE",
"from": "string",
"to": "string",
"inverted": false
}
},
"trendDefinitions": [{"title": "string",
"description": "string",
"action": {"id": 0,
"name": "page.visit"
},
"expressions": [{"attribute": {"type": "PARAM",
"param": "string",
"id": 0
},
"constraint": {"type": "BOOL",
"logic": "IS_TRUE"
}
}
],
"tabIndex": 0,
"aggregationType": "EVENT",
"chartType": "COLUMN"
}
]
}
},
"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",
"isPredefinedAnalytic": true,
"isDynamicAnalytic": true,
"isDeleted": true,
"namespace": "string",
"directoryId": "786c2ec1-fb9a-4593-b705-005b34c18c18"
}

Update trend

Update an existing trend

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.permissions required: ANALYTICS_BACKEND_TRENDS_UPDATE, 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_TRENDS

Authorizations:

JWT

path Parameters

namespace required	string Value: "profiles" Namespace. Currently, only `profiles` is available.
trendId required	string <uuid> Trend UUID

Request Body schema: application/json

required

object

Details of a trend analysis

Responses

Request samples

Content type

application/json

{"analysis": {"title": "string",
"description": "string",
"filter": {"matching": true,
"expressions": [{"type": "FUNNEL",
"matching": true,
"funnel": {"completedWithin": {"period": "YEARS",
"value": 0
},
"dateFilter": {"type": "ABSOLUTE",
"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"filter": {"type": "DAILY",
"nestingType": "IN_PLACE",
"from": "string",
"to": "string",
"inverted": false
}
},
"exact": false,
"steps": [{"title": "string",
"action": {"id": 0,
"name": "page.visit"
},
"expressions": [{"attribute": null,
"constraint": null
}
]
}
],
"title": "string"
}
}
],
"expression": { }
},
"trend": {"aggregateDataBy": {"type": "YEARS",
"value": 0
},
"dateFilter": {"type": "ABSOLUTE",
"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"filter": {"type": "DAILY",
"nestingType": "IN_PLACE",
"from": "string",
"to": "string",
"inverted": false
}
},
"trendDefinitions": [{"title": "string",
"description": "string",
"action": {"id": 0,
"name": "page.visit"
},
"expressions": [{"attribute": {"type": "PARAM",
"param": "string",
"id": 0
},
"constraint": {"type": "BOOL",
"logic": "IS_TRUE"
}
}
],
"tabIndex": 0,
"aggregationType": "EVENT",
"chartType": "COLUMN"
}
]
}
}
}

Response samples

4XX
5XX

Content type

application/json

{"timestamp": "2019-08-24T14:15:22Z",
"status": 0,
"error": "string",
"message": "string",
"path": "string"
}

Delete trend

Delete a trend.

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.permissions required: ANALYTICS_BACKEND_TRENDS_DELETE, 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_TRENDS

Authorizations:

JWT

path Parameters

namespace required	string Value: "profiles" Namespace. Currently, only `profiles` is available.
trendId required	string <uuid> Trend UUID

Responses

Request samples

curl --request DELETE 
  --url https://api.synerise.com/analytics/%7Bnamespace%7D/trends/%7BtrendId%7D 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

4XX
5XX

Content type

application/json

{"timestamp": "2019-08-24T14:15:22Z",
"status": 0,
"error": "string",
"message": "string",
"path": "string"
}

List trends

Returns a paginated list of trends.

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:

JWT

path Parameters

namespace

required

string

Value: "profiles"

Namespace. Currently, only profiles is available.

query Parameters

page	integer <int32> >= 1 Default: 1 The number of the page to retrieve
limit	integer <int32> Default: 50 Limit of items per page
search	string A string to search for in analyses' titles
sortBy	string Default: "updatedAt:desc" Enum: "name:asc" "name:desc" "author:asc" "author:desc" "updatedAt:asc" "updatedAt:desc" "createdAt:asc" "createdAt:desc" "id:asc" "id:desc" "directoryId:asc" "directoryId:desc" Example: sortBy=name:asc You can sort the results. The sorting direction is selected by adding `asc` or `desc`, for example `sortBy=name:desc`.
directoryId	string <uuid> Unique ID of the directory to retrieve analyses from
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/trends?page=SOME_INTEGER_VALUE&limit=SOME_INTEGER_VALUE&search=SOME_STRING_VALUE&sortBy=name%3Aasc&directoryId=SOME_STRING_VALUE&ids=SOME_STRING_VALUE' 
  --header 'Authorization: Bearer _YOUR_JWT_TOKEN_'

Response samples

200
4XX
5XX

Content type

application/json

{"data": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"author": {"id": 0,
"name": "string",
"icon": "string"
},
"updatedAt": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z",
"isDynamicAnalytic": true,
"variables": [{"name": "event.params.PARAMNAME",
"value": "string"
}
]
}
],
"meta": {"links": [{"url": "string",
"rel": "first"
}
],
"limit": 0,
"count": 0
}
}

Create a trend

Create a trend.

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_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_TRENDS

Authorizations:

JWT

path Parameters

namespace

required

string

Value: "profiles"

Namespace. Currently, only profiles is available.

Request Body schema: application/json

required

object

Details of a trend analysis

Responses

Request samples

Content type

application/json

{"analysis": {"title": "string",
"description": "string",
"filter": {"matching": true,
"expressions": [{"type": "FUNNEL",
"matching": true,
"funnel": {"completedWithin": {"period": "YEARS",
"value": 0
},
"dateFilter": {"type": "ABSOLUTE",
"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"filter": {"type": "DAILY",
"nestingType": "IN_PLACE",
"from": "string",
"to": "string",
"inverted": false
}
},
"exact": false,
"steps": [{"title": "string",
"action": {"id": 0,
"name": "page.visit"
},
"expressions": [{"attribute": null,
"constraint": null
}
]
}
],
"title": "string"
}
}
],
"expression": { }
},
"trend": {"aggregateDataBy": {"type": "YEARS",
"value": 0
},
"dateFilter": {"type": "ABSOLUTE",
"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"filter": {"type": "DAILY",
"nestingType": "IN_PLACE",
"from": "string",
"to": "string",
"inverted": false
}
},
"trendDefinitions": [{"title": "string",
"description": "string",
"action": {"id": 0,
"name": "page.visit"
},
"expressions": [{"attribute": {"type": "PARAM",
"param": "string",
"id": 0
},
"constraint": {"type": "BOOL",
"logic": "IS_TRUE"
}
}
],
"tabIndex": 0,
"aggregationType": "EVENT",
"chartType": "COLUMN"
}
]
}
}
}

Response samples

200
4XX
5XX

Content type

application/json

"497f6eca-6276-4993-bfeb-53cbbbba6f08"

Preview trend calculation

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:

JWT

Request Body schema: application/json

required

object

Details of a trend analysis

Responses

Request samples

Content type

application/json

{"analysis": {"title": "string",
"description": "string",
"filter": {"matching": true,
"expressions": [{"type": "FUNNEL",
"matching": true,
"funnel": {"completedWithin": {"period": "YEARS",
"value": 0
},
"dateFilter": {"type": "ABSOLUTE",
"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"filter": {"type": "DAILY",
"nestingType": "IN_PLACE",
"from": "string",
"to": "string",
"inverted": false
}
},
"exact": false,
"steps": [{"title": "string",
"action": {"id": 0,
"name": "page.visit"
},
"expressions": [{"attribute": null,
"constraint": null
}
]
}
],
"title": "string"
}
}
],
"expression": { }
},
"trend": {"aggregateDataBy": {"type": "YEARS",
"value": 0
},
"dateFilter": {"type": "ABSOLUTE",
"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"filter": {"type": "DAILY",
"nestingType": "IN_PLACE",
"from": "string",
"to": "string",
"inverted": false
}
},
"trendDefinitions": [{"title": "string",
"description": "string",
"action": {"id": 0,
"name": "page.visit"
},
"expressions": [{"attribute": {"type": "PARAM",
"param": "string",
"id": 0
},
"constraint": {"type": "BOOL",
"logic": "IS_TRUE"
}
}
],
"tabIndex": 0,
"aggregationType": "EVENT",
"chartType": "COLUMN"
}
]
}
}
}

Response samples

200
4XX
5XX

Content type

application/json

{"name": "string",
"metadata": {"aggregateDataBy": {"type": "YEARS",
"value": 0
},
"dateFilter": {"type": "ABSOLUTE",
"from": "2019-08-24T14:15:22Z",
"to": "2019-08-24T14:15:22Z",
"filter": {"type": "DAILY",
"nestingType": "IN_PLACE",
"from": "string",
"to": "string",
"inverted": false
}
}
},
"items": [{"aggregateTimeDescription": "2019-08-24T14:15:22Z",
"values": [{"trendId": "e690f845-235e-49cc-a6ee-5e571e093347",
"countedEvents": 0,
"countedClients": 0
}
]
}
],
"legends": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"title": "string",
"chartType": "COLUMN"
}
]
}

Analytics: Management

Manage analytics folders or delete multiple analyses

Delete directory

Deletes a directory. If the directory contains any analyses, they are moved to the default 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:

JWT

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:

JWT

path Parameters

directoryId

required

string <uuid>

ID of a directory

Request Body schema: application/json

newName

required

string

New name for the directory

Responses

Request samples

Content type

application/json

{"newName": "string"
}

Response samples

4XX
5XX

Content type

application/json

{"timestamp": "2019-08-24T14:15:22Z",
"status": 0,
"error": "string",
"message": "string",
"path": "string"
}

List directories

Returns a list of directories for a 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:

JWT

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

200
4XX
5XX

Content type

application/json

[{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"createdAt": "2019-08-24T14:15:22Z",
"default": true
}
]

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:

JWT

Request Body schema: application/json

name required	string Name of the resource
analyticType required	string Enum: "EXPRESSION" "AGGREGATE" "SEGMENTATION" "METRIC" "FUNNEL" "SANKEY" "TREND" "HISTOGRAM" "REPORT" "ANALYTICS_QUERY" "ANALYTICS_DASHBOARD"

Responses

Request samples

Content type

application/json

{"name": "string",
"analyticType": "EXPRESSION"
}

Response samples

201
4XX
5XX

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Change Directory

Moves an analysis to another 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:

JWT

path Parameters

analyticId

required

string <uuid>

ID of the analysis

Request Body schema: application/json

newDir required	string <uuid> ID of the new directory
analyticType required	string Enum: "EXPRESSION" "AGGREGATE" "SEGMENTATION" "METRIC" "FUNNEL" "SANKEY" "TREND" "HISTOGRAM" "REPORT" "ANALYTICS_QUERY" "ANALYTICS_DASHBOARD"

Responses

Request samples

Content type

application/json

{"newDir": "927cf82e-bfcc-4026-ba0d-96408cda03cb",
"analyticType": "EXPRESSION"
}

Response samples

4XX
5XX

Content type

application/json

{"timestamp": "2019-08-24T14:15:22Z",
"status": 0,
"error": "string",
"message": "string",
"path": "string"
}

Delete multiple analyses

Deletes many analytics in a single request

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_BATCH_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:

JWT

Request Body schema: application/json

funnelIds required	Array of strings <uuid> >= 0 items A list of funnels to delete
segmentationIds required	Array of strings <uuid> >= 0 items A list of segmentations to delete
trendIds required	Array of strings <uuid> >= 0 items A list of trends to delete
metricIds required	Array of strings <uuid> >= 0 items A list of metrics to delete
histogramIds required	Array of strings <uuid> >= 0 items A list of histograms to delete
reportIds required	Array of strings <uuid> >= 0 items A list of reports to delete
aggregateIds required	Array of strings <uuid> >= 0 items A list of aggregates to delete
expressionIds required	Array of strings <uuid> >= 0 items A list of expressions to delete
sankeyIds required	Array of strings <uuid> >= 0 items A list of sankey analyses to delete

Responses

Request samples

Content type

application/json

{"funnelIds": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"segmentationIds": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"trendIds": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"metricIds": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"histogramIds": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"reportIds": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"aggregateIds": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"expressionIds": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"sankeyIds": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

Response samples

4XX
5XX

Content type

application/json

{"timestamp": "2019-08-24T14:15:22Z",
"status": 0,
"error": "string",
"message": "string",
"path": "string"
}