HeldSway

Analytics & Reports

Dashboard (UI)

Navigate to Sidebar → Analytics Reports in your dashboard.

Sub-section URL Description
Overview /reports Sessions, page views, conversion rate, revenue
Conversions & Funnel /reports/conversions Total conversions, revenue, commission, conversion rate
E-commerce /reports/ecommerce Product-level sales data
Coupons /reports/coupons Coupon code performance
Affiliates /reports/affiliates Per-affiliate performance metrics
Links /reports/links Click and conversion data per referral link

Date range filters: 7d, 30d, 90d, This Month, or custom.

Analytics REST API

Endpoint: GET /v1/affiliate/analytics Scope required: reports:read

curl "https://api.heldsway.com/api//v1/affiliate/analytics?section=stats&from=2024-01-01&to=2024-01-31&metrics=total_clicks,total_conversions,total_revenue" \
  -H "Authorization: Bearer <access_token>"

Query Parameters:

Parameter Type Required Default Description
section string Yes — Data section: stats, trends, charts, tables, recent_clicks, recent_conversions, recent_events
from date No 30 days ago Start date (YYYY-MM-DD)
to date No Today End date (YYYY-MM-DD)
metrics string No All Comma-separated metric names
page integer No 1 Page number
per_page integer No 15 Results per page (1–100)
top_limit integer No 10 Max rows for tables (1–50)

stats section — Aggregate Totals:

{
  "success": true,
  "data": {
    "section": "stats",
    "stats": {
      "total_clicks": 1842,
      "total_conversions": 73,
      "total_revenue": 12450.00
    }
  }
}

Available stats metrics: total_clicks, total_pageviews, unique_visitors, pages_per_visit, total_conversions, total_revenue, total_commission, conversion_rate, total_product_views, total_add_to_carts, total_remove_from_carts, total_thank_you_views, cart_to_conversion_rate

trends section — Period-over-Period Change:

{
  "data": {
    "section": "trends",
    "trends": {
      "clicks": 12.5,
      "conversions": -3.2,
      "revenue": 8.1
    }
  }
}

charts section — Time-Series & Breakdown:

{
  "data": {
    "section": "charts",
    "charts": {
      "clicks_over_time": {
        "labels": ["2024-01-01", "2024-01-02"],
        "data": [120, 145]
      },
      "device_breakdown": {
        "labels": ["desktop", "mobile", "tablet"],
        "data": [612, 389, 30]
      }
    }
  }
}

Available charts metrics: clicks_over_time, pageviews_over_time, device_breakdown, conversions_over_time, revenue_over_time, product_views_over_time, add_to_carts_over_time, country_breakdown, browser_breakdown, os_breakdown, traffic_source_breakdown

tables section — Ranked Lists: Available metrics: top_pages, top_tracking_codes, top_affiliates, top_products

Error Reference:

HTTP Code Cause
401 UNAUTHORIZED Missing or invalid token
403 FORBIDDEN Token lacks reports:read scope
422 VALIDATION_ERROR Invalid section, metrics, or date range
429 — Rate limit exceeded (120 req/min)
← CleanupConversions →