Listar sites

Parâmetros

Este endpoint não aceita parâmetros de caminho nem de consulta.

Corpo da requisição

Este endpoint não exige um corpo JSON.

Resposta

Retorna um objeto com um array websites.

• websites (Website[]): Sites monitorados visíveis para a conta do token.

Objeto Website

• id (string): UUID do site.
• accountGroupId (string): Grupo de conta resolvido a partir do token.
• domain (string): Domínio normalizado do site.
• url (string): URL do site.
• name (string | null): Nome de exibição.
• description (string | null): Contexto usado para pontuação de relevância.
• createdAt, updatedAt (ISO string | null): Carimbos de criação e atualização em formato ISO 8601, ou null.
• keywords (Keyword[]): Objetos Keyword deste site.

Objeto Keyword

• id (string): UUID da palavra-chave.
• websiteId (string): UUID do site principal.
• value (string): Texto da palavra-chave, até 255 caracteres.
• status (string): PENDING, ACTIVE, DISABLED ou SUSPENDED.
• createdAt, updatedAt (ISO string | null): Carimbos de criação e atualização em formato ISO 8601, ou null.

Notas

Use primeiro para descobrir valores websiteId e keywordId para chamadas posteriores.

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.