Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This feature is available only to organizations with a Platinum license.

Using an API Key, Galooli clients can display Galooli dashboards on their internal platforms in a customized and branded manner.

Table of Contents
minLevel1
maxLevel6
outlinefalse
typelist
printablefalse

Request Structure

Code Block
languagec#
https://embeddedDashboard.galooli.com/embeddedDashboard?apikey=[key]&period=[days]&token=[token]
  • API Key - An individual Galooli API key that is associated with a specific dashboard in the system.

  • Period - Days back from the current date to execute the dashboard on. Galooli will verify that the period does not exceed the time range limitations.

  • Token (optional). A token will be sent by Galooli upon request, with a time to live (TTL) of two minutes. In order to receive this information, the server must send the following parameters in the request:

    • Partner's username & password

    • Period

Limitations

  • A "light" version of the dashboards will be provided to end users with the following limitations:

    • It is not possible to view the report on which the dashboard is based

    • The organization tree cannot be viewed

    • Only be able to execute favorite dashboards

  • By default, the dashboard will be applied to the entire organization. Filters can be applied to the dashboard after it has been executed by the user.

  • The end-user will only see the results of the groups he has permissions to see.

  • It is possible for each end-user to send a request to Galooli every one hour.

  • Domains from which requests are sent must be configured as authorized domains for the organization's requests.

User Flow Description

The Request

  1. A dashboard should be prepared by the client and saved as a favorite - Dashboard Designer.

  2. In order to use Galooli Embedded Dashboard, the client must submit a support ticket requesting an API key from Galooli - Support

  3. The client will get an API Key from Galooli.

The Usage

  1. User will enter the required data in the request address and enter it in the relevant platform.

  2. Once the request parameters have been verified, the login popup will appear.

Galooli will verify the user,
  1. The user will be verified by Galooli and if he

cannot login as a result of
  1. is unable to login for any reason

-
  1. , an error message will appear

in the login popup.
  • After the login, the user will view the dashboard.

  • Image Removed
    • If the partner's requests reached the execution limitations, show the following message instead of the dashboard:

    Image Removed
    1. .

    image-20240131-092550.pngImage Added
    1. The dashboard will appear once the user has logged in.

      • By clicking "Discover more", users will be redirected to Galooli's login page (where they will have to enter their credentials again).

    image-20240131-093121.pngImage Added
    • When a user's request exceeds the execution limits, a suitable message will appear instead of the dashboard.

    image-20240131-092722.pngImage Added