Embed Visualization Widget (Beta)

Embed predefined visualizations of your users' data in your web app with the Thryve Visualization Widget. Request a visualization by specifying the template ID and optional parameters in a REST API call. Then embed the returned URL in an iframe.

The API request creates a visualizationSessionToken that the widget uses to authorize and identify the user. For security, the token expires after 15 minutes. Your web app must handle expiration and create a new session.

Visualization widgets are in beta. We plan to add more templates over time. If you want a new template or have feedback on an existing one, contact our product team through the support center.

Templates

templateId	Name
100	Daily Totals
101	Social Jet Lag

Create a visualization session

post

Creates a new visualization session for the given end user and template. Returns a short-lived URL to be embedded in an iframe or WebView.

Header parameters

AuthorizationstringRequired

Basic Auth credentials for the customer account. Format: Basic <base64(username:password)>.

Example: Basic dXNlcm5hbWU6cGFzc3dvcmQ=

AppAuthorizationstringRequired

Basic Auth credentials for the app. Format: Basic <base64(authId:authSecret)>.

Example: Basic YXV0aElkOmF1dGhTZWNyZXQ=

Body

endUserIdstringRequired

Thryve end user identifier. This is the same identifier returned when the user was created.

Example: 846d36baf7133d06e940e683e9b1e323

templateIdinteger · enumRequired

Visualization template to render.

Possible values:

localestringOptional

ISO 639-1 locale code. Controls the widget's display language. Defaults to en. Available languages: ar,bg,cs,da,de,el,en,es,et,fi,fr,hu,id,it,ja,ko,lt,lv,nl,pl,pt,ro ,ru, sk, sl, sv, tr, uk`

Example: en

configobjectOptional

Template-specific configuration. All fields are optional and fall back to server-side defaults when omitted. Shape depends on templateId — see Templates section.

Responses

200

Session created. Embed the returned url in an iframe or WebView.

application/json

urlstring · uriRequiredExample: https://visualization-widget.thryve.health/?visualizationSessionToken=a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5&lang=en

visualizationSessionTokenstringRequiredExample: a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5

localestringRequiredExample: en

400

Request validation failed. Typically caused by an invalid endUserId format, a missing required field, an unrecognised config property, or an invalid field value.

application/json

401

Authentication failed.

application/json

404

The specified templateId does not exist.

application/json

500

Unexpected server error.

application/json

post/widget/v6/visualization

POST /widget/v6/visualization HTTP/1.1
Host: api.thryve.de
Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=
AppAuthorization: Basic YXV0aElkOmF1dGhTZWNyZXQ=
Content-Type: application/json
Accept: */*
Content-Length: 65

{
  "endUserId": "846d36baf7133d06e940e683e9b1e323",
  "templateId": 101
}

{
  "url": "https://visualization-widget.thryve.health/?visualizationSessionToken=a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5&lang=en",
  "visualizationSessionToken": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5",
  "locale": "en"
}