Skip to main content

Hotjar API Data Source

Nexla's bi-directional connectors allow data to flow both to and from any location, making it simple to create a FlexFlow, DB-CDC, Spark ETL, or Replication data flow that ingests data from a Hotjar API location.
hotjar_api.png

Hotjar API

Follow the instructions below to create a new data flow that ingests data from a Hotjar API source in Nexla.

Create a New Data Flow​

  1. To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Then, select the desired flow type from the list, and click the Create button.

  2. Select the Hotjar API connector tile from the list of available connectors. Then, select the credential that will be used to connect to the Hotjar account, and click Next; or, create a new Hotjar API credential for use in this flow.

  3. In Nexla, Hotjar API data sources can be created using pre-built endpoint templates, which expedite source setup for common Hotjar API endpoints. Each template is designed specifically for the corresponding Hotjar API endpoint, making source configuration easy and efficient.
    • To configure this source using a template, follow the instructions in Configure Using a Template.

    Hotjar API sources can also be configured manually, allowing you to ingest data from Hotjar API endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
    • To configure this source manually, follow the instructions in Configure Manually.

Configure Using a Template​

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Hotjar API endpoints. Each template is designed specifically for the corresponding Hotjar API endpoint, making data source setup easy and efficient.

Endpoint Settings​

  • Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below. Click on an endpoint to see more information about it and how to configure your data source for this endpoint.

    List Surveys

    List Surveys

    • Enter the site's unique identifier in the Site ID field. This ID can be found in the Sites & Organizations page under the respective organization in your Hotjar account.
    • Optionally, enter the number of surveys to be returned in the Limit field. The maximum is 100. If not specified, the default limit will be used.
    • Optionally, enter the cursor to be used for fetching a specific page in the Cursor field. The cursor is used for pagination to retrieve specific pages of results.
    • Optionally, enter a flag (true/false) indicating whether the question information should be included in the response in the With Questions field. By default, question information is not included.
    • The endpoint uses GET requests to https://help.hotjar.com/v1/sites/{site_id}/surveys where {site_id} is the Site ID you provide. The endpoint URL is automatically constructed based on the Hotjar API base URL and the site ID.
    • The endpoint uses token-based pagination (iteration.type: paging.next.token) through the cursor mechanism. The response data path is $.results[*], which extracts all items from the results array in the API response. Additional metadata is also included from the root-level object.
    • When a response includes a next_cursor value, Nexla automatically uses it as the cursor parameter for the subsequent request to fetch the next page of results until all surveys have been retrieved (when next_cursor is null).

    This endpoint retrieves all surveys for a specific site in your Hotjar account. The endpoint supports pagination through the cursor mechanism, which allows you to retrieve large lists of surveys efficiently. You can optionally include question information in the response by setting the with_questions parameter to true. The response includes pagination metadata that indicates the current cursor and next cursor available. When next_cursor is null, all surveys have been retrieved. For detailed information about the API response format and available fields, see the Hotjar API Reference documentation.

    List Survey Responses

    List Survey Responses

    • Enter the site's unique identifier in the Site ID field. This ID can be found in the Sites & Organizations page under the respective organization in your Hotjar account.
    • Enter the survey's unique identifier in the Survey ID field. This is the unique identifier for the survey whose responses you want to retrieve.
    • Optionally, enter the number of survey responses to be returned in the Limit field. The maximum is 100. If not specified, the default limit will be used.
    • Optionally, enter the cursor to be used for fetching a specific page in the Cursor field. The cursor is used for pagination to retrieve specific pages of results.
    • The endpoint uses GET requests to https://api.hotjar.io/v1/sites/{site_id}/surveys/{survey_id}/responses where {site_id} is the Site ID you provide and {survey_id} is the Survey ID you provide. The endpoint URL is automatically constructed based on the Hotjar API base URL, the site ID, and the survey ID.
    • The endpoint uses token-based pagination (iteration.type: paging.next.token) through the cursor mechanism. The response data path is $.results[*], which extracts all items from the results array in the API response. Additional metadata is also included from the root-level object.
    • When a response includes a next_cursor value, Nexla automatically uses it as the cursor parameter for the subsequent request to fetch the next page of results until all survey responses have been retrieved (when next_cursor is null).

    This endpoint retrieves all responses for a specific survey in your Hotjar account. The endpoint supports pagination through the cursor mechanism, which allows you to retrieve large lists of survey responses efficiently. The response includes pagination metadata that indicates the current cursor and next cursor available. When next_cursor is null, all survey responses have been retrieved. For detailed information about the API response format and available fields, see the Hotjar API Reference documentation.

Configure Manually​

Hotjar API data sources can be manually configured to ingest data from any valid Hotjar API endpoint. Manual configuration provides maximum flexibility for accessing endpoints not covered by pre-built templates or when you need custom API configurations.

With manual configuration, you can also create more complex Hotjar API sources, such as sources that use custom query parameters, different HTTP methods, or custom data transformations.

Content Format​

  1. Select the format in which the data from the Hotjar API will be received from the Content Format pulldown menu. Nexla will automatically parse the data in the selected format. The Hotjar API typically returns data in JSON format.

API Endpoint URL​

  1. Enter the URL of the Hotjar API endpoint from which this source will fetch data in the Set API URL field. This should be the complete URL including the protocol (https://) and any required path parameters. Hotjar API endpoints typically follow the pattern https://api.hotjar.io/v1/{endpoint_path} or https://help.hotjar.com/v1/{endpoint_path}.

Ensure the API endpoint URL is correct and accessible with your current credentials. You can test the endpoint using the Test button after configuring the URL. The endpoint requires token-based authentication via the Authorization: Bearer {token} header, which is handled automatically by your credential configuration. The access token is obtained using the OAuth2 client credentials flow with your Client ID and Client Secret. For detailed information about Hotjar API endpoints and available APIs, see the Hotjar API Reference documentation.