# Surveys Plugin documentation?

**URL:** https://meta.discourse.org/t/surveys-plugin-documentation/209310
**Category:** Support
**Tags:** surveys
**Created:** [November 16, 2021, 4:08pm UTC](https://meta.discourse.org/t/surveys-plugin-documentation/209310 "2021-11-16T16:08:05Z")
**Posts on this page:** 13
**Page:** 1

<div class="post-metadata">

### Author: ![Nick\_Chomey](https://sea3.discourse-cdn.com/meta/user_avatar/meta.discourse.org/nick_chomey/32/215378_2.png) [@Nick\_Chomey](https://meta.discourse.org/u/Nick_Chomey)
#### Post date: [November 16, 2021, 4:08pm UTC](https://meta.discourse.org/t/surveys-plugin-documentation/209310/1 "2021-11-16T16:08:05Z")

</div>

I installed the Surveys plugin from the Discourse repo ( [discourse/discourse-surveys (github.com)](https://github.com/discourse/discourse-surveys/)) but can’t figure out how to actually use it. There also doesn’t appear to be any documentation for it here on Meta.

Any tips?

---

<div class="post-metadata">

### Author: ![IAmGav](https://sea3.discourse-cdn.com/meta/user_avatar/meta.discourse.org/iamgav/32/235598_2.png) [@IAmGav](https://meta.discourse.org/u/IAmGav)
#### Post date: [November 16, 2021, 5:39pm UTC](https://meta.discourse.org/t/surveys-plugin-documentation/209310/2 "2021-11-16T17:39:36Z")

</div>

@techAPJ can you shed some light on this plugin please 🙂

---

<div class="post-metadata">

### Author: ![techAPJ](https://sea3.discourse-cdn.com/meta/user_avatar/meta.discourse.org/techapj/32/342990_2.png) [@techAPJ](https://meta.discourse.org/u/techAPJ)
#### Post date: [November 17, 2021, 2:42pm UTC](https://meta.discourse.org/t/surveys-plugin-documentation/209310/3 "2021-11-17T14:42:32Z")

</div>

The Surveys plugin was written for a customer with their specific use case in mind. I do not have a documentation handy. Will try to write one next week.

---

<div class="post-metadata">

### Author: ![Nick\_Chomey](https://sea3.discourse-cdn.com/meta/user_avatar/meta.discourse.org/nick_chomey/32/215378_2.png) [@Nick\_Chomey](https://meta.discourse.org/u/Nick_Chomey)
#### Post date: [November 17, 2021, 2:43pm UTC](https://meta.discourse.org/t/surveys-plugin-documentation/209310/4 "2021-11-17T14:43:25Z")

</div>

@techAPJ Thanks! Could you at least point out how I can even use it? Is there a particular button, menu, markdown code, etc… that allows you to use it? I can’t find anything to even tinker with.

---

<div class="post-metadata">

### Author: ![techAPJ](https://sea3.discourse-cdn.com/meta/user_avatar/meta.discourse.org/techapj/32/342990_2.png) [@techAPJ](https://meta.discourse.org/u/techAPJ)
#### Post date: [November 17, 2021, 2:45pm UTC](https://meta.discourse.org/t/surveys-plugin-documentation/209310/5 "2021-11-17T14:45:12Z")

</div>

Here’s a basic survey markdown with all available fields:

```plaintext
[survey name="awesome-survey-thumbs" title="Awesome Survey"]

[radio question="Choose any one option:"]
- cat
- dog
[/radio]

[checkbox question="Choose multiple options:"]
- red
- blue
- green
[/checkbox]

[dropdown question="Gender:"]
- Male
- Female
[/dropdown]

[number question="Rate this survey from 1 to 10:"]
[/number]

[textarea question="What is your feedback about xyz?" required="false"]
[/textarea]

[star question="How would you rate overall experience?"]
[/star]

[thumbs question="Were you satisfied with our services?"]
[/thumbs]

[/survey]

```

---

<div class="post-metadata">

### Author: ![Nick\_Chomey](https://sea3.discourse-cdn.com/meta/user_avatar/meta.discourse.org/nick_chomey/32/215378_2.png) [@Nick\_Chomey](https://meta.discourse.org/u/Nick_Chomey)
#### Post date: [November 17, 2021, 2:49pm UTC](https://meta.discourse.org/t/surveys-plugin-documentation/209310/6 "2021-11-17T14:49:34Z")

</div>

Thanks! Very cool!

Where can I see the results? The survey creator (an admin user) only sees the following after submission by a couple users.

 ![image](https://global.discourse-cdn.com/meta/original/3X/d/e/dee0139ada7e1464dd496aa836901f3915652aa4.png)

It would also be useful if survey responders could see the results as well.

---

<div class="post-metadata">

### Author: ![techAPJ](https://sea3.discourse-cdn.com/meta/user_avatar/meta.discourse.org/techapj/32/342990_2.png) [@techAPJ](https://meta.discourse.org/u/techAPJ)
#### Post date: [November 17, 2021, 2:51pm UTC](https://meta.discourse.org/t/surveys-plugin-documentation/209310/7 "2021-11-17T14:51:58Z")

</div>

Currently there is no interface to view survey results. I did write some [data explorer](https://meta.discourse.org/t/32566?silent=true) queries to view survey results. I’ll dig those up and post them along with documentation sometime next week.

---

<div class="post-metadata">

### Author: ![Nick\_Chomey](https://sea3.discourse-cdn.com/meta/user_avatar/meta.discourse.org/nick_chomey/32/215378_2.png) [@Nick\_Chomey](https://meta.discourse.org/u/Nick_Chomey)
#### Post date: [November 17, 2021, 2:55pm UTC](https://meta.discourse.org/t/surveys-plugin-documentation/209310/8 "2021-11-17T14:55:39Z")

</div>

ah ok. Thanks. I look forward to seeing the docs! Moreover, if you’re ever able to create some sort of front-end display/interface, that would be fantastic! Until then, I suspect I and most people will have to stick to Polls

---

<div class="post-metadata">

### Author: ![nathank](https://sea3.discourse-cdn.com/meta/user_avatar/meta.discourse.org/nathank/32/290039_2.png) [@nathank](https://meta.discourse.org/u/nathank)
#### Post date: [November 17, 2021, 6:23pm UTC](https://meta.discourse.org/t/surveys-plugin-documentation/209310/9 "2021-11-17T18:23:09Z")

</div>

You can also use the [Custom Wizard plugin](https://meta.discourse.org/t/custom-wizard-plugin/73345) for surveys plus more.

---

<div class="post-metadata">

### Author: ![Nick\_Chomey](https://sea3.discourse-cdn.com/meta/user_avatar/meta.discourse.org/nick_chomey/32/215378_2.png) [@Nick\_Chomey](https://meta.discourse.org/u/Nick_Chomey)
#### Post date: [November 17, 2021, 7:04pm UTC](https://meta.discourse.org/t/surveys-plugin-documentation/209310/10 "2021-11-17T19:04:42Z")

</div>

Woah, i had no idea that existed. That looks very cool. Its not clear to me how this would provide survey capabilities, but I could definitely make use of it for other things.

---

<div class="post-metadata">

### Author: ![nathank](https://sea3.discourse-cdn.com/meta/user_avatar/meta.discourse.org/nathank/32/290039_2.png) [@nathank](https://meta.discourse.org/u/nathank)
#### Post date: [November 17, 2021, 8:00pm UTC](https://meta.discourse.org/t/surveys-plugin-documentation/209310/11 "2021-11-17T20:00:00Z")

</div>

You simply use it to ask questions, with most HTML survey stuff supported. The data is collected nicely as a .csv that you can then mess with as much as you like. You can force it upon users (if you wish) or target it nicely.

There is quite a learning curve though.

---

<div class="post-metadata">

### Author: ![Nick\_Chomey](https://sea3.discourse-cdn.com/meta/user_avatar/meta.discourse.org/nick_chomey/32/215378_2.png) [@Nick\_Chomey](https://meta.discourse.org/u/Nick_Chomey)
#### Post date: [November 17, 2021, 9:13pm UTC](https://meta.discourse.org/t/surveys-plugin-documentation/209310/12 "2021-11-17T21:13:52Z")

</div>

Thanks very much. I’ll put it on the backburner for now, but good to know it exists!

---

<div class="post-metadata">

### Author: ![system](https://sea3.discourse-cdn.com/meta/user_avatar/meta.discourse.org/system/32/443519_2.png) [@system](https://meta.discourse.org/u/system)
#### Post date: [December 18, 2021, 10:47am UTC](https://meta.discourse.org/t/surveys-plugin-documentation/209310/14 "2021-12-18T10:47:42Z")

</div>

This topic was automatically closed 30 days after the last reply. New replies are no longer allowed.
