Feedback, now known as Surveys in the app, are internal surveys a business can collect from their end clients. Typically, these are measured as NPS or CSAT.
| Attribute | Type | Description |
|---|---|---|
| messages | array[string] | Message that the survey respondent sent. |
| location.uid | string | Podium unique identifier for location. |
| location.organizationUid | string | Podium unique identifier for organization. |
| uid | string | Podium unique identifier for feedback survey. |
| createdAt | string | When the survey was created. |
| updatedAt | string | When the survey was updated. |
| channel.type | string | Messenger channel for the conversation. Possible values: ["apple", "car_wars", "email", "facebook", "fallback_email", "google", "google_brand", "iframe", "instagram", "phone", "secure", "sms", "text", "whatsapp"] |
| channel.identifier | string | Identifies the Messenger channel. Must be a valid email address or a phone number. Non-US/Canada numbers must include the country code (e.g. +61 for AUS) |
| archived | boolean | If the survey response has been archived. |
| score | integer | Score the respondent has responded with. |
| attributions | array | Podium user who the survey is attributed to. For example, the user who was assigned to the customer that the survey was sent to. There may be more than one user who have a single survey attributed to them. |
| attributions[].type | string | Type of attribution that is assigned to sending the survey. Possible values: ["integrated_send", "manual_tag", "final"] |
| attributions[].userName | string | Name of the user attributed to sending the survey. |
| attributions[].userUid | string | Podium unique identifier for user. |
| customerName | string | Name of the customer who the survey was sent to. |
| flowUid | string | Podium unique identifier for survey flow. |
| adjustedScore | integer | Normalized value representing the survey score an individual responded with. Example with NPS scoring structure a 10 would be a 100 and a 5 would be -100. |
| currentStep | string | Current step of the flow that the survey is on. Possible values: ["start", "follow_up", "final"] |
| firstResponseReceivedAt | string | When the first response to the survey was received. |
{
"messages": [
"wonderful."
],
"location": {
"uid": "00000000-0000-0000-0000-000000000000",
"organizationUid": "00000000-0000-0000-0000-000000000000"
},
"uid": "00000000-0000-0000-0000-000000000000",
"createdAt": "2015-01-23T23:50:07Z",
"updatedAt": "2015-01-23T23:50:07Z",
"channel": {
"type": "email",
"identifier": "[email protected]"
},
"archived": false,
"score": 5,
"attributions": [
{
"type": "integrated_send",
"userName": "John Apple",
"userUid": "00000000-0000-0000-0000-000000000000"
}
],
"customerName": "Joe Orange",
"flowUid": "00000000-0000-0000-0000-000000000000",
"adjustedScore": 100,
"currentStep": "start",
"firstResponseReceivedAt": "2015-01-23T23:50:07Z"
}