Skip to content
Vocapable Developers

Count current saved responses across a bounded window

GET
/v1/workflow-outcomes/summary
curl --request GET \
  --url https://api.vocapable.com/v1/workflow-outcomes/summary \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
workflow
Any of:
string
Allowed values: workforce sales recruiting
response
Any of:
string
<= 64 characters
agent_id
Any of:
string
<= 128 characters
campaign_id
Any of:
string
>= 1 characters <= 128 characters
start
Any of:
string format: date-time

Inclusive lower bound, ISO-8601. The attempt and turn ledgers are month-partitioned, so a report must name both sides of its window and may span at most 93 days.

end
Any of:
string format: date-time

Exclusive upper bound, ISO-8601.

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
WorkflowOutcomeSummary

Latest caller response per call/subject as of end, saved within the window.

object
window
required
DashboardWindow

The exact half-open UTC interval the historical counts cover.

object
start
required
Start
string format: date-time
end
required
End
string format: date-time
as_of
required
As Of
string format: date-time
counts
required
Counts
Array<object>
WorkflowOutcomeCount
object
workflow
required
Workflow
string
Allowed values: workforce sales recruiting
response
required
Response
string
count
required
Count
integer
Example
{
  "counts": [
    {
      "workflow": "workforce"
    }
  ]
}

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": {}
    }
  ]
}