Opportunity performance
Get opportunity performance overview
See Analytics scope and time ranges for shared filtering behavior.
GET
/
api
/
calls
/
aggregates
/
opportunities-overview
/
Get opportunity performance overview
curl --request GET \
--url https://api.prod.peerlogic.com/api/calls/aggregates/opportunities-overview/ \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.prod.peerlogic.com/api/calls/aggregates/opportunities-overview/"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.prod.peerlogic.com/api/calls/aggregates/opportunities-overview/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.prod.peerlogic.com/api/calls/aggregates/opportunities-overview/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.prod.peerlogic.com/api/calls/aggregates/opportunities-overview/"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.prod.peerlogic.com/api/calls/aggregates/opportunities-overview/")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.prod.peerlogic.com/api/calls/aggregates/opportunities-overview/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"total_calls": 124,
"total_open_call": 7,
"revenue_potential": {
"new_patient": 5000,
"existing_patient": 2000
},
"total_follow_up_calls": 12,
"booked_opportunities": 8,
"booked_opportunities_percentage": 6.45,
"followed_up_calls_percentage": 9.68,
"revenue_recovered": {
"new_patient": 6000,
"existing_patient": 2000
}
}{
"field_error": "One of the following parameter must be provided [practice_ids, organization_id or region_id]"
}{
"detail": "'Authorization' header is required"
}{
"message": "No permissions assigned to permit access to this endpoint."
}Authorizations
Bearer access token issued by Peerlogic.
Query Parameters
Include accessible practices in this organization.
Include accessible practices assigned to this region.
Comma-separated practice IDs. All requested practices must be accessible to the authenticated account.
Include calls on or after this date, in YYYY-MM-DD format.
Include calls before this date, in YYYY-MM-DD format.
Filter by one or more non-practice participant types. Repeat the parameter for multiple values.
Available options:
new_patient, existing_patient, contractor_vendor, insurance_provider, not_applicable, not_applicable_internal, others Response
Opportunity and follow-up summary for the selected scope.
The response is of type object.
Was this page helpful?
Get opportunity performance overview
curl --request GET \
--url https://api.prod.peerlogic.com/api/calls/aggregates/opportunities-overview/ \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.prod.peerlogic.com/api/calls/aggregates/opportunities-overview/"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.prod.peerlogic.com/api/calls/aggregates/opportunities-overview/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.prod.peerlogic.com/api/calls/aggregates/opportunities-overview/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.prod.peerlogic.com/api/calls/aggregates/opportunities-overview/"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.prod.peerlogic.com/api/calls/aggregates/opportunities-overview/")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.prod.peerlogic.com/api/calls/aggregates/opportunities-overview/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"total_calls": 124,
"total_open_call": 7,
"revenue_potential": {
"new_patient": 5000,
"existing_patient": 2000
},
"total_follow_up_calls": 12,
"booked_opportunities": 8,
"booked_opportunities_percentage": 6.45,
"followed_up_calls_percentage": 9.68,
"revenue_recovered": {
"new_patient": 6000,
"existing_patient": 2000
}
}{
"field_error": "One of the following parameter must be provided [practice_ids, organization_id or region_id]"
}{
"detail": "'Authorization' header is required"
}{
"message": "No permissions assigned to permit access to this endpoint."
}