---
title: "Get communications metrics"
method: GET
path: "/Metrics/communications"
tags: ["Metrics"]
---

# Get communications metrics

`GET /Metrics/communications`

## Request

- Base URL: `https://api.clinicos.vet/backend/business`
- URL: `https://api.clinicos.vet/backend/business/Metrics/communications`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/clinicos/apis/pawthosx-business-api-v1/docs/Metrics/communications/get.ts> (a function with typed inputs; its response is checked against the schema)

## Query parameters

- `period` string

## Response `200`

OK

- BusinessMetricsResponseDtoOfCommunicationsDto
  - `success` boolean
  - `data` CommunicationsDto
    - `calls` union
      - integer
      - string, int32
    - `emails` union
      - integer
      - string, int32
    - `sms` union
      - integer
      - string, int32
    - `totalOutbound` union
      - integer
      - string, int32
    - `period` string
  - `error` string, nullable
  - `message` string, nullable

## Other responses

- `500`: Internal Server Error

---

[API](https://skmtc.dev/clinicos/apis/pawthosx-business-api-v1.md) - [All operations](https://skmtc.dev/clinicos/apis/pawthosx-business-api-v1/llms.txt) - [OpenAPI document](https://skmtc.dev/clinicos/apis/pawthosx-business-api-v1/revisions/099cf36186e0?raw)
