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.

SecurityBasicAuth

Responses

200

HTTP Request was successful.

Response Schema: application/json

apiversion	integer The version of the API.
func	string The name of the method called.
module	string The name of the module called.
	object

get/InProductSurvey/get_in_product_survey_url

Request samples

CLI
URL
LiveAPI Perl
LiveAPI PHP

uapi --output=jsonpretty \
--user=username \
InProductSurvey \
get_in_product_survey_url

Response samples

application/json

{"apiversion": 3,
"func": "get_in_product_survey_url",
"module": "InProductSurvey",
"result": {"data": {"display": "1",
"link": "https://survey.example.tld/some/generated/link",
"max_dismiss": "3",
"new_user": "0",
"submit_event": "survey_submitted",
"server_type": "cpanel",
"user_type": "cpanel"
},
"errors": null,
"messages": null,
"metadata": { },
"status": 1,
"warnings": null
}
}