NueForm

API de Análises

Recupere métricas de respostas e análises de conclusão dos seus formulários.

A API de Análises fornece métricas agregadas sobre as respostas dos formulários, incluindo contagens totais, taxas de conclusão e detalhamentos diários.

Todos os corpos de resposta usam nomes de campo em snake_case.

Painel de Análises do Formulário
O painel de análises mostrando métricas de respostas e taxas de conclusão.
Endpoints
GET/api/v1/forms/:id/analytics

Obter Análises do Formulário

GET/api/v1/forms/:id/analytics

Retorna as análises de respostas de um formulário específico. Opcionalmente, você pode filtrar por um intervalo de datas para analisar períodos específicos.

Parâmetros de Caminho

idstring

O ID do formulário

Parâmetros de Consulta

sincestring

Data ISO 8601. Inclui apenas respostas enviadas nesta data ou depois dela.

untilstring

Data ISO 8601. Inclui apenas respostas enviadas nesta data ou antes dela.

Campos da Resposta

form_idstring

O ID do formulário

total_responsesinteger

Número total de envios (incluindo parciais)

completed_responsesinteger

Número de envios totalmente concluídos

completion_ratenumber

Porcentagem de respostas concluídas (0-100, arredondada para 2 casas decimais)

average_completion_time_secondsinteger or null

Tempo médio em segundos da primeira resposta até a conclusão. null se não houver respostas concluídas.

responses_by_dayarray

Detalhamento diário das contagens de respostas

responses_by_day[].datestring

Data no formato YYYY-MM-DD

responses_by_day[].totalinteger

Total de respostas enviadas nesta data

responses_by_day[].completedinteger

Respostas concluídas nesta data

Resposta

json
{
  "form_id": "665a1b2c3d4e5f6a7b8c9d0e",
  "total_responses": 342,
  "completed_responses": 298,
  "completion_rate": 87.13,
  "average_completion_time_seconds": 194,
  "responses_by_day": [
    { "date": "2026-02-22", "total": 18, "completed": 16 },
    { "date": "2026-02-23", "total": 24, "completed": 21 },
    { "date": "2026-02-24", "total": 31, "completed": 27 },
    { "date": "2026-02-25", "total": 22, "completed": 20 },
    { "date": "2026-02-26", "total": 28, "completed": 25 },
    { "date": "2026-02-27", "total": 35, "completed": 30 },
    { "date": "2026-02-28", "total": 12, "completed": 11 }
  ]
}

Exemplos de Código

bash
curl -X GET "https://api.nueform.io/api/v1/forms/665a1b2c3d4e5f6a7b8c9d0e/analytics?since=2026-02-01&until=2026-02-28" \
  -H "Authorization: Bearer YOUR_API_KEY"

Dicas de Consulta

Use os parâmetros de consulta since e until para controlar o intervalo de datas das análises.

Histórico completo

Omita tanto since quanto until para obter as análises de todo o período de vida do formulário.

Últimos 7 dias

Calcule a data de 7 dias atrás e passe-a como o parâmetro since para obter uma janela semanal móvel.

Mês específico

Passe o primeiro e o último dia do mês como since e until para obter as análises de um mês específico do calendário.

Histórico completo

bash
curl -X GET "https://api.nueform.io/api/v1/forms/665a1b2c3d4e5f6a7b8c9d0e/analytics" \
  -H "Authorization: Bearer YOUR_API_KEY"

Últimos 7 dias

javascript
const since = new Date();
since.setDate(since.getDate() - 7);

const response = await fetch(
  `https://api.nueform.io/api/v1/forms/${formId}/analytics?since=${since.toISOString().split("T")[0]}`,
  { headers: { Authorization: "Bearer YOUR_API_KEY" } }
);

Mês específico

python
response = requests.get(
    f"https://api.nueform.io/api/v1/forms/{form_id}/analytics",
    params={"since": "2026-01-01", "until": "2026-01-31"},
    headers={"Authorization": "Bearer YOUR_API_KEY"},
)

Respostas de Erro

Respostas de erro padrão retornadas por este endpoint.

Códigos de Erro

400Bad Request

Formato de data inválido para since ou until

401Unauthorized

Chave de API ausente ou inválida

403Forbidden

Permissões insuficientes para formulários de equipe

404Not Found

Formulário não encontrado

500Server Error

Erro interno do servidor

Exemplo de Erro

json
{
  "error": "Form not found"
}
Última atualização: 20 de julho de 2026