Recommendations analytics¶

See how your Recommendations boxes perform: site-wide totals, the best and worst performing boxes, one box's totals, and its day-by-day series. Only LIVE boxes produce analytics; drafts serve nothing.

All metrics share one shape: views, clicks, conversions, and revenue, plus the derived click-through rate (clicks/views), conversion rate (conversions/clicks), and average order size (revenue/conversions).

Every tool takes a recomType. MANAGED (the default) covers boxes configured in Hello Retail. UNMANAGED covers recommendations you fetch through the API and render yourself, tracked under a key you supply; those rows carry the tracking key only, with no box name or type.

Tips & tricks¶

Pick the card that matches what you're doing. Each prompt is ready to paste into your assistant.

Show my website's Recommendations performance for the last 30 days, then list the top 10 boxes by revenue.

Which of my Recommendations boxes have the lowest click-through rate this month? Suggest what to change on the worst three.

Show the daily clicks and revenue for Recommendations box <KEY> over the last 90 days and point out any drop.

Find my worst-converting Recommendations box, show its design and placement, and suggest changes.

Show the analytics for the recommendations I render myself through the API, grouped by tracking key, for the last 30 days.

recoms_getAnalyticsTotals¶

Get the site-wide Recommendations totals for a customer website using Hello Retail: views, clicks, conversions, revenue and the derived click-through rate, conversion rate and average order size, summed over every box of the chosen type. Numbers mirror the Recommendations Analytics page.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "recoms_getAnalyticsTotals",
    "arguments": {
      "websiteUuid": "<string>"
    }
  }
}

{
  "recomType": "MANAGED",
  "totals": {
    "views": 0,
    "clicks": 0,
    "conversions": 0,
    "revenue": 0.0,
    "clickThroughRate": 0.0,
    "conversionRate": 0.0,
    "averageOrderSize": 0.0
  }
}

recoms_getAnalyticsGrouped¶

Rank the Recommendations boxes of a customer website using Hello Retail by a performance metric: per box, the same metrics as the totals, as on the Recommendations Analytics page. Sort descending (default) for the best performers, ascending for the worst. Each row carries the box key (use with recoms_getAnalyticsForKey, recoms_getAnalyticsDailyForKey or recoms_listBoxes) and, for MANAGED boxes, the box name and type. Boxes deleted since the traffic was recorded are left out. UNMANAGED rows carry the tracking key only.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "recoms_getAnalyticsGrouped",
    "arguments": {
      "websiteUuid": "<string>",
      "sortBy": "REVENUE"
    }
  }
}

{
  "recomType": "MANAGED",
  "results": [
    {
      "key": "<string>",
      "name": "<string>",
      "type": "<string>",
      "metrics": {
        "views": 0,
        "clicks": 0,
        "conversions": 0,
        "revenue": 0.0,
        "clickThroughRate": 0.0,
        "conversionRate": 0.0,
        "averageOrderSize": 0.0
      }
    }
  ]
}

recoms_getAnalyticsForKey¶

Get one Recommendations box's totals for a customer website using Hello Retail: views, clicks, conversions, revenue and the derived click-through rate, conversion rate and average order size over the window, as on the box's analytics detail page. For MANAGED the key must be an existing box. Use recoms_getAnalyticsDailyForKey for the day-by-day series.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "recoms_getAnalyticsForKey",
    "arguments": {
      "websiteUuid": "<string>",
      "key": "<string>"
    }
  }
}

{
  "key": "<string>",
  "recomType": "MANAGED",
  "name": "<string>",
  "type": "<string>",
  "totals": {
    "views": 0,
    "clicks": 0,
    "conversions": 0,
    "revenue": 0.0,
    "clickThroughRate": 0.0,
    "conversionRate": 0.0,
    "averageOrderSize": 0.0
  }
}

recoms_getAnalyticsDailyForKey¶

Get one Recommendations box's day-by-day series for a customer website using Hello Retail: per day, views, clicks, conversions, revenue and the derived rates, oldest first, with one row for every day in the window (days without traffic read 0). Same data as the performance graph on the box's analytics detail page. For MANAGED the key must be an existing box.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "recoms_getAnalyticsDailyForKey",
    "arguments": {
      "websiteUuid": "<string>",
      "key": "<string>",
      "startDate": "<YYYY-MM-DD>",
      "endDate": "<YYYY-MM-DD>"
    }
  }
}

{
  "key": "<string>",
  "recomType": "MANAGED",
  "days": [
    {
      "date": "<YYYY-MM-DD>",
      "metrics": {
        "views": 0,
        "clicks": 0,
        "conversions": 0,
        "revenue": 0.0,
        "clickThroughRate": 0.0,
        "conversionRate": 0.0,
        "averageOrderSize": 0.0
      }
    }
  ]
}