Skip to content

Pages analytics

See how Hello Retail Pages perform: site-wide totals, the best and worst performing pages, and a per-URL breakdown. Only LIVE pages produce analytics; drafts serve nothing.

All metrics share one shape: views, unique views, clicks, conversions, and revenue, plus the derived click-through rate (clicks/views), conversion rate (conversions/unique views), and average order size (revenue/conversions). Supply a comparison period to populate the change percentages for unique views and revenue.

Tips & tricks

Start with the overview, then rank the pages behind the numbers.

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

Sort ascending to find underperformers worth improving or retiring.

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

One page config can serve many URLs (an INPUT product filter renders a different product selection per URL). The URL breakdown shows which URLs carry a page's traffic.

Break down page <KEY> by URL and tell me which categories drive its conversions.

Combine with the Pages tools: find a weak page, inspect its product filters and boosts with pages_getConfigProductFilters and pages_getConfigProductBoosts, and draft an improvement with the update tools.

Find my worst-converting page, show its product filters and boosts, and suggest changes.

pages_getAnalyticsOverview

Get the overall Pages performance overview for a customer website using Hello Retail: site-wide totals across all of the website's pages. Numbers mirror the Pages Analytics overview cards exactly. Optionally compare against an earlier period to get change percentages.

Name Type Required Description
websiteUuid string Yes The UUID of the customer's website in Hello Retail. Use website_getInfo to look up available websites, or find it in my.helloretail.com under Settings → Website Settings → Website Unique Id.
startDate string No Start of the window, inclusive, ISO YYYY-MM-DD. Defaults to 30 days before endDate.
endDate string No End of the window, inclusive, ISO YYYY-MM-DD. Defaults to today.
comparisonStartDate string No Comparison-period start, inclusive, ISO YYYY-MM-DD. Supply with comparisonEndDate to get change percentages.
comparisonEndDate string No Comparison-period end, inclusive, ISO YYYY-MM-DD. Supply with comparisonStartDate to get change percentages.
Example request & response 
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "pages_getAnalyticsOverview",
    "arguments": {
      "websiteUuid": "<string>"
    }
  }
}

{
  "totals": {
    "views": 0,
    "uniqueViews": 0,
    "clicks": 0,
    "conversions": 0,
    "revenue": 0.0,
    "clickThroughRate": 0.0,
    "conversionRate": 0.0,
    "averageOrderSize": 0.0,
    "uniqueViewsChangePercent": null,
    "revenueChangePercent": null
  }
}

pages_getTopPages

Rank the pages of a customer website using Hello Retail by a performance metric: per page config, the same totals its analytics detail view shows. Use it to find the best and worst performing pages; sort descending (default) for the top, ascending for the bottom. Each row carries the page config key (use with pages_getConfig or pages_updateConfig) and the page config's name, null when the page config no longer exists.

Name Type Required Description
websiteUuid string Yes The UUID of the customer's website in Hello Retail. Use website_getInfo to look up available websites, or find it in my.helloretail.com under Settings → Website Settings → Website Unique Id.
startDate string No Start of the window, inclusive, ISO YYYY-MM-DD. Defaults to 30 days before endDate.
endDate string No End of the window, inclusive, ISO YYYY-MM-DD. Defaults to today.
comparisonStartDate string No Comparison-period start, inclusive, ISO YYYY-MM-DD. Supply with comparisonEndDate to get change percentages.
comparisonEndDate string No Comparison-period end, inclusive, ISO YYYY-MM-DD. Supply with comparisonStartDate to get change percentages.
sortBy string No Metric to rank by: VIEWS, UNIQUE_VIEWS (default), CLICKS, CONVERSIONS, REVENUE, CTR, CONVERSION_RATE, or AVERAGE_ORDER_SIZE.
ascending boolean No Sort ascending to get the worst performers first. Defaults to false (best first).
limit integer No Maximum number of pages to return. Default 20, capped at 100.
Example request & response 
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "pages_getTopPages",
    "arguments": {
      "websiteUuid": "<string>",
      "sortBy": "REVENUE"
    }
  }
}

{
  "results": [
    {
      "configKey": "<string>",
      "name": "<string>",
      "metrics": {
        "views": 0,
        "uniqueViews": 0,
        "clicks": 0,
        "conversions": 0,
        "revenue": 0.0,
        "clickThroughRate": 0.0,
        "conversionRate": 0.0,
        "averageOrderSize": 0.0,
        "uniqueViewsChangePercent": null,
        "revenueChangePercent": null
      }
    }
  ]
}

pages_getUrlBreakdown

Break Pages performance down per URL for a customer website using Hello Retail. One page config can serve many URLs, and this shows each URL's metrics: the same rows as the Pages Analytics URL table. Optionally scope to one page config with configKey, and sort descending (default) for the top URLs or ascending for the bottom.

Name Type Required Description
websiteUuid string Yes The UUID of the customer's website in Hello Retail. Use website_getInfo to look up available websites, or find it in my.helloretail.com under Settings → Website Settings → Website Unique Id.
configKey string No Key of a page config to scope to. Use pages_listConfigs to find available keys. Omit for all pages.
startDate string No Start of the window, inclusive, ISO YYYY-MM-DD. Defaults to 30 days before endDate.
endDate string No End of the window, inclusive, ISO YYYY-MM-DD. Defaults to today.
comparisonStartDate string No Comparison-period start, inclusive, ISO YYYY-MM-DD. Supply with comparisonEndDate to get change percentages.
comparisonEndDate string No Comparison-period end, inclusive, ISO YYYY-MM-DD. Supply with comparisonStartDate to get change percentages.
sortBy string No Metric to rank by: VIEWS, UNIQUE_VIEWS (default), CLICKS, CONVERSIONS, REVENUE, CTR, CONVERSION_RATE, or AVERAGE_ORDER_SIZE.
ascending boolean No Sort ascending to get the worst performers first. Defaults to false (best first).
limit integer No Maximum number of URLs to return. Default 20, capped at 100.
Example request & response 
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "pages_getUrlBreakdown",
    "arguments": {
      "websiteUuid": "<string>",
      "configKey": "<string>"
    }
  }
}

{
  "results": [
    {
      "configKey": "<string>",
      "url": "<string>",
      "metrics": {
        "views": 0,
        "uniqueViews": 0,
        "clicks": 0,
        "conversions": 0,
        "revenue": 0.0,
        "clickThroughRate": 0.0,
        "conversionRate": 0.0,
        "averageOrderSize": 0.0,
        "uniqueViewsChangePercent": null,
        "revenueChangePercent": null
      }
    }
  ]
}