Request results screen URL

Intro

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

Prerequisites

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

• Request plug-in URL
• Embed plug-in

Request URL

You can retrieve the URL for the results screen 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 screen, 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 temporary plug-in results URL

GEThttps://engine.intelliprove.com/v1/plugin/make/results/{uuid}

Path parameters

UUIDstring

required

The unique reference ID for the measurement

Query parameters

apikeystring	optional	Customer API key
languagestring	optional	Set a language for the plug-in. Default is English when not given.

Request

curl

curl 'https://engine.intelliprove.com/v1/plugin/make/results/<YOUR_UUID>?apikey=<YOUR_API_KEY>'

Response

200

"https://plugin.intelliprove.com/#/measurement/result/<UUID>?action_token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyIjp7ImVtYWlsIjoiIiwiY3VzdG9tZXIiOiJ0ZXN0aW5nLWFwaS1rZXkiLCJncm91cCI6InN1cGVyLWFkbWluIiwibWF4X21lYXN1cmVtZW50X2NvdZ50IjoxMDAwMH0sIm1ldGEiOnt9LCJleHAiOjE3MDE4MjA4MDB9.CMVqCq2yFufk6oVnLbMqCW6eOc3CNjLTyR4oUyGdvdE"

401

{
    "reason": "Missing or invalid authentication credentials."
}

400

{
    "detail": "Measurement with UUID not found!"
}

422

{
    "errorCode": 99,
    "errorType": "SomeKindOfError",
    "errorDescription": "Reason why this error is thrown"
}