Performance
Get Aimee revenue overview
Returns missed-call recovery, Aimee engagement, booking, and estimated-revenue metrics for an organization. If the selected organization has no active Aimee-enabled practices, the response is marked as projected.
GET
/
api
/
aimee
/
revenue-overview
/
Get Aimee revenue overview
curl --request GET \
--url https://api.prod.peerlogic.com/api/aimee/revenue-overview/ \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.prod.peerlogic.com/api/aimee/revenue-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/aimee/revenue-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/aimee/revenue-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/aimee/revenue-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/aimee/revenue-overview/")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.prod.peerlogic.com/api/aimee/revenue-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{
"is_projected": false,
"projected_assumptions": null,
"date_range": {
"start": "2026-08-01T00:00:00-07:00",
"end": "2026-09-01T00:00:00-07:00",
"periods": 1,
"period_length_days": 30,
"timezone": "America/Phoenix"
},
"organization_id": "org_example",
"practices_count": 4,
"org_total_practices_count": 4,
"avg_appointment_value": 750,
"calls": {
"inbound_total": 420,
"inbound_with_opportunities": 96,
"missed_total": 61,
"missed_opportunities_total": 48,
"missed_opportunities_trailing_30d": 45
},
"opportunities": {
"active": 14,
"resolved_booked": 21
},
"aimee_sms": {
"conversations_initiated": 52,
"patients_engaged": 31,
"engagement_rate": 59.62,
"appointments_booked": 12,
"booking_rate": 38.71,
"booked_revenue": 9000
}
}{
"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
Organization ID.
Limit the overview to one or more eligible practices. Repeat this parameter for multiple practices.
Start date in YYYY-MM-DD format. Defaults to a 31-day lookback when no dates are supplied.
End date in YYYY-MM-DD format.
Response
Aimee revenue and engagement overview.
The response is of type object.
Was this page helpful?
Get Aimee revenue overview
curl --request GET \
--url https://api.prod.peerlogic.com/api/aimee/revenue-overview/ \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.prod.peerlogic.com/api/aimee/revenue-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/aimee/revenue-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/aimee/revenue-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/aimee/revenue-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/aimee/revenue-overview/")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.prod.peerlogic.com/api/aimee/revenue-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{
"is_projected": false,
"projected_assumptions": null,
"date_range": {
"start": "2026-08-01T00:00:00-07:00",
"end": "2026-09-01T00:00:00-07:00",
"periods": 1,
"period_length_days": 30,
"timezone": "America/Phoenix"
},
"organization_id": "org_example",
"practices_count": 4,
"org_total_practices_count": 4,
"avg_appointment_value": 750,
"calls": {
"inbound_total": 420,
"inbound_with_opportunities": 96,
"missed_total": 61,
"missed_opportunities_total": 48,
"missed_opportunities_trailing_30d": 45
},
"opportunities": {
"active": 14,
"resolved_booked": 21
},
"aimee_sms": {
"conversations_initiated": 52,
"patients_engaged": 31,
"engagement_rate": 59.62,
"appointments_booked": 12,
"booking_rate": 38.71,
"booked_revenue": 9000
}
}{
"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."
}