Pular para o conteúdo

SLA (Service Level Agreement)

Defina politicas de nivel de servico para monitorar tempos de primeira resposta, resolucao e acompanhar o cumprimento dos SLAs por equipe e agente.

Recurso Enterprise

Os endpoints de SLA estao disponiveis apenas no plano Enterprise.

Politicas SLA

GET/api/v1/accounts/{account_id}/sla_policies

Lista todas as politicas SLA da conta.

bash
curl -s "https://chat.seudominio.com/api/v1/accounts/1/sla_policies" \
  -H "api_access_token: YOUR_TOKEN" | jq .
200Lista de politicas
json
{
  "data": [
    {
      "id": 1,
      "name": "SLA Premium",
      "description": "Para clientes do plano Enterprise",
      "first_response_time_threshold": 300,
      "next_response_time_threshold": 900,
      "resolution_time_threshold": 14400,
      "only_during_business_hours": true,
      "created_at": "2025-06-01T00:00:00Z"
    }
  ]
}
POST/api/v1/accounts/{account_id}/sla_policies

Cria uma nova politica SLA.

Body

NomeTipoObrigatorioDescricao
namestringSimNome da politica
descriptionstringNaoDescricao
first_response_time_thresholdintegerSimTempo max primeira resposta (segundos)
next_response_time_thresholdintegerNaoTempo max respostas seguintes (segundos)
resolution_time_thresholdintegerNaoTempo max resolucao (segundos)
only_during_business_hoursbooleanNaoConsiderar apenas horario comercial
bash
curl -X POST "https://chat.seudominio.com/api/v1/accounts/1/sla_policies" \
  -H "api_access_token: YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "SLA Padrao",
    "first_response_time_threshold": 600,
    "next_response_time_threshold": 1800,
    "resolution_time_threshold": 28800,
    "only_during_business_hours": true
  }'
GET/api/v1/accounts/{account_id}/sla_policies/{id}

Retorna detalhes de uma politica SLA.

PATCH/api/v1/accounts/{account_id}/sla_policies/{id}

Atualiza uma politica SLA.

DELETE/api/v1/accounts/{account_id}/sla_policies/{id}

Remove uma politica SLA.

SLAs Aplicados

Acompanhe o cumprimento dos SLAs em conversas individuais.

GET/api/v1/accounts/{account_id}/applied_slas

Lista SLAs aplicados a conversas.

Parametros

NomeTipoObrigatorioDescricao
sla_policy_id(query)integerNaoFiltrar por politica
status(query)stringNaoactive, hit, missed
page(query)integerNaoPagina

Metricas SLA

GET/api/v1/accounts/{account_id}/applied_slas/metrics

Metricas agregadas de cumprimento de SLA.

200Metricas SLA
json
{
  "data": {
    "total_applied": 250,
    "hit": 210,
    "missed": 40,
    "hit_rate": 84.0,
    "avg_first_response_time": 245,
    "avg_resolution_time": 10800,
    "breaches_by_type": {
      "first_response": 15,
      "next_response": 10,
      "resolution": 15
    }
  }
}
GET/api/v1/accounts/{account_id}/applied_slas/download

Exporta relatorio de SLA como CSV.

Parametros

NomeTipoObrigatorioDescricao
start_date(query)stringNaoData inicio (YYYY-MM-DD)
end_date(query)stringNaoData fim (YYYY-MM-DD)
bash
curl -s "https://chat.seudominio.com/api/v1/accounts/1/applied_slas/download?start_date=2026-01-01&end_date=2026-01-31" \
  -H "api_access_token: YOUR_TOKEN" -o sla_report.csv