Game Studios

Casino game studios endpoints

get
/api/casino/game_studios/popular

Returns popular game studios for the given time frame.

The game studios are sorted by popularity.

circle-info

Popularity

The metric used to measure popularity is the number of sessions played on each game studio.

circle-info

Filtering example

In this example we get all popular game studios from 2022-03-15 to 2022-03-25.

$ curl --request GET \
  --url 'https://api.vaix.ai/api/casino/game_studios/popular?from=2022-03-25%2000%3A00%3A00&from_offset=10d'
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
countinteger · min: 1Optional

Number of game studios to return.

Default: 100Example: 10
filtersstring · enumOptional

Optional filtering of the games to retrieve. It expects a string adhering to the filtering format, as described in the filtering section, e.g. enabled:eq:1.

Example: enabled:eq:1Possible values:
operatorstringOptional

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.

bookmaker_idintegerOptional

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.

sub_bookmaker_idintegerOptional

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.

locationstringOptional

The location of the page where the request takes place.

Example: inplay_widget
Header parameters
x-vaix-client-idstringRequired

Custom client header, the value should be the name of the group the user belongs to

x-vaix-authentication-methodstringOptional

Authentication method to be used, supported values [vaix, iam]. Defaults to vaix

Responses
chevron-right
200

OK

application/json

API response

statusstring · enumOptional

The status of the request

Possible values:
get
/api/casino/game_studios/popular
get
/api/casino/game_studios/recommended

Returns personalized game studios recommendations.

circle-info

Confidence

Each returned item is associated with a number from 0 to 1 indicating the confidence of the system in this specific recommendation. The higher the number the more confident the recommendation of it.

circle-info

Result ordering

By default game studios are sorted based on confidence, with the most confident one on top. The order_by parameter can be used to order the results in the desired order.

circle-info

Getting recommendations for a user

In this example we get all recommended game studios for the user with id 0 without passing any extra parameters except the user

$ curl --request GET \
  --url 'https://api.vaix.ai/api/casino/game_studios/recommended?user=0'
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
userstringOptional

The user to get recommendations for.

Default: 0
countinteger · min: 1Optional

Number of game studios to return.

Default: 100Example: 10
filtersstring · enumOptional

Optional filtering of the games to retrieve. It expects a string adhering to the filtering format, as described in the filtering section, e.g. enabled:eq:1.

Example: enabled:eq:1Possible values:
operatorstringOptional

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.

bookmaker_idintegerOptional

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.

sub_bookmaker_idintegerOptional

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.

locationstringOptional

The location of the page where the request takes place.

Example: inplay_widget
Header parameters
x-vaix-client-idstringRequired

Custom client header, the value should be the name of the group the user belongs to

x-vaix-authentication-methodstringOptional

Authentication method to be used, supported values [vaix, iam]. Defaults to vaix

Responses
chevron-right
200

OK

application/json

API response

statusstring · enumOptional

The status of the request

Possible values:
get
/api/casino/game_studios/recommended
get
/api/casino/game_studios/trending

Returns trending game studios for the given time frame.

The game studios are sorted by trending score.

circle-info

Trending score

To calculate trending score for a game studio, each session played on this game studio contributes a value determined by how recently the session was played.

Recent sessions add more value than older ones.

circle-info

Filtering example

In this example we get all trending game studios at 2022-03-25.

$ curl --request GET \
  --url 'https://api.vaix.ai/api/casino/game_studios/trending?&at=2022-03-25%2000%3A00%3A00'
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
countinteger · min: 1Optional

Number of game studios to return.

Default: 100Example: 10
filtersstring · enumOptional

Optional filtering of the games to retrieve. It expects a string adhering to the filtering format, as described in the filtering section, e.g. enabled:eq:1.

Example: enabled:eq:1Possible values:
operatorstringOptional

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.

bookmaker_idintegerOptional

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.

sub_bookmaker_idintegerOptional

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.

locationstringOptional

The location of the page where the request takes place.

Example: inplay_widget
trending_withinstringOptional

Considers game sessions played after the current timestamp minus the given minutes/hours/days. If not set defaults to 2 days. The value must be in range [1m - 7d].

Default: 2dExample: 3hPattern: ^[+-]?[0-9]+([.][0-9]+)?[smhd]?$
Header parameters
x-vaix-client-idstringRequired

Custom client header, the value should be the name of the group the user belongs to

x-vaix-authentication-methodstringOptional

Authentication method to be used, supported values [vaix, iam]. Defaults to vaix

Responses
chevron-right
200

OK

application/json

API response

statusstring · enumOptional

The status of the request

Possible values:
get
/api/casino/game_studios/trending

Get all casino game studios

get
/api/casino/offering/game_studios

Returns all casino game studios.

circle-info

Example

In this example we get all casino game studios.

$ curl --request GET \
  --url 'https://api.vaix.ai/api/casino/offering/game_studios
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
filtersstring · enumOptional

Optional filtering of the games to retrieve. It expects a string adhering to the filtering format, as described in the filtering section, e.g. enabled:eq:1.

Example: enabled:eq:1Possible values:
typestring · enumOptional

Whether to return vaix or operator studios.

Default: operatorPossible values:
countinteger · min: 1Optional

Number of game studios to return.

Default: 100Example: 10
order_bystring · enumOptional

The columns to sort the results by. It expects a string adhering to the ordering format, as described in the ordering section, e.g. +game_studio.

Possible values:
operatorstringOptional

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.

bookmaker_idintegerOptional

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.

sub_bookmaker_idintegerOptional

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.

locationstringOptional

The location of the page where the request takes place.

Example: inplay_widget
Header parameters
x-vaix-client-idstringRequired

Custom client header, the value should be the name of the group the user belongs to

x-vaix-authentication-methodstringOptional

Authentication method to be used, supported values [vaix, iam]. Defaults to vaix

Responses
chevron-right
200

OK

application/json

API response

statusstring · enumOptional

The status of the request

Possible values:
get
/api/casino/offering/game_studios

Last updated

Was this helpful?