Listar menções

Parâmetros

• websiteId (consulta, UUID, opcional): Filtra para um único site.
• statuses (consulta, repetível, opcional): Status de menção: NEW, APPROVED, REJECTED.
• scoreBuckets (consulta, repetível, opcional): Faixas de relevância: VERY_LOW, LOW, MEDIUM, HIGH, VERY_HIGH.
• includeLowRelevance (consulta, booleano, opcional): Inclui menções abaixo da pontuação mínima do site (30 por padrão).
• minScore (consulta, inteiro, opcional, 0-100): Apenas menções com pelo menos essa pontuação. Menções sem pontuação ficam de fora. A pontuação mínima do site continua valendo, a menos que includeLowRelevance seja true.
• keywords (consulta, repetível, opcional): Filtra por valores de palavra-chave.
• sources (consulta, repetível, opcional): Fontes de menção: REDDIT_POST, REDDIT_COMMENT, TWITTER (X), BLUESKY, HACKERNEWS, FACEBOOK, FACEBOOK_GROUP.
• sort (consulta, opcional): Ordenação: RELEVANCE ou RECENT.
• from, to (consulta, string ISO, opcional): Intervalo de datas de ingestão.
• limit (consulta, inteiro, opcional, 1-500, padrão 50): Tamanho da página.
• offset (consulta, inteiro, opcional, mínimo 0, padrão 0): Deslocamento de paginação.

Corpo da requisição

Este endpoint não exige um corpo JSON.

Resposta

Retorna objetos Mention públicos paginados.

• mentions (Mention[]): Menções da página atual.
• total (number): Total de menções correspondentes.
• limit (number): Tamanho da página usado pela resposta.
• offset (number): Deslocamento de paginação usado pela resposta.

Objeto Mention

• id (string): UUID da menção.
• websiteId (string | null): UUID do site.
• source (string): REDDIT_POST, REDDIT_COMMENT, TWITTER (X), BLUESKY, HACKERNEWS, FACEBOOK ou FACEBOOK_GROUP.
• keyword (string | null): Valor de palavra-chave que correspondeu.
• title, contentText, url, author, subreddit (string | null): Contexto de título, conteúdo e link. subreddit contém o subreddit nas fontes do Reddit e o id do grupo em FACEBOOK_GROUP, e é null nas demais fontes.
• status (string): NEW, APPROVED ou REJECTED.
• relevanceScore (number | null): Pontuação de relevância de IA de 0 a 100, ou null.
• relevanceReason (string | null): Explicação de IA para a correspondência, ou null.
• aiReplySuggestion (string | null): Resposta redigida por IA para uma pessoa revisar antes de publicar, ou null.
• tags (string[]): Tags de relevância geradas por IA.
• publishedAt, ingestedAt, reviewedAt, createdAt, updatedAt (ISO string | null): Carimbos de publicação, ingestão, revisão, criação e atualização em formato ISO 8601, ou null.

Notas

Por padrão, menções REJECTED são excluídas e menções abaixo da pontuação mínima do site (30 por padrão) ficam ocultas. minScore filtra ainda mais e nunca reduz esse limite sozinho. Faixas: VERY_LOW <10, LOW 10-29, MEDIUM 30-49, HIGH 50-74, VERY_HIGH >=75.

Erros

• 400 Bad Request: Entrada, URL, UUID, enum, parâmetro de consulta ou corpo inválido.
• 401 Unauthorized: Bearer token ausente ou inválido, ou code: "token_issuer_lost_access" quando a pessoa que criou a chave API foi desativada ou saiu do workspace.
• 403 Forbidden: code: "subscription_required" quando o plano do workspace não inclui acesso à API, code: "workspace_access_denied" quando X-Workspace-Id indica um workspace que esta credencial não pode alcançar, ou code: "permission_denied" quando seu papel no workspace não tem a permissão redreplier.write (Admin e Editor têm).
• 404 Not Found: O recurso não existe para a conta do token.
• 429 Too Many Requests: Limite de requisições excedido. Aguarde os segundos indicados em Retry-After.
• 500 Internal Server Error: Erro inesperado do servidor.