Default

Root

get

Responses

200

Successful Response

application/json

anyOptional

get

/

HTTPcURLJavaScriptPython

GET / HTTP/1.1
Accept: */*

200

Successful Response

No content

Health Check

get

Responses

200

Successful Response

application/json

anyOptional

get

/health_check

HTTPcURLJavaScriptPython

GET /health_check HTTP/1.1
Accept: */*

200

Successful Response

No content

Get Recos

get

Route to get recommendations from d level tables. Recommendation is fetched either from: - Redis: cache recommendation layer with a 6 hours TTL - Bigtable: pre-computed recommendations activated manually by a superuser on client's side. It' called "boost" mode. Reco is computed for every available variable. For now it can be activated for reco with one variable only. - ClickHouse when a new query is required to get fresh recommendations :param site_id: the client for which to fetch the recommendations :param recos_id: UUID for the recommendation created by the client. :param variables: a dictionary provided by the client to provided context. Example: { "last_order_items": ["5064176"], "viewing_item": "5064176", "most_expensive_cart_item": "5064160", "most_expensive_order_item": "5064160" } :param fields: the fields from reco table the client wants to fetch :param output_format: the format to get the data. Default to JSON. :param delimiter: when output format is CSV you can specify a delimiter :param abtest_group: Parameter used to set the abtest_group. Default to None. :return:

Authorizations

APIKeyHeader

AuthorizationstringRequired

Path parameters

site_idintegerRequired

recos_idstringRequired

Recommendations id.

Query parameters

variablesany ofOptional

Variables of the query represented as a JSON string

stringOptional

or

nullOptional

fieldsany ofOptional

Item fields which should be returned by the API. Defaults to id

string[]Optional

or

nullOptional

output_formatany ofOptional

format for the output recommendation. Default to JSON

stringOptional

or

nullOptional

delimiterstring · enumOptional

Use the specified delimiter for the output format : comma (,) semicolon (;) tab (%09) pipe (|) ). Default to ;

Default: ;Possible values:

Responses

200

Successful Response

application/json

anyOptional

422

Validation Error

application/json

get

/{site_id}/recos/{recos_id}

HTTPcURLJavaScriptPython

GET /{site_id}/recos/{recos_id} HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

No content

Get Recos Infos

get

Authorizations

APIKeyHeader

AuthorizationstringRequired

Path parameters

site_idintegerRequired

recos_idstringRequired

Recommendations id.

Responses

200

Successful Response

application/json

anyOptional

422

Validation Error

application/json

get

/{site_id}/recos/{recos_id}/infos

HTTPcURLJavaScriptPython

GET /{site_id}/recos/{recos_id}/infos HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

No content

Get Merch By Site And Category

get

Authorizations

APIKeyHeader

AuthorizationstringRequired

Path parameters

site_idintegerRequired

category_idstringRequired

Category id.

Responses

200

Successful Response

application/json

anyOptional

422

Validation Error

application/json

get

/{site_id}/merch/category_id/{category_id}

HTTPcURLJavaScriptPython

GET /{site_id}/merch/category_id/{category_id} HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

No content

Debug Recos

get

Authorizations

APIKeyHeader

AuthorizationstringRequired

Path parameters

site_idintegerRequired

recos_idstringRequired

Recommendations id.

Query parameters

variablesany ofOptional

Variables of the query represented as a JSON string

stringOptional

or

nullOptional

fieldsany ofOptional

Item fields which should be returned by the API. Defaults to id

string[]Optional

or

nullOptional

Responses

200

Successful Response

application/json

anyOptional

422

Validation Error

application/json

get

/{site_id}/recos/{recos_id}/debug

HTTPcURLJavaScriptPython

GET /{site_id}/recos/{recos_id}/debug HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

No content

Get Recos From Query

post

Authorizations

APIKeyHeader

AuthorizationstringRequired

Path parameters

site_idintegerRequired

Query parameters

variablesany ofOptional

Variables of the query represented as a JSON string

stringOptional

or

nullOptional

fieldsany ofOptional

Item fields which should be returned by the API. Defaults to id

string[]Optional

or

nullOptional

Body

application/json

nameany ofOptionalDefault: n/a

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

anyOptional

422

Validation Error

application/json

post

/{site_id}/recos

HTTPcURLJavaScriptPython

POST /{site_id}/recos HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 113

{
  "name": "n/a",
  "rules": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "parameters": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

No content

Get Merch

get

Authorizations

APIKeyHeader

AuthorizationstringRequired

Path parameters

site_idintegerRequired

merch_idstringRequired

Emerch id.

Query parameters

variablesany ofOptional

Variables of the query represented as a JSON string

stringOptional

or

nullOptional

fieldsany ofOptional

Item fields which should be returned by the API. Defaults to id

string[]Optional

or

nullOptional

output_formatany ofOptional

format for the output recommendation. Default to JSON

stringOptional

or

nullOptional

delimiterstring · enumOptional

Use the specified delimiter for the output format : comma (,) semicolon (;) tab (%09) pipe (|) ). Default to ;

Default: ;Possible values:

Responses

200

Successful Response

application/json

anyOptional

422

Validation Error

application/json

get

/{site_id}/merch/{merch_id}

HTTPcURLJavaScriptPython

GET /{site_id}/merch/{merch_id} HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

No content

Get Merch From Query

post

Authorizations

APIKeyHeader

AuthorizationstringRequired

Path parameters

site_idintegerRequired

Query parameters

variablesany ofOptional

Variables of the query represented as a JSON string

stringOptional

or

nullOptional

fieldsany ofOptional

Item fields which should be returned by the API. Defaults to id

string[]Optional

or

nullOptional

limitany ofOptional

Limit of the query

integerOptional

or

nullOptional

offsetany ofOptional

Offset of the query

Default: 0

integerOptional

or

nullOptional

Body

application/json

nameany ofOptionalDefault: n/a

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

anyOptional

422

Validation Error

application/json

post

/{site_id}/merch

HTTPcURLJavaScriptPython

POST /{site_id}/merch HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 224

{
  "name": "n/a",
  "rules": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "parameters": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "items_rules": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "items_parameters": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

No content

Get Recos Templated From Query

post

Authorizations

APIKeyHeader

AuthorizationstringRequired

Path parameters

site_idintegerRequired

template_uuidstringRequired

Template uuid.

Query parameters

variablesany ofOptional

Variables of the query represented as a JSON string

stringOptional

or

nullOptional

Body

application/json

nameany ofOptionalDefault: n/a

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

anyOptional

422

Validation Error

application/json

post

/{site_id}/recos/template/{template_uuid}

HTTPcURLJavaScriptPython

POST /{site_id}/recos/template/{template_uuid} HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 113

{
  "name": "n/a",
  "rules": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "parameters": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

No content

Get Templated From Query

post

Authorizations

APIKeyHeader

AuthorizationstringRequired

Path parameters

site_idintegerRequired

recos_idstringRequired

Recommendations id.

Query parameters

variablesany ofOptional

Variables of the query represented as a JSON string

stringOptional

or

nullOptional

Body

application/json

namestringRequired

htmlstringRequired

Responses

200

Successful Response

application/json

anyOptional

422

Validation Error

application/json

post

/{site_id}/template/recos/{recos_id}

HTTPcURLJavaScriptPython

POST /{site_id}/template/recos/{recos_id} HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 77

{
  "name": "text",
  "html": "text",
  "params": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

No content

Get Template

get

Authorizations

APIKeyHeader

AuthorizationstringRequired

Path parameters

site_idintegerRequired

template_uuidstringRequired

Template uuid.

recos_idstringRequired

Recommendations id.

Query parameters

variablesany ofOptional

Variables of the query represented as a JSON string

stringOptional

or

nullOptional

Responses

200

Successful Response

text/html

stringOptional

422

Validation Error

application/json

get

/{site_id}/template/{template_uuid}/recos/{recos_id}

HTTPcURLJavaScriptPython

GET /{site_id}/template/{template_uuid}/recos/{recos_id} HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

text

Get Template Infos

get

Authorizations

APIKeyHeader

AuthorizationstringRequired

Path parameters

site_idintegerRequired

template_uuidstringRequired

Template Uuid.

Responses

200

Successful Response

application/json

anyOptional

422

Validation Error

application/json

get

/{site_id}/template/{template_uuid}/infos

HTTPcURLJavaScriptPython

GET /{site_id}/template/{template_uuid}/infos HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

No content