Skip to main content

What’s New

Qrvey 8.7
Version 8.7 of the Qrvey platform is now available to customers! This version includes new features including area charts, the ability to pivot and export data, as well as numerous bug fixes and performance improvements.
Learn More
Qrvey 8.6
Version 8.6 of the Qrvey platform is now available to customers. This version includes several new feature enhancements and performance improvements.
Learn More
Required Update for 8.5.1
Attention 8.5.1 customers: for any 8.5.1 instance deployed prior to 08/05/2024, an update is required to ensure you are running the latest images.
Learn More
Qrvey 8.5
Version 8.5 (LTS) of the Qrvey platform is now available to customers. This version includes several new features and performance improvements.
Learn More
End-of-life Schedule
We've added a new article that lists the features and endpoints that have been scheduled for deprecation. All features and endpoints will be supported for (1) year after the release date of the LTS version that contains the alternative.
Learn More
Version: 8.7

Pixel-perfect Reports

The Pixel-perfect Reports widget enables you to embed the Pixel-perfect Reports feature in an application.

Embeddable Script​

<!-- Tag -->
<qrvey-pixel-builder settings="config"></qrvey-pixel-builder>

<!-- Config -->
<script>
  var config = {
    apiKey: "<YOUR_PRIVATE_API_KEY>",
    domain: "<DOMAIN>",
    userId: "<USER_ID>",
    appId: "<APP_ID>"
  };
</script>

<!-- Launcher -->
<script type="text/javascript" src="https://<YOUR_QRVEY_DOMAIN>/widgets-launcher/app.js?2024-07-15T17:26:30.135Z"></script>

Configuration Object​

PropertyValueRequired
qvTokenString, Encrypted token used for secure authentication.Required, if apiKey is not provided
apiKeyString, Your organization’s unique API key required to access the Qrvey platform.Required, if qvToken is not provided.
domainString, The base URL of your Qrvey instance.Required
appIdString, ID of the Qrvey application that contains the asset you want to embed.Required
userIdString, ID of the Qrvey Composer user account accessing this feature. Optional: You can alternately specify the user ID in a Qrvey session cookie.Required
clientidString, Unique identifier for the tenant end user. Required for using the End User Personalization and Download Manager features. The client ID must be set to a unique value for each tenant end user.Optional
timezoneObject, Overrides the time zone setting in Qrvey Admin Center. Please see The timezone Object for details.Optional
reportIdString, Used to embed a specific report by ID. If omitted, this embeds the "browse all reports" page.Optional
showFormulasButtonBoolean, Shows or hides the formula modal button in the toolbar. It is "visible" by default.Optional
showBucketsButtonBoolean, Shows or hides the bucket modal button in the toolbar. It is "visible" by default.Optional
parameterValuesObject, Enables you to set the value of a pixel perfect parameter. This value will override the default value set for the parameter. Pattern: { key1: value1, key2: value2 } Example: { parameterName: paramVal }.Optional
defaultModeString, either "preview" or "design". A value of "preview" enables users to embed the Pixel-perfect Reports in preview mode. Defaults to "design" if not set.Optional

Timezone​

For more information, see Configuring Time Zone Settings.

ParameterDescriptionRequired
offsetstring, Time to offset by. Pattern: {"HH:MM" } Example: { "offset": "-1:00" }Optional