DocsAPIAnalytics

Analytics

Clicks, views, buy-now clicks and attributed sales for your products, as a summary, a time series and per host. Human traffic only.

ReferenceUpdated Oct 8, 20266 min read

On this page

Retrieve click analytics
List host performance

Analytics endpoints read the same numbers as the Analytics tab in your console. Known bots and crawlers are filtered out before anything is counted, so a click here is a person. Sales come from every store and network you have connected, attributed to the host whose link or code drove them.

Both endpoints need the analytics:read scope and a plan that includes Analytics.

Retrieve click analytics#

GET/api/brand/v1/analytics/clicks

Clicks, views and sales for your products in one call: a summary, a time series, and your top hosts and products. Human traffic only; known bots are filtered out before anything is counted.

Scopeanalytics:readPlanAnalytics

Parameters

start_datedateoptional
Only activity on or after this ISO 8601 date (YYYY-MM-DD) or timestamp, UTC.
end_datedateoptional
Only activity on or before this ISO 8601 date or timestamp, UTC.
group_byenumoptionaldefault day
The bucket size of timeseries.
dayweekmonth
host_idstringoptional
Limit everything to one host (UUID).
limitintegeroptionaldefault 20
How many rows top_hosts and top_products return, between 1 and 100.

Returns

A summary for the range, a time series, and top-N hosts and products.

summaryobject
Totals for the whole range.
- total_clicksinteger
  Every tracked click on your products.
- product_clicksinteger
  Clicks on a product card.
- product_viewsinteger
  Product page views.
- buy_now_clicksinteger
  Clicks through to your store.
- unique_buy_now_clicksinteger
  Buy-now clicks, one per session.
- profile_viewsinteger
  Views of host profiles that feature you.
- list_viewsinteger
  Views of gear lists that feature you.
- opportunity_clicksinteger
  Clicks on your campaign links.
- unique_sessionsinteger
  Distinct browsing sessions.
- unique_usersinteger
  Distinct signed-in shoppers.
- ordersinteger
  Attributed orders, across every connected store and network.
- revenuenumber
  Order totals, in your store currency.
- subtotal_revenuenumber
  Order subtotals before tax and shipping.
- conversion_ratenumber
  Tracked orders divided by buy-now clicks, as a ratio between 0 and 1.
- manual_ordersinteger
  Orders your team attributed by hand.
timeseriesarray of objects
One point per group_by bucket.
- datedate
  The start of the bucket.
- total_clicksinteger
  As in summary.
- product_clicksinteger
  As in summary.
- buy_now_clicksinteger
  As in summary.
- unique_buy_now_clicksinteger
  As in summary.
- profile_viewsinteger
  As in summary.
- list_viewsinteger
  As in summary.
- unique_sessionsinteger
  As in summary.
- ordersinteger
  As in summary.
- revenuenumber
  As in summary.
- subtotal_revenuenumber
  As in summary.
- conversion_ratenumber
  As in summary.
top_hostsarray of objects
Hosts ranked by clicks.
- hostobjectnullable
  The host’s public identity.
  - idstring
    The host’s Rendezvu user id (UUID).
  - usernamestringnullable
    The host’s handle, as in rendezvu.co/username.
  - first_namestringnullable
    First name.
  - last_namestringnullable
    Last name.
  - profile_photostringnullable
    URL of the host’s profile photo.
- total_clicksinteger
  As in summary.
- product_clicksinteger
  As in summary.
- buy_now_clicksinteger
  As in summary.
- unique_buy_now_clicksinteger
  As in summary.
- unique_sessionsinteger
  As in summary.
- ordersinteger
  As in summary.
- revenuenumber
  As in summary.
- subtotal_revenuenumber
  As in summary.
- conversion_ratenumber
  As in summary.
top_productsarray of objects
Products ranked by clicks.
- product_idstring
  The Rendezvu product id.
- titlestring
  Product title.
- brand_namestring
  The brand on the product.
- total_clicksinteger
  As in summary.
- product_clicksinteger
  As in summary.
- buy_now_clicksinteger
  As in summary.
- unique_buy_now_clicksinteger
  As in summary.

curl 'https://api.rendezvu.co/api/brand/v1/analytics/clicks?start_date=2026-09-01&end_date=2026-09-30&group_by=week&limit=5' \
  -H "Authorization: Bearer $RENDEZVU_BRAND_API_KEY"

Response

{
  "success": true,
  "data": {
    "summary": {
      "total_clicks": 4210,
      "product_clicks": 2984,
      "product_views": 1870,
      "buy_now_clicks": 1126,
      "unique_buy_now_clicks": 948,
      "profile_views": 3120,
      "list_views": 2455,
      "opportunity_clicks": 312,
      "unique_sessions": 2701,
      "unique_users": 418,
      "orders": 61,
      "revenue": 9843.5,
      "subtotal_revenue": 8910,
      "conversion_rate": 0.0542,
      "manual_orders": 3
    },
    "timeseries": [
      {
        "date": "2026-09-01",
        "total_clicks": 988,
        "product_clicks": 702,
        "buy_now_clicks": 260,
        "unique_buy_now_clicks": 221,
        "profile_views": 740,
        "list_views": 588,
        "unique_sessions": 640,
        "orders": 14,
        "revenue": 2210,
        "subtotal_revenue": 1998,
        "conversion_rate": 0.0538
      }
    ],
    "top_hosts": [
      {
        "host": {
          "id": "6f1c2a9e-3b4d-4e1f-9a8b-2c7d5e6f7a81",
          "username": "jordanalpine",
          "first_name": "Jordan",
          "last_name": "Reyes",
          "profile_photo": "https://media.rendezvu.co/6f1c2a9e_profile.jpg"
        },
        "total_clicks": 1204,
        "product_clicks": 866,
        "buy_now_clicks": 341,
        "unique_buy_now_clicks": 290,
        "unique_sessions": 802,
        "orders": 22,
        "revenue": 3480,
        "subtotal_revenue": 3150,
        "conversion_rate": 0.0645
      }
    ],
    "top_products": [
      {
        "product_id": "5c6d7e8f-9a0b-4c1d-8e2f-3a4b5c6d7e8f",
        "title": "Ridgeline 30L Pack",
        "brand_name": "Northfork Gear Co.",
        "total_clicks": 640,
        "product_clicks": 455,
        "buy_now_clicks": 172,
        "unique_buy_now_clicks": 150
      }
    ]
  },
  "_timing": {
    "duration_ms": 42
  }
}

List host performance#

GET/api/brand/v1/analytics/hosts

Clicks and sales per host, all time. Use it to rank your roster by what each host actually sells.

Scopeanalytics:readPlanAnalyticsListpaginated

Parameters

pageintegeroptionaldefault 1
The page to return, starting at 1. At most 10,000.
per_pageintegeroptionaldefault 25
Items per page, between 1 and 100.
sortenumoptionaldefault sale_amount
What to rank by. actions is orders.
clicksbuy_now_clicksactionssale_amount
orderenumoptionaldefault desc
Sort direction.
ascdesc

Returns

A page of hosts with their totals. data is an array of objects with these attributes, and the body carries pagination.

hostobjectnullable
The host. id can be null for a sale attributed to a username that no longer exists.
- idstring
  The host’s Rendezvu user id (UUID).
- usernamestringnullable
  The host’s handle, as in rendezvu.co/username.
- first_namestringnullable
  First name.
- last_namestringnullable
  Last name.
- profile_photostringnullable
  URL of the host’s profile photo.
clicksinteger
Clicks on your products from this host.
buy_now_clicksinteger
Clicks through to your store.
ordersinteger
Attributed orders.
salesnumber
Attributed sales, in your store currency.

curl 'https://api.rendezvu.co/api/brand/v1/analytics/hosts?sort=sale_amount&per_page=2' \
  -H "Authorization: Bearer $RENDEZVU_BRAND_API_KEY"

Response

{
  "success": true,
  "data": [
    {
      "host": {
        "id": "6f1c2a9e-3b4d-4e1f-9a8b-2c7d5e6f7a81",
        "username": "jordanalpine",
        "first_name": "Jordan",
        "last_name": "Reyes",
        "profile_photo": "https://media.rendezvu.co/6f1c2a9e_profile.jpg"
      },
      "clicks": 5120,
      "buy_now_clicks": 1488,
      "orders": 96,
      "sales": 15412
    },
    {
      "host": {
        "id": "b2e4d6f8-1a3c-4e5f-8b7d-9c0e1f2a3b4c",
        "username": "sam.on.granite",
        "first_name": "Sam",
        "last_name": "Okafor",
        "profile_photo": null
      },
      "clicks": 2210,
      "buy_now_clicks": 610,
      "orders": 41,
      "sales": 6390.5
    }
  ],
  "pagination": {
    "page": 1,
    "per_page": 2,
    "total_items": 37,
    "total_pages": 19,
    "has_next": true,
    "has_prev": false
  },
  "_timing": {
    "duration_ms": 42
  }
}

OrdersEvery order Rendezvu attributed to one of your hosts, across your store and every connected network, with the host's commission on each.
RosterThe hosts you actively work with, with their public profile, commission rate and how many of your campaigns each one has joined.

Was this page helpful?