Skip to main content
GET
/
api
/
v1
/
public
/
quests
/
metrics
Métricas de quests
curl --request GET \
  --url https://api.indiqai.com/api/v1/public/quests/metrics \
  --header 'X-API-Key: <x-api-key>'
{
  "quest_id": "<string>",
  "status": "<string>",
  "title": "<string>",
  "type": "<string>",
  "avg_score": 123,
  "completion_rate": 0,
  "detractors": 123,
  "neutrals": 123,
  "nps_score": 123,
  "period_days": 30,
  "promoters": 123,
  "responses_by_period": [
    {
      "period": "<string>",
      "avg_score": 123,
      "count": 0
    }
  ],
  "responses_total": 0,
  "score_distribution": {},
  "top_responses": [
    {}
  ]
}

Documentation Index

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

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

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
top_responses
Top Responses · object[]