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, 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" }
  }'

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

Compare

​Overview

​Response

​Trends

​Genie performance

​Compare

Overview

Response

Trends

Genie performance

Compare