Skip to content
vocapable.Docs

Summarize saved survey responses for the selected conversations

GET
/v1/mobile/results/survey-summary
curl --request GET \
  --url 'https://api.vocapable.com/v1/mobile/results/survey-summary?start=2026-04-15T12%3A00%3A00Z&end=2026-04-15T12%3A00%3A00Z&service=all&direction=all' \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
start
required
Start
string format: date-time
end
required
End
string format: date-time
service
Service
string
default: all
Allowed values: all receptionist workforce sales feedback custom
agent_id
Any of:
string
>= 1 characters <= 128 characters
direction
Direction
string
default: all
Allowed values: all inbound outbound browser

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
SurveyResponseSummary

All saved responses matching the list filters, independent of pagination.

object
total
required
Total
integer
complete
required
Complete
integer
partial
required
Partial
integer
refused
required
Refused
integer
scored
required
Scored
integer
average_score
Any of:
number
Examplegenerated
{
  "total": 1,
  "complete": 1,
  "partial": 1,
  "refused": 1,
  "scored": 1,
  "average_score": 1
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}