Analytics

Use the analytics resource to fetch overview metrics, conversation trends, genie performance breakdowns, and period-over-period comparisons. Supported actions: all, overview, trends, genie-performance, page-views, page-view-totals, page-view-unused-analysis, compare.

Overview

Returns account-level aggregate counts for genies, conversations, leads, and knowledge base documents. all and overview are equivalent.

string

required

Must be "analytics".

string

required

"all" or "overview".

object

Show properties

boolean

Admin only. View analytics across all users.

string

Admin only. Scope analytics to a specific user.

Response

boolean

object

Show properties

object

Show properties

number

Total number of genies.

number

Total number of conversations.

number

Total number of leads.

number

Total number of knowledge base documents.

{
  "resource": "analytics",
  "action": "overview"
}

{
  "success": true,
  "data": {
    "stats": {
      "genies": 4,
      "conversations": 312,
      "leads": 58,
      "knowledgeBaseDocuments": 19
    }
  }
}

Trends

Returns daily conversation trend data points over a time period.

string

required

Must be "analytics".

string

required

Must be "trends".

object

Show properties

string

Time period. One of "7d", "30d", "90d". Default: "30d".

boolean

Admin only.

string

Admin only.

curl -X POST https://api.helpgenie.ai/v1/analytics \
  -H "Authorization: Bearer hg_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "action": "trends", "data": { "period": "30d" } }'

Genie performance

Returns conversation volume grouped by genie, filtered by time period. Supports custom date ranges.

string

required

Must be "analytics".

string

required

Must be "genie-performance".

object

Show properties

string

Time period. One of "7d", "30d", "90d". Default: "30d".

string

ISO 8601 start timestamp for custom date range.

string

ISO 8601 end timestamp for custom date range.

boolean

Admin only.

string

Admin only.

curl -X POST https://api.helpgenie.ai/v1/analytics \
  -H "Authorization: Bearer hg_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "action": "genie-performance",
    "data": { "period": "30d" }
  }'

Page views

Admin only. Requests from non-admin accounts return 403 Forbidden.

Returns per-path, per-day page view counts for the platform’s own pages over a time period. Rows are ordered newest day first, then by view count descending.

string

required

Must be "analytics".

string

required

Must be "page-views".

object

Show properties

string

Time period. One of "7d", "30d", "90d". Default: "30d".

string

ISO 8601 start timestamp for a custom date range. Must be paired with to.

string

ISO 8601 end timestamp for a custom date range. Must be paired with from.

string

Case-insensitive substring filter on the page path.

number

Rows per page. Maximum 200. Default: 50.

number

Pagination offset. Default: 0.

Response

boolean

object

Show properties

string

The period that was applied, or "custom" when from and to were supplied.

string

Start of the analysed range, as a YYYY-MM-DD date.

string

End of the analysed range, as a YYYY-MM-DD date.

object[]

Show item properties

string

The page path.

string

The day the views were recorded (YYYY-MM-DD).

number

Views recorded for that path on that day.

number

Total number of matching rows, ignoring pagination.

number

const response = await ApiService.invoke({
  resource: "analytics",
  action: "page-views",
  data: {
    period: "30d",
    search: "/genie",
    limit: 50,
  },
});

curl -X POST https://api.helpgenie.ai/v1/analytics \
  -H "Authorization: Bearer hg_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "action": "page-views",
    "data": { "period": "30d", "search": "/genie", "limit": 50 }
  }'

{
  "success": true,
  "data": {
    "period": "30d",
    "from": "2026-08-25",
    "to": "2026-09-24",
    "items": [
      { "path": "/genies", "visit_date": "2026-09-24", "view_count": 184 },
      { "path": "/genie/studio", "visit_date": "2026-09-24", "view_count": 61 }
    ],
    "count": 412,
    "limit": 50,
    "offset": 0
  }
}

Page view totals

Admin only. Requests from non-admin accounts return 403 Forbidden.

Returns view counts aggregated per page path across the whole period — the daily rows from page-views collapsed into one total per path, sorted most-viewed first. Not paginated.

string

required

Must be "analytics".

string

required

Must be "page-view-totals".

object

Show properties

string

Time period. One of "7d", "30d", "90d". Default: "30d".

string

ISO 8601 start timestamp for a custom date range. Must be paired with to.

string

ISO 8601 end timestamp for a custom date range. Must be paired with from.

string

Case-insensitive substring filter on the page path.

Response

boolean

object

Show properties

string

The period that was applied, or "custom" when from and to were supplied.

string

Start of the analysed range, as a YYYY-MM-DD date.

string

End of the analysed range, as a YYYY-MM-DD date.

object[]

Show item properties

string

The page path.

number

Total views for that path across the period.

const response = await ApiService.invoke({
  resource: "analytics",
  action: "page-view-totals",
  data: { period: "90d" },
});

curl -X POST https://api.helpgenie.ai/v1/analytics \
  -H "Authorization: Bearer hg_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "action": "page-view-totals", "data": { "period": "90d" } }'

{
  "success": true,
  "data": {
    "period": "90d",
    "from": "2026-06-26",
    "to": "2026-09-24",
    "items": [
      { "path": "/genies", "view_count": 5218 },
      { "path": "/knowledge-base", "view_count": 1904 }
    ]
  }
}

Unused page analysis

Admin only. Requests from non-admin accounts return 403 Forbidden.

Matches recorded page-view URLs to the route patterns in a supplied route manifest, aggregates traffic per route, and returns a Smart review of which feature and public pages look safe to retire. Concrete URLs are rolled up into their route pattern (so a dynamic route such as /genie-hub/my-genies/:genieId counts every URL it serves), and each route is compared with the same-length prior period. Only routes of kind feature and public are judged. Per-genie, system, redirect, and internal routes are set aside and returned under excluded with their numbers. Confidence is capped when tracking coverage is short (never high with under 14 days of coverage), and every number in the response comes from the server-side aggregation, not from the review itself. The result is advisory only — nothing is deleted.

string

required

Must be "analytics".

string

required

Must be "page-view-unused-analysis".

object

required

Show properties

object[]

required

The application’s route manifest — one entry per registered route. Entries with a missing path or an unknown kind are ignored; if no valid entries remain, a 400 validation error is returned.

Show item properties

string

required

Route pattern, e.g. "/genies" or "/genie-hub/my-genies/:genieId".

string

required

One of "feature", "public", "per-genie", "system", "redirect", "internal".

string

One of "public", "authenticated", "admin".

string | null

Page component name rendered by the route.

string | null

Source file of the page component.

string

Target path, for redirect routes.

number

Number of source files that link to the route.

boolean

Whether the route appears in the app’s navigation menu.

string

Time period. One of "7d", "30d", "90d". Default: "30d".

string

ISO 8601 start timestamp for a custom date range. Must be paired with to.

string

ISO 8601 end timestamp for a custom date range. Must be paired with from.

Response

Every route returned in analysis.candidates, analysis.caution, and excluded carries a stats object:

Field	Type	Description
`views`	number	Views in the analysed period
`previousViews`	number \| null	Views in the same-length prior period, or `null` when tracking did not cover it
`instances`	number	Distinct concrete URLs matched to the route
`activeDays`	number	Days in the period with at least one view
`lastSeen`	string \| null	Date (`YYYY-MM-DD`) of the most recent recorded view

boolean

object

Show properties

string

The period that was applied, or "custom" when from and to were supplied.

string

Start of the analysed range, as a YYYY-MM-DD date.

string

End of the analysed range, as a YYYY-MM-DD date.

number

Length of the analysed range in days.

string | null

Date of the earliest recorded page view, or null if nothing has been recorded.

number

How many days of the analysed range are covered by page-view tracking.

object

Show properties

number

Total views across all routes in the period.

number | null

Total views in the prior period, or null when not tracked.

number

Number of feature and public routes that were reviewed.

number

Number of routes set aside by kind.

number

Views on URLs that matched no route in the manifest.

object

Show properties

string

A short overall summary, including how much tracking data the verdicts rest on.

object[]

Pages that look safe to consider removing, most confident first.

Show item properties

string

The route path.

string

One of "low", "medium", "high".

string

What the page is for, how users would reach it, and why the numbers say they don’t.

string[]

Short factual bullets quoting the numbers behind the verdict.

string

One concrete next step.

object

The full manifest entry for the route plus its stats.

object[]

Low-traffic pages that should not be removed.

Show item properties

string

The route path.

string

One of "critical-flow", "deep-link-only", "sub-page", "insufficient-data", "other".

string

Why low traffic here does not mean unused.

string[]

Short factual bullets quoting the numbers behind the verdict.

object

The full manifest entry for the route plus its stats.

object[]

Routes that were not judged, grouped by kind. Only groups with at least one route are returned.

Show item properties

string

One of "per-genie", "system", "redirect", "internal".

string

Display label for the group.

string

Why routes of this kind are not judged on their own traffic.

object[]

Manifest entries with their stats, most-viewed first.

object[]

Up to 25 recorded paths that matched no route in the manifest, each as { path, views }.

Treat candidates as a shortlist to verify rather than a delete list — low traffic can also mean a route was only recently added or tracking coverage is still short. Check coverageDays before acting on the results.

const response = await ApiService.invoke({
  resource: "analytics",
  action: "page-view-unused-analysis",
  data: {
    period: "90d",
    routeManifest: [
      { path: "/genies", kind: "feature", access: "authenticated", component: "Genies", file: "src/pages/Genies.tsx", references: 12, inNav: true },
      { path: "/legacy-setup", kind: "feature", access: "authenticated", component: "LegacySetup", file: "src/pages/LegacySetup.tsx", references: 0, inNav: false },
      { path: "/auth/callback", kind: "system", access: "public", component: "AuthCallback", file: "src/pages/AuthCallback.tsx", references: 1, inNav: false },
    ],
  },
});

curl -X POST https://api.helpgenie.ai/v1/analytics \
  -H "Authorization: Bearer hg_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "action": "page-view-unused-analysis",
    "data": {
      "period": "90d",
      "routeManifest": [
        { "path": "/genies", "kind": "feature", "access": "authenticated", "component": "Genies", "file": "src/pages/Genies.tsx", "references": 12, "inNav": true },
        { "path": "/legacy-setup", "kind": "feature", "access": "authenticated", "component": "LegacySetup", "file": "src/pages/LegacySetup.tsx", "references": 0, "inNav": false },
        { "path": "/auth/callback", "kind": "system", "access": "public", "component": "AuthCallback", "file": "src/pages/AuthCallback.tsx", "references": 1, "inNav": false }
      ]
    }
  }'

{
  "success": true,
  "data": {
    "period": "90d",
    "from": "2026-07-03",
    "to": "2026-10-01",
    "periodDays": 90,
    "trackingSince": "2026-05-12",
    "coverageDays": 91,
    "totals": {
      "views": 18422,
      "previousViews": 16107,
      "analyzedRoutes": 2,
      "excludedRoutes": 1,
      "unmatchedViews": 14
    },
    "analysis": {
      "summary": "Three months of full tracking coverage. One strong removal candidate; the remaining feature page has healthy traffic.",
      "candidates": [
        {
          "path": "/legacy-setup",
          "confidence": "high",
          "reasoning": "An old onboarding page with no nav entry and no in-app links. It recorded no visits in 90 days while the current setup flow is used daily.",
          "signals": ["0 views in 90 days", "0 views in the prior 90 days", "not in nav", "0 in-app links"],
          "recommendation": "Remove src/pages/LegacySetup.tsx and its route.",
          "route": {
            "path": "/legacy-setup",
            "kind": "feature",
            "access": "authenticated",
            "component": "LegacySetup",
            "file": "src/pages/LegacySetup.tsx",
            "references": 0,
            "inNav": false,
            "stats": { "views": 0, "previousViews": 0, "instances": 0, "activeDays": 0, "lastSeen": null }
          }
        }
      ],
      "caution": []
    },
    "excluded": [
      {
        "kind": "system",
        "label": "System paths",
        "description": "Auth, OAuth callback, payment return, SSO hand-off or catch-all. Reached by flows rather than navigation, so low traffic never means unused.",
        "routes": [
          {
            "path": "/auth/callback",
            "kind": "system",
            "access": "public",
            "component": "AuthCallback",
            "file": "src/pages/AuthCallback.tsx",
            "references": 1,
            "inNav": false,
            "stats": { "views": 41, "previousViews": 37, "instances": 1, "activeDays": 28, "lastSeen": "2026-09-30" }
          }
        ]
      }
    ],
    "unmatched": [
      { "path": "/old-pricing", "views": 14 }
    ]
  }
}

Compare

Returns a period-over-period conversation comparison (e.g., this week vs last week).

string

required

Must be "analytics".

string

required

Must be "compare".

object

Show properties

string

Time period. One of "7d", "30d", "90d". Default: "30d".

boolean

Admin only.

string

Admin only.

curl -X POST https://api.helpgenie.ai/v1/analytics \
  -H "Authorization: Bearer hg_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "action": "compare", "data": { "period": "7d" } }'

Overview

Public (unauthenticated)

Agents

Knowledge

CRM

Marketplace

Platform

Telephony

Worker genies

Quality & Compliance

Access Control

Intelligence

Education

Voice

Integrations

Expanded Platform

Overview

Response

Trends

Genie performance

Page views

Response

Page view totals

Response

Unused page analysis

Response

Compare

​Overview

​Response

​Trends

​Genie performance

​Page views

​Response

​Page view totals

​Response

​Unused page analysis

​Response

​Compare

Overview

Response

Trends

Genie performance

Page views

Response

Page view totals

Response

Unused page analysis

Response

Compare