Fetching Recommendations with the Delivery API

First, create and save a JSON-based design to use in your recommendation. For sample JSON, plus background information regarding how JSON responses can be returned when configuring a form-based activity, see the documentation on Creating Recommendation Designs. In this example, the design is named Simple JSON.

In Target, navigate to Activities > Create Activity > Recommendations, then select Form.

Select a Property, and click Next.

Define the location where you would like users to receive the recommendation’s response. The example below uses a location named api_charter. Select your JSON-based design, created earlier, named Simple JSON.

Save and activate the recommendation. It will generate results. Once the results are ready, you can use the Delivery API to retrieve them.

Note the client code is required. As a reminder, your client code may be found in Adobe Target by navigating to Recommendations > Settings. Note the Client Code value in the Recommendation API Token section.

Once you have your client code, construct your Delivery API call. The example below begins with the Web Batched Mboxes Delivery API Call provided in the Delivery API Postman collection, making relevant modifications. For example:

• the browser and address objects were removed from the Body, since they are not required for non-HTML use cases
• api_charter is listed as the location name in this example
• the entity.id is specified, since this recommendation is based on Content Similarity, which requires a current item key to be passed to Target.
  
  Remember to configure your query parameters correctly. For example, be sure to specify {{CLIENT_CODE}} as necessary. <!— Q: In the updated call syntax, entity.id is listed as a profileParameter instead of an mboxParameter as in older versions. —> <!— Q: Old image Old accompanying text: “Note this recommendation is based on Content Similar products based on the entity.id sent via mboxParameters.” —>
  

Send the request. This executes against the api_charter location, which has an active recommendation running on it, defined with your JSON design which will output a list of recommended entities.

Receive a response based on the JSON design.

The response includes the key ID, as well as the entity IDs of the recommended entities.