Calls
List Calls
- Dashboard
- Community
- GETReturn the logs for a call
- PATCHSet call as viewed by the user making the request
- GETGets an organization's usage
- GETList Call tags
- PATCHUpdate a note on a call
- GETGet Call
- POSTAdd a note to a call
- GETList Calls
- GETGet Transcript
- PATCHSet call rating
- GETGet Calls
- POSTStop Call
- DELDelete a call
- GETReturn a pre-signed URL to the call recording
- DELDelete a note from a call
- POSTCreate Assistant
- PATCHUpdate Assistant
- DELDelete Assistant
- GETList Assistants
- GETGet Assistant
- PATCHUpdate an existing tool
- GETReturns a list of tools for a use case id
- DELDelete a tool
- POSTCreate a new tool
- GETReturns a list of tools for a use case id
- GETReturns a list of tools for a use case id
- GETGet Campaigns
- POSTCreate batched Outbound Calls
- POSTCreate Outbound Call
- POSTCreate Outbound Call
- GETGet all users for an organization
- POSTCreate a new member for an organization
- GETGet an organization
- DELDelete a member from an organization
- PATCHUpdate a user
- PATCHUpdate an organization
- DELDelete a list of numbers
- GETReturns a list of phone numbers
- DELDelete a phone number
- PATCHUpdate a phone number routes
- POSTBuy a new phone number
- GETReturns a single number
- POSTCreate a new hook
- PATCHUpdate an existing hook
- GETReturns a list of hooks for an assistant id
- DELDelete a hook
- DELDelete a message
- GETReturns a list of samples for an assistant id
- POSTGenerate a list of samples in jsonl format
- GETReturns a sample by id
- POSTAdd a new message
- DELDelete a list of samples
- PATCHUpdate an existing example
- PATCHUpdate an existing message
- POSTCreate a new sample
- POSTDownload a backup of a list of samples
- GETGet Use Case
- POSTCreate a Use Case
- DELDelete Use Case
- GETList Use Cases
- PATCHUpdate Use Case
- POSTCreate a label for Use Case
- DELDelete Use Case's label
- POSTCreate a new agent
- GETReturns a list of agents
- DELDelete an agent
- GETReturns a single agent
- PATCHUpdate an existing agent
- GETReturn the logs for a call
- PATCHSet call as viewed by the user making the request
- GETGets an organization's usage
- GETList Call tags
- PATCHUpdate a note on a call
- GETGet Call
- POSTAdd a note to a call
- POSTCancel Call
- GETGet Transcript
- PATCHSet call rating
- GETList Calls
- POSTStop Call
- DELDelete a call
- GETReturn a pre-signed URL to the call recording
- DELDelete a note from a call
Calls
Assistants
Tools
Dial
Orgs
Numbers
Hooks
Samples
Usecases
Agents
Analytics
Calls
List Calls
Returns a list of calls.
GET
/
call-kpis
authorization
string
*
authorization
Required
string
Your API key for authentication. Use Bearer format.
Add Example Value
from
string
*
from
Required
string
Filter by start date
Add Example Value
to
string
*
to
Required
string
Filter by end date
Add Example Value
curl --request GET \
--url https://app.happyrobot.ai/api/v1/call-kpis \
--header 'authorization: <authorization>'{
"total": {
"value": 123,
"percentage": 123,
"delta": 123,
"lightHexColor": "#FF0000",
"hexColor": "#FF0000"
},
"extraction": {}
}Headers
authorization
string
requiredYour API key for authentication. Use Bearer format.
Query Parameters
from
string
requiredFilter by start date
to
string
requiredFilter by end date
Response
200 - application/json
total
object
requiredtotal.value
number
requiredValue of the KPI
total.percentage
number
Percentage of the total of the KPI
total.delta
number
Delta of the KPI, in %
total.lightHexColor
string
Color of the KPI in HEX
total.hexColor
string
Color of the KPI in HEX
extraction
object
AI extracted data from the call.
Was this page helpful?
curl --request GET \
--url https://app.happyrobot.ai/api/v1/call-kpis \
--header 'authorization: <authorization>'{
"total": {
"value": 123,
"percentage": 123,
"delta": 123,
"lightHexColor": "#FF0000",
"hexColor": "#FF0000"
},
"extraction": {}
}