SimilarWeb Digital Rank API

Visão geral

A SimilarWeb Digital Rank API oferece acesso gratuito a dados globais de ranking de sites para benchmarking e análise competitiva. Com a integração no SquadOS, seus agentes podem recuperar listas de sites mais visitados por país e categoria, consultar metadados de campanhas de rastreamento de posicionamento e verificar o status da assinatura para monitorar o uso dos créditos disponíveis.

• Documentação na Composio: docs.composio.dev/toolkits/similarweb_digitalrank_api

Autenticação

Esta ferramenta utiliza chave de API (API_KEY) para conectar.

Você vai precisar dos seguintes campos:

Campo	Obrigatório	Descrição
api_key	Sim	Chave de API gerada no painel SimilarWeb em Configurações → API.

Como obter a credencial

1. Acesse account.similarweb.com/standard-api com sua conta SimilarWeb.
2. Clique em Generate A New API Key.
3. Informe um nome descritivo para a chave (ex.: SquadOS) e clique em Create.
4. Sua nova chave aparecerá na tabela Generated Keys — copie o valor exibido.

Dica

Use uma chave dedicada para o SquadOS. A SimilarWeb permite gerenciar múltiplas chaves individualmente, facilitando a revogação sem afetar outras integrações.

Como conectar no SquadOS

1. Acesse Ferramentas no menu lateral (/admin/tools).
2. Abra a aba Disponíveis e procure por SimilarWeb Digital Rank API.
3. Clique no card para abrir o modal de detalhes e em Conectar.
4. Você é levado para a página de conexão segura hospedada pela Composio, onde informa a chave de API obtida acima.
5. Ao concluir, você volta para o SquadOS com a conta conectada e a ferramenta disponível para os agentes. (Detalhes do fluxo em Ferramentas da Organização.)

Ações disponíveis

Obter metadados de campanha do Rank Tracker

SIMILARWEB_DIGITALRANK_API_GET_RANK_TRACKER_DESCRIBE

Recupera os metadados de campanha para rastreamento de posicionamento. Retorna os IDs de campanha e as configurações de scraping necessárias para consultar outras APIs do Rank Tracker.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter principais sites do SimilarRank

SIMILARWEB_DIGITALRANK_API_GET_SIMILAR_RANK_TOP_SITES

Recupera uma lista dos sites mais bem posicionados globalmente ou filtrada por país e categoria. Use quando precisar descobrir sites populares com base nos dados de tráfego do SimilarWeb.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
limit	integer	Não	Número máximo de sites a retornar. Controla a paginação dos resultados.
country	string	Não	Código de país para filtrar os principais sites por país específico (ex.: us, gb, fr). Se não informado, retorna os sites globais.
category	string	Não	Categoria para filtrar os principais sites por setor ou tópico específico (ex.: shopping, news, social_media). Se não informada, retorna todas as categorias.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter status da assinatura

SIMILARWEB_DIGITALRANK_API_GET_SUBSCRIPTION_STATUS

Verifica o uso restante da assinatura do usuário.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.