...

Annex #2 - Advanced Request Parameters

The API supports also the settings of advanced parameters for special use-cases.

Correlations

What is it about?

Boxalino standard processes as well as your own custom projects in Google BigQuery can generate highly relevant data to be deployed and made available in Boxalino Real-Time Platform as described here: Open Data Science Lab (B/C DSL)

One of the most used table in the Open Data Science Lab is the “correlations” as documented here: correlations . It will be in your own BigQuery project in “[your_account_name]_lab.correlations”.

Most of the times these data will be used within the Boxalino configuration and will influence the algorithms deciding which products (or content) are returned in which order for each customer.

But sometimes, you might need to retrieve these data as they are saved in the “correlations” table. This can be done with configuration in the Boxalino Admin, but this can also be directly requested (without requiring any configuration) in your API request, which is the use-case we are documenting here.

What to send in the request?

In your request, you need to send another parameter called “correlations” as follows:

{
  ...
  ,"correlations": [
    {
      "origin": "boxalino_std",
      "type": "xxx",
      "source": "yyy"
    }
  ]
}

it is an array of object, each with 3 parameters:

What will be in the response?

As the advanced parameters, there will be another parameter in the response also called “correlations”

{
  ...,
  "correlations": [
    {
      "origin": "boxalino_std",
      "typxxe": "xxx",
      "source": "yyy",
      "target": [
        "zzz"
      ]
    }
  ]
}

The values you can retrieve are stored in the array parameter “target” as in the example (“zzz”) above.