Get HelpCenter Content Performance
helpcenter_get_content_performancePer-article views and ratings for the connected HelpCenter.io help center. This is the "which articles should I fix" call.
Read-only.
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.
IMPORTANT — an article that got NO views in the window has no row here at all. The pipeline records views, not their absence. So 'sort=views_asc' gives you the least-read of the articles that WERE read, not the ones nobody opened; to find those, call helpcenter_list_articles and subtract the ids this returns. The response carries excludes_never_viewed: true as a reminder.
Args:
sort ('views_desc' | 'views_asc' | 'rating_asc', optional): default 'views_desc'. Use 'rating_asc' for "what should I fix" — it puts the worst-rated first and breaks ties towards the most-read article, because a badly-rated page nobody visits matters less than one everybody lands on.
category_id (number, optional): restrict to one category belonging to this help center.
limit (number, optional): items per page, 1-100 (default 100).
page (number, optional): page number (default 1).
from / to / lang (optional): see above.
response_format ('markdown' | 'json'): default 'markdown'.
Returns: { range, excludes_never_viewed, articles: [{ article_id, title, slug, status, views_in_range, total_views, ratings: { love_pct, thumbs_up_pct, thumbs_down_pct }, updated_at, _links: { view } }], meta }.
Ratings are percentage SHARES of the feedback an article received, not counts — one thumbs-down reads as 100%. Weigh them against views_in_range before acting.
Having found a weak article, fix it with helpcenter_stage_article_changes (edit privately, then publish) or helpcenter_update_article (visible immediately).
Errors: 429 if the shared analytics rate limit is exceeded — stop, do not retry. 422 if category_id belongs to a different help center. 503 if the analytics backend is temporarily unavailable.
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_content_performance"
}
}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. | |
| page | No | Page number for pagination (default 1). | |
| sort | No | 'views_desc' (default) most-read first; 'views_asc' least-read first; 'rating_asc' worst-rated first, ties broken towards the most-read article. Use 'rating_asc' for 'what should I fix'. | |
| limit | No | Maximum items to return per page (1-100, default 100). | |
| 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. | |
| category_id | No | Restrict to one category id belonging to this help center. | |
| response_format | No | Output format: 'markdown' for a human-readable summary or 'json' for the full structured payload. | markdown |