Dashboard Integrations
Dashboard Answers
For Answers which are a dashboard within the provider’s content, we require an Answer Preview image to be supplied along with the dashboard embed code. This preview is used in cases where embeds are either unsupported or would not be feasible to load. The image asset loads much faster than any dashboard and scales better when used in a preview setting.
For this placeholder image, we also recommend a 16:9 image as this will maximize rendering effectiveness across the wide variety of screen sizes and represented in Answer Cards. This is very likely the same image asset as Answer Preview, as this is the most common use case for preview images of dashboards. Preview images will automatically scale to fit the screen space given. Rasterized text is encouraged to demonstrate the value of the dashboard, but text along the edges of images may not be readable depending on cropping.
Once the Answer is open, you can take up as much height as you want, however be sure to prioritize content so that the first screen shows the most value. Don't make users scroll unless necessary.
Figure 1 – Lucy Dashboard Answer.
Answers Specifications
Answer Card - Top Answer
- 419~926px width (depending on window size).
- 240px height.
Answer Card - Rest of Answers
- 419px width.
- 236px height.
Answer Opened View
- 419~926px width (depending on window size).
- Height grows to fit content.
Recommended Answer User Interface
For custom integrations with 3rd party data sources in Lucy, it may be desirable to show content other than a slide of a presentation or a page of a document. This is especially true for dashboard-type content where the link out opens an analytics tool (e.g., Tableau, PowerBI, etc.). In this case, Lucy recommends the following to all data providers to support a mutually beneficial Answer experience which best showcases the providers’ content.
Answer Preview
Answer Preview, also known as Answer Cards, represent an Answer throughout the UI any time it is not opened. For the Answer Preview, we recommend a 16:9 image as this will maximize rendering effectiveness across the wide variety of screen sizes and represented in Answer Cards. Images will automatically scale to fit the screen space given.
Figure 2 – Lucy Answer Preview.
Answer Opened View
Once the Answer is open, the integration provider can take up as much height as they want, however be sure to prioritize content so that the first screen shows the most value. We want to discourage providers from making users scroll unless necessary.
Figure 3 – Lucy Answer Opened View.
Sample API Endpoint
Content providers also have the option of building and supporting their own API to integration and share data with Lucy through any system that supports receiving or making API calls. This example combines Lucy’s utterance/subject extraction model to provide various embedded dashboards as supplied. The utterances are keyed to a “queryType” which hints to which dashboards to supply for a given subject. Note if API fails, takes too long to respond (greater than 4 seconds), or responds with not found, no dashboards will be shown.
Usage
GET https://api.sample.co/lucyParameters
| Parameter | Description | Comment |
|---|---|---|
query | Search query or users’ question | Required |
queryType | Determines which embed to display; extracted from query | Optional |
Table 1 – Sample API parameters.
For example, a Lucy user could ask either of the questions below which would both be considered utterances. Lucy would send the query to the API endpoint along with the queryType to determine which embed to display based on a predefined list of queries and available subjects.
- “What’s trending in online shopping?”
- “What are popular purchases with gen z?”
Response Object
A typical response is a JSON object, that has the following structure:
{"hasData": true,"token": "sample token here","lucy": [{"lucy_url": "https://api.sample.co/lucy/trend-overview?terms=onlineshoping&token=[token]","tracking_url": "","title": "Trend Overview for Online Shopping","deep_link": "https://api.sample.co/sso/clientX?RelayState= solutions/trend-overview/reports/spotlight?terms=onlineshopping","preview_url": {"wide": "https://static.sample.co/lucy/Overview/lucy_trend_overview.jpg","square": "https://static.sample.co/lucy/Overview/lucy_trend_overview.jpg"}},{" lucy_url": "https://api.sample.co/lucy/purchases-overview?terms=genz&token=[token]","tracking_url": "","title": "Purchases for Gen Z","deep_link": "https://api.sample.co/sso/clientX?RelayState= solutions/purchases-overview/reports/spotlight?terms=genz","preview_url": {"wide": "https://static.sample.co/lucy/Overview/lucy_purchases_overview.jpeg","square": "https://static.sample.co/Lucy/Overview/lucy_Purchases_Overview.jpg"}}]}
| Object | Comment |
|---|---|
| Is there data available for the specific query |
| The authentication token to be used |
| An array of embeddable widgets; each widget has the following fields as presented in the table below |
| A link to platform for the specific widget |
| Widget title for embedding in Lucy answer |
| A link to SSO login screen |
| Images pair (wide and square) to be used for embedding inside Lucy answers |
Table 2 – Sample API objects.
Error Response Statuses
400: A required parameter is missing. See response body for more information. A typical error response body:
{"error":true,"message":"(field) must be provided"