Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Whatfix Analytics API

The Analytics API from Whatfix — 4 operation(s) for analytics.

Whatfix Analytics API is one of 5 APIs that Whatfix publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Analytics. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 4 operations across 4 paths, and defines 5 schemas. It is described by OpenAPI 3.0.3, at version v1.

Requests are made against a single base URL, https://whatfix.com/api/v1.

4 operations 4 paths 5 schemas 4 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
v1
Base URL
https://whatfix.com/api/v1
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

Whatfix Analytics API declares 1 security scheme for authenticating requests. An API key is passed in the header as x-whatfix-integration-key (ApiKeyAuth). By default, every request must be authenticated.

  • ApiKeyAuth — User API token obtained from the Whatfix dashboard. Pass your registered Whatfix email address in the x-whatfix-user header as well.

Paths & Operations 4

Across 4 paths, the API surfaces 4 operations — 4 GET. Each is listed below with its method, path, parameters, and response codes.

Analytics 4
GET
/{accountId}/analytics/flows
Get Flow Analytics
getFlowAnalytics 3 params → 200401
GET
/{accountId}/analytics/end-users
Get End User Engagement
getEndUserEngagement 5 params → 200
GET
/{accountId}/analytics/self-help
Get Self Help Analytics
getSelfHelpAnalytics 3 params → 200
GET
/{accountId}/analytics/task-completion
Get User Task Completion
getUserTaskCompletion 5 params → 200

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are TaskCompletion (8 properties), FlowAnalytics (6 properties), Pagination (4 properties), FlowAnalyticsList (3 properties). Each schema is shown below with its type and property counts.

Error
object
3 properties
TaskCompletion
object
Task completion status for an end user.
8 properties
FlowAnalyticsList
object
3 properties
FlowAnalytics
object
Analytics data for a Whatfix flow.
6 properties
Pagination
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

whatfix-analytics-api-openapi.yml Raw ↑

Other APIs Whatfix publishes across the network.

Whatfix Content API
Whatfix End Users API
Whatfix Reports API
Whatfix Segments API