> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Hotjar

> How to set up the Hotjar connector, plus the actions that are available.

<div className="connector-page-header">
  <img src="https://stackone-logos.com/api/hotjar/filled/svg" alt="Hotjar" className="connector-page-icon" />

  <div className="connector-page-changelog">
    <div className="connector-page-version"><span className="connector-page-tag-beta connector-page-stage-tag">Beta</span><span>v1.0.0</span></div>
  </div>

  <div className="connector-page-header-meta">
    <div className="connector-page-subtitle"><a href="#actions">4 actions</a> · 1 auth method</div>

    <div className="connector-page-category-tags">
      <span className="connector-page-category-tag">Surveys</span>
    </div>
  </div>
</div>

## Getting Started

<Steps>
  <Step title="Create or Select a Project">
    Set up a new project or select an existing one. See [Organizations & Projects](/gateway/concepts/organizations-and-projects).
  </Step>

  <Step title="Configure the Connector">
    Enable the connector and set up a Connector Profile in your project. See [Setup Connector Profile](/gateway/quickstart#setup-connector-profile).

    <Columns cols={2}>
      <Card title="Connector Profile · OAuth 2.0" href="/connectors/hotjar/guides/connector-profile/oauth-2-0" icon="https://stackone-logos.com/api/hotjar/filled/svg" horizontal>
        OAuth 2.0 Client Credentials flow. Hotjar API access requires a Scale plan (Observe Scale or Ask Scale). API keys auto-e...
      </Card>
    </Columns>
  </Step>

  <Step title="Link an Account">
    Link an account [from the dashboard](/connect/managing-connectors/linking-accounts#link-from-the-dashboard) (or via [StackOne Hub](/embed/account-linking/overview)).

    See the guide for the authentication type chosen in the Connector Profile:

    <Columns cols={2}>
      <Card title="Link Account · OAuth 2.0" href="/connectors/hotjar/guides/link-account/oauth-2-0" icon="https://stackone-logos.com/api/hotjar/filled/svg" horizontal />
    </Columns>
  </Step>

  <Step title="Use Actions">
    Connect an AI platform to the linked account's actions. See [AI Platforms](/connect/ai-platforms/overview).

    Other ways to call actions are listed in [Protocols & SDKs](/connect/protocols-and-sdks).
  </Step>
</Steps>

## Actions

<div className="connector-meta-library-section">
  <div className="connector-actions-controls not-prose" data-connector-actions-controls>
    <div className="connector-actions-controls__row">
      <input type="search" className="connector-actions-search" data-connector-actions-search placeholder="Search actions" aria-label="Search actions" />

      <div className="connector-actions-scopes" data-connector-actions-scopes>
        <button type="button" className="connector-actions-scopes__toggle" data-connector-actions-scopes-toggle aria-expanded="false">
          <span>Scopes<span data-connector-actions-scopes-count /></span>
        </button>

        <div className="connector-actions-scopes__menu">
          <div className="connector-actions-scopes__header">
            <input type="search" className="connector-actions-scopes__search" data-connector-actions-scope-search placeholder="Search scopes..." aria-label="Search scopes" />

            <div className="connector-actions-scopes__actions">
              <button type="button" data-connector-actions-scopes-select-all>Select all</button>
              <span>|</span>
              <button type="button" data-connector-actions-scopes-clear>Clear</button>
            </div>
          </div>

          <label className="connector-actions-scopes__item">
            <input type="checkbox" value="hotjar.responses_read" data-connector-actions-scope-filter />

            <span>hotjar.responses\_read</span>
          </label>

          <label className="connector-actions-scopes__item">
            <input type="checkbox" value="hotjar.user_lookup" data-connector-actions-scope-filter />

            <span>hotjar.user\_lookup</span>
          </label>

          <div className="connector-actions-scopes__empty" data-connector-actions-scopes-empty hidden>No scopes found</div>
        </div>
      </div>
    </div>
  </div>

  <div className="meta-library-count" data-connector-actions-count>4 actions</div>

  <div className="not-prose meta-library-table-container" data-connector-actions-table>
    <div className="connector-meta-library-grid connector-meta-library-grid--three-col">
      <div className="connector-meta-library-row">
        <div className="meta-library-grid-header-cell">Action</div>
        <div className="meta-library-grid-header-cell">Description</div>
        <div className="meta-library-grid-header-cell">Required scopes</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="hotjar_list_surveys" data-action-label="List Surveys" data-action-scopes="hotjar.responses_read" data-action-auth="OAuth 2.0" data-action-auth-scopes="{&#x22;OAuth 2.0&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>List Surveys</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="hotjar_list_surveys" aria-label="Copy hotjar_list_surveys"><code className="connector-page-code">hotjar\_list\_surveys</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">List all surveys configured on a Hotjar site with cursor-based pagination</div>

        <div className="meta-library-grid-cell meta-library-grid-cell--values">
          <div className="connector-meta-library-values-list"><button type="button" className="connector-page-code-button" data-copy="hotjar.responses_read" aria-label="Copy scope hotjar.responses_read"><code className="connector-page-code">hotjar.responses\_read</code></button></div>
        </div>
      </div>

      <div className="connector-meta-library-row" data-action-id="hotjar_get_survey" data-action-label="Get Survey" data-action-scopes="hotjar.responses_read" data-action-auth="OAuth 2.0" data-action-auth-scopes="{&#x22;OAuth 2.0&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Get Survey</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="hotjar_get_survey" aria-label="Copy hotjar_get_survey"><code className="connector-page-code">hotjar\_get\_survey</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve full details of a single survey including its question definitions</div>

        <div className="meta-library-grid-cell meta-library-grid-cell--values">
          <div className="connector-meta-library-values-list"><button type="button" className="connector-page-code-button" data-copy="hotjar.responses_read" aria-label="Copy scope hotjar.responses_read"><code className="connector-page-code">hotjar.responses\_read</code></button></div>
        </div>
      </div>

      <div className="connector-meta-library-row" data-action-id="hotjar_list_survey_responses" data-action-label="List Survey Responses" data-action-scopes="hotjar.responses_read" data-action-auth="OAuth 2.0" data-action-auth-scopes="{&#x22;OAuth 2.0&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>List Survey Responses</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="hotjar_list_survey_responses" aria-label="Copy hotjar_list_survey_responses"><code className="connector-page-code">hotjar\_list\_survey\_responses</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">List collected responses for a specific survey with cursor-based pagination</div>

        <div className="meta-library-grid-cell meta-library-grid-cell--values">
          <div className="connector-meta-library-values-list"><button type="button" className="connector-page-code-button" data-copy="hotjar.responses_read" aria-label="Copy scope hotjar.responses_read"><code className="connector-page-code">hotjar.responses\_read</code></button></div>
        </div>
      </div>

      <div className="connector-meta-library-row" data-action-id="hotjar_lookup_user" data-action-label="Look Up User Data" data-action-scopes="hotjar.user_lookup" data-action-auth="OAuth 2.0" data-action-auth-scopes="{&#x22;OAuth 2.0&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Look Up User Data</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="hotjar_lookup_user" aria-label="Copy hotjar_lookup_user"><code className="connector-page-code">hotjar\_lookup\_user</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Asynchronously look up (and optionally delete) all Hotjar data associated with a specific end-user across all sites in t...</div>

        <div className="meta-library-grid-cell meta-library-grid-cell--values">
          <div className="connector-meta-library-values-list"><button type="button" className="connector-page-code-button" data-copy="hotjar.user_lookup" aria-label="Copy scope hotjar.user_lookup"><code className="connector-page-code">hotjar.user\_lookup</code></button></div>
        </div>
      </div>
    </div>
  </div>
</div>