Description
The new /analytics/faq-search/ endpoint serves FAQ Search analytics at individual search-level
to help monitor & evaluate FAQ effectiveness for the end user.
API endpoint
https://analytics.helpshift.com/v1/domain_name/analytics/faq-search/
Metrics
| Metric Name | Datatype | Metric Definition |
| total_search_count | bigint | Count of FAQ searches completed within in-app FAQs, regardless of whether they turned up results or not. |
| successful_search_count | bigint | Count of FAQ searches which turned up FAQs where the user clicked on one or more of the FAQs that appeared. |
| no_search_result_count | bigint | Count of FAQ searches which turned up zero related FAQs. |
| successful_search_with_no_clicks_count | bigint | Count of FAQ searches which turned up some FAQs, but where the user did not click on any of the FAQs that appeared. |
Request parameters
| Parameter | Description |
| from | Start of the time range (timestamp: ISO 8601 datetime format w/o timezone) |
| to | End of the time range (timestamp: ISO 8601 datetime format w/o timezone) |
| aggregation | Aggregation level of the metrics (optional) Option: workzone_id, to group the analytics records further by workzone ID for App level permission enabled domains. Adds another dimension to the (app_id + language + search_term + date) aggregation, splitting the data further at workzone-level. |
| limit | Number of records to fetch in a single call (optional) Option: 1-1000, default limit is 1000. |
Response format
Mock response
