How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

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.2.0, at version 1.0.

Requests are made against a single base URL, https://api.hotjar.io/v1.

2 operations 2 paths 4 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

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

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.

Surveys 2

Endpoints for listing surveys and retrieving survey details for a specific site.

GET
/sites/{site_id}/surveys
List surveys for a site
listSurveys 4 params → 200401403404
GET
/sites/{site_id}/surveys/{survey_id}
Get a specific survey
getSurvey 2 params → 200401403404

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), SurveyListResponse (2 properties), Error (2 properties). Each schema is shown below with its type and property counts.

SurveyQuestion
object
A question within a Hotjar survey, including its type, text, and available answer options.
7 properties
Error
object
An error response returned by the API when a request fails.
2 properties
SurveyListResponse
object
A paginated list of surveys with cursor-based pagination support.
2 properties
Survey
object
A Hotjar survey with its configuration, status, and optional question details.
9 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hotjar-surveys-api-openapi.yml Raw ↑

Other APIs Hotjar publishes across the network.

Hotjar Events API
Hotjar Identify API
Hotjar JavaScript SDK
hotjar Authentication API
hotjar Survey Responses API
hotjar User Lookup API
Where this information came from

This is an independent, third-party profile of hotjar Surveys API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.