Skip to main content
Reports show how visitors use your knowledge base. All commands take a period. For fields and response details, see the API reference. This command lists the keywords visitors search for, with how often.
--duration takes all_time (the default), last_24_hours, last_7_days, this_week, last_week, last_30_days, this_month, last_month, this_quarter, last_quarter or custom. With custom, pass both --start-date and --end-date, and the start must not be after the end.

Failed searches

This command lists the searches that found no article. Use this to decide which articles to write next.

Invalid URLs

This command lists visited URLs that do not exist, with how often and where the visitor came from. Use this to decide which redirections to add.

Visits

This command shows the visits to the knowledge base for each day, oldest first. It is not paginated.

Clear report data

These commands delete report data. They cannot be undone. With no period, they delete everything of that kind. They return the number of rows deleted, which is 0 when nothing matched. They need the Manage articles permission.
Each command takes the same period flags as its report, and clear invalid-urls also takes --url.

Clear failed searches

Clear invalid URLs