UPupsmith
call-analysis

Get Call Analysis Calls

get/call-analysis/calls

Request

  • Base URL
    https://api-docs.upsmith.com (the document declares no server; this is the origin it was published from)
  • Auth
    • API key in header x-api-key
    • or HTTP bearer

Query parameters

started_atstring date-time required

Inclusive timestamp from overview.period.started_at

ended_atstring date-time required

Exclusive timestamp from overview.period.ended_at

sort_by'time' | 'agent' | 'classification' | 'booking_intent' | 'handling'
sort_direction'asc' | 'desc'
prioritize_booking_intentboolean
exclude_booked_sinceboolean
exclude_internalboolean
bucket'all' | 'bookable' | 'booked' | 'not_booked' | 'booking_unknown' | 'no_intent' | 'handled' | 'not_handled' | 'irrelevant' | 'handling_unclear' | 'intent_unclear' | 'not_evaluated'
classification'booked' | 'unbooked' | 'abandoned' | 'excused' | 'not_lead' | 'other' | 'missing'
evaluation_status'no_recording' | 'pending'
processing_status'no_recording' | 'not_transcribed' | 'not_evaluated' | 'pending'
limitinteger
offsetinteger
csr_idstring nullable
reasonstring nullable

Exact saved ServiceTitan call reason name

reason_missingboolean

Only calls without a saved ServiceTitan reason name; cannot be combined with reason

direction'inbound' | 'outbound'

Which calls the tab reads. Its own enum rather than the ServiceTitan model's, so the public query vocabulary does not move when that mirror does.

Headers

organization-idstring nullable
x-user-idstring nullable
timezonestring
x-actor-emailstring nullable
x-request-sourcestring nullable
x-operation-idstring nullable
x-commit-messagestring nullable
x-confirmation-idstring nullable
x-chat-idstring nullable

Response

Successful Response

sort_by'time' | 'agent' | 'classification' | 'booking_intent' | 'handling'
sort_direction'asc' | 'desc'
prioritize_booking_intentboolean
exclude_booked_sinceboolean
exclude_internalboolean
reasonstring nullable
reason_missingboolean
csr_idstring nullable
started_atstring date-time required
ended_atstring date-time required
bucket'all' | 'bookable' | 'booked' | 'not_booked' | 'booking_unknown' | 'no_intent' | 'handled' | 'not_handled' | 'irrelevant' | 'handling_unclear' | 'intent_unclear' | 'not_evaluated' required
classification'booked' | 'unbooked' | 'abandoned' | 'excused' | 'not_lead' | 'other' | 'missing' required
evaluation_status'no_recording' | 'pending'
processing_status'no_recording' | 'not_transcribed' | 'not_evaluated' | 'pending'
itemsCallAnalysisCallPublic[] required
totalinteger required
limitinteger required
offsetinteger required
has_moreboolean required

Changes

No recorded changes to this operation across all 1 revision of this API.