Metadata-Version: 2.1
Name: hotjar-data-wrapper
Version: 0.1.2
Summary: a wrapper for using Hotjar APIs
Author-email: Tobias McVey <tobias.mcvey@nav.no>
License: MIT License
        
        Copyright (c) 2022 NAV IT
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
Project-URL: Homepage, https://github.com/navikt/hotjar-data-wrapper
Keywords: hotjar
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: certifi (==2023.5.7)
Requires-Dist: charset-normalizer (==3.1.0)
Requires-Dist: idna (==3.4)
Requires-Dist: requests (==2.30.0)
Requires-Dist: tqdm (==4.65.0)
Requires-Dist: urllib3 (==2.0.2)

# Hotjar Data Wrapper

[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

This is a wrapper for Hotjar APIs to let you login and download survey data and metadata for your account.

## Supported APIs and docs

- [Hotjar Data Wrapper](#hotjar-data-wrapper)
  - [Supported APIs and docs](#supported-apis-and-docs)
    - [Get survey metadata](#get-survey-metadata)
    - [Get survey questions](#get-survey-questions)
    - [List all surveys](#list-all-surveys)
    - [Get all survey metadata](#get-all-survey-metadata)

### Get survey metadata

Login and download metadata for a specific survey.

```python
meta = get_survey_metadata(survey_id=survey_id, site_id=site_id, username=username, password=password)
meta.status_code # 200
meta.content # prints content
```

### Get survey questions

Login and download questions for a specific survey.

```python
questions = get_survey_questions(survey_id=survey_id, site_id=site_id, username=username, password=password)
questions.content 
```

### List all surveys

Login and download list of all surveys for a given site ID.

```python
all_surveys = get_list_all_surveys(site_id=site_id, username=username, password=password)
all_surveys.content
```

### Get all survey metadata

Login and download metadata for a list of surveys with survey IDs.

```python
get_all_surveys_metadata(
    path="data/hotjar surveys",
    surveys_list=ids,
    site_id=site_id,
    username=username,
    password=password,
)
```
