{"_id":"576beb8874a8640e004cece9","category":{"_id":"576beb8874a8640e004cece1","project":"55a7ff613efe0c2f0074cbe4","version":"576beb8874a8640e004cecda","__v":0,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-05-19T18:14:58.840Z","from_sync":false,"order":6,"slug":"api-feedbacks","title":"API - Feedback"},"editedParams":true,"version":{"_id":"576beb8874a8640e004cecda","project":"55a7ff613efe0c2f0074cbe4","__v":2,"createdAt":"2016-06-23T14:00:40.149Z","releaseDate":"2016-06-23T14:00:40.149Z","categories":["576beb8874a8640e004cecdb","576beb8874a8640e004cecdc","576beb8874a8640e004cecdd","576beb8874a8640e004cecde","576beb8874a8640e004cecdf","576beb8874a8640e004cece0","576beb8874a8640e004cece1","58ee8a5737e50a2f00d12147"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2"},"parentDoc":null,"project":"55a7ff613efe0c2f0074cbe4","user":"55a7ff4f3efe0c2f0074cbe2","__v":0,"editedParams2":true,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-05-18T21:21:59.777Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","status":200,"language":"json","code":"{\n  \"conversationCount\" : 1,\n  \"conversations\":\n  [\n     {\n        \"id\": \"57504457a6cca38a00cfb4f88,\n        \"creationDate\": \"2016-06-02T14:36:07.035Z\",\n        \"lastModificationDate\": \"2016-06-02T14:36:07.035Z\",\n        \"userDisplayName\": \"Bobby Bob\",\n        \"userEmail\": \"bobby:::at:::test.com\",\n        \"questionAsked\": \"What's on your mind?\",\n        \"message\": \"I'm happy\",\n        \"tags\": [\n          \"Suggestion Box\"\n        ],\n        \"replies\": [\n            {\n            \"creationDate\": \"2016-05-30T20:16:14.633Z\",\n            \"userDisplayName\": \"Lea Pres\",\n            \"userEmail\": \"lea@test.com\",\n            \"message\": \"Ok nice!\"\n          }\n      }\n  ]\n}"}]},"settings":"","examples":{"codes":[{"language":"http","code":"https://app.officevibe.com/api/v2/feedback\nhttps://app.officevibe.com/api/v2/feedback?groupName=Officevibe&metric=MG-1"}]},"method":"get","auth":"required","params":[{"_id":"573ce10e47337f0e00b6d86e","ref":"","in":"query","required":false,"desc":"The name of the group to retrieve feedback. If null, it retrieves feedback for All Company.","default":"","type":"string","name":"groupName"},{"_id":"573ce10e47337f0e00b6d86d","ref":"","in":"query","required":false,"desc":"Filter the feedback with a specific metric, ex : \"MG-1\". See documentation below.","default":"","type":"string","name":"metric"},{"_id":"573ce10e47337f0e00b6d86c","ref":"","in":"query","required":false,"desc":"Filter the feedback with a specific tone, ex : \"FP\". See documentation below.","default":"","type":"string","name":"tone"},{"_id":"573ce10e47337f0e00b6d86b","ref":"","in":"query","required":false,"desc":"Filter the feedback with a specific type, ex : \"POLL\". See documentation below.","default":"","type":"string","name":"type"},{"_id":"573ce10e47337f0e00b6d86a","ref":"","in":"query","required":false,"desc":"Filter the feedback with a specific label, ex : \"CT-1\". See documentation below.","default":"","type":"string","name":"label"},{"_id":"574f3b031866ba2000108382","ref":"","in":"query","required":false,"desc":"Filter the feedback from a specified date.","default":"","type":"yyyy-mm-dd","name":"fromDate"},{"_id":"574f3b031866ba2000108381","ref":"","in":"query","required":false,"desc":"Filter the feedback to a specified date.","default":"","type":"yyyy-mm-dd","name":"toDate"}],"url":"/feedback"},"isReference":true,"order":0,"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Metric Ids\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"Recognition\",\n    \"h-0\": \"Metric Name\",\n    \"h-1\": \"Metric Key\",\n    \"0-1\": \"MG-1\",\n    \"1-0\": \"Feedback\",\n    \"2-0\": \"Relationship With Colleagues\",\n    \"3-0\": \"Relationship With Managers\",\n    \"4-0\": \"Satisfaction\",\n    \"5-0\": \"Company Alignment\",\n    \"6-0\": \"Happiness\",\n    \"7-0\": \"Wellness\",\n    \"8-0\": \"Personal Growth\",\n    \"9-0\": \"Ambassadorship\",\n    \"1-1\": \"MG-2\",\n    \"2-1\": \"MG-3\",\n    \"3-1\": \"MG-4\",\n    \"4-1\": \"MG-5\",\n    \"5-1\": \"MG-6\",\n    \"6-1\": \"MG-7\",\n    \"7-1\": \"MG-8\",\n    \"8-1\": \"MG-9\",\n    \"9-1\": \"MG-10\"\n  },\n  \"cols\": 2,\n  \"rows\": 10\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Tone Ids\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"Positive\",\n    \"1-0\": \"Constructive\",\n    \"0-1\": \"FP\",\n    \"1-1\": \"FC\",\n    \"h-0\": \"Tone Name\",\n    \"h-1\": \"Tone Key\"\n  },\n  \"cols\": 2,\n  \"rows\": 2\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Type Ids\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"Questionnaire Feedback\",\n    \"1-0\": \"Poll Feedback\",\n    \"2-0\": \"Suggestion Box Feedback\",\n    \"0-1\": \"GEN\",\n    \"1-1\": \"POLL\",\n    \"2-1\": \"BOX\",\n    \"h-0\": \"Type Name\",\n    \"h-1\": \"Type Key\"\n  },\n  \"cols\": 2,\n  \"rows\": 3\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Label Ids\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"Custom label 1\",\n    \"1-0\": \"Custom label 2\",\n    \"2-0\": \"Custom label 3\",\n    \"3-0\": \"Custom label 4\",\n    \"4-0\": \"Custom label 5\",\n    \"5-0\": \"Custom label 6\",\n    \"0-1\": \"CT-1\",\n    \"1-1\": \"CT-2\",\n    \"2-1\": \"CT-3\",\n    \"3-1\": \"CT-4\",\n    \"4-1\": \"CT-5\",\n    \"5-1\": \"CT-6\",\n    \"h-0\": \"Labels\",\n    \"h-1\": \"Label Key\"\n  },\n  \"cols\": 2,\n  \"rows\": 6\n}\n[/block]","excerpt":"This request returns feedback conversations.","slug":"feedbacklist","type":"endpoint","title":"/feedback"}

get/feedback

This request returns feedback conversations.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

groupName:
string
The name of the group to retrieve feedback. If null, it retrieves feedback for All Company.
metric:
string
Filter the feedback with a specific metric, ex : "MG-1". See documentation below.
tone:
string
Filter the feedback with a specific tone, ex : "FP". See documentation below.
type:
string
Filter the feedback with a specific type, ex : "POLL". See documentation below.
label:
string
Filter the feedback with a specific label, ex : "CT-1". See documentation below.
fromDate:
yyyy-mm-dd
Filter the feedback from a specified date.
toDate:
yyyy-mm-dd
Filter the feedback to a specified date.

Examples


Result Format


Documentation

[block:api-header] { "type": "basic", "title": "Metric Ids" } [/block] [block:parameters] { "data": { "0-0": "Recognition", "h-0": "Metric Name", "h-1": "Metric Key", "0-1": "MG-1", "1-0": "Feedback", "2-0": "Relationship With Colleagues", "3-0": "Relationship With Managers", "4-0": "Satisfaction", "5-0": "Company Alignment", "6-0": "Happiness", "7-0": "Wellness", "8-0": "Personal Growth", "9-0": "Ambassadorship", "1-1": "MG-2", "2-1": "MG-3", "3-1": "MG-4", "4-1": "MG-5", "5-1": "MG-6", "6-1": "MG-7", "7-1": "MG-8", "8-1": "MG-9", "9-1": "MG-10" }, "cols": 2, "rows": 10 } [/block] [block:api-header] { "type": "basic", "title": "Tone Ids" } [/block] [block:parameters] { "data": { "0-0": "Positive", "1-0": "Constructive", "0-1": "FP", "1-1": "FC", "h-0": "Tone Name", "h-1": "Tone Key" }, "cols": 2, "rows": 2 } [/block] [block:api-header] { "type": "basic", "title": "Type Ids" } [/block] [block:parameters] { "data": { "0-0": "Questionnaire Feedback", "1-0": "Poll Feedback", "2-0": "Suggestion Box Feedback", "0-1": "GEN", "1-1": "POLL", "2-1": "BOX", "h-0": "Type Name", "h-1": "Type Key" }, "cols": 2, "rows": 3 } [/block] [block:api-header] { "type": "basic", "title": "Label Ids" } [/block] [block:parameters] { "data": { "0-0": "Custom label 1", "1-0": "Custom label 2", "2-0": "Custom label 3", "3-0": "Custom label 4", "4-0": "Custom label 5", "5-0": "Custom label 6", "0-1": "CT-1", "1-1": "CT-2", "2-1": "CT-3", "3-1": "CT-4", "4-1": "CT-5", "5-1": "CT-6", "h-0": "Labels", "h-1": "Label Key" }, "cols": 2, "rows": 6 } [/block]

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}