Get HelpCenter Analytics Summary
helpcenter_get_analytics_summaryHeadline traffic, ratings and authoring activity for the connected HelpCenter.io help center, each compared against the equally-long window before it.
Read-only. This is the "how are we doing" and "what changed since last month" call.
COST AND RATE LIMIT: this is an expensive query, and the three analytics tools share a limit of 6 requests per minute per API key — far below the other read tools. The underlying figures are recomputed only once a day, so asking again in a few seconds returns identical numbers at full cost. Read once, keep the answer, and do NOT poll or retry in a loop. If you are refused with a rate-limit error, stop rather than backing off and retrying.
Leave from/to unset unless the user asked about a specific period: the default window is the trailing 7 days, is served from a pre-computed cache rather than the warehouse, and is the right answer for a general question. Maximum window is 92 days; wider is refused.
Args:
from (string, optional): YYYY-MM-DD start of the window.
to (string, optional): YYYY-MM-DD end, inclusive. Defaults to today.
lang (string, optional): restrict to one enabled language.
response_format ('markdown' | 'json'): default 'markdown'.
Returns: { range: { from, to, days }, summary: { traffic: { article_views, visitors, searches, article_views_per_visitor }, ratings: { total }, activity: {...}, totals: { published_articles } } }. Each traffic metric is { count, change_pct } where change_pct compares against the immediately preceding window of the same length.
summary.traffic.searches.count is the authoritative search volume — helpcenter_get_search_queries deliberately reports no totals of its own.
To act on what this shows: use helpcenter_get_search_queries to find what people cannot find, and helpcenter_get_content_performance to find which existing articles are failing.
Errors: 429 if the shared analytics rate limit is exceeded — stop, do not retry. 503 if the analytics backend is temporarily unavailable; that is not your request's fault and retrying immediately will not help.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "helpcenter_get_analytics_summary"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| to | No | End of the reporting window, YYYY-MM-DD, inclusive. Defaults to today. | |
| from | No | Start of the reporting window, YYYY-MM-DD. OMIT unless the user asked for a specific period — the default window is cheaper to serve and is the right answer for a general 'how are we doing' question. | |
| lang | No | Restrict to one language code. Must be enabled on the help center. Costs more to serve than the unfiltered call, so only send it for a genuinely multilingual question. | |
| site_id | No | Which help center to act on: an id from helpcenter_list_sites. Needed when this connection reaches more than one help center; omit it when it reaches one. Applies to this call only — pass it on every call of a task, and ask the user which help center they mean if their request does not say. | |
| response_format | No | Output format: 'markdown' for a human-readable summary or 'json' for the full structured payload. | markdown |