Skip to main content
GET
Best-converting products (windowed)

Authorizations

Authorization
string
header
required

API Key Authentication

Use your API key in the Authorization header:

Key Types:

Secret Keys (Server-Side Only):

  • Format: tybrite_sk_live_* (production) or tybrite_sk_test_* (sandbox)
  • Full read/write access to all endpoints
  • ⚠️ NEVER expose in client-side code or public repositories
  • Required for: every write a shopper does not make for themselves, authentication, payment verification, AI recommendations

Publishable Keys (Client-Safe):

  • Format: tybrite_pk_live_* (production) or tybrite_pk_test_* (sandbox)
  • Catalogue reads, plus the actions a shopper takes for themselves
  • ✅ Safe for client-side JavaScript, mobile apps, and public code
  • Allowed for: browsing products, search, CMS content, pricing queries, cart and wishlist, reviews, storefront events, and the Agent API's quotes, cart drafts and checkout intents

Endpoint-Specific Requirements:

  • Authentication endpoints (/v1/auth/*): Secret key required
  • Payment verification (POST /v1/payments/verify): Secret key required
  • AI Recommendations (POST /v1/recommendations): Secret key required
  • Semantic Search (POST /v1/search): Both key types allowed (read-only operation)
  • Shopper actions (cart, wishlist, reviews, storefront events, Agent API quotes, cart drafts and checkout intents): Both key types allowed
  • All other write operations: Secret key required
  • All read operations: Both key types allowed

Using a publishable key for restricted operations returns 403 Forbidden.

Query Parameters

window_hours
enum<integer>
default:168

The ranking window in hours. One of 168, 720. Defaults to 168.

Available options:
168,
720
limit
integer
default:12
Required range: 1 <= x <= 50

Response

Ranked best-converting products for the window.

A windowed storefront discovery list — product ids ranked by the requested signal.

metric
string

The discovery metric returned (most-viewed, most-added-to-cart, or best-converting).

Example:

"most-viewed"

window_hours
integer

The time window the ranking covers, in hours.

Example:

720

backfilled
boolean

Whether any entry in products is padding rather than a measured signal.

A store with little or no activity in the window would otherwise return an empty or one-item shelf, so the list is topped up from featured and recently-added products. Those entries are real, purchasable products and are safe to display — but they were not ranked by the requested metric, and their score is a ranking weight rather than a view count or conversion ratio.

true is common on a new store or a short window; it is not an error. Label the shelf generically ("Popular picks") or hide it, rather than presenting padding as the metric.

Example:

false

products
object[]