Read Visit Survey
๐งพ Read Visit Survey
Endpoint: GET /api/v3/visits/{visitId}/survey
Auth Required: โ Yes (Bearer Token)
๐ Description
Retrieves survey response data associated with a specific visit. This typically includes attendee feedback collected post-visit and is used for performance tracking, reporting, and continuous improvement.
๐ข URL Parameters
Parameter | Type | Required | Description |
---|---|---|---|
visitId |
integer/string | โ Yes | Unique identifier of the visit. |
๐ Query Parameters
None.
๐ค Request Example
GET https://api.briefingedge.com/api/v3/visits/555/survey Authorization: Bearer <token>
โ Success Response (200 OK)
Returns a survey data object for the visit.
Example:
{ "VisitID": 555, "SurveySubmittedBy": "customer@example.com", "SubmittedOn": "2025-11-06T15:00:00Z", "Responses": [ { "Question": "Overall experience?", "Answer": "Excellent" }, { "Question": "Suggestions for improvement?", "Answer": "More technical content would be great." } ] }
โ Error Responses
Code | Message | Description |
---|---|---|
401 | Unauthorized | Missing or invalid bearer token. |
404 | Not Found | No survey found for the given visit ID. |
500 | Internal Server Error | Unexpected server-side failure. |