Skip to content
vocapable.Docs

Effort and results for a period, with definitions

GET
/v1/workspace/reports
curl --request GET \
  --url 'https://api.vocapable.com/v1/workspace/reports?period=today' \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
period
Period
string
default: 7d
Allowed values: today 7d 30d month
tz
Any of:
string
<= 64 characters
user_id
Any of:
string
<= 64 characters

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
WorkspaceReport
object
window
required
WorkspaceReportWindow
object
period
required
Period
string
Allowed values: today 7d 30d month
timezone
required
Timezone
string
start
required
Start
string format: date-time
end
required
End
string format: date-time
label
required
Label
string
scope
required
Scope
string
Allowed values: team self
figures
required
Figures
Array<object>
WorkspaceReportFigure
object
metric
required
Metric
string
Allowed values: attempts conversations follow_ups_due follow_ups_completed appointments_held appointments_no_show won_value collected_payments deliveries_completed opportunities_created
label
required
Label
string
value
required
Value
integer
amounts
Any of:
Array<object>
WorkspaceAmount
object
amount_minor
required
Amount Minor
integer
currency
required
Currency
string
definition
required
Definition
string
sources
required
Sources
Array<object>
WorkspaceReportSource
object
source
required
Source
string
opportunities
required
Opportunities
integer
won
required
Won
integer
won_amounts
required
Won Amounts
Array<object>
WorkspaceAmount
object
amount_minor
required
Amount Minor
integer
currency
required
Currency
string
people
required
Any of:
Array<object>
WorkspaceReportPerson
object
user_id
required
User Id
string
name
required
Name
string
attempts
required
Attempts
integer
conversations
required
Conversations
integer
follow_ups_completed
required
Follow Ups Completed
integer
won
required
Won
integer
notes
required
Notes
Array<string>
Example
{
  "window": {
    "period": "today"
  },
  "scope": "team",
  "figures": [
    {
      "metric": "attempts"
    }
  ]
}

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