Skip to main content
GET
Métricas de quests

Métricas de Quests

Retorna métricas de quests da empresa. Com quest_id, retorna visão detalhada; sem quest_id, retorna visão global agregada.

Headers

X-API-Key
string
required

Chave de API

Query Parameters

quest_id
string<uuid> | null

ID da quest (null retorna visão global)

days
integer
default:30
Required range: 1 <= x <= 365
group_by
string
default:day

"day", "week" ou "month"

Response

Successful Response

Métricas detalhadas de uma quest específica.

quest_id
string
required
status
string
required
title
string
required
type
string
required
avg_score
number | null
completion_rate
number
default:0
detractors
integer | null
neutrals
integer | null
nps_score
integer | null
period_days
integer
default:30
promoters
integer | null
responses_by_period
QuestMetricsResponseByPeriod · object[]
responses_total
integer
default:0
score_distribution
Score Distribution · object | null
top_responses
Top Responses · object[]