Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.gleap.io/llms.txt

Use this file to discover all available pages before exploring further.

Gleap allows you to create micro surveys to be run directly in your Gleap widget. We offer templates for some of the most common survey types, such as NPS scores, product market fit or product satisfaction.

​
Sending surveys with triggers

Usually customers use triggers to send surveys. Example use cases for that include:
  • Sending surveys after a certain amount of time
  • Sending a survey on a certain page
  • Sending a survey after a specific event happened
  • …
In order to get started with survey triggers, you need to start tracking events. Once an event has been tracked, you can use it as trigger in the survey options. You can find more information about tracking events here. Gleap survey triggers

​
Manually sending surveys

You can also manually send surveys to your users. For this you only need to call the following method: 
Gleap.showSurvey({
  surveyId: "survey_id",
  format: "survey",
});
The first parameter is the survey id, the second parameter is the format of the survey. The format can be either survey (default: card style survey) or survey_full (full screen survey).
Please note that the Gleap SDK needs to be fully initialized to be able to show a survey.

​
Send surveys with URL parameters (Web SDK only)

You can also send surveys with URL parameters. This is useful if you want to send surveys to specific users. For example, you can send a survey to a specific user by sending them a link like this: 
https://yourapp.com/?gleap_survey=\{your-survey-id\}&gleap_survey_format=\{survey\}
Please replace {your-survey-id} with your survey id and {survey} with the survey format. The survey format can be either “survey” (default: card style survey) or “survey_full” (full screen survey).
The application that you use for sending surveys with URL parameters needs to have the Gleap SDK installed.