API Hop

Documentação

Documentação do API Hop

Referência da API Similarweb

Parâmetros de consulta, valores padrão e formatos nativos de resposta dos endpoints Similarweb.

Todos os caminhos abaixo são relativos à origem da sua API. Toda requisição exige Authorization: Bearer YOUR_API_KEY, usa GET e não tem corpo. Consulte autenticação, cobrança e erros.

Regras de consulta

Os campos singulares de site key e Key exigem um único domínio ASCII, como amazon.com, com até 253 caracteres e sem espaços nas extremidades. Não envie URL, endereço IP, lista de domínios ou credenciais de API nesses campos. Use punycode para domínios internacionalizados.

Os nomes dos parâmetros diferenciam maiúsculas de minúsculas. Campos desconhecidos, campos duplicados, CR/LF/NUL e valores inválidos são rejeitados. Valores booleanos são os literais true ou false; zero não equivale a false. O texto deve ter 1-2048 bytes UTF-8 após remover espaços nas extremidades. Codifique espaços, arrays JSON e separadores com o codificador de consultas do seu cliente HTTP.

from e to devem aparecer juntos, ser datas reais do calendário no formato YYYY-MM-DD ou YYYY|MM|DD e satisfazer from <= to. Um par de comparação segue a mesma regra. Campos opcionais herdam os valores padrão do endpoint; as tabelas listam campos permitidos, sem exigir que todos sejam enviados.

Nos endpoints que aceitam datas, um intervalo explícito from/to válido e completo tem prioridade. Se o endpoint aceita latest, o valor informado ainda deve passar pelas validações existentes de formato e do endpoint, mas é ignorado na seleção do intervalo e não é enviado ao Similarweb; nenhum latest padrão é adicionado. Sem um intervalo explícito, as regras existentes de latest, valores padrão e janelas permanecem inalteradas. As restrições de History continuam válidas; endpoints que não aceitam latest continuam rejeitando esse campo.

Sem um intervalo explícito from/to: Rotas baseadas em janela normalmente usam 28 dias terminando três dias UTC atrás e aceitam de latest=1d a 366d. Rotas de meses fixos têm os valores padrão indicados abaixo. Engajamento, visitas, classificações e canais também aceitam latest=1m|2m|3m|6m para meses anteriores completos do calendário UTC; esses seletores exigem isWindow=false e usam timeGranularity=Monthly por padrão. O histórico tem regras mais restritas documentadas para seus quatro endpoints.

Somente dados mundiais são aceitos (country=999). Identificadores de sites são domínios como example.com, exceto no endpoint de classificação por palavra-chave, em que keys é uma palavra-chave de busca. A disponibilidade de dados, os filtros e os tipos de correspondência da fonte upstream podem variar. Outros valores de país válidos são alterados para 999 antes da solicitação ao fornecedor e retornam dados mundiais, não do país indicado.

Respostas bem-sucedidas preservam o JSON nativo em vez de adotar um esquema universal. Tabelas de referências de entrada e saída usam Records; métricas históricas podem usar Data aninhados. Os nomes e as unidades abaixo não implicam que todo campo opcional da fonte upstream esteja sempre presente.

Pontos de acesso

Sugestões de palavras-chave

GET https://api.apihop.ai/v1/similarweb/keywords/suggestions

Valores padrão: country 999, latest 28d, rowsPerPage 100, type Broad, websource Total e windowVolume em ordem decrescente. O parâmetro opcional page começa em 1. rangeFilter usa a sintaxe nativa, por exemplo volume,100,10000|difficulty,0,40. A disponibilidade de tipos de correspondência e filtros depende da fonte de dados. Somente dados mundiais são aceitos (country=999).

Campo de consultaObrigatórioTipo e restrições
keywordSimString; 1-2048 bytes UTF-8 após remover espaços nas extremidades
countryNãoString de inteiro não negativo; Somente dados mundiais são aceitos (country=999). Outros valores de país válidos são alterados para 999 antes da solicitação ao fornecedor e retornam dados mundiais, não do país indicado.
fromNãoString; data válida nos formatos acima
toNãoString; data válida nos formatos acima
latestNãoString; 1-2048 bytes UTF-8 após remover espaços nas extremidades
sortNãoString; 1-2048 bytes UTF-8 após remover espaços nas extremidades
ascNãoString booleana: true ou false
pageNãoString de inteiro; 1-1000
rowsPerPageNãoString de inteiro; 1-1000
typeNãoString; valores permitidos: Broad, Phrase, Exact, Related
websourceNãoString; valores permitidos: Total, Desktop, MobileWeb
isWindowNãoString booleana: true ou false
rangeFilterNãoString; 1-2048 bytes UTF-8 após remover espaços nas extremidades

GET https://api.apihop.ai/v1/similarweb/websites/backlinks

Valores padrão: Page 1, PageSize 100, Status All, FollowType All e DomainScore em ordem decrescente. Key começa com maiúscula; não use key nem keys.

Campo de consultaObrigatórioTipo e restrições
KeySimString; 1-2048 bytes UTF-8 após remover espaços nas extremidades
PageNãoString de inteiro; 1-1000
PageSizeNãoString de inteiro; 1-1000
StatusNãoString; valores permitidos: All, Active, New, Lost
FollowTypeNãoString; valores permitidos: All, DoFollowOnly, NoFollowOnly, DoFollow, NoFollow
DomainScoreFromNãoString de inteiro; 0-100
DomainScoreToNãoString de inteiro; 0-100
sortNãoString; 1-2048 bytes UTF-8 após remover espaços nas extremidades
ascNãoString booleana: true ou false

Palavras-chave do site

GET https://api.apihop.ai/v1/similarweb/websites/keywords

Valores padrão: page 1, pageSize 100, sourceType all e ambos os indicadores de marca false. pageFilterJson é uma única string de array JSON codificada para URL; quando omitida, usa keys como domínio. Sem um intervalo explícito from/to: latest=1m seleciona o modo de visão geral de um mês com pageSize 5 e isWindow=false, salvo indicação explícita. Use sourceType=organic ou paid com IncludeNoneBranded=true e IncludeBranded=false para visualizar palavras-chave sem marca.

Campo de consultaObrigatórioTipo e restrições
keysSimString; 1-2048 bytes UTF-8 após remover espaços nas extremidades
countryNãoString de inteiro não negativo; Somente dados mundiais são aceitos (country=999). Outros valores de país válidos são alterados para 999 antes da solicitação ao fornecedor e retornam dados mundiais, não do país indicado.
fromNãoString; data válida nos formatos acima
toNãoString; data válida nos formatos acima
includeSubDomainsNãoString booleana: true ou false
isWindowNãoString booleana: true ou false
webSourceNãoString; valores permitidos: Total, Desktop, MobileWeb
timeGranularityNãoString; valores permitidos: Daily, Monthly
latestNãoString; 1-2048 bytes UTF-8 após remover espaços nas extremidades
sortNãoString; 1-2048 bytes UTF-8 após remover espaços nas extremidades
ascNãoString booleana: true ou false
isoNãoString; 1-2048 bytes UTF-8 após remover espaços nas extremidades
isDailyNãoString booleana: true ou false
IncludeBrandedNãoString booleana: true ou false
IncludeNoneBrandedNãoString booleana: true ou false
pageNãoString de inteiro; 1-1000
pageSizeNãoString de inteiro; 1-1000
sourceTypeNãoString; 1-2048 bytes UTF-8 após remover espaços nas extremidades
pageFilterJsonNãoString contendo um array JSON

Sites classificados por palavra-chave

GET https://api.apihop.ai/v1/similarweb/keywords/websites

keys é uma palavra-chave, não um domínio de site. Os valores padrão incluem selectedPageTab=Organic, sourceType=organic, Device=Total e graphDuration=28d. Os parâmetros opcionais page e pageSize usam, respectivamente, inteiros a partir de 1 e inteiros positivos.

Campo de consultaObrigatórioTipo e restrições
keysSimString; 1-2048 bytes UTF-8 após remover espaços nas extremidades
countryNãoString de inteiro não negativo; Somente dados mundiais são aceitos (country=999). Outros valores de país válidos são alterados para 999 antes da solicitação ao fornecedor e retornam dados mundiais, não do país indicado.
fromNãoString; data válida nos formatos acima
toNãoString; data válida nos formatos acima
includeSubDomainsNãoString booleana: true ou false
isWindowNãoString booleana: true ou false
webSourceNãoString; valores permitidos: Total, Desktop, MobileWeb
timeGranularityNãoString; valores permitidos: Daily, Monthly
latestNãoString; 1-2048 bytes UTF-8 após remover espaços nas extremidades
sortNãoString; 1-2048 bytes UTF-8 após remover espaços nas extremidades
ascNãoString booleana: true ou false
isoNãoString; 1-2048 bytes UTF-8 após remover espaços nas extremidades
isDailyNãoString booleana: true ou false
tabNãoString de inteiro não negativo
mtdNãoString booleana: true ou false
selectedPageTabNãoString; valores permitidos: Organic, Paid
graphDurationNãoString; 1-2048 bytes UTF-8 após remover espaços nas extremidades
graphTypeNãoString de inteiro; 1-1000
isDurationChangedNãoString booleana: true ou false
ignoreFilterConsistencyNãoString booleana: true ou false
DeviceNãoString; 1-2048 bytes UTF-8 após remover espaços nas extremidades
sourceTypeNãoString; 1-2048 bytes UTF-8 após remover espaços nas extremidades
pageNãoString de inteiro; 1-1000
pageSizeNãoString de inteiro; 1-1000

Fontes de tráfego

GET https://api.apihop.ai/v1/similarweb/websites/traffic-sources

Valores padrão: sourceType=Referral, page=1, orderBy=Share desc e timeGranularity=Daily. Esta tabela é distinta do endpoint de referências de entrada.

Campo de consultaObrigatórioTipo e restrições
keysSimString; 1-2048 bytes UTF-8 após remover espaços nas extremidades
countryNãoString de inteiro não negativo; Somente dados mundiais são aceitos (country=999). Outros valores de país válidos são alterados para 999 antes da solicitação ao fornecedor e retornam dados mundiais, não do país indicado.
fromNãoString; data válida nos formatos acima
toNãoString; data válida nos formatos acima
includeSubDomainsNãoString booleana: true ou false
isWindowNãoString booleana: true ou false
webSourceNãoString; valores permitidos: Total, Desktop, MobileWeb
timeGranularityNãoString; valores permitidos: Daily, Monthly
latestNãoString; 1-2048 bytes UTF-8 após remover espaços nas extremidades
sourceTypeNãoString; 1-2048 bytes UTF-8 após remover espaços nas extremidades
ignoreFilterConsistencyNãoString booleana: true ou false
pageNãoString de inteiro; 1-1000
orderByNãoString; 1-2048 bytes UTF-8 após remover espaços nas extremidades

Tráfego de saída

GET https://api.apihop.ai/v1/similarweb/websites/outgoing-traffic

from e to são obrigatórios. Somente key no singular. Valores padrão: country=999, isWWW=false, isWindow=false, webSource=Total, page=1, orderby=Share desc, orderBy=Share desc, sort=Share, asc=false. orderby e orderBy são distintos e encaminhados de forma independente; mantenha-os consistentes. Não são aceitos latest, pageSize, rowsPerPage, includeSubDomains ou timeGranularity. As linhas ficam em Records; TotalCount é o total da fonte upstream, não o tamanho da página atual. Somente dados mundiais são aceitos (country=999).

Campo de consultaObrigatórioTipo e restrições
keySimString; 1-2048 bytes UTF-8 após remover espaços nas extremidades
countryNãoString de inteiro não negativo; Somente dados mundiais são aceitos (country=999). Outros valores de país válidos são alterados para 999 antes da solicitação ao fornecedor e retornam dados mundiais, não do país indicado.
fromSimString; data válida nos formatos acima
toSimString; data válida nos formatos acima
isWWWNãoString booleana: true ou false
isWindowNãoString booleana: true ou false
webSourceNãoString; valores permitidos: Total, Desktop, MobileWeb
orderbyNãoString; 1-2048 bytes UTF-8 após remover espaços nas extremidades
orderByNãoString; 1-2048 bytes UTF-8 após remover espaços nas extremidades
sortNãoString; 1-2048 bytes UTF-8 após remover espaços nas extremidades
ascNãoString booleana: true ou false
pageNãoString de inteiro; 1-1000

Referências de entrada

GET https://api.apihop.ai/v1/similarweb/websites/incoming-referrals

Somente key no singular. Valores padrão: country=999, latest=28d, isWWW=false, isWindow=true, isDaily=false, webSource=Total, selectedTab=incomingTraffic, orderBy=TotalShare desc, ignoreFilterConsistency=false, page=1. Não são aceitos keys, pageSize, rowsPerPage, includeSubDomains ou timeGranularity. As linhas ficam em Records; campos nativos podem incluir SiteOrigins e TotalShare. Somente dados mundiais são aceitos (country=999).

Campo de consultaObrigatórioTipo e restrições
keySimString; 1-2048 bytes UTF-8 após remover espaços nas extremidades
countryNãoString de inteiro não negativo; Somente dados mundiais são aceitos (country=999). Outros valores de país válidos são alterados para 999 antes da solicitação ao fornecedor e retornam dados mundiais, não do país indicado.
fromNãoString; data válida nos formatos acima
toNãoString; data válida nos formatos acima
isWWWNãoString booleana: true ou false
isoNãoString; 1-2048 bytes UTF-8 após remover espaços nas extremidades
isWindowNãoString booleana: true ou false
isDailyNãoString booleana: true ou false
latestNãoString; 1-2048 bytes UTF-8 após remover espaços nas extremidades
webSourceNãoString; valores permitidos: Total, Desktop, MobileWeb
selectedTabNãoString; valores permitidos: incomingTraffic
orderByNãoString; 1-2048 bytes UTF-8 após remover espaços nas extremidades
ignoreFilterConsistencyNãoString booleana: true ou false
pageNãoString de inteiro; 1-1000

Participação de palavras-chave de marca

GET https://api.apihop.ai/v1/similarweb/websites/branded-keywords

O padrão é o mês UTC completo anterior. duration é fixado em 1m.

Campo de consultaObrigatórioTipo e restrições
keysSimString; 1-2048 bytes UTF-8 após remover espaços nas extremidades
countryNãoString de inteiro não negativo; Somente dados mundiais são aceitos (country=999). Outros valores de país válidos são alterados para 999 antes da solicitação ao fornecedor e retornam dados mundiais, não do país indicado.
fromNãoString; data válida nos formatos acima
toNãoString; data válida nos formatos acima
includeSubDomainsNãoString booleana: true ou false
isWindowNãoString booleana: true ou false
webSourceNãoString; valores permitidos: Total, Desktop, MobileWeb
timeGranularityNãoString; valores permitidos: Daily, Monthly
latestNãoString; 1-2048 bytes UTF-8 após remover espaços nas extremidades
durationNãoString; valores permitidos: 1m

Distribuição geográfica do tráfego

GET https://api.apihop.ai/v1/similarweb/websites/geography

O padrão são os três meses UTC completos anteriores, pageSize=5 e orderBy=TotalShare desc.

Campo de consultaObrigatórioTipo e restrições
keysSimString; 1-2048 bytes UTF-8 após remover espaços nas extremidades
countryNãoString de inteiro não negativo; Somente dados mundiais são aceitos (country=999). Outros valores de país válidos são alterados para 999 antes da solicitação ao fornecedor e retornam dados mundiais, não do país indicado.
fromNãoString; data válida nos formatos acima
toNãoString; data válida nos formatos acima
includeSubDomainsNãoString booleana: true ou false
isWindowNãoString booleana: true ou false
webSourceNãoString; valores permitidos: Total, Desktop, MobileWeb
timeGranularityNãoString; valores permitidos: Daily, Monthly
latestNãoString; 1-2048 bytes UTF-8 após remover espaços nas extremidades
pageSizeNãoString de inteiro; 1-1000
orderByNãoString; 1-2048 bytes UTF-8 após remover espaços nas extremidades

Distribuição por dispositivo

GET https://api.apihop.ai/v1/similarweb/websites/devices

O padrão são os três meses UTC completos anteriores e ShouldGetVerifiedData=false.

Campo de consultaObrigatórioTipo e restrições
keysSimString; 1-2048 bytes UTF-8 após remover espaços nas extremidades
countryNãoString de inteiro não negativo; Somente dados mundiais são aceitos (country=999). Outros valores de país válidos são alterados para 999 antes da solicitação ao fornecedor e retornam dados mundiais, não do país indicado.
fromNãoString; data válida nos formatos acima
toNãoString; data válida nos formatos acima
includeSubDomainsNãoString booleana: true ou false
isWindowNãoString booleana: true ou false
webSourceNãoString; valores permitidos: Total, Desktop, MobileWeb
timeGranularityNãoString; valores permitidos: Daily, Monthly
latestNãoString; 1-2048 bytes UTF-8 após remover espaços nas extremidades
ShouldGetVerifiedDataNãoString booleana: true ou false

Desempenho de busca

GET https://api.apihop.ai/v1/similarweb/websites/search-performance

O padrão é o mês UTC completo anterior, pageSize=5, duration=1m e SourceType=Organic. Use SourceType=Paid para palavras-chave pagas; não substitua por sourceType.

Campo de consultaObrigatórioTipo e restrições
keysSimString; 1-2048 bytes UTF-8 após remover espaços nas extremidades
countryNãoString de inteiro não negativo; Somente dados mundiais são aceitos (country=999). Outros valores de país válidos são alterados para 999 antes da solicitação ao fornecedor e retornam dados mundiais, não do país indicado.
fromNãoString; data válida nos formatos acima
toNãoString; data válida nos formatos acima
includeSubDomainsNãoString booleana: true ou false
isWindowNãoString booleana: true ou false
webSourceNãoString; valores permitidos: Total, Desktop, MobileWeb
timeGranularityNãoString; valores permitidos: Daily, Monthly
latestNãoString; 1-2048 bytes UTF-8 após remover espaços nas extremidades
pageSizeNãoString de inteiro; 1-1000
durationNãoString; valores permitidos: 1m
SourceTypeNãoString; valores permitidos: Organic, Paid

Tráfego de redes sociais

GET https://api.apihop.ai/v1/similarweb/websites/social-traffic

O padrão são os três meses UTC completos anteriores. webSource não é aceito.

Campo de consultaObrigatórioTipo e restrições
keysSimString; 1-2048 bytes UTF-8 após remover espaços nas extremidades
countryNãoString de inteiro não negativo; Somente dados mundiais são aceitos (country=999). Outros valores de país válidos são alterados para 999 antes da solicitação ao fornecedor e retornam dados mundiais, não do país indicado.
fromNãoString; data válida nos formatos acima
toNãoString; data válida nos formatos acima
includeSubDomainsNãoString booleana: true ou false
isWindowNãoString booleana: true ou false
timeGranularityNãoString; valores permitidos: Daily, Monthly
latestNãoString; 1-2048 bytes UTF-8 após remover espaços nas extremidades

Visão geral de engajamento

GET https://api.apihop.ai/v1/similarweb/websites/engagement

Os valores padrão incluem ShouldGetVerifiedData=false, includeLeaders=true e unBounced=false. Linhas nativas de Data podem conter AvgMonthVisits, BounceRate, PagesPerVisit e AvgVisitDuration.

Campo de consultaObrigatórioTipo e restrições
keysSimString; 1-2048 bytes UTF-8 após remover espaços nas extremidades
countryNãoString de inteiro não negativo; Somente dados mundiais são aceitos (country=999). Outros valores de país válidos são alterados para 999 antes da solicitação ao fornecedor e retornam dados mundiais, não do país indicado.
fromNãoString; data válida nos formatos acima
toNãoString; data válida nos formatos acima
includeSubDomainsNãoString booleana: true ou false
isWindowNãoString booleana: true ou false
webSourceNãoString; valores permitidos: Total, Desktop, MobileWeb
timeGranularityNãoString; valores permitidos: Daily, Monthly
latestNãoString; 1-2048 bytes UTF-8 após remover espaços nas extremidades
ShouldGetVerifiedDataNãoString booleana: true ou false
includeLeadersNãoString booleana: true ou false
unBouncedNãoString booleana: true ou false
betaNãoString booleana: true ou false

Total de visitas

GET https://api.apihop.ai/v1/similarweb/websites/visits

compareFrom e compareTo devem ser fornecidos juntos como datas válidas e ordenadas. timeGranularity é Monthly. Campos nativos podem incluir TotalVisits, Change e ShareOfVisits; um total móvel não é necessariamente o total de um mês completo do calendário.

Campo de consultaObrigatórioTipo e restrições
keysSimString; 1-2048 bytes UTF-8 após remover espaços nas extremidades
countryNãoString de inteiro não negativo; Somente dados mundiais são aceitos (country=999). Outros valores de país válidos são alterados para 999 antes da solicitação ao fornecedor e retornam dados mundiais, não do país indicado.
fromNãoString; data válida nos formatos acima
toNãoString; data válida nos formatos acima
includeSubDomainsNãoString booleana: true ou false
isWindowNãoString booleana: true ou false
webSourceNãoString; valores permitidos: Total, Desktop, MobileWeb
timeGranularityNãoString; valores permitidos: Monthly
latestNãoString; 1-2048 bytes UTF-8 após remover espaços nas extremidades
compareFromNãoString; data válida nos formatos acima
compareToNãoString; data válida nos formatos acima
ShouldGetVerifiedDataNãoString booleana: true ou false

Tabela de visitas

GET https://api.apihop.ai/v1/similarweb/websites/visits/table

compareFrom e compareTo devem ser fornecidos juntos como datas válidas e ordenadas. timeGranularity é Monthly; as linhas ficam em Data, com Domain e TotalVisits. TotalCount pode ser 0 mesmo quando Data contém linhas; examine o próprio array para determinar se há resultados.

Campo de consultaObrigatórioTipo e restrições
keysSimString; 1-2048 bytes UTF-8 após remover espaços nas extremidades
countryNãoString de inteiro não negativo; Somente dados mundiais são aceitos (country=999). Outros valores de país válidos são alterados para 999 antes da solicitação ao fornecedor e retornam dados mundiais, não do país indicado.
fromNãoString; data válida nos formatos acima
toNãoString; data válida nos formatos acima
includeSubDomainsNãoString booleana: true ou false
isWindowNãoString booleana: true ou false
webSourceNãoString; valores permitidos: Total, Desktop, MobileWeb
timeGranularityNãoString; valores permitidos: Monthly
latestNãoString; 1-2048 bytes UTF-8 após remover espaços nas extremidades
compareFromNãoString; data válida nos formatos acima
compareToNãoString; data válida nos formatos acima
ShouldGetVerifiedDataNãoString booleana: true ou false

Tendência de visitas

GET https://api.apihop.ai/v1/similarweb/websites/visits/trend

O padrão é a janela móvel de 28 dias com dados diários. timeGranularity aceita Daily, Weekly ou Monthly.

Campo de consultaObrigatórioTipo e restrições
keysSimString; 1-2048 bytes UTF-8 após remover espaços nas extremidades
countryNãoString de inteiro não negativo; Somente dados mundiais são aceitos (country=999). Outros valores de país válidos são alterados para 999 antes da solicitação ao fornecedor e retornam dados mundiais, não do país indicado.
fromNãoString; data válida nos formatos acima
toNãoString; data válida nos formatos acima
includeSubDomainsNãoString booleana: true ou false
isWindowNãoString booleana: true ou false
webSourceNãoString; valores permitidos: Total, Desktop, MobileWeb
timeGranularityNãoString; valores permitidos: Daily, Weekly, Monthly
latestNãoString; 1-2048 bytes UTF-8 após remover espaços nas extremidades
ShouldGetVerifiedDataNãoString booleana: true ou false

Classificações de sites

GET https://api.apihop.ai/v1/similarweb/websites/ranks

timeGranularity é Monthly. A resposta nativa usa objetos distintos GlobalRank, CountryRank e CategoryRank.

Campo de consultaObrigatórioTipo e restrições
keysSimString; 1-2048 bytes UTF-8 após remover espaços nas extremidades
countryNãoString de inteiro não negativo; Somente dados mundiais são aceitos (country=999). Outros valores de país válidos são alterados para 999 antes da solicitação ao fornecedor e retornam dados mundiais, não do país indicado.
fromNãoString; data válida nos formatos acima
toNãoString; data válida nos formatos acima
includeSubDomainsNãoString booleana: true ou false
isWindowNãoString booleana: true ou false
webSourceNãoString; valores permitidos: Total, Desktop, MobileWeb
timeGranularityNãoString; valores permitidos: Monthly
latestNãoString; 1-2048 bytes UTF-8 após remover espaços nas extremidades

Classificações por país

GET https://api.apihop.ai/v1/similarweb/websites/ranks/country

timeGranularity é Monthly. Esta é a tabela explícita de classificação por país, não a resposta combinada de classificações. As linhas ficam em Data, com Domain e Rank. TotalCount pode ser 0 mesmo quando há linhas; examine Data diretamente.

Campo de consultaObrigatórioTipo e restrições
keysSimString; 1-2048 bytes UTF-8 após remover espaços nas extremidades
countryNãoString de inteiro não negativo; Somente dados mundiais são aceitos (country=999). Outros valores de país válidos são alterados para 999 antes da solicitação ao fornecedor e retornam dados mundiais, não do país indicado.
fromNãoString; data válida nos formatos acima
toNãoString; data válida nos formatos acima
includeSubDomainsNãoString booleana: true ou false
isWindowNãoString booleana: true ou false
webSourceNãoString; valores permitidos: Total, Desktop, MobileWeb
timeGranularityNãoString; valores permitidos: Monthly
latestNãoString; 1-2048 bytes UTF-8 após remover espaços nas extremidades

Classificações globais

GET https://api.apihop.ai/v1/similarweb/websites/ranks/global

timeGranularity é Monthly. Retorna a tabela separada de classificação global. As linhas ficam em Data, com Domain e Rank. TotalCount pode ser 0 mesmo quando há linhas; examine Data diretamente.

Campo de consultaObrigatórioTipo e restrições
keysSimString; 1-2048 bytes UTF-8 após remover espaços nas extremidades
countryNãoString de inteiro não negativo; Somente dados mundiais são aceitos (country=999). Outros valores de país válidos são alterados para 999 antes da solicitação ao fornecedor e retornam dados mundiais, não do país indicado.
fromNãoString; data válida nos formatos acima
toNãoString; data válida nos formatos acima
includeSubDomainsNãoString booleana: true ou false
isWindowNãoString booleana: true ou false
webSourceNãoString; valores permitidos: Total, Desktop, MobileWeb
timeGranularityNãoString; valores permitidos: Monthly
latestNãoString; 1-2048 bytes UTF-8 após remover espaços nas extremidades

Classificações por categoria

GET https://api.apihop.ai/v1/similarweb/websites/ranks/category

timeGranularity é Monthly. Retorna a tabela separada de classificação por setor/categoria. As linhas ficam em Data, com Domain e Rank. TotalCount pode ser 0 mesmo quando há linhas; examine Data diretamente.

Campo de consultaObrigatórioTipo e restrições
keysSimString; 1-2048 bytes UTF-8 após remover espaços nas extremidades
countryNãoString de inteiro não negativo; Somente dados mundiais são aceitos (country=999). Outros valores de país válidos são alterados para 999 antes da solicitação ao fornecedor e retornam dados mundiais, não do país indicado.
fromNãoString; data válida nos formatos acima
toNãoString; data válida nos formatos acima
includeSubDomainsNãoString booleana: true ou false
isWindowNãoString booleana: true ou false
webSourceNãoString; valores permitidos: Total, Desktop, MobileWeb
timeGranularityNãoString; valores permitidos: Monthly
latestNãoString; 1-2048 bytes UTF-8 após remover espaços nas extremidades

Canais de tráfego

GET https://api.apihop.ai/v1/similarweb/websites/channels

O padrão é a janela móvel de 28 dias com dados diários. Com webSource=Total, os valores dos canais ficam em Data.Total[domain], não diretamente em Data[domain]. Os nomes dos canais são preservados, por exemplo Search - Organic e Direct. Os valores são contagens de visitas; calcule participações somente quando a soma for positiva.

Campo de consultaObrigatórioTipo e restrições
keysSimString; 1-2048 bytes UTF-8 após remover espaços nas extremidades
countryNãoString de inteiro não negativo; Somente dados mundiais são aceitos (country=999). Outros valores de país válidos são alterados para 999 antes da solicitação ao fornecedor e retornam dados mundiais, não do país indicado.
fromNãoString; data válida nos formatos acima
toNãoString; data válida nos formatos acima
includeSubDomainsNãoString booleana: true ou false
isWindowNãoString booleana: true ou false
webSourceNãoString; valores permitidos: Total, Desktop, MobileWeb
timeGranularityNãoString; valores permitidos: Daily, Monthly
latestNãoString; 1-2048 bytes UTF-8 após remover espaços nas extremidades

Sites semelhantes

GET https://api.apihop.ai/v1/similarweb/websites/similar-sites

O padrão são os três meses UTC completos anteriores. isWindow deve ser false, timeGranularity é Monthly e orderBy é fixado em Affinity desc. latest e webSource não são aceitos.

Campo de consultaObrigatórioTipo e restrições
keysSimString; 1-2048 bytes UTF-8 após remover espaços nas extremidades
countryNãoString de inteiro não negativo; Somente dados mundiais são aceitos (country=999). Outros valores de país válidos são alterados para 999 antes da solicitação ao fornecedor e retornam dados mundiais, não do país indicado.
fromNãoString; data válida nos formatos acima
toNãoString; data válida nos formatos acima
includeSubDomainsNãoString booleana: true ou false
isWindowNãoString booleana: true ou false
timeGranularityNãoString; valores permitidos: Monthly
orderByNãoString; valores permitidos: Affinity desc

Sugestões de sites semelhantes

GET https://api.apihop.ai/v1/similarweb/websites/similar-sites/suggestions

key no singular; limit tem padrão 20 e deve estar entre 1-20. country tem padrão 999 e webSource, Total. A resposta nativa observada é um array de candidatos sem invólucro, contendo Domain, DomainWithoutSub, Rank numérico e Favicon; não espere um invólucro Data. Um array vazio não contém sugestões. Somente dados mundiais são aceitos (country=999).

Campo de consultaObrigatórioTipo e restrições
keySimString; 1-2048 bytes UTF-8 após remover espaços nas extremidades
limitNãoString de inteiro; 1-20
countryNãoString de inteiro não negativo; Somente dados mundiais são aceitos (country=999). Outros valores de país válidos são alterados para 999 antes da solicitação ao fornecedor e retornam dados mundiais, não do país indicado.
webSourceNãoString; valores permitidos: Total, Desktop, MobileWeb

Histórico mensal de visitas

GET https://api.apihop.ai/v1/similarweb/websites/history/visits

O padrão são os seis meses UTC completos anteriores. Apenas country=999, isWindow=false e timeGranularity=Monthly são aceitos. latest aceita de 1m a 6m; datas explícitas devem abranger meses completos dentro dessa janela móvel de seis meses. Séries nativas podem aparecer em Data.<domain>.<source> com pontos Key/Value; os nomes das fontes, incluindo MobileWeb ou Mobile Web, são preservados. Os valores representam visitas estimadas.

Campo de consultaObrigatórioTipo e restrições
keysSimString; 1-2048 bytes UTF-8 após remover espaços nas extremidades
countryNãoString de inteiro não negativo; Somente dados mundiais são aceitos (country=999). Outros valores de país válidos são alterados para 999 antes da solicitação ao fornecedor e retornam dados mundiais, não do país indicado.
fromNãoString; data válida nos formatos acima
toNãoString; data válida nos formatos acima
includeSubDomainsNãoString booleana: true ou false
isWindowNãoString booleana: true ou false
webSourceNãoString; valores permitidos: Total, Desktop, MobileWeb
timeGranularityNãoString; valores permitidos: Monthly
latestNãoString; 1-2048 bytes UTF-8 após remover espaços nas extremidades

Histórico mensal da taxa de rejeição

GET https://api.apihop.ai/v1/similarweb/websites/history/bounce-rate

O padrão são os seis meses UTC completos anteriores. Apenas country=999, isWindow=false e timeGranularity=Monthly são aceitos. latest aceita de 1m a 6m; datas explícitas devem abranger meses completos dentro dessa janela móvel de seis meses. Séries nativas podem aparecer em Data.<domain>.<source> com pontos Key/Value; os nomes das fontes, incluindo MobileWeb ou Mobile Web, são preservados. Os valores representam frações da taxa de rejeição.

Campo de consultaObrigatórioTipo e restrições
keysSimString; 1-2048 bytes UTF-8 após remover espaços nas extremidades
countryNãoString de inteiro não negativo; Somente dados mundiais são aceitos (country=999). Outros valores de país válidos são alterados para 999 antes da solicitação ao fornecedor e retornam dados mundiais, não do país indicado.
fromNãoString; data válida nos formatos acima
toNãoString; data válida nos formatos acima
includeSubDomainsNãoString booleana: true ou false
isWindowNãoString booleana: true ou false
webSourceNãoString; valores permitidos: Total, Desktop, MobileWeb
timeGranularityNãoString; valores permitidos: Monthly
latestNãoString; 1-2048 bytes UTF-8 após remover espaços nas extremidades

Histórico mensal da duração das visitas

GET https://api.apihop.ai/v1/similarweb/websites/history/visit-duration

O padrão são os seis meses UTC completos anteriores. Apenas country=999, isWindow=false e timeGranularity=Monthly são aceitos. latest aceita de 1m a 6m; datas explícitas devem abranger meses completos dentro dessa janela móvel de seis meses. Séries nativas podem aparecer em Data.<domain>.<source> com pontos Key/Value; os nomes das fontes, incluindo MobileWeb ou Mobile Web, são preservados. Os valores representam segundos por visita.

Campo de consultaObrigatórioTipo e restrições
keysSimString; 1-2048 bytes UTF-8 após remover espaços nas extremidades
countryNãoString de inteiro não negativo; Somente dados mundiais são aceitos (country=999). Outros valores de país válidos são alterados para 999 antes da solicitação ao fornecedor e retornam dados mundiais, não do país indicado.
fromNãoString; data válida nos formatos acima
toNãoString; data válida nos formatos acima
includeSubDomainsNãoString booleana: true ou false
isWindowNãoString booleana: true ou false
webSourceNãoString; valores permitidos: Total, Desktop, MobileWeb
timeGranularityNãoString; valores permitidos: Monthly
latestNãoString; 1-2048 bytes UTF-8 após remover espaços nas extremidades

Histórico mensal de páginas por visita

GET https://api.apihop.ai/v1/similarweb/websites/history/pages-per-visit

O padrão são os seis meses UTC completos anteriores. Apenas country=999, isWindow=false e timeGranularity=Monthly são aceitos. latest aceita de 1m a 6m; datas explícitas devem abranger meses completos dentro dessa janela móvel de seis meses. Séries nativas podem aparecer em Data.<domain>.<source> com pontos Key/Value; os nomes das fontes, incluindo MobileWeb ou Mobile Web, são preservados. Os valores representam páginas por visita.

Campo de consultaObrigatórioTipo e restrições
keysSimString; 1-2048 bytes UTF-8 após remover espaços nas extremidades
countryNãoString de inteiro não negativo; Somente dados mundiais são aceitos (country=999). Outros valores de país válidos são alterados para 999 antes da solicitação ao fornecedor e retornam dados mundiais, não do país indicado.
fromNãoString; data válida nos formatos acima
toNãoString; data válida nos formatos acima
includeSubDomainsNãoString booleana: true ou false
isWindowNãoString booleana: true ou false
webSourceNãoString; valores permitidos: Total, Desktop, MobileWeb
timeGranularityNãoString; valores permitidos: Monthly
latestNãoString; 1-2048 bytes UTF-8 após remover espaços nas extremidades