Skip to main content

API: FAQs (Internal)

Frequently Asked Questions

Are there any limits or restrictions around the length or characters for sessionIDs?

There is no such limit on the session IDs. However, there is an upper limit on the number of characters (or bytes) for a request.

For shoppers that aren't logged into a site, can RR make use of the cookie information to show recs?

Yes. As long as we receive browser cookies or pass through cookies (in the case of a server side integration).

How do I override a client API key?

  1. Navigate to the Admin section of Portal and select API Client Keys.
  2. Click +new.
  3. Add a name and select enter API key. All values/symbols are acceptable.
  4. This name will show in Site Analytics reporting, under Channel.

api key.png

What information is collected under a Mobile API implementation?

The API collects the same thing that is collected on site:

  • Views
  • Clicks
  • Carts
  • Purchases (items, prices, quantities)
  • Search Terms

Also with any request, we track:

  • session ID
  • user ID
  • request time

What's the limitation regarding the number of characters and/or products in the case of a purchase complete action?

The recsForPlacement API uses the HTTP's GET method. There's no limit on number of products or number of characters each product ID can have. We only allow one order ID to be passed for a purchase complete action. And, since it's HTTP GET, browser imposed URL length will be the deciding factor.

If a view or purchase is recorded for a user ID through an API request, how long does it take that user ID to get harvested into a user model and published back to the runtimes before it is available for personalized recs?

12-24 hours.

How much time does it take {rr} to remove an item marked as do not use from recommendations?

It is immediate.

Does our system understand a recsUsingStrategy request with a seed product ID as a view of the item?

Scenario: Say I indicate ClickCP using item ID 123 as a seed in recsUsingStrategy.

Will that API request add to the view count of item 123 for the purposes of rec models? Will that API request add item 123 to my user behavior model as a recent view?

Short answer: No. recsUsingStrategy logs a view event, but currently it does not include seed product and other information about the context in the log.

For a guest who is not logged in, would RR be able to make use of the cookie information to show recommendations?

Yes. As far as we receive browser cookies or pass through cookies (in the case of server side integration), the API can make use of them.

  • Was this article helpful?