Pages

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Next »

Learn how to make Recommendations API requests to retrieve recommendation data generated from recommendation configurations:

See also Recommendations API: Responses (configurations).

If you want to retrieve recommendation data generated from recommendation strategies, see Recommendations API: Requests (strategies).

URL

The URL for Recommendations API requests is https://<platform_instance>/recoApi/v2, where <platform_instance> is the domain name of your Frosmo Platform instance.

To get the URL for your Frosmo Platform instance:

  1. In the Frosmo Control Panel, select Utilities > Frosmo APIs.
  2. In the Recommendations API section, copy the URL.

    URL for Recommendations API requests

Authentication

The Recommendations API does not require authentication.

Methods

The Recommendations API supports the following HTTP methods for recommendation configurations:

  • GET
  • POST

The only difference between the two is that with GET you provide the recommendation details in the request URL, while with POST you provide the details in the request body. If you're retrieving data for a recommendation configuration with a GET request, and the request URL exceeds the maximum URL length, use a POST request instead.

Syntax

GET

To retrieve recommendation data for a recommendation configuration using the GET method, make the following request:

Recommendation configuration
GET https://<platform_instance>/recoApi/v2?method=multifetch&
    origin=<site_origin>&
    recos=[{
      "name": "<recommendation_configuration_name>",
      "params": {
        "<parameter_1_name>": "<parameter_1_value>",
        "<parameter_n_name>": "<parameter_n_value>"
      }
    }]

POST

To retrieve recommendation data for a recommendation configuration using the POST method, make the following request:

Recommendation configuration
POST https://<platform_instance>/recoApi/v2?method=multifetch&
     origin=<site_origin>

# REQUEST BODY

[{
  "name": "<recommendation_configuration_name>",
  "params": {
    "<parameter_1_name>": "<parameter_1_value>",
    "<parameter_n_name>": "<parameter_n_value>"
  }
}]

Parameters

Table: Query parameters for Recommendations API requests

ParameterDescriptionTypeRoleExample
method

Request type.

Use the value multifetch.

StringRequired
method=multifetch
origin

Site origin.

To find out your site's origin, see Getting your site origin.

StringRequired
origin=shop_company_com
recos

Information about what recommendation data to retrieve and, if appropriate, how to filter the returned data with parameters defined in the recommendation configuration.

You can retrieve the data for one or more recommendation configurations. You specify each configuration in its own recommendation configuration settings object using the JSON format.

The array must not be empty ([]).

If you want to guarantee a fast response, limit the number of recommendations to four. You can retrieve the data for five or more recommendations in the same request, if you want, but the platform may then take longer to respond.

The recos query parameter is only required for GET requests. POST requests pass the array of recommendation configuration settings objects in the request body. The rules for the objects nonetheless apply to both GET and POST requests.

Array of recommendation configuration settings objectsRequired (GET)

Retrieve the data for one recommendation configuration:

recos=[{
  "name": "Most viewed products",
  "params": {
    "type": "Books"
  }
}]

Retrieve the data for two recommendation configurations:

recos=[{
  "name": "Most viewed products",
  "params": {
    "type": "Books"
  }
},{
  "name": "Products viewed together",
  "params": {
    "id": "123"
  }
}]
debug

Define whether to return debugging information about the recommendation data.

The debugging information for a recommendation consists of:

The possible values are:

  • false: Do not return debugging information.
  • true: Return debugging information.

The default value is false.

BooleanOptional
debug=true

Recommendation configuration settings object

The following table describes the recommendation configuration settings object of the recos array. The object defines what recommendation data to retrieve and, if appropriate, how to filter the returned data.

Table: Recommendation configuration settings object properties

PropertyDescriptionTypeRoleExample
nameRecommendation configuration name.StringRequired
"name": "Most viewed products"
params

Request parameters defined in the recommendation configuration. Use the parameters to filter which recommended items to return.

You can only include parameters defined in the recommendation configuration:

  • If you want to filter the results by a given parameter, assign the parameter an exact field or segment value (case insensitive).
  • If you do not want to filter the results by a given parameter, either omit the parameter or set the parameter value to an empty string ("").

If the recommendation type is bundle_viewed, bundle_converted, or bundle_viewed_converted, only include a single parameter: the target field against which the recommendation is generated, as defined in the recommendation configuration. For example, if you're recommending products purchased together with a product the visitor just added to their shopping cart, include the product ID parameter with a valid product ID as its value, since the recommendation is based on a specific product. Do not include any other parameters.

If the recommendation type is most_viewed or most_converted, include zero or more of the parameters defined in the recommendation configuration. The order of the parameters does not matter in the request. In addition, if you're filtering by segment, you can only define one segment per request.

If you do not want to use any parameters to filter the recommendation results, omit this property from the request.

ObjectOptional

For a bundle recommendation whose configuration defines the id parameter:

"params": {
  "id": "123"
}   

For a most recommendation whose configuration defines the type parameter:

"params": {
  "type": "Books"
}

For a most recommendation whose configuration defines the type and language parameters:

# Filter by type and language.

"params": {
  "type": "Books",
  "language": "English"
}

# Filter by type only.

"params": {
  "type": "Books",
  "language": ""
}

# Filter by neither, return all results.

"params": {
  "type": "",
  "language": ""
}

# Omitting "params" from the request yields the same result as the empty values above.
params.<parameter_name>

Request parameter defined in the recommendation configuration. Use the parameter to filter which recommended items to return.

You can define either a single string or an array of strings as the parameter value. In the latter case, the recommendation results are filtered separately by each string value.

If the parameter corresponds to a source data field that has a Boolean or number value, such as product price, define the parameter value nonetheless as a string. For example, define the Boolean true as the string "true", and define the number 1 as the string "1".

If you do not want to filter the results by the parameter, set the parameter value to an empty string ("").

String | Array of stringsRequired

Filter for Books English:

"params": {
  "type": "Books",
  "language": "English"
}

Filter for Books English and Books Finnish:

"params": {
  "type": "Books",
  "language": [
    "English",
    "Finnish"
  ]
}

Filter for Books English, Books Finnish, Magazines English, and Magazines Finnish:

"params": {
  "type": [
    "Books",
    "Magazines"
  ],
  "language": [
    "English",
    "Finnish"
  ]
}

Filter by originally boolean and numeric values:

"params": {
  "isAvailable": "true",
  "price": "99.99"
}

No filtering:

"params": {
  "type": "",
  "language": ""
}
excludeIds

This property is only valid for product recommendations.

IDs of the products to exclude from the recommendation data.

Array of stringsOptional

Exclude products 123, 456, and 789 from the recommendation data:

"excludeIds": [
  "123",
  "456",
  "789"
]
limit

Maximum number of recommended items to return.

By default, the platform uses the limit value defined in the recommendation configuration. If you want to set a different maximum for a request, define a limit in the request.

The minimum value is 1. The maximum value is 120.

NumberOptional
"limit": 5
mapping

Logic for mapping the IDs of the recommended items to source data in the Frosmo back end. This determines what data the recommendation actually returns for each item.

By default, the platform uses the map_ids value defined in the recommendation configuration. If you want to set a different mapping for a request, define a map_ids in the request.

The possible values are:

  • datapoint: Do not map the item IDs to anything. Return the raw recommendation data (ID and recommendation weight) for each item.
  • product: Map each item ID to a product ID. Return the full product data for each ID.
StringOptional
"mapping": ""

Examples

Example: Single recommendation with filtering (GET)
GET https://inpref.com/recoApi/v2?method=multifetch&
    origin=shop_company_com&
    recos=[{
      "name": "Most viewed products",
      "params": {
        "type": "Books"
      }
    }]
Example: Single recommendation with filtering (POST)
POST https://inpref.com/recoApi/v2?method=multifetch&
     origin=shop_company_com

# REQUEST BODY

[{
  "name": "Most viewed products",
  "params": {
    "type": "Books"
  }
}]
Example: Single recommendation with filtering and selected results excluded (GET)
GET https://inpref.com/recoApi/v2?method=multifetch&
    origin=shop_company_com&
    recos=[{
      "name": "Most viewed products",
      "params": {
        "type": "Books"
      },
      "excludeIds": [
        "123",
        "456",
        "789"
      ]
    }]
Example: Single recommendation without filtering (GET)
GET https://inpref.com/recoApi/v2?method=multifetch&
    origin=shop_company_com&
    recos=[{
      "name": "Most viewed products"
    }]
Example: Multiple recommendations with filtering (GET)
GET https://inpref.com/recoApi/v2?method=multifetch&
    origin=shop_company_com&
    recos=[{
      "name": "Most viewed products",
      "params": {
        "type": "Books"
      }
    },{
      "name": "Most bought products",
      "params": {
        "type": "Books"
      }
    }]