Skip to main content
GET

Descrição

Retorna métricas detalhadas de inscrições, incluindo totais por newsletter, taxas de crescimento e análises temporais. Requer autenticação e permissão subscription-metrics.view.

Query Parameters

period
string
Período para análise. Valores aceitos:
  • today - Métricas do dia
  • week - Últimos 7 dias
  • month - Últimos 30 dias (padrão)
  • quarter - Últimos 90 dias
  • year - Últimos 365 dias
newsletter
string
Filtrar por newsletter específica
include_inactive
boolean
Incluir assinantes inativos nas métricas (padrão: false)

Headers

Authorization
string
required
Token JWT no formato: Bearer <token>\

Response

success
boolean
Indica se a operação foi bem-sucedida
data
object

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

period
enum<string>
default:month

Período para análise

Available options:
today,
week,
month,
quarter,
year
newsletter
string

Filtrar por newsletter

include_inactive
boolean
default:false

Incluir inativos

Response

Métricas obtidas

success
boolean
data
object