hotjar Surveys API
Endpoints for listing surveys and retrieving survey details for a specific site.
hotjar Surveys API is one of 7 APIs that hotjar publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Surveys. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 2 operations across 2 paths, and defines 4 schemas. It is described by OpenAPI 3.1.0, at version 1.0.
Requests are made against a single base URL, https://api.hotjar.io/v1.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
hotjar Surveys API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (bearerAuth).
By default, every request must be authenticated.
bearerAuth— Bearer token obtained from the OAuth token endpoint using client credentials grant.
Paths & Operations 2
Across 2 paths, the API surfaces 2 operations — 2 GET. Each is listed below with its method, path, parameters, and response codes.
Endpoints for listing surveys and retrieving survey details for a specific site.
Schemas 4
The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are Survey (9 properties), SurveyQuestion (7 properties), Error (2 properties), SurveyListResponse (2 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from hotjar 6
Other APIs hotjar publishes across the network.