Saltar para o conteúdo principal
Cada número de um relatório de monitor vem de respostas pontuadas que você pode abrir. Esta página cobre os endpoints de leitura que as mostram: quais fontes são citadas, como as citações evoluem ao longo do tempo, a resposta por trás de uma pontuação, um prompt em detalhe, respostas por localização e a exportação completa. Eles só leem resultados armazenados, então não custam nada.

Quais fontes são citadas

GET /v1/monitors/{id}/sources (referência) ordena os domínios ou páginas que os mecanismos citaram, com a mesma janela e os mesmos filtros do relatório. Ele conta respostas distintas, não citações brutas: uma página citada três vezes em uma resposta conta uma vez.
Por exemplo:
As linhas são ordenadas por citations e depois por key. nextCursor é null na última página; não há corte dos N primeiros, então todo domínio ou página citado na janela pode ser alcançado. Trate o cursor como opaco.

Citações ao longo do tempo

GET /v1/monitors/{id}/citations (referência) retorna os dados por trás dos gráficos de citações do painel: totais da janela, uma série diária e os 20 principais domínios e páginas, cada um com sua própria série diária.
Aqui uma citação é uma página em uma resposta, então citations conta páginas citadas, não respostas. /sources conta respostas distintas, por isso os números podem diferir. kind é owned para os seus domínios; os outros tipos vêm de uma lista fixa de publicações conhecidas, e qualquer coisa desconhecida é other. A participação de uma fonte é o seu citations dividido por totals.citations. kind, q e offset só restringem domains, pages e pagination; totals, days e types sempre cobrem todas as fontes da janela.

Leia uma resposta

GET /v1/monitors/{id}/answers/{taskId} (referência) retorna a resposta armazenada por trás de uma pontuação, com aquilo com que ela foi comparada, para que uma menção possa ser conferida em vez de aceita na confiança. Os ids de tarefa vêm de evidenceTaskId, mentionTaskId e latestTaskId em um relatório, de /sources e das linhas exportadas.
Por exemplo:
Um id de tarefa que não é uma resposta pontuada deste monitor retorna 404 NOT_FOUND.

Um prompt em detalhe

GET /v1/monitors/{id}/prompt (referência) retorna os dados de um prompt. prompt (texto exato) é obrigatório e funciona para prompts que você já removeu do monitor; days é 7, 30 (padrão) ou 90.
Aqui citations conta páginas citadas entre as respostas, não respostas distintas. Para uma lista de fontes completa e paginada de um prompt, use /sources?prompt=....

Respostas por localização

GET /v1/monitors/{id}/grid (referência) retorna as respostas de um monitor por ponto da sua localização ou grade atual. engine (um dos mecanismos do monitor) e prompt, opcionais, restringem o resultado; days é 7, 30 (padrão) ou 90. A resposta tem location, grid, engine, prompt, windowDays e points. Cada ponto tem row, col, location, runs, mentioned, cited, topCompetitor ({ name, mentions } ou null) e latest ({ taskId, engine, mentioned, ranAt } da resposta mais nova, ou null). As respostas são associadas aos pontos pelas coordenadas exatas, então respostas de uma localização ou grade anterior do mesmo monitor ficam de fora. Um monitor sem localização nem grade não retorna pontos.

Exporte as respostas pontuadas

GET /v1/monitors/{id}/results (referência) retorna as próprias respostas pontuadas, para carga em um data warehouse, uma planilha ou uma apresentação. Para entregar cada resposta nova em um armazenamento em nuvem conforme uma agenda, veja Exportação de resultados.
A resposta JSON, por exemplo:
As linhas vêm da mais nova para a mais antiga. A paginação é um keyset sobre ranAt (precisão de microssegundos) e o id da linha, então linhas com o mesmo timestamp nunca são puladas nem repetidas. Para uma extração repetível, envie since e until explícitos, mantenha-os fixos e siga nextCursor até ele ser null. Mudar a janela entre páginas pode pular ou repetir linhas. Trate o cursor como opaco.

CSV

Com format=csv, a resposta é text/csv, UTF-8 com BOM para que os aplicativos de planilha a abram corretamente. Um corpo CSV não carrega a paginação, então ela vai para os cabeçalhos: As colunas são ran_at, monitor, engine, prompt, mentioned, cited, position, competitors, task_id, mais answer_text, sources, scoring_context com includeEvidence=true. competitors junta os nomes com |; sources e scoring_context trazem texto JSON. Uma célula que começa com =, +, -, @, tabulação ou retorno de carro recebe o prefixo ', para que o texto do mecanismo não vire fórmula de planilha.

Erros e limites

Parâmetros inválidos retornam 400 VALIDATION_ERROR indicando o problema, inclusive um cursor que não foi retornado pela página anterior. Um monitor de outra conta, ou um id de tarefa desconhecido, retorna 404 NOT_FOUND. Veja Monitores para os códigos compartilhados.

Próximos passos

Eventos e alertas

Receba um webhook quando as respostas a um prompt mudarem.

Exportação de resultados

Entregue as respostas pontuadas no seu próprio armazenamento conforme uma agenda.