Plug-in solution

Request results page URL

Intro

Instead of requesting the URL for the complete plug-in with the recording page, as described in Request plug-in URL, you can also request the URL for just the results page of a previously performed health check. This allows you to display the results page anywhere in your app. This might be handy for certain use cases, such as the Custom questions page before results use case.

Prerequisites

Make sure you've gone through the documentation below or have already set this up before.

Request URL

You can retrieve the URL for the results page by calling the API endpoint below and providing the UUID of the health check. The UUID uniquely identifies the health check and can be retrieved via the Message events that are sent by the plug-in during the recording phase.

To display the results page, you can follow the same procedure as for the complete plug-in, but with a different iframe src URL loaded. Head back to Embed in web app or Embed in mobile app for more information about how to accomplish this.

GET
Request
Path Params
UUID
required
String
The unique reference ID for the measurement
Query Parameters
apikey
optional
String
Customer API key
language
optional
String
Set a language for the plug-in. Default is English when not given.
Curl
Responses
200
401
400
422