curl --request GET \
--url 'https://api.finseo.ai/v1/projects/67a1c2d3e4f5061728394a5b/metrics?timeframe=30d' \
--header "Authorization: Bearer $FINSEO_API_KEY"
import requests
r = requests.get(
"https://api.finseo.ai/v1/projects/67a1c2d3e4f5061728394a5b/metrics",
headers={"Authorization": "Bearer sk_live_xxxxxxxx"},
params={"timeframe": "30d", "language": "en"},
)
metrics = r.json()["data"]
cur, chg = metrics["today"], metrics["changes"]
print(cur["responseVisibilityRate"], cur["mentionRate"], cur["citationRate"], chg["responseVisibilityRateChange"])
{
"data": {
"today": {
"date": "2026-09-08",
"visible": 28,
"notVisible": 14,
"mentions": 44,
"cited": 22,
"totalResponses": 84,
"position": 22.4,
"sentiment": 78,
"visibilityRate": 66.67,
"responseVisibilityRate": 59.52,
"mentionRate": 52.38,
"citationRate": 26.19
},
"yesterday": {
"date": "2026-08-09",
"visible": 22,
"notVisible": 20,
"mentions": 34,
"cited": 15,
"totalResponses": 76,
"position": 28.1,
"sentiment": 71,
"visibilityRate": 52.38,
"responseVisibilityRate": 50.0,
"mentionRate": 44.74,
"citationRate": 19.74
},
"changes": {
"visibleChange": 6,
"visibilityRateChange": 14.29,
"responseVisibilityRateChange": 9.52,
"mentionsChange": 10,
"citedChange": 7,
"mentionRateChange": 7.64,
"citationRateChange": 6.45,
"positionChange": -5.7,
"sentimentChange": 7
}
}
}
Metrics
Métricas do Projeto (Resumo)
GET
/
v1
/
projects
/
{projectId}
/
metrics
curl --request GET \
--url 'https://api.finseo.ai/v1/projects/67a1c2d3e4f5061728394a5b/metrics?timeframe=30d' \
--header "Authorization: Bearer $FINSEO_API_KEY"
import requests
r = requests.get(
"https://api.finseo.ai/v1/projects/67a1c2d3e4f5061728394a5b/metrics",
headers={"Authorization": "Bearer sk_live_xxxxxxxx"},
params={"timeframe": "30d", "language": "en"},
)
metrics = r.json()["data"]
cur, chg = metrics["today"], metrics["changes"]
print(cur["responseVisibilityRate"], cur["mentionRate"], cur["citationRate"], chg["responseVisibilityRateChange"])
{
"data": {
"today": {
"date": "2026-09-08",
"visible": 28,
"notVisible": 14,
"mentions": 44,
"cited": 22,
"totalResponses": 84,
"position": 22.4,
"sentiment": 78,
"visibilityRate": 66.67,
"responseVisibilityRate": 59.52,
"mentionRate": 52.38,
"citationRate": 26.19
},
"yesterday": {
"date": "2026-08-09",
"visible": 22,
"notVisible": 20,
"mentions": 34,
"cited": 15,
"totalResponses": 76,
"position": 28.1,
"sentiment": 71,
"visibilityRate": 52.38,
"responseVisibilityRate": 50.0,
"mentionRate": 44.74,
"citationRate": 19.74
},
"changes": {
"visibleChange": 6,
"visibilityRateChange": 14.29,
"responseVisibilityRateChange": 9.52,
"mentionsChange": 10,
"citedChange": 7,
"mentionRateChange": 7.64,
"citationRateChange": 6.45,
"positionChange": -5.7,
"sentimentChange": 7
}
}
}
Retorna métricas agregadas de visibilidade em IA para o período atual em comparação com o período anterior de mesma duração. Use isto em dashboards e KPIs de visibilidade da Finseo no ChatGPT, Claude, Perplexity e outros modelos monitorados.
A resposta traz o período atual em
Uma resposta pode contar tanto para
today e o período anterior em yesterday (nomes legados — cada bloco agrega o período inteiro e date é a data final do período). Todas as taxas compartilham o mesmo denominador, totalResponses (veja KPIs explicados):
| Campo | Significado |
|---|---|
responseVisibilityRate | Visibility — % de respostas em que a marca está visível: nomeada no texto OU domínio próprio citado como fonte (o KPI “Visibility” do dashboard) |
mentionRate | Mention Rate — % de respostas que nomeiam a marca no texto da resposta |
citationRate | Citation Rate — % de respostas que citam o domínio próprio (ou um alias de domínio configurado) como fonte |
mentions / cited | Contagens absolutas por trás de Mention Rate e Citation Rate (respostas, cada uma contada uma vez) |
visibilityRate | Cobertura de prompts — % de prompts monitorados com pelo menos uma resposta visível (um número diferente, geralmente mais alto) |
visible / notVisible | Número de prompts com / sem uma resposta visível |
position | Profundidade da menção — a que profundidade do texto da resposta a menção aparece (0 = topo), não é um ranking |
mentionRate quanto para citationRate, então responseVisibilityRate ≤ mentionRate + citationRate.
string
obrigatório
Identificador do projeto.
string
padrão:"30d"
Janela móvel, por exemplo
7d, 30d, 90d.string
Restrinja as métricas a um único modelo.
string
Filtre por idioma do Prompt.
string
Array JSON ou Tags separadas por vírgula para filtrar os Prompts.
integer
Incluído para o parsing compartilhado de query; as métricas ignoram paginação.
integer
Incluído para o parsing compartilhado de query; as métricas ignoram paginação.
curl --request GET \
--url 'https://api.finseo.ai/v1/projects/67a1c2d3e4f5061728394a5b/metrics?timeframe=30d' \
--header "Authorization: Bearer $FINSEO_API_KEY"
import requests
r = requests.get(
"https://api.finseo.ai/v1/projects/67a1c2d3e4f5061728394a5b/metrics",
headers={"Authorization": "Bearer sk_live_xxxxxxxx"},
params={"timeframe": "30d", "language": "en"},
)
metrics = r.json()["data"]
cur, chg = metrics["today"], metrics["changes"]
print(cur["responseVisibilityRate"], cur["mentionRate"], cur["citationRate"], chg["responseVisibilityRateChange"])
{
"data": {
"today": {
"date": "2026-09-08",
"visible": 28,
"notVisible": 14,
"mentions": 44,
"cited": 22,
"totalResponses": 84,
"position": 22.4,
"sentiment": 78,
"visibilityRate": 66.67,
"responseVisibilityRate": 59.52,
"mentionRate": 52.38,
"citationRate": 26.19
},
"yesterday": {
"date": "2026-08-09",
"visible": 22,
"notVisible": 20,
"mentions": 34,
"cited": 15,
"totalResponses": 76,
"position": 28.1,
"sentiment": 71,
"visibilityRate": 52.38,
"responseVisibilityRate": 50.0,
"mentionRate": 44.74,
"citationRate": 19.74
},
"changes": {
"visibleChange": 6,
"visibilityRateChange": 14.29,
"responseVisibilityRateChange": 9.52,
"mentionsChange": 10,
"citedChange": 7,
"mentionRateChange": 7.64,
"citationRateChange": 6.45,
"positionChange": -5.7,
"sentimentChange": 7
}
}
}