/
CL
clinicos
/
PawthosX.Business.API | v1
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Sources
Checked 10h ago · Updated 1d ago
View markdown
clinicos
PawthosX.Business.API | v1
get
Get communications metrics
v2
latest
OpenAPI 3.1.1
2026-08-07
854
993
2.4 MB
AdminS3
2
ApiKeys
7
Appointments
21
AppointmentTypes
10
BillableItems
5
Breeds
5
BulkClientExport
2
BulkPatientExport
2
CareQueue
2
CaseMilestones
6
Cases
5
ChatExport
1
ClientAppInvite
3
ClientExport
3
Clients
5
ClinicConfig
29
ClinicSettings
2
Clocking
6
Compliance
1
ConsentDocuments
2
DeaBooks
9
DeaExport
2
DiagnosisTerms
1
DiscountCodes
7
Drafts
7
EdgePrinters
3
EdgePrintJobs
2
EmailVerification
2
Estimates
25
ExamTemplates
5
Expenses
6
Featurebase
2
Flowboard
10
GroupCodes
5
GroupVisits
6
Health
1
HomeAgain
4
IntegrationCredentials
15
InternalPrescribing
1
InternalWidget
1
Inventory
23
InventoryApprovals
5
InventoryLocations
7
Invoices
24
JourneyMilestones
6
Kiosk
4
LabPanels
5
Labs
16
LocationClosures
4
Locations
11
Logos
7
MedicationRequests
7
MentorMetrics
5
Metrics
31
get
Get EBITDA summary with trend data
get
Get labor efficiency metrics by role
get
Get statistical variance alerts
get
Get schedule heatmap data (appointment density by day/hour)
get
Get AI presence/activity data
get
Get daily goal progress metrics
put
Update daily goal targets
get
Get KPI summary with sparklines
get
Get trend data for sparkline charts
get
Get P and L summary data
get
Get labor breakdown for stacked bar chart
get
Get inventory health metrics
get
Get patient funnel data
get
Get provider rankings
get
Get financial details for table view
get
Get communications metrics
get
Get dashboard summary metrics
get
Get normalized performance metrics
get
Get AI impact metrics (marketing-friendly numbers derived from real data)
get
Get top revenue-generating items (services and inventory)
get
Get revenue rankings by procedure/service category
get
Get recent patient transactions for the master grid
get
Get DVM production metrics (PAW-108, Phase 1): per-provider revenue/hours/visits and clinic totals.
get
Get the severity-weighted DVM Production signals on their own (PAW-579), for the BI Overview tab and the home page.
get
List veterinarian compensation settings (PAW-108 Phase 2). One row per primary-provider user; `IsConfigured` is false for un-modeled providers.
put
Upsert a veterinarian's compensation settings. Requires user_management permission since this controls how margin/profit numbers are reported.
get
Get service-mix buckets excluded from production-pay revenue (PAW-578): clinic-wide buckets plus per primary-provider overrides.
put
Replace the excluded-bucket set for one scope ("clinic" or a single "vet"). Requires user_management since it changes how production pay is reported.
post
AI root-cause diagnosis for one provider's DVM Production drill-down (PAW-576). POST since it may trigger an LLM call; the result is cached server-side.
get
Clinic-wide breakdown of deferred (client-declined) services by individual service over a period, weighted by frequency. Drives the BI "Deferred Services" card.
get
Drill-down list of the deferred services behind one breakdown bucket (by service key) over a period.
NpsAnalytics
3
Partners
6
PatientGroups
9
PatientMasses
6
PatientProblems
4
PatientRecordExport
3
Patients
20
Payments
19
PaymentTokens
5
Pharmacies
5
Phones
2
PriceRules
6
Printers
6
PrintJobs
4
PtoRequests
6
PublicNps
2
PublicPriceList
5
PublicQuestionnaires
2
PublicSmsConsent
2
PurchaseOrders
11
QiEvents
9
QuestionnaireResponses
6
Questionnaires
10
RabiesTags
10
RdvmPortal
22
Recordings
7
RecurringExpenses
5
ReferralMessages
2
Referrals
20
Reminders
14
Reports
2
RetailItems
11
Roles
6
RoomDayAssignments
3
RxGovernance
25
SavedReports
5
ScheduleItems
10
ServiceCatalog
5
Shifts
5
ShiftSwaps
8
SlotConfigurations
6
SmsConsent
9
Species
5
Subscriptions
8
SurgicalRecords
6
TagAssignments
4
Tags
5
TelnyxCallControl
1
Templates
10
TenantKnowledge
4
TimeEntries
5
Transparency
3
Users
11
Vaccinations
9
VaccineAdministration
3
VaccineCertificateRecords
6
VaccineCertificates
2
VaccineTypes
5
Vendors
6
Vitals
2
VitalTypes
6
Widget
17
WidgetChatbot
4
WorkItemRules
5
WorkTasks
13
Metrics
Get communications metrics
get
/Metrics/communications
Query parameters
period
string
Period filter: today, week, month
Response
OK
BusinessMetricsResponseDtoOfCommunicationsDto
required
success
boolean
data
CommunicationsDto
error
string
nullable
message
string
nullable