---
title: "Get in-product survey URL"
method: GET
path: "/get_in_product_survey_url"
tags: ["InProductSurvey"]
---

# Get in-product survey URL

`GET /get_in_product_survey_url`

This function returns whether to display the in-product survey banner and the survey link.

## Response `200`

HTTP Request was successful.

- object
  - `data` object
    - `display` '0' | '1' — Indicates whether the banner should be displayed. * `1` — Display the banner. * `0` — Do not display the banner.
    - `link` string — The fully-resolved survey URL.
    - `max_dismiss` string — Maximum number of times the banner may be dismissed before it is suppressed.
    - `new_user` '0' | '1' — Indicates whether the authenticated user is considered new. * `1` — New user. * `0` — Existing user.
    - `submit_event` string — Event identifier emitted on successful survey submission for analytics.
    - `server_type` string — Product/server type identifier.
    - `user_type` 'whm' — The user context type. Always "whm" for this endpoint.
  - `metadata` object
    - `command` string — The method name called.
    - `reason` string — The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.
    - `result` 0 | 1 — * `1` - Success * `0` - Failed. Check the `reason` field for more details.
    - `version` integer — The version of the API function.

---

[API](https://skmtc.net/cpanel/apis/whm-api.md) · [All operations](https://skmtc.net/cpanel/apis/whm-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cpanel/whm-api/revisions/3da41671c02c/schema)