Posts
Wiki

Getting Started with Community Survey

This wiki page is a guide to help you create and publish your first Community Survey, and start receiving feedback from your subreddit members!

1. Installing Community Survey

To install Community Survey, go to the Community Survey App Page ( https://developers.reddit.com/apps/community-survey)). There should be a "+ Add to Community" button after the App description:

You will then see a dialog appear to confirm the app permissions. If you have questions about how the app handles user data, refer to the Terms and Privacy page. In summary, the app only stores the minimum necessary data required for app functionality (User IDs and their survey responses). Currently, the "everything" mod permission is needed for all Devvit apps. If you have a question of what the app may do as a moderator, please feel free to reach out or review the source code yourself! No mod actions are taken unless necessary for app performance/function!

On the next screen, you can choose the community you wish to install the app on, then choose "Install app".

Congratulations! Community Survey is now installed and ready to use!

Next we will show you how to create the "Survey Hub", where you will be able to manage your community's surveys.


2. Create the Survey Hub

The Survey Hub acts as a central place for users to see surveys created by mods. It is also used by mods to launch the Survey Dashboard: where surveys are created, edited, published, and more.

To create the "Survey Hub" post, first go to your subreddit's main page/feed. On desktop, in the upper right next to the "Mod Tools" button, you should see a button with three ellipses. In the mobile apps, the ellipses also appear in the upper right. Once the menu is open, choose the "Create Survey Hub" option. It will create the new post and redirect you there!

In the future (say in 3 months), if you cannot find the hub post, you can follow the same steps to be directed to the original hub post. A fail-safe is added so two requests to create a hub within the same minute or if the post does not exist, it will force a new hub post to be created.


3. Creating a Survey

Once the Survey Hub post is created, you can launch the dashboard editor by clicking the [Survey Editor] button. This button is only visible to moderators.

The Survey Dashboard will list only your surveys you have created. Currently, you cannot see the surveys other mods have created. This will likely change in a future release.

Surveys follow the following "lifecycle":

  • Draft- When a survey is being worked on, and not yet published

  • Scheduled- When a survey has been set with a publish date, but not yet published. You may still edit a survey in this state.

  • Live- The survey has been published and is open to receive responses.

  • Closed- The survey has been closed ans is no longer able to receive responses.

  • Delete Queued - When a survey has been queued fo be delered.

From the list you can see the status of each of your surveys. If the survey is editable (not yet published), you can edit them. Surveys that are live cannot be edited, but may be viewed or closed early. Only draft or closed surveys may be deleted.

To create a new survey, choose the green [+ New] button in the upper right. This will display the Survey Editor. The first section is for the Survey Settings. Here you will see three settings tabs (1): Survey Title, Responder Criteria, and Survey Settings.

Survey Title and Intro

By default, you will first see the survey Title (2) and Intro (3) inputs. These are displayed to the user right above the Start Survey button in the survey post that appears in feeds.

The intro text accepts the following Markdown formatting:

  • Paragraphs - One empty line

  • Line Break - Two spaces at line end

  • **Bold Text**

  • *Italicised Text*

  • _Underlined Text_

  • Strike Through

  • [Link Text](https://link.com/path)

This is an example of **markdown formated** text. It *might not* make much
sense, but is __effective__ at showing the formatting ~~logic~~ syntax.

You may also inlcude [page links](https://reddit.com) and force<space><space>
line breaks where you want.

Responder Criteria

The next tab is called "Responder Criteria". This tab will allow you to choose which users can respond to your survey. The criteria options are all inclusive, meaning all selections must apply. However, user flair restrictions are "one must apply". For example, setting a minimum age of 30 days AND user has either Flair A OR Flair B.

  • Verified Email - Only users who have a verified email on their account can respond.

  • Approved Users - Only subreddit approved users can respond.

  • Minimum Account Age (Days)- A user's account must be this many days old to respond.

  • Minimum Account Karma - A user's account must have a minimum Post, Comment, or total karma to respond.

  • Minimum Account Karma Value - The minimum karma amount, based on the selector above.

    Negative numbers are allowed.

  • User Flair - Only users with the selected flair(s) may respond. This list of flairs is pulled from the sub's user flair list!

Survey Settings

This tab currently only has one option, but other options are coming soon!

  • Result Visibility - Choose whether results are always visible, only when survey has closed, once a user has completed the survey, or only mods can see results.

  1. Question Types

  2. Viewing responses