{ "opencollection": "1.0.0", "info": { "name": "Whatfix Analytics API", "version": "v1" }, "request": { "auth": { "type": "apikey", "key": "x-whatfix-integration-key", "value": "{{x-whatfix-integration-key}}", "placement": "header" } }, "items": [ { "info": { "name": "Analytics", "type": "folder" }, "items": [ { "info": { "name": "Get Flow Analytics", "type": "http" }, "http": { "method": "GET", "url": "https://whatfix.com/api/v1/:accountId/analytics/flows", "params": [ { "name": "accountId", "value": "", "type": "path", "description": "Your Whatfix account identifier." }, { "name": "startDate", "value": "", "type": "query", "description": "Start date for analytics range (ISO 8601 date)." }, { "name": "endDate", "value": "", "type": "query", "description": "End date for analytics range (ISO 8601 date)." } ] }, "docs": "Returns analytics data for all flows including view counts, completion rates, and average time-to-complete for the specified date range." }, { "info": { "name": "Get End User Engagement", "type": "http" }, "http": { "method": "GET", "url": "https://whatfix.com/api/v1/:accountId/analytics/end-users", "params": [ { "name": "accountId", "value": "", "type": "path", "description": "Your Whatfix account identifier." }, { "name": "startDate", "value": "", "type": "query", "description": "Start date for analytics range (ISO 8601 date)." }, { "name": "endDate", "value": "", "type": "query", "description": "End date for analytics range (ISO 8601 date)." }, { "name": "page", "value": "", "type": "query", "description": "Page number for paginated results (1-based)." }, { "name": "pageSize", "value": "", "type": "query", "description": "Number of results per page." } ] }, "docs": "Returns engagement analytics broken down by end users, showing content interactions for each user over the specified date range." }, { "info": { "name": "Get Self Help Analytics", "type": "http" }, "http": { "method": "GET", "url": "https://whatfix.com/api/v1/:accountId/analytics/self-help", "params": [ { "name": "accountId", "value": "", "type": "path", "description": "Your Whatfix account identifier." }, { "name": "startDate", "value": "", "type": "query", "description": "Start date for analytics range (ISO 8601 date)." }, { "name": "endDate", "value": "", "type": "query", "description": "End date for analytics range (ISO 8601 date)." } ] }, "docs": "Returns analytics for Self Help widget content, showing which content items were viewed and how many times during the specified period." }, { "info": { "name": "Get User Task Completion", "type": "http" }, "http": { "method": "GET", "url": "https://whatfix.com/api/v1/:accountId/analytics/task-completion", "params": [ { "name": "accountId", "value": "", "type": "path", "description": "Your Whatfix account identifier." }, { "name": "startDate", "value": "", "type": "query", "description": "Start date for analytics range (ISO 8601 date)." }, { "name": "endDate", "value": "", "type": "query", "description": "End date for analytics range (ISO 8601 date)." }, { "name": "page", "value": "", "type": "query", "description": "Page number for paginated results (1-based)." }, { "name": "pageSize", "value": "", "type": "query", "description": "Number of results per page." } ] }, "docs": "Returns task list completion status for each end user, showing individual progress on assigned onboarding or training task lists." } ] } ], "bundled": true }