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

hotjar Survey Responses API

Endpoints for exporting and listing survey response data with cursor-based pagination.

hotjar Survey Responses API is one of 7 APIs that hotjar publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 1 operation across 1 path, and defines 5 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.

1 operations 1 paths 5 schemas 1 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0
Base URL
https://api.hotjar.com
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

hotjar Survey Responses 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 1

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

Survey Responses 1

Endpoints for exporting and listing survey response data with cursor-based pagination.

GET
/sites/{site_id}/surveys/{survey_id}/responses
List survey responses
listSurveyResponses 4 params → 200401403404

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are SurveyResponse (4 properties), SurveyAnswer (2 properties), SurveyResponseListResponse (2 properties), Error (2 properties). Each schema is shown below with its type and property counts.

SurveyResponseTag
object
A tag associated with a survey response for categorization and filtering.
1 property
SurveyResponse
object
A single response to a Hotjar survey, containing the answers provided by a respondent.
4 properties
Error
object
An error response returned by the API when a request fails.
2 properties
SurveyResponseListResponse
object
A paginated list of survey responses with cursor-based pagination support.
2 properties
SurveyAnswer
object
An individual answer to a survey question within a response.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hotjar-survey-responses-api-openapi.yml Raw ↑

Other APIs hotjar publishes across the network.

Hotjar Events API
Hotjar Identify API
Hotjar JavaScript SDK
hotjar Authentication API
hotjar Surveys API
hotjar User Lookup API