Skip to main content
GET
/
subscription
curl --request GET \
  --url 'https://backend.testeswaffle.org/subscription/?period=month&newsletter=thenews' \
  --header 'Authorization: Bearer seu-token-jwt'

{
  "success": true,
  "data": {
    "total_subscribers": 45230,
    "new_subscribers": 3421,
    "unsubscribes": 234,
    "growth_rate": 7.8,
    "by_newsletter": {
      "thenews": {
        "total": 25430,
        "new": 2100,
        "unsubscribed": 120,
        "active_rate": 94.5
      },
      "thebizness": {
        "total": 12800,
        "new": 890,
        "unsubscribed": 65,
        "active_rate": 92.3
      }
    },
    "by_source": {
      "organic": 15230,
      "referral": 12450,
      "social": 10550,
      "paid": 7000
    },
    "timeline": [
      {
        "date": "2024-01-01",
        "subscribers": 41809,
        "new": 125
      },
      {
        "date": "2024-01-02",
        "subscribers": 41934,
        "new": 130
      }
    ]
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.thenewscc.com.br/llms.txt

Use this file to discover all available pages before exploring further.

​
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
curl --request GET \
  --url 'https://backend.testeswaffle.org/subscription/?period=month&newsletter=thenews' \
  --header 'Authorization: Bearer seu-token-jwt'

{
  "success": true,
  "data": {
    "total_subscribers": 45230,
    "new_subscribers": 3421,
    "unsubscribes": 234,
    "growth_rate": 7.8,
    "by_newsletter": {
      "thenews": {
        "total": 25430,
        "new": 2100,
        "unsubscribed": 120,
        "active_rate": 94.5
      },
      "thebizness": {
        "total": 12800,
        "new": 890,
        "unsubscribed": 65,
        "active_rate": 92.3
      }
    },
    "by_source": {
      "organic": 15230,
      "referral": 12450,
      "social": 10550,
      "paid": 7000
    },
    "timeline": [
      {
        "date": "2024-01-01",
        "subscribers": 41809,
        "new": 125
      },
      {
        "date": "2024-01-02",
        "subscribers": 41934,
        "new": 130
      }
    ]
  }
}

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