A survey's completion and per-question results
GET
/api/v1/workspaces/{workspace}/surveys/{surveyId}/results
package main
import ( "fmt" "net/http" "io")
func main() {
url := "https://reputecast.example.com/api/v1/workspaces/acme-newsletter/surveys/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/results"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close() body, _ := io.ReadAll(res.Body)
fmt.Println(res) fmt.Println(string(body))
}const url = 'https://reputecast.example.com/api/v1/workspaces/acme-newsletter/surveys/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/results';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://reputecast.example.com/api/v1/workspaces/acme-newsletter/surveys/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/results \ --header 'Authorization: Bearer <token>'Permission: reports:view
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”workspace
required
Workspace slug
string
Workspace slug
surveyId
required
Survey id
string format: uuid
Survey id
Responses
Section titled “Responses”OK
Media typeapplication/json
object
completed
required
integer format: int64
completionPercent
required
number format: double
nonContacts
required
integer format: int64
pollOnly
required
integer format: int64
questions
required
Array<object>
object
answered
required
integer format: int64
counts
required
Array<object>
object
count
required
integer format: int64
emoji
string
key
required
integer format: int64
label
required
string
percent
required
number format: double
tag
string
key
required
string
nps
object
detractorPercent
required
number format: double
detractors
required
integer format: int64
passivePercent
required
number format: double
passives
required
integer format: int64
promoterPercent
required
number format: double
promoters
required
integer format: int64
score
required
integer format: int64
number
required
integer format: int64
required
required
boolean
savedTo
string
text
required
string
type
required
string
recipients
required
integer format: int64
started
required
integer format: int64
Example generated
{ "completed": 1, "completionPercent": 1, "nonContacts": 1, "pollOnly": 1, "questions": [ { "answered": 1, "counts": [ { "count": 1, "emoji": "example", "key": 1, "label": "example", "percent": 1, "tag": "example" } ], "key": "example", "nps": { "detractorPercent": 1, "detractors": 1, "passivePercent": 1, "passives": 1, "promoterPercent": 1, "promoters": 1, "score": 1 }, "number": 1, "required": true, "savedTo": "example", "text": "example", "type": "example" } ], "recipients": 1, "started": 1}default
Section titled “default”Error
Media typeapplication/problem+json
object
code
Stable error code, e.g. permission_denied
string
detail
A human-readable explanation specific to this occurrence of the problem.
string
errors
Optional list of individual error details
Array<object>
object
location
Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’
string
message
Error message text
string
value
The value at the given location
helpers
Members who hold the missing permission
Array<string>
instance
A URI reference that identifies the specific occurrence of the problem.
string format: uri
meta
object
key
additional properties
permission
The missing permission key
string
status
HTTP status code
integer format: int64
title
A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
string
type
A URI reference to human-readable documentation for the error.
string format: uri
Example
{ "detail": "Property foo is required but is missing.", "instance": "https://example.com/error-log/abc123", "status": 400, "title": "Bad Request", "type": "about:blank"}