# Oratrix API - Dashboard

## Status

Documentacao parcial baseada na parte enviada para o projeto Wezapp Shots.

Este grupo fornece estatisticas do Oratrix ligadas a tickets, canais, usuarios, filas, status e motivos de encerramento.

Para a primeira versao do Wezapp Shots, estes endpoints sao auxiliares. O dashboard principal do Shots deve ser calculado a partir das tabelas internas do Wezapp, usando dados do Oratrix como complemento quando necessario.

## Base URL

```text
https://api-pro1.oratrixchat.com.br/v2/api/external/{ApiID}
```

## Autenticacao

```http
Authorization: Bearer {token}
```

## Query params padrao

Os endpoints deste grupo aceitam filtros de periodo:

| Parametro | Obrigatorio | Descricao | Exemplo |
|---|---:|---|---|
| startDate | Nao | Data inicial no formato YYYY-MM-DD | 2026-06-01 |
| endDate | Nao | Data final no formato YYYY-MM-DD | 2026-06-30 |

## Endpoints do grupo

Total documentado nesta parte: 10 endpoints.

---

## 1. Estatisticas gerais de tickets e tempos

```http
GET /dash/ticketsAndTimes
```

Nome na documentacao Oratrix:

```text
DashTicketsAndTimes
```

Descricao:

Estatisticas gerais: total de tickets e tempos medios de atendimento.

URL completa:

```text
https://api-pro1.oratrixchat.com.br/v2/api/external/{ApiID}/dash/ticketsAndTimes
```

---

## 2. Tickets por canal de comunicacao

```http
GET /dash/ticketsChannels
```

Nome na documentacao Oratrix:

```text
DashTicketsChannels
```

Descricao:

Tickets agrupados por canal de comunicacao.

URL completa:

```text
https://api-pro1.oratrixchat.com.br/v2/api/external/{ApiID}/dash/ticketsChannels
```

---

## 3. Evolucao de tickets

```http
GET /dash/ticketsEvolution
```

Nome na documentacao Oratrix:

```text
DashTicketsEvolution
```

Descricao:

Evolucao diaria/mensal do volume de tickets.

URL completa:

```text
https://api-pro1.oratrixchat.com.br/v2/api/external/{ApiID}/dash/ticketsEvolution
```

---

## 4. Evolucao de tickets por valor

```http
GET /dash/ticketsEvolutionByValue
```

Nome na documentacao Oratrix:

```text
DashTicketsEvolutionByValue
```

Descricao:

Evolucao de tickets por valor de CRM.

URL completa:

```text
https://api-pro1.oratrixchat.com.br/v2/api/external/{ApiID}/dash/ticketsEvolutionByValue
```

---

## 5. Evolucao de tickets por nome de canal

```http
GET /dash/ticketsEvolutionChannelsName
```

Nome na documentacao Oratrix:

```text
DashTicketsEvolutionChannelsName
```

Descricao:

Evolucao de tickets por nome de canal.

URL completa:

```text
https://api-pro1.oratrixchat.com.br/v2/api/external/{ApiID}/dash/ticketsEvolutionChannelsName
```

---

## 6. Tickets por usuario/atendente

```http
GET /dash/ticketsPerUser
```

Nome na documentacao Oratrix:

```text
DashTicketsPerUser
```

Descricao:

Tickets atribuidos por usuario/atendente.

URL completa:

```text
https://api-pro1.oratrixchat.com.br/v2/api/external/{ApiID}/dash/ticketsPerUser
```

---

## 7. Resumo de tickets por usuario

```http
GET /dash/ticketsUser
```

Nome na documentacao Oratrix:

```text
DashTicketsUser
```

Descricao:

Resumo de tickets por usuario com metricas.

URL completa:

```text
https://api-pro1.oratrixchat.com.br/v2/api/external/{ApiID}/dash/ticketsUser
```

---

## 8. Tickets por fila de atendimento

```http
GET /dash/ticketsQueue
```

Nome na documentacao Oratrix:

```text
DashTicketsQueue
```

Descricao:

Tickets agrupados por fila de atendimento.

URL completa:

```text
https://api-pro1.oratrixchat.com.br/v2/api/external/{ApiID}/dash/ticketsQueue
```

---

## 9. Tickets por status

```http
GET /dash/ticketsStatus
```

Nome na documentacao Oratrix:

```text
DashTicketsStatus
```

Descricao:

Tickets agrupados por status, como aberto, pendente e encerrado.

URL completa:

```text
https://api-pro1.oratrixchat.com.br/v2/api/external/{ApiID}/dash/ticketsStatus
```

---

## 10. Tickets por motivo de encerramento

```http
GET /dash/ticketsReasons
```

Nome na documentacao Oratrix:

```text
DashTicketsReasons
```

Descricao:

Tickets agrupados por motivo de encerramento.

URL completa:

```text
https://api-pro1.oratrixchat.com.br/v2/api/external/{ApiID}/dash/ticketsReasons
```

## Mapeamento sugerido com Wezapp Shots

| Wezapp Shots | Oratrix |
|---|---|
| Dashboard interno do Shots | Fonte primaria: banco Wezapp |
| Metricas de atendimento | Endpoints `/dash/*` do Oratrix |
| Performance por canal | Combinar `wezapp_channels` com retorno de dashboard Oratrix |
| Relatorios futuros | Dados externos do Oratrix como complemento |

## Pendencias tecnicas para validar

- Confirmar se `startDate` e `endDate` sao obrigatorios ou opcionais de fato.
- Confirmar formato de retorno de cada endpoint.
- Confirmar se os endpoints retornam dados por canal com ID, nome ou ambos.
- Confirmar timezone usado nos filtros de data.
- Confirmar se a evolucao e diaria, mensal ou definida pela API.

## Regras recomendadas para o Wezapp Shots

1. Nao depender destes endpoints para calcular saldo de shots.
2. Nao depender destes endpoints para calcular consumo interno.
3. Usar como complemento de relatorio e conciliacao.
4. Armazenar snapshots apenas se houver necessidade operacional.