Call Logs and Analytics
tip
Webhooks are recommended for a more robust and scalable approach to retrieve call logs.
Retrieve Call Logs
Retrieve call logs based on filters provided in query parameters. All parameters are optional.
This endpoint returns a paginated response.
GET /api/v1/integrations/calls/
Headers
Name | Value |
---|---|
Authorization | Bearer Access Token |
Query Parameters
Name | Type | Required | Description |
---|---|---|---|
candidate_id | string | No | Custom Metadata Field |
candidate_number | string | No | Callee Number (E.164 format) |
date | string | No | Start date in DD/MM/YY H:M:S format |
end_date | string | No | End date in DD/MM/YY H:M:S format |
event_id | string | No | event_id obtained on initiating call |
job_id | string | No | Custom Metadata Field |
recruiter_email | string | No | Email of FreJun user |
transaction_id | string | No | Custom Metadata Field |
Response
{
"success": true,
"message": "Successfully retrieved calls data",
"data": {
"count": 123,
"next": "https://api.frejun.com/integrations/calls/",
"previous": "https://api.frejun.com/integrations/calls/",
"results": [
"list of calls"
]
}
}
Retrieve Call Analytics
Retrieve call analytics based on filters provided in query parameters.
GET /api/v1/integrations/call-analytics/
Headers
Name | Value |
---|---|
Authorization | Bearer Access Token |
Query Parameters
Name | Type | Required | Description |
---|---|---|---|
date_end | string | Yes | End date in YYYY-MM-DD |
date_start | string | Yes | Start date in YYYY-MM-DD |
users | string | No | List of user emails |
Response
{
"data": [
{
"user": "[email protected]",
"total_calls": 1000,
"answered_calls": 500,
"total_minutes": 2500
},
{
"user": "[email protected]",
"total_calls": 500,
"answered_calls": 250,
"total_minutes": 1250
}
]
}