Retention
The user to get information for.
The date to get predictions for. Can be latest for latest available data.
If not set, defaults to the current date.
nowThe users list for which we ask predictions. Has priority over user.
[]The type of predictions to return. Notice that you must have access to the underlying package, otherwise an unauthorized response will be returned.
allPossible values: The operator to use for querying data. Notice that this is applied only if your account has access to multiple operators. In a different case the assigned operator to your account is used and the value of this field is ignored.
The bookmaker id to use for querying data. Notice that this is applied only
if your account has access to multiple operators. In a different case
the assigned operator to your account is used and the value of this
field is ignored. Note that this parameter is used together with the
sub_bookmaker_id parameter.
The sub-bookmaker id to use for querying data. Notice that this is applied only
if your account has access to multiple operators. In a different case
the assigned operator to your account is used and the value of this
field is ignored. Note that this parameter is used together with the
bookmaker_id parameter.
The type of product to get predictions for. If an operator has the CRM
package for more than one products, then this must be set. Can be one
of sports, casino, horses, combined. If not set it defaults to sports.
sportsPossible values: The columns to sort the results by. It expects a string adhering to
the ordering format, as described in the ordering section, e.g.
+churn_score_007,-churn_score_014.
+user_idPossible values: Optional filtering of the results. It expects a string adhering to the
filtering format, as described in the filtering section, e.g.
churn_score_007:gt:0.7;predicted_ggr_030:lt:5000.
""Possible values: The page to retrieve. Notice that if set the random access pagination mechanism will be used. If not set the pagination mechanism default to the keyset mode.
The number of items ot include in each page.
100The cursor to get data from. It should be retrieved from the pagination
section of a previous response in case of keyset pagination.
This value will be ignored if the page parameter has been provided
and random access pagination will be used instead.
Notice that the the cursor is cryptographically signed and verified, make sure to set the exact value it was returned.
The underlying schema version. Some endpoints can operate on multiple
internal database schemas. Must be one of the allowed values. If not
set it defaults to v2.
v2Possible values: Optional selection of the object fields to retrieve. It expects a comma
separated list of strings, as described in the field selection section,
e.g. churn_score_060,campaign_segment.
If set to true, the response will be formatted for export.
This will include all users.
falseA comma-separated list of email addresses to which the export file will be sent. If the resulting file is smaller than 25MB it will be sent as an attachment, otherwise a download link will be provided. If not set, the file will not be emailed.
[]Custom client header, the value should be the name of the group the user belongs to
Authentication method to be used, supported values [vaix, iam]. Defaults to vaix
OK
API response
The status of the request
Bad Request
Unauthorized
Forbidden
Not Acceptable
Request Entity Too Large
Unprocessable Entity
Too Early
Internal Server Error
The user to get information for.
The date to get predictions for. Can be latest for latest available data.
If not set, defaults to the current date.
nowThe users list for which we ask predictions. Has priority over user.
[]The operator to use for querying data. Notice that this is applied only if your account has access to multiple operators. In a different case the assigned operator to your account is used and the value of this field is ignored.
The bookmaker id to use for querying data. Notice that this is applied only
if your account has access to multiple operators. In a different case
the assigned operator to your account is used and the value of this
field is ignored. Note that this parameter is used together with the
sub_bookmaker_id parameter.
The sub-bookmaker id to use for querying data. Notice that this is applied only
if your account has access to multiple operators. In a different case
the assigned operator to your account is used and the value of this
field is ignored. Note that this parameter is used together with the
bookmaker_id parameter.
The type of product to get predictions for. If an operator has the CRM
package for more than one products, then this must be set. Can be one
of sports, casino, horses, combined. If not set it defaults to sports.
sportsPossible values: The columns to sort the results by. It expects a string adhering to
the ordering format, as described in the ordering section, e.g.
+churn_score_007,-churn_score_014.
+user_idPossible values: Optional filtering of the results. It expects a string adhering to the
filtering format, as described in the filtering section, e.g.
churn_score_007:gt:0.7;predicted_ggr_030:lt:5000.
""Possible values: The page to retrieve. Notice that if set the random access pagination mechanism will be used. If not set the pagination mechanism default to the keyset mode.
The number of items ot include in each page.
100The cursor to get data from. It should be retrieved from the pagination
section of a previous response in case of keyset pagination.
This value will be ignored if the page parameter has been provided
and random access pagination will be used instead.
Notice that the the cursor is cryptographically signed and verified, make sure to set the exact value it was returned.
The underlying schema version. Some endpoints can operate on multiple
internal database schemas. Must be one of the allowed values. If not
set it defaults to v2.
v2Possible values: Optional selection of the object fields to retrieve. It expects a comma
separated list of strings, as described in the field selection section,
e.g. acquisition_source,apds.
If set to true, the response will be formatted for export.
This will include all users.
falseA comma-separated list of email addresses to which the export file will be sent. If the resulting file is smaller than 25MB it will be sent as an attachment, otherwise a download link will be provided. If not set, the file will not be emailed.
[]Custom client header, the value should be the name of the group the user belongs to
Authentication method to be used, supported values [vaix, iam]. Defaults to vaix
OK
API response
The status of the request
Bad Request
Unauthorized
Forbidden
Not Acceptable
Request Entity Too Large
Unprocessable Entity
Too Early
Internal Server Error
The user to get information for.
The date to get predictions for. Can be latest for latest available data.
If not set, defaults to the current date.
nowThe users list for which we ask predictions. Has priority over user.
[]The operator to use for querying data. Notice that this is applied only if your account has access to multiple operators. In a different case the assigned operator to your account is used and the value of this field is ignored.
The bookmaker id to use for querying data. Notice that this is applied only
if your account has access to multiple operators. In a different case
the assigned operator to your account is used and the value of this
field is ignored. Note that this parameter is used together with the
sub_bookmaker_id parameter.
The sub-bookmaker id to use for querying data. Notice that this is applied only
if your account has access to multiple operators. In a different case
the assigned operator to your account is used and the value of this
field is ignored. Note that this parameter is used together with the
bookmaker_id parameter.
The type of product to get predictions for. If an operator has the CRM
package for more than one products, then this must be set. Can be one
of sports, casino, horses, combined. If not set it defaults to sports.
sportsPossible values: The columns to sort the results by. It expects a string adhering to
the ordering format, as described in the ordering section, e.g.
+churn_score_007,-churn_score_014.
+user_idPossible values: Optional filtering of the results. It expects a string adhering to the
filtering format, as described in the filtering section, e.g.
churn_score_007:gt:0.7;predicted_ggr_030:lt:5000.
""Possible values: The page to retrieve. Notice that if set the random access pagination mechanism will be used. If not set the pagination mechanism default to the keyset mode.
The number of items ot include in each page.
100The cursor to get data from. It should be retrieved from the pagination
section of a previous response in case of keyset pagination.
This value will be ignored if the page parameter has been provided
and random access pagination will be used instead.
Notice that the the cursor is cryptographically signed and verified, make sure to set the exact value it was returned.
The underlying schema version. Some endpoints can operate on multiple
internal database schemas. Must be one of the allowed values. If not
set it defaults to v2.
v2Possible values: Optional selection of the object fields to retrieve. It expects a comma
separated list of strings, as described in the field selection section,
e.g. acquisition_source,apds.
If set to true, the response will be formatted for export.
This will include all users.
falseA comma-separated list of email addresses to which the export file will be sent. If the resulting file is smaller than 25MB it will be sent as an attachment, otherwise a download link will be provided. If not set, the file will not be emailed.
[]Custom client header, the value should be the name of the group the user belongs to
Authentication method to be used, supported values [vaix, iam]. Defaults to vaix
OK
API response
The status of the request
Bad Request
Unauthorized
Forbidden
Not Acceptable
Request Entity Too Large
Unprocessable Entity
Too Early
Internal Server Error
The user to get information for.
The date to get predictions for. Can be latest for latest available data.
If not set, defaults to the current date.
nowThe users list for which we ask predictions. Has priority over user.
[]The operator to use for querying data. Notice that this is applied only if your account has access to multiple operators. In a different case the assigned operator to your account is used and the value of this field is ignored.
The bookmaker id to use for querying data. Notice that this is applied only
if your account has access to multiple operators. In a different case
the assigned operator to your account is used and the value of this
field is ignored. Note that this parameter is used together with the
sub_bookmaker_id parameter.
The sub-bookmaker id to use for querying data. Notice that this is applied only
if your account has access to multiple operators. In a different case
the assigned operator to your account is used and the value of this
field is ignored. Note that this parameter is used together with the
bookmaker_id parameter.
The type of product to get predictions for. If an operator has the CRM
package for more than one products, then this must be set. Can be one
of sports, casino, horses, combined. If not set it defaults to sports.
sportsPossible values: The columns to sort the results by. It expects a string adhering to
the ordering format, as described in the ordering section, e.g.
+churn_score_007,-churn_score_014.
+user_idPossible values: Optional filtering of the results. It expects a string adhering to the
filtering format, as described in the filtering section, e.g.
churn_score_007:gt:0.7;predicted_ggr_030:lt:5000.
""Possible values: The page to retrieve. Notice that if set the random access pagination mechanism will be used. If not set the pagination mechanism default to the keyset mode.
The number of items ot include in each page.
100The cursor to get data from. It should be retrieved from the pagination
section of a previous response in case of keyset pagination.
This value will be ignored if the page parameter has been provided
and random access pagination will be used instead.
Notice that the the cursor is cryptographically signed and verified, make sure to set the exact value it was returned.
The underlying schema version. Some endpoints can operate on multiple
internal database schemas. Must be one of the allowed values. If not
set it defaults to v2.
v2Possible values: Optional selection of the object fields to retrieve. It expects a comma
separated list of strings, as described in the field selection section,
e.g. acquisition_source,apds.
If set to true, the response will be formatted for export.
This will include all users.
falseA comma-separated list of email addresses to which the export file will be sent. If the resulting file is smaller than 25MB it will be sent as an attachment, otherwise a download link will be provided. If not set, the file will not be emailed.
[]Custom client header, the value should be the name of the group the user belongs to
Authentication method to be used, supported values [vaix, iam]. Defaults to vaix
OK
API response
The status of the request
Bad Request
Unauthorized
Forbidden
Not Acceptable
Request Entity Too Large
Unprocessable Entity
Too Early
Internal Server Error
The user to get information for.
The date to get predictions for. Can be latest for latest available data.
If not set, defaults to the current date.
nowThe users list for which we ask predictions. Has priority over user.
[]The operator to use for querying data. Notice that this is applied only if your account has access to multiple operators. In a different case the assigned operator to your account is used and the value of this field is ignored.
The bookmaker id to use for querying data. Notice that this is applied only
if your account has access to multiple operators. In a different case
the assigned operator to your account is used and the value of this
field is ignored. Note that this parameter is used together with the
sub_bookmaker_id parameter.
The sub-bookmaker id to use for querying data. Notice that this is applied only
if your account has access to multiple operators. In a different case
the assigned operator to your account is used and the value of this
field is ignored. Note that this parameter is used together with the
bookmaker_id parameter.
The type of product to get predictions for. If an operator has the CRM
package for more than one products, then this must be set. Can be one
of sports, casino, horses, combined. If not set it defaults to sports.
sportsPossible values: The columns to sort the results by. It expects a string adhering to
the ordering format, as described in the ordering section, e.g.
+churn_score_007,-churn_score_014.
+user_idPossible values: Optional filtering of the results. It expects a string adhering to the
filtering format, as described in the filtering section, e.g.
churn_score_007:gt:0.7;predicted_ggr_030:lt:5000.
""Possible values: The page to retrieve. Notice that if set the random access pagination mechanism will be used. If not set the pagination mechanism default to the keyset mode.
The number of items ot include in each page.
100The cursor to get data from. It should be retrieved from the pagination
section of a previous response in case of keyset pagination.
This value will be ignored if the page parameter has been provided
and random access pagination will be used instead.
Notice that the the cursor is cryptographically signed and verified, make sure to set the exact value it was returned.
The underlying schema version. Some endpoints can operate on multiple
internal database schemas. Must be one of the allowed values. If not
set it defaults to v2.
v2Possible values: Optional selection of the object fields to retrieve. It expects a comma
separated list of strings, as described in the field selection section,
e.g. acquisition_source,apds.
If set to true, the response will be formatted for export.
This will include all users.
falseA comma-separated list of email addresses to which the export file will be sent. If the resulting file is smaller than 25MB it will be sent as an attachment, otherwise a download link will be provided. If not set, the file will not be emailed.
[]Custom client header, the value should be the name of the group the user belongs to
Authentication method to be used, supported values [vaix, iam]. Defaults to vaix
OK
API response
The status of the request
Bad Request
Unauthorized
Forbidden
Not Acceptable
Request Entity Too Large
Unprocessable Entity
Too Early
Internal Server Error
The user to get information for.
The date to get predictions for. Can be latest for latest available data.
If not set, defaults to the current date.
nowThe users list for which we ask predictions. Has priority over user.
[]The operator to use for querying data. Notice that this is applied only if your account has access to multiple operators. In a different case the assigned operator to your account is used and the value of this field is ignored.
The bookmaker id to use for querying data. Notice that this is applied only
if your account has access to multiple operators. In a different case
the assigned operator to your account is used and the value of this
field is ignored. Note that this parameter is used together with the
sub_bookmaker_id parameter.
The sub-bookmaker id to use for querying data. Notice that this is applied only
if your account has access to multiple operators. In a different case
the assigned operator to your account is used and the value of this
field is ignored. Note that this parameter is used together with the
bookmaker_id parameter.
The type of product to get predictions for. If an operator has the CRM
package for more than one products, then this must be set. Can be one
of sports, casino, horses, combined. If not set it defaults to sports.
sportsPossible values: The columns to sort the results by. It expects a string adhering to
the ordering format, as described in the ordering section, e.g.
+churn_score_007,-churn_score_014.
+user_idPossible values: Optional filtering of the results. It expects a string adhering to the
filtering format, as described in the filtering section, e.g.
churn_score_007:gt:0.7;predicted_ggr_030:lt:5000.
""Possible values: The page to retrieve. Notice that if set the random access pagination mechanism will be used. If not set the pagination mechanism default to the keyset mode.
The number of items ot include in each page.
100The cursor to get data from. It should be retrieved from the pagination
section of a previous response in case of keyset pagination.
This value will be ignored if the page parameter has been provided
and random access pagination will be used instead.
Notice that the the cursor is cryptographically signed and verified, make sure to set the exact value it was returned.
The underlying schema version. Some endpoints can operate on multiple
internal database schemas. Must be one of the allowed values. If not
set it defaults to v2.
v2Possible values: Optional selection of the object fields to retrieve. It expects a comma
separated list of strings, as described in the field selection section,
e.g. acquisition_source,apds.
If set to true, the response will be formatted for export.
This will include all users.
falseA comma-separated list of email addresses to which the export file will be sent. If the resulting file is smaller than 25MB it will be sent as an attachment, otherwise a download link will be provided. If not set, the file will not be emailed.
[]Custom client header, the value should be the name of the group the user belongs to
Authentication method to be used, supported values [vaix, iam]. Defaults to vaix
OK
API response
The status of the request
Bad Request
Unauthorized
Forbidden
Not Acceptable
Request Entity Too Large
Unprocessable Entity
Too Early
Internal Server Error
The user to get information for.
The date to get predictions for. Can be latest for latest available data.
If not set, defaults to the current date.
nowThe users list for which we ask predictions. Has priority over user.
[]The operator to use for querying data. Notice that this is applied only if your account has access to multiple operators. In a different case the assigned operator to your account is used and the value of this field is ignored.
The bookmaker id to use for querying data. Notice that this is applied only
if your account has access to multiple operators. In a different case
the assigned operator to your account is used and the value of this
field is ignored. Note that this parameter is used together with the
sub_bookmaker_id parameter.
The sub-bookmaker id to use for querying data. Notice that this is applied only
if your account has access to multiple operators. In a different case
the assigned operator to your account is used and the value of this
field is ignored. Note that this parameter is used together with the
bookmaker_id parameter.
The type of product to get predictions for. If an operator has the CRM
package for more than one products, then this must be set. Can be one
of sports, casino, horses, combined. If not set it defaults to sports.
sportsPossible values: The columns to sort the results by. It expects a string adhering to
the ordering format, as described in the ordering section, e.g.
+churn_score_007,-churn_score_014.
+user_idPossible values: Optional filtering of the results. It expects a string adhering to the
filtering format, as described in the filtering section, e.g.
churn_score_007:gt:0.7;predicted_ggr_030:lt:5000.
""Possible values: The page to retrieve. Notice that if set the random access pagination mechanism will be used. If not set the pagination mechanism default to the keyset mode.
The number of items ot include in each page.
100The cursor to get data from. It should be retrieved from the pagination
section of a previous response in case of keyset pagination.
This value will be ignored if the page parameter has been provided
and random access pagination will be used instead.
Notice that the the cursor is cryptographically signed and verified, make sure to set the exact value it was returned.
The underlying schema version. Some endpoints can operate on multiple
internal database schemas. Must be one of the allowed values. If not
set it defaults to v2.
v2Possible values: Optional selection of the object fields to retrieve. It expects a comma
separated list of strings, as described in the field selection section,
e.g. acquisition_source,apds.
If set to true, the response will be formatted for export.
This will include all users.
falseA comma-separated list of email addresses to which the export file will be sent. If the resulting file is smaller than 25MB it will be sent as an attachment, otherwise a download link will be provided. If not set, the file will not be emailed.
[]Custom client header, the value should be the name of the group the user belongs to
Authentication method to be used, supported values [vaix, iam]. Defaults to vaix
OK
API response
The status of the request
Bad Request
Unauthorized
Forbidden
Not Acceptable
Request Entity Too Large
Unprocessable Entity
Too Early
Internal Server Error
Returned values
{
"predicted_stake_007": 0.07000000029802322,
"predicted_stake_014": 0.10000000149011612,
"predicted_stake_030": 0.1599999964237213,
"predicted_stake_060": 0.2800000011920929,
"predicted_stake_090": 0.3499999940395355,
"predicted_stake_180": 0.46000000834465027,
"predicted_stake_365": null,
}The user to get information for.
The date to get predictions for. Can be latest for latest available data.
If not set, defaults to the current date.
nowThe users list for which we ask predictions. Has priority over user.
[]The operator to use for querying data. Notice that this is applied only if your account has access to multiple operators. In a different case the assigned operator to your account is used and the value of this field is ignored.
The bookmaker id to use for querying data. Notice that this is applied only
if your account has access to multiple operators. In a different case
the assigned operator to your account is used and the value of this
field is ignored. Note that this parameter is used together with the
sub_bookmaker_id parameter.
The sub-bookmaker id to use for querying data. Notice that this is applied only
if your account has access to multiple operators. In a different case
the assigned operator to your account is used and the value of this
field is ignored. Note that this parameter is used together with the
bookmaker_id parameter.
The type of product to get predictions for. If an operator has the CRM
package for more than one products, then this must be set. Can be one
of sports, casino, horses, combined. If not set it defaults to sports.
sportsPossible values: The columns to sort the results by. It expects a string adhering to
the ordering format, as described in the ordering section, e.g.
+churn_score_007,-churn_score_014.
+user_idPossible values: Optional filtering of the results. It expects a string adhering to the
filtering format, as described in the filtering section, e.g.
churn_score_007:gt:0.7;predicted_ggr_030:lt:5000.
""Possible values: The page to retrieve. Notice that if set the random access pagination mechanism will be used. If not set the pagination mechanism default to the keyset mode.
The number of items ot include in each page.
100The cursor to get data from. It should be retrieved from the pagination
section of a previous response in case of keyset pagination.
This value will be ignored if the page parameter has been provided
and random access pagination will be used instead.
Notice that the the cursor is cryptographically signed and verified, make sure to set the exact value it was returned.
The underlying schema version. Some endpoints can operate on multiple
internal database schemas. Must be one of the allowed values. If not
set it defaults to v2.
v2Possible values: Optional selection of the object fields to retrieve. It expects a comma
separated list of strings, as described in the field selection section,
e.g. acquisition_source,apds.
If set to true, the response will be formatted for export.
This will include all users.
falseA comma-separated list of email addresses to which the export file will be sent. If the resulting file is smaller than 25MB it will be sent as an attachment, otherwise a download link will be provided. If not set, the file will not be emailed.
[]Custom client header, the value should be the name of the group the user belongs to
Authentication method to be used, supported values [vaix, iam]. Defaults to vaix
OK
API response
The status of the request
Bad Request
Unauthorized
Forbidden
Not Acceptable
Request Entity Too Large
Unprocessable Entity
Too Early
Internal Server Error
Aggregations
Multiple aggregations
aggregations=min,max,avg
fields=ggr{
"data": [
{
"avg_ggr": -96.62872752506948,
"count": 6881,
"max_ggr": 8837.9103,
"min_ggr": -115770.3471
}
],
"status": "success"
}Grouping results
Filtering the result set
The columns to group the results by. It should be a comma separated list
with the columns to use for grouping in the format col1,col2.
The columns to use in aggregations. It should be a comma separated list,
e.g. predicted_apds_030,predicted_ggr_030.
The aggregations to be applied on all selected fields. You can pass
more than one aggregations through a comma separated list, e.g.
min,max,avg.
The type of product to get predictions for. If an operator has the CRM
package for more than one products, then this must be set. Can be one
of sports, casino, horses, combined. If not set it defaults to sports.
sportsPossible values: Optional filtering of the results. It expects a string adhering to the
filtering format, as described in the filtering section, e.g.
churn_score_007:gt:0.7;predicted_ggr_030:lt:5000.
""Possible values: The underlying schema version. Some endpoints can operate on multiple
internal database schemas. Must be one of the allowed values. If not
set it defaults to v2.
v2Possible values: Custom client header, the value should be the name of the group the user belongs to
Authentication method to be used, supported values [vaix, iam]. Defaults to vaix
OK
API response
Array of objects
The status of the request
Bad Request
Unauthorized
Forbidden
Not Acceptable
Request Entity Too Large
Unprocessable Entity
Too Early
Internal Server Error
Last updated
Was this helpful?