@robinpath/hotjar
v0.3.0
Published
Hotjar integration — list heatmaps, session recordings, and surveys. Uses the encrypted credential vault for API tokens.
Readme
@robinpath/hotjar
Hotjar module for RobinPath.
Why use this module?
The hotjar module lets you:
- listSurveys
- getSurvey
- getSurveyResponses
- listFeedback
- getFeedbackItem
All functions are callable directly from RobinPath scripts with a simple, consistent API.
Installation
robinpath add @robinpath/hotjarQuick Start
1. Set up credentials
hotjar.setCredentials "your-credentials"2. listSurveys
hotjar.listSurveysAvailable Functions
| Function | Description |
|----------|-------------|
| hotjar.setCredentials | Configure hotjar credentials. |
| hotjar.listSurveys | listSurveys |
| hotjar.getSurvey | getSurvey |
| hotjar.getSurveyResponses | getSurveyResponses |
| hotjar.listFeedback | listFeedback |
| hotjar.getFeedbackItem | getFeedbackItem |
| hotjar.listHeatmaps | listHeatmaps |
| hotjar.getHeatmap | getHeatmap |
| hotjar.listRecordings | listRecordings |
| hotjar.getRecording | getRecording |
| hotjar.getSiteInfo | getSiteInfo |
| hotjar.getUserInfo | getUserInfo |
| hotjar.getSessionCount | getSessionCount |
Examples
listSurveys
hotjar.listSurveysgetSurvey
hotjar.getSurveygetSurveyResponses
hotjar.getSurveyResponsesIntegration with RobinPath
import { RobinPath } from "@wiredwp/robinpath";
import Module from "@robinpath/hotjar";
const rp = new RobinPath();
rp.registerModule(Module.name, Module.functions);
rp.registerModuleMeta(Module.name, Module.functionMetadata);
const result = await rp.executeScript(`
hotjar.setCredentials "your-credentials"
hotjar.listSurveys
`);Full API Reference
See MODULE.md for complete documentation including all parameters, return types, error handling, and advanced examples.
Related Modules
@robinpath/json— JSON module for complementary functionality
License
MIT
