# 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.



* The function selects a link template based on whether the authenticated user is a webmail user or a cPanel/Team user.
* A  value of  means you should not render the banner UI.

Endpoint: GET /InProductSurvey/get_in_product_survey_url
Version: 11.134.0.5
Security: BasicAuth

## Response 200 fields (application/json):

  - `apiversion` (integer)
    The version of the API.
    Example: 3

  - `func` (string)
    The name of the method called.
    Example: "get_in_product_survey_url"

  - `module` (string)
    The name of the module called.
    Example: "InProductSurvey"

  - `result` (object)

  - `result.data` (object)
    The in-product survey banner data.
    Example: {"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"}

  - `result.data.display` (string)
    Whether to display the in-product survey banner.
*  — Display the banner.
*  — Do not display the banner.
    Enum: "1", "0"

  - `result.data.link` (string)
    The fully resolved survey URL.
    Example: "https://survey.example.tld/some/generated/link"

  - `result.data.max_dismiss` (string)
    Maximum number of dismissals allowed before the banner is suppressed.
    Example: "3"

  - `result.data.new_user` (string)
    Whether the authenticated user is considered new.
*  — New user experience.
*  — Established user.
    Enum: "1", "0"

  - `result.data.submit_event` (string)
    Client-side analytics or event identifier emitted on successful survey submission.
    Example: "survey_submitted"

  - `result.data.server_type` (string)
    Product/server type identifier (e.g., cpanel, whm).
    Example: "cpanel"

  - `result.data.user_type` (string)
    Type of authenticated user context.
    Enum: "cpanel", "webmail"

  - `result.errors` (array,null)
    List of errors if the API failed.

  - `result.messages` (array,null)
    List of messages generated by the API.

  - `result.metadata` (object)

  - `result.status` (integer)
    *  — Success.
*  — Failed. Check the  field for more details.
    Enum: 1, 0

  - `result.warnings` (array,null)
    List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running an API.