GET /{environment}/searches/lists

Description

Query cached items in a list computed for in an environment-aware setup.

Parameters

Type Name Description Schema

Path

environment
required

The environment for which a request is made.

string

Query

limit
required

The number of items to fetch.

integer

Query

list_key
required

String identifier of the previously computed list to request recommended items from.

string

Query

offset
required

The rank of the first item to be requested. Starts at counting at 1.

integer

Responses

HTTP Code Description Schema

200

OK

404

list_key not found, it either expired or never existed

No Content

Produces

  • application/json

Example HTTP response

Response 200

{
  "list_size" : 10,
  "lists" : [ {
    "grouped_by" : [ ],
    "items" : [ {
      "item_id" : "b0156c7e-2265-4d7f-8c75-e0ec31138377",
      "item_type" : "some_type",
      "title" : "some_title"
    }, {
      "item_id" : "3f3c895a-1508-4045-9ff4-97bcef2b801b",
      "item_type" : "some_type",
      "title" : "some_title"
    } ],
    "limit" : 2,
    "list_key" : "a_unique_list_identifier",
    "list_name" : "Search results 1",
    "list_size" : 5
  } ],
  "num_lists" : 1,
  "request_id" : "2141141"
}

Item

One content-item.

Name Description Schema

information_field
required

The Froomle API can be configured to return additional information fields (if present in the item information). Please contact your Froomle Solution Architect to set this up.

string

item_id
required

The identifier of the recommended item.

string

type
required

The document type of the object being returned.

string

List

A list of limit items is returned. Potentially the list consists of list_size items in total, of which the next can be queried by passing the list_key to the /lists endpoint.

Name Description Schema

grouped_by
optional

Values of group_by-keys that are common among Items in a List. Default: []

< string > array

items
optional

List of limit Items. limit is equal to the minimum of limit specified in the request and the number of recommendations found.

< Item > array

limit
optional

Number of Items returned

integer

list_key
optional

Bytestring identifier of the List

string

list_name
optional

Bytestring name of the list. Generated by Froomle.

string

list_size
optional

Total number of Items in this List (of which only limit Items are returned)

integer

SearchResults

Name Description Schema

auto_suggest
optional

New query term, if the query term was autocorrected.

string

lists
required

List of lists of items

< List > array

num_lists
required

Number of Lists requested as specified in Search. Repeated for ease of use.

integer

perfect_match
optional

A perfect match for the search query if there was one.

request_id
required

The request ID of the search request

string

user_group
optional

The group the user is assigned to. If users get the Froomle experience, this will always be "froomle".

string

version
optional

The version the user is assigned to. Used for AB testing purposes

string