Qrvey

https://qrvey-docs.netlify.app/docs/
Admin
Qrvey is an all-in-one analytics platform that enables SaaS providers to quickly embed analytics,...
Tokens:20,005
Snippets:444
Trust Score:7.6
Update:3 months ago
Show doc for...
Tokens:
Raw
### Execute AWS Terraform Deployment

Source: https://qrvey-docs.netlify.app/docs/release-notes/release-and-upgrade-notes

Run this command during step 5 of the installation process to apply specific infrastructure targets.

```bash
docker run --platform=linux/amd64 -v $(pwd)/config.json:/app/qrvey/config.json -it qrvey.azurecr.io/qrvey-terraform-aws:9.0.2-20250520 apply --target aws_security_group.vpc_endpoints --target aws_vpc_endpoint.s3_gateway --target aws_vpc_endpoint.sts_interface --target module.vpc
```

--------------------------------

### Configure AWS Public Subnet for Database

Source: https://qrvey-docs.netlify.app/docs/release-notes/release-and-upgrade-notes

Include this property in the configuration object during the AWS installation process.

```json
{
    "use_public_subnet_for_db": true,
}
```

--------------------------------

### Retrieve Qrvey Environment Details

Source: https://qrvey-docs.netlify.app/docs/faqs

Displays the console output format containing deployment IDs, URLs, admin credentials, and API keys generated after running the Qrvey docker command.

```text
    ##########  
   ###      ####  
 ###          ###    +++ +++      +++  +++++  +++      ++  
###            ### ++++   +++    +++ +++   +++ ++     +++  
###            ### ++      ++   +++ +++   ++++  ++   +++  
###            ### ++       ++  ++  ++++++++    +++  ++  
 ###          ###  ++       ++++++  +++          ++++++  
   ####    #####   ++        ++++    +++   +++    ++++  
     ########      ++         ++      +++++++     +++  
       #####                                      ++  
        ########                               ++++  
          
# ENVIRONMENT DETAILS  
DEPLOYMENT_ID: deployment-id  
URL: https://deployment-id.mp.qrveyapp.com  
ADMIN URL: https://deployment-id.mp.qrveyapp.com/admin/app/  
ADMIN USER: admin@company.tld  
ADMIN PASSWORD: generated_admin_password  
APIKEY: qrvey_api_key  
PostgresqlConnection: postgres://qrvey_usr:db_password@deployment-id-qrvey-db.postgres.database.azure.com:5432/postgres  
ES_HOST: https://1.2.3.4:9200/  
ES_USERNAME: elastic  
ES_PASSWORD: elastic_password  
```

--------------------------------

### Frontend Widget Authentication Script

Source: https://qrvey-docs.netlify.app/docs/quickstart

Handles fetching the authentication token from a backend and injecting the widget configuration into the global scope.

```javascript
// Frontend Script  
  
// The qrveyDomain needs to be a "var" to put it in the global scope.  
var masterObject = {   
    backendDomain: "https://get-demo-token.qrveyapp.com",  
    qrveyDomain: "https://demo.qrvey.com"  
}  
  
// A frontend call to your backend, which fetches AND forwards the qvToken.  
async function fetchToken() {   
  try {   
    const response = await axios.get(  
      masterObject.backendDomain + "/quickstart-dashboard"  
    );  
    console.log("RESPONSE:", response);  
    return response.data?.token;  
  } catch(error) {   
    console.log(error)  
  }  
}  
  
// Injects widget with global settings.  
async function embedWidget() {   
    let token = await fetchToken();  
    let widgetContainer = document.querySelector("#widget-container");  
    window["qrvey-dashboard-config"] = { // Setting global settings  
        "domain": masterObject.qrveyDomain,  
        "qvToken": token,  
        };  
    let dashboard = document.createElement("qrvey-dashboard");  
    dashboard.setAttribute("settings", "qrvey-dashboard-config");  
    widgetContainer.append(dashboard);  
}  
  
embedWidget();  
```

--------------------------------

### Backend Token Generation Server

Source: https://qrvey-docs.netlify.app/docs/quickstart

An Express server that generates authentication tokens using environment variables and provides an endpoint for the frontend.

```javascript
// Your backend server  
const express = require("express");  
const axios = require("axios");  
require("dotenv").config();  
  
const app = express();  
const PORT = process.env.PORT || 3000;  
  
const {  
  API_KEY,  
  DOMAIN,  
  APP_ID,  
  USER_ID,  
  CLIENT_ID  
} = process.env;  
  
// CORS setup  
app.use((req, res, next) => {  
  res.header("Access-Control-Allow-Origin", "*");  
  res.header("Access-Control-Allow-Methods", "GET, OPTIONS");  
  res.header("Access-Control-Allow-Headers", "Content-Type, Authorization");  
  next();  
});  
  
// Token generator  
async function generateToken(body, baseUrl) {  
  const response = await axios.post(  
    `${baseUrl}/devapi/v4/core/login/token`,  
    body,  
    {  
      headers: {  
        "Content-Type": "application/json",  
        "x-api-key": API_KEY,  
      },  
    }  
  );  
  return response.data;  
}  
  
// Static quickstart config  
const quickstartConfig = {  
  apiKey: API_KEY,  
  userId: USER_ID,  
  clientId: CLIENT_ID,  
  appid: APP_ID,  
  dashboardId: DASHBOARD_ID,  
  orgId: "org:0",  
};  
  
// Quickstart dashboard route  
app.get("/quickstart-dashboard", async (req, res) => {  
  if (!API_KEY || !DOMAIN || !APP_ID || !USER_ID || !CLIENT_ID) {  
    return res.status(400).json({ error: "Missing required configuration." });  
  }  
  
  try {  
    const token = await generateToken(quickstartConfig, DOMAIN);  
    res.json(token);  
  } catch (err) {  
    console.error("Error generating token:", err);  
    res.status(500).json({ error: "Error generating token" });  
  }  
});  
```
Tokens:
Raw