cPanel module
InProductSurvey
1 functions, invoked through the cpanel_uapi tool.
scope cpanel:uapi
Call any function with
cpanel_uapi(service_id, module="InProductSurvey", function, params). Live availability depends on the cPanel features JetHost has enabled on your account — call list_cpanel_operations to see what is active.get_in_product_survey_url GET#
Return in-product survey banner data
This function returns whether the in-product survey banner should display for the current user and the survey link.
Notes:
- The function selects a link template based on whether the authenticated user is a webmail user or a cPanel/Team user.
- A display value of 0 means you should not render the banner UI.
No parameters.
Response — normalized as { ok, data, errors[], warnings[] }; data contains:
displaystring
Whether to display the in-product survey banner. 1 — Display the banner. 0 — Do not display the banner.
One of: 1 0
linkstring
The fully resolved survey URL.
max_dismissstring
Maximum number of dismissals allowed before the banner is suppressed.
new_userstring
Whether the authenticated user is considered new. 1 — New user experience. 0 — Established user.
One of: 1 0
submit_eventstring
Client-side analytics or event identifier emitted on successful survey submission.
server_typestring
Product/server type identifier (e.g., cpanel, whm).
user_typestring
Type of authenticated user context.
One of: cpanel webmail