Recommendations

The Recommendations API identifies consumption patterns from your transaction information in order to provide recommendations. These recommendations can help your customers more easily discover items that they may be interested in.
By showing your customers products that they are more likely to be interested in, you will, in turn, increase your sales.

Upload usage event

Upload a usage event to a model. If buildId is set to "-1", the event is ingested against the Active Build of the model. Set the buildId is set to null or 0, the events are ingested against the Active build, if Active build doesn't exist, the events are not associated with any build.

Open API testing console

Request URL

Request parameters

string

Unique identifier of the model.

Request headers

(optional)
string
Media type of the body sent to the API.
string
Subscription key which provides access to this API. Found in your Cognitive Services accounts.

Request body

The usage event to upload

{
  "userId": "string",
  "buildId": 0,
  "events": [
    {
      "eventType": "Click",
      "itemId": "string",
      "timestamp": "string",
      "count": 0,
      "unitPrice": 0.0
    }
  ]
}
{
  "description": "Usage event",
  "type": "object",
  "properties": {
    "userId": {
      "description": "The id of the user that created the events",
      "type": "string"
    },
    "buildId": {
      "format": "int64",
      "description": "The build id associated with the events",
      "type": "integer"
    },
    "events": {
      "description": "The events information",
      "type": "array",
      "items": {
        "description": "Information describing a usage event",
        "type": "object",
        "properties": {
          "eventType": {
            "description": "The type of the event",
            "enum": [
              "Click",
              "RecommendationClick",
              "AddShopCart",
              "RemoveShopCart",
              "Purchase"
            ],
            "type": "string"
          },
          "itemId": {
            "description": "The id of the item in context",
            "type": "string"
          },
          "timestamp": {
            "description": "The time of the event",
            "type": "string"
          },
          "count": {
            "format": "int32",
            "description": "The number of items",
            "type": "integer"
          },
          "unitPrice": {
            "format": "float",
            "description": "The price of the item in context",
            "type": "number"
          }
        }
      }
    }
  }
}
{
  "userId": "string",
  "buildId": 0,
  "events": [
    {
      "eventType": "Click",
      "itemId": "string",
      "timestamp": "string",
      "count": 0,
      "unitPrice": 0.0
    }
  ]
}
{
  "description": "Usage event",
  "type": "object",
  "properties": {
    "userId": {
      "description": "The id of the user that created the events",
      "type": "string"
    },
    "buildId": {
      "format": "int64",
      "description": "The build id associated with the events",
      "type": "integer"
    },
    "events": {
      "description": "The events information",
      "type": "array",
      "items": {
        "description": "Information describing a usage event",
        "type": "object",
        "properties": {
          "eventType": {
            "description": "The type of the event",
            "enum": [
              "Click",
              "RecommendationClick",
              "AddShopCart",
              "RemoveShopCart",
              "Purchase"
            ],
            "type": "string"
          },
          "itemId": {
            "description": "The id of the item in context",
            "type": "string"
          },
          "timestamp": {
            "description": "The time of the event",
            "type": "string"
          },
          "count": {
            "format": "int32",
            "description": "The number of items",
            "type": "integer"
          },
          "unitPrice": {
            "format": "float",
            "description": "The price of the item in context",
            "type": "number"
          }
        }
      }
    }
  }
}
<UsageEvent>
  <userId>string</userId>
  <buildId>0</buildId>
  <events>
    <eventType>Click</eventType>
    <itemId>string</itemId>
    <timestamp>string</timestamp>
    <count>0</count>
    <unitPrice>0</unitPrice>
  </events>
</UsageEvent>
{
  "description": "Usage event",
  "type": "object",
  "properties": {
    "userId": {
      "description": "The id of the user that created the events",
      "type": "string"
    },
    "buildId": {
      "format": "int64",
      "description": "The build id associated with the events",
      "type": "integer"
    },
    "events": {
      "description": "The events information",
      "type": "array",
      "items": {
        "description": "Information describing a usage event",
        "type": "object",
        "properties": {
          "eventType": {
            "description": "The type of the event",
            "enum": [
              "Click",
              "RecommendationClick",
              "AddShopCart",
              "RemoveShopCart",
              "Purchase"
            ],
            "type": "string"
          },
          "itemId": {
            "description": "The id of the item in context",
            "type": "string"
          },
          "timestamp": {
            "description": "The time of the event",
            "type": "string"
          },
          "count": {
            "format": "int32",
            "description": "The number of items",
            "type": "integer"
          },
          "unitPrice": {
            "format": "float",
            "description": "The price of the item in context",
            "type": "number"
          }
        }
      }
    }
  }
}
<UsageEvent>
  <userId>string</userId>
  <buildId>0</buildId>
  <events>
    <eventType>Click</eventType>
    <itemId>string</itemId>
    <timestamp>string</timestamp>
    <count>0</count>
    <unitPrice>0</unitPrice>
  </events>
</UsageEvent>
{
  "description": "Usage event",
  "type": "object",
  "properties": {
    "userId": {
      "description": "The id of the user that created the events",
      "type": "string"
    },
    "buildId": {
      "format": "int64",
      "description": "The build id associated with the events",
      "type": "integer"
    },
    "events": {
      "description": "The events information",
      "type": "array",
      "items": {
        "description": "Information describing a usage event",
        "type": "object",
        "properties": {
          "eventType": {
            "description": "The type of the event",
            "enum": [
              "Click",
              "RecommendationClick",
              "AddShopCart",
              "RemoveShopCart",
              "Purchase"
            ],
            "type": "string"
          },
          "itemId": {
            "description": "The id of the item in context",
            "type": "string"
          },
          "timestamp": {
            "description": "The time of the event",
            "type": "string"
          },
          "count": {
            "format": "int32",
            "description": "The number of items",
            "type": "integer"
          },
          "unitPrice": {
            "format": "float",
            "description": "The price of the item in context",
            "type": "number"
          }
        }
      }
    }
  }
}

Response 200

Response 400

Code samples

@ECHO OFF

curl -v -X POST "https://westus.api.cognitive.microsoft.com/recommendations/v4.0/models/{modelId}/usage/events"
-H "Content-Type: application/json"
-H "Ocp-Apim-Subscription-Key: {subscription key}"

--data-ascii "{body}" 
using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;

namespace CSHttpClientSample
{
    static class Program
    {
        static void Main()
        {
            MakeRequest();
            Console.WriteLine("Hit ENTER to exit...");
            Console.ReadLine();
        }
        
        static async void MakeRequest()
        {
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);

            // Request headers
            client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");

            var uri = "https://westus.api.cognitive.microsoft.com/recommendations/v4.0/models/{modelId}/usage/events?" + queryString;

            HttpResponseMessage response;

            // Request body
            byte[] byteData = Encoding.UTF8.GetBytes("{body}");

            using (var content = new ByteArrayContent(byteData))
            {
               content.Headers.ContentType = new MediaTypeHeaderValue("< your content type, i.e. application/json >");
               response = await client.PostAsync(uri, content);
            }

        }
    }
}	
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class JavaSample 
{
    public static void main(String[] args) 
    {
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("https://westus.api.cognitive.microsoft.com/recommendations/v4.0/models/{modelId}/usage/events");


            URI uri = builder.build();
            HttpPost request = new HttpPost(uri);
            request.setHeader("Content-Type", "application/json");
            request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");


            // Request body
            StringEntity reqEntity = new StringEntity("{body}");
            request.setEntity(reqEntity);

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null) 
            {
                System.out.println(EntityUtils.toString(entity));
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }
}

<!DOCTYPE html>
<html>
<head>
    <title>JSSample</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
        };
      
        $.ajax({
            url: "https://westus.api.cognitive.microsoft.com/recommendations/v4.0/models/{modelId}/usage/events?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Content-Type","application/json");
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
            },
            type: "POST",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert("success");
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>
#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
    
    NSString* path = @"https://westus.api.cognitive.microsoft.com/recommendations/v4.0/models/{modelId}/usage/events";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"POST"];
    // Request headers
    [_request setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
    [_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

    if (nil != error)
    {
        NSLog(@"Error: %@", error);
    }
    else
    {
        NSError* error = nil;
        NSMutableDictionary* json = nil;
        NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
        NSLog(@"%@", dataString);
        
        if (nil != _connectionData)
        {
            json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
        }
        
        if (error || !json)
        {
            NSLog(@"Could not parse loaded json with error:%@", error);
        }
        
        NSLog(@"%@", json);
        _connectionData = nil;
    }
    
    [pool drain];

    return 0;
}
<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';

$request = new Http_Request2('https://westus.api.cognitive.microsoft.com/recommendations/v4.0/models/{modelId}/usage/events');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Content-Type' => 'application/json',
    'Ocp-Apim-Subscription-Key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_POST);

// Request body
$request->setBody("{body}");

try
{
    $response = $request->send();
    echo $response->getBody();
}
catch (HttpException $ex)
{
    echo $ex;
}

?>
########### Python 2.7 #############
import httplib, urllib, base64

headers = {
    # Request headers
    'Content-Type': 'application/json',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('westus.api.cognitive.microsoft.com')
    conn.request("POST", "/recommendations/v4.0/models/{modelId}/usage/events?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64

headers = {
    # Request headers
    'Content-Type': 'application/json',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
})

try:
    conn = http.client.HTTPSConnection('westus.api.cognitive.microsoft.com')
    conn.request("POST", "/recommendations/v4.0/models/{modelId}/usage/events?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################
require 'net/http'

uri = URI('https://westus.api.cognitive.microsoft.com/recommendations/v4.0/models/{modelId}/usage/events')
uri.query = URI.encode_www_form({
})

request = Net::HTTP::Post.new(uri.request_uri)
# Request headers
request['Content-Type'] = 'application/json'
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"

response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    http.request(request)
end

puts response.body