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 consulta | Obrigatório | Tipo e restrições |
|---|---|---|
keyword | Sim | String; 1-2048 bytes UTF-8 após remover espaços nas extremidades |
country | Não | String 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. |
from | Não | String; data válida nos formatos acima |
to | Não | String; data válida nos formatos acima |
latest | Não | String; 1-2048 bytes UTF-8 após remover espaços nas extremidades |
sort | Não | String; 1-2048 bytes UTF-8 após remover espaços nas extremidades |
asc | Não | String booleana: true ou false |
page | Não | String de inteiro; 1-1000 |
rowsPerPage | Não | String de inteiro; 1-1000 |
type | Não | String; valores permitidos: Broad, Phrase, Exact, Related |
websource | Não | String; valores permitidos: Total, Desktop, MobileWeb |
isWindow | Não | String booleana: true ou false |
rangeFilter | Não | String; 1-2048 bytes UTF-8 após remover espaços nas extremidades |
Links de entrada
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 consulta | Obrigatório | Tipo e restrições |
|---|---|---|
Key | Sim | String; 1-2048 bytes UTF-8 após remover espaços nas extremidades |
Page | Não | String de inteiro; 1-1000 |
PageSize | Não | String de inteiro; 1-1000 |
Status | Não | String; valores permitidos: All, Active, New, Lost |
FollowType | Não | String; valores permitidos: All, DoFollowOnly, NoFollowOnly, DoFollow, NoFollow |
DomainScoreFrom | Não | String de inteiro; 0-100 |
DomainScoreTo | Não | String de inteiro; 0-100 |
sort | Não | String; 1-2048 bytes UTF-8 após remover espaços nas extremidades |
asc | Não | String 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 consulta | Obrigatório | Tipo e restrições |
|---|---|---|
keys | Sim | String; 1-2048 bytes UTF-8 após remover espaços nas extremidades |
country | Não | String 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. |
from | Não | String; data válida nos formatos acima |
to | Não | String; data válida nos formatos acima |
includeSubDomains | Não | String booleana: true ou false |
isWindow | Não | String booleana: true ou false |
webSource | Não | String; valores permitidos: Total, Desktop, MobileWeb |
timeGranularity | Não | String; valores permitidos: Daily, Monthly |
latest | Não | String; 1-2048 bytes UTF-8 após remover espaços nas extremidades |
sort | Não | String; 1-2048 bytes UTF-8 após remover espaços nas extremidades |
asc | Não | String booleana: true ou false |
iso | Não | String; 1-2048 bytes UTF-8 após remover espaços nas extremidades |
isDaily | Não | String booleana: true ou false |
IncludeBranded | Não | String booleana: true ou false |
IncludeNoneBranded | Não | String booleana: true ou false |
page | Não | String de inteiro; 1-1000 |
pageSize | Não | String de inteiro; 1-1000 |
sourceType | Não | String; 1-2048 bytes UTF-8 após remover espaços nas extremidades |
pageFilterJson | Não | String 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 consulta | Obrigatório | Tipo e restrições |
|---|---|---|
keys | Sim | String; 1-2048 bytes UTF-8 após remover espaços nas extremidades |
country | Não | String 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. |
from | Não | String; data válida nos formatos acima |
to | Não | String; data válida nos formatos acima |
includeSubDomains | Não | String booleana: true ou false |
isWindow | Não | String booleana: true ou false |
webSource | Não | String; valores permitidos: Total, Desktop, MobileWeb |
timeGranularity | Não | String; valores permitidos: Daily, Monthly |
latest | Não | String; 1-2048 bytes UTF-8 após remover espaços nas extremidades |
sort | Não | String; 1-2048 bytes UTF-8 após remover espaços nas extremidades |
asc | Não | String booleana: true ou false |
iso | Não | String; 1-2048 bytes UTF-8 após remover espaços nas extremidades |
isDaily | Não | String booleana: true ou false |
tab | Não | String de inteiro não negativo |
mtd | Não | String booleana: true ou false |
selectedPageTab | Não | String; valores permitidos: Organic, Paid |
graphDuration | Não | String; 1-2048 bytes UTF-8 após remover espaços nas extremidades |
graphType | Não | String de inteiro; 1-1000 |
isDurationChanged | Não | String booleana: true ou false |
ignoreFilterConsistency | Não | String booleana: true ou false |
Device | Não | String; 1-2048 bytes UTF-8 após remover espaços nas extremidades |
sourceType | Não | String; 1-2048 bytes UTF-8 após remover espaços nas extremidades |
page | Não | String de inteiro; 1-1000 |
pageSize | Não | String 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 consulta | Obrigatório | Tipo e restrições |
|---|---|---|
keys | Sim | String; 1-2048 bytes UTF-8 após remover espaços nas extremidades |
country | Não | String 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. |
from | Não | String; data válida nos formatos acima |
to | Não | String; data válida nos formatos acima |
includeSubDomains | Não | String booleana: true ou false |
isWindow | Não | String booleana: true ou false |
webSource | Não | String; valores permitidos: Total, Desktop, MobileWeb |
timeGranularity | Não | String; valores permitidos: Daily, Monthly |
latest | Não | String; 1-2048 bytes UTF-8 após remover espaços nas extremidades |
sourceType | Não | String; 1-2048 bytes UTF-8 após remover espaços nas extremidades |
ignoreFilterConsistency | Não | String booleana: true ou false |
page | Não | String de inteiro; 1-1000 |
orderBy | Não | String; 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 consulta | Obrigatório | Tipo e restrições |
|---|---|---|
key | Sim | String; 1-2048 bytes UTF-8 após remover espaços nas extremidades |
country | Não | String 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. |
from | Sim | String; data válida nos formatos acima |
to | Sim | String; data válida nos formatos acima |
isWWW | Não | String booleana: true ou false |
isWindow | Não | String booleana: true ou false |
webSource | Não | String; valores permitidos: Total, Desktop, MobileWeb |
orderby | Não | String; 1-2048 bytes UTF-8 após remover espaços nas extremidades |
orderBy | Não | String; 1-2048 bytes UTF-8 após remover espaços nas extremidades |
sort | Não | String; 1-2048 bytes UTF-8 após remover espaços nas extremidades |
asc | Não | String booleana: true ou false |
page | Não | String 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 consulta | Obrigatório | Tipo e restrições |
|---|---|---|
key | Sim | String; 1-2048 bytes UTF-8 após remover espaços nas extremidades |
country | Não | String 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. |
from | Não | String; data válida nos formatos acima |
to | Não | String; data válida nos formatos acima |
isWWW | Não | String booleana: true ou false |
iso | Não | String; 1-2048 bytes UTF-8 após remover espaços nas extremidades |
isWindow | Não | String booleana: true ou false |
isDaily | Não | String booleana: true ou false |
latest | Não | String; 1-2048 bytes UTF-8 após remover espaços nas extremidades |
webSource | Não | String; valores permitidos: Total, Desktop, MobileWeb |
selectedTab | Não | String; valores permitidos: incomingTraffic |
orderBy | Não | String; 1-2048 bytes UTF-8 após remover espaços nas extremidades |
ignoreFilterConsistency | Não | String booleana: true ou false |
page | Não | String 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 consulta | Obrigatório | Tipo e restrições |
|---|---|---|
keys | Sim | String; 1-2048 bytes UTF-8 após remover espaços nas extremidades |
country | Não | String 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. |
from | Não | String; data válida nos formatos acima |
to | Não | String; data válida nos formatos acima |
includeSubDomains | Não | String booleana: true ou false |
isWindow | Não | String booleana: true ou false |
webSource | Não | String; valores permitidos: Total, Desktop, MobileWeb |
timeGranularity | Não | String; valores permitidos: Daily, Monthly |
latest | Não | String; 1-2048 bytes UTF-8 após remover espaços nas extremidades |
duration | Não | String; 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 consulta | Obrigatório | Tipo e restrições |
|---|---|---|
keys | Sim | String; 1-2048 bytes UTF-8 após remover espaços nas extremidades |
country | Não | String 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. |
from | Não | String; data válida nos formatos acima |
to | Não | String; data válida nos formatos acima |
includeSubDomains | Não | String booleana: true ou false |
isWindow | Não | String booleana: true ou false |
webSource | Não | String; valores permitidos: Total, Desktop, MobileWeb |
timeGranularity | Não | String; valores permitidos: Daily, Monthly |
latest | Não | String; 1-2048 bytes UTF-8 após remover espaços nas extremidades |
pageSize | Não | String de inteiro; 1-1000 |
orderBy | Não | String; 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 consulta | Obrigatório | Tipo e restrições |
|---|---|---|
keys | Sim | String; 1-2048 bytes UTF-8 após remover espaços nas extremidades |
country | Não | String 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. |
from | Não | String; data válida nos formatos acima |
to | Não | String; data válida nos formatos acima |
includeSubDomains | Não | String booleana: true ou false |
isWindow | Não | String booleana: true ou false |
webSource | Não | String; valores permitidos: Total, Desktop, MobileWeb |
timeGranularity | Não | String; valores permitidos: Daily, Monthly |
latest | Não | String; 1-2048 bytes UTF-8 após remover espaços nas extremidades |
ShouldGetVerifiedData | Não | String 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 consulta | Obrigatório | Tipo e restrições |
|---|---|---|
keys | Sim | String; 1-2048 bytes UTF-8 após remover espaços nas extremidades |
country | Não | String 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. |
from | Não | String; data válida nos formatos acima |
to | Não | String; data válida nos formatos acima |
includeSubDomains | Não | String booleana: true ou false |
isWindow | Não | String booleana: true ou false |
webSource | Não | String; valores permitidos: Total, Desktop, MobileWeb |
timeGranularity | Não | String; valores permitidos: Daily, Monthly |
latest | Não | String; 1-2048 bytes UTF-8 após remover espaços nas extremidades |
pageSize | Não | String de inteiro; 1-1000 |
duration | Não | String; valores permitidos: 1m |
SourceType | Não | String; 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 consulta | Obrigatório | Tipo e restrições |
|---|---|---|
keys | Sim | String; 1-2048 bytes UTF-8 após remover espaços nas extremidades |
country | Não | String 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. |
from | Não | String; data válida nos formatos acima |
to | Não | String; data válida nos formatos acima |
includeSubDomains | Não | String booleana: true ou false |
isWindow | Não | String booleana: true ou false |
timeGranularity | Não | String; valores permitidos: Daily, Monthly |
latest | Não | String; 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 consulta | Obrigatório | Tipo e restrições |
|---|---|---|
keys | Sim | String; 1-2048 bytes UTF-8 após remover espaços nas extremidades |
country | Não | String 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. |
from | Não | String; data válida nos formatos acima |
to | Não | String; data válida nos formatos acima |
includeSubDomains | Não | String booleana: true ou false |
isWindow | Não | String booleana: true ou false |
webSource | Não | String; valores permitidos: Total, Desktop, MobileWeb |
timeGranularity | Não | String; valores permitidos: Daily, Monthly |
latest | Não | String; 1-2048 bytes UTF-8 após remover espaços nas extremidades |
ShouldGetVerifiedData | Não | String booleana: true ou false |
includeLeaders | Não | String booleana: true ou false |
unBounced | Não | String booleana: true ou false |
beta | Não | String 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 consulta | Obrigatório | Tipo e restrições |
|---|---|---|
keys | Sim | String; 1-2048 bytes UTF-8 após remover espaços nas extremidades |
country | Não | String 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. |
from | Não | String; data válida nos formatos acima |
to | Não | String; data válida nos formatos acima |
includeSubDomains | Não | String booleana: true ou false |
isWindow | Não | String booleana: true ou false |
webSource | Não | String; valores permitidos: Total, Desktop, MobileWeb |
timeGranularity | Não | String; valores permitidos: Monthly |
latest | Não | String; 1-2048 bytes UTF-8 após remover espaços nas extremidades |
compareFrom | Não | String; data válida nos formatos acima |
compareTo | Não | String; data válida nos formatos acima |
ShouldGetVerifiedData | Não | String 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 consulta | Obrigatório | Tipo e restrições |
|---|---|---|
keys | Sim | String; 1-2048 bytes UTF-8 após remover espaços nas extremidades |
country | Não | String 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. |
from | Não | String; data válida nos formatos acima |
to | Não | String; data válida nos formatos acima |
includeSubDomains | Não | String booleana: true ou false |
isWindow | Não | String booleana: true ou false |
webSource | Não | String; valores permitidos: Total, Desktop, MobileWeb |
timeGranularity | Não | String; valores permitidos: Monthly |
latest | Não | String; 1-2048 bytes UTF-8 após remover espaços nas extremidades |
compareFrom | Não | String; data válida nos formatos acima |
compareTo | Não | String; data válida nos formatos acima |
ShouldGetVerifiedData | Não | String 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 consulta | Obrigatório | Tipo e restrições |
|---|---|---|
keys | Sim | String; 1-2048 bytes UTF-8 após remover espaços nas extremidades |
country | Não | String 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. |
from | Não | String; data válida nos formatos acima |
to | Não | String; data válida nos formatos acima |
includeSubDomains | Não | String booleana: true ou false |
isWindow | Não | String booleana: true ou false |
webSource | Não | String; valores permitidos: Total, Desktop, MobileWeb |
timeGranularity | Não | String; valores permitidos: Daily, Weekly, Monthly |
latest | Não | String; 1-2048 bytes UTF-8 após remover espaços nas extremidades |
ShouldGetVerifiedData | Não | String 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 consulta | Obrigatório | Tipo e restrições |
|---|---|---|
keys | Sim | String; 1-2048 bytes UTF-8 após remover espaços nas extremidades |
country | Não | String 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. |
from | Não | String; data válida nos formatos acima |
to | Não | String; data válida nos formatos acima |
includeSubDomains | Não | String booleana: true ou false |
isWindow | Não | String booleana: true ou false |
webSource | Não | String; valores permitidos: Total, Desktop, MobileWeb |
timeGranularity | Não | String; valores permitidos: Monthly |
latest | Não | String; 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 consulta | Obrigatório | Tipo e restrições |
|---|---|---|
keys | Sim | String; 1-2048 bytes UTF-8 após remover espaços nas extremidades |
country | Não | String 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. |
from | Não | String; data válida nos formatos acima |
to | Não | String; data válida nos formatos acima |
includeSubDomains | Não | String booleana: true ou false |
isWindow | Não | String booleana: true ou false |
webSource | Não | String; valores permitidos: Total, Desktop, MobileWeb |
timeGranularity | Não | String; valores permitidos: Monthly |
latest | Não | String; 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 consulta | Obrigatório | Tipo e restrições |
|---|---|---|
keys | Sim | String; 1-2048 bytes UTF-8 após remover espaços nas extremidades |
country | Não | String 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. |
from | Não | String; data válida nos formatos acima |
to | Não | String; data válida nos formatos acima |
includeSubDomains | Não | String booleana: true ou false |
isWindow | Não | String booleana: true ou false |
webSource | Não | String; valores permitidos: Total, Desktop, MobileWeb |
timeGranularity | Não | String; valores permitidos: Monthly |
latest | Não | String; 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 consulta | Obrigatório | Tipo e restrições |
|---|---|---|
keys | Sim | String; 1-2048 bytes UTF-8 após remover espaços nas extremidades |
country | Não | String 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. |
from | Não | String; data válida nos formatos acima |
to | Não | String; data válida nos formatos acima |
includeSubDomains | Não | String booleana: true ou false |
isWindow | Não | String booleana: true ou false |
webSource | Não | String; valores permitidos: Total, Desktop, MobileWeb |
timeGranularity | Não | String; valores permitidos: Monthly |
latest | Não | String; 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 consulta | Obrigatório | Tipo e restrições |
|---|---|---|
keys | Sim | String; 1-2048 bytes UTF-8 após remover espaços nas extremidades |
country | Não | String 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. |
from | Não | String; data válida nos formatos acima |
to | Não | String; data válida nos formatos acima |
includeSubDomains | Não | String booleana: true ou false |
isWindow | Não | String booleana: true ou false |
webSource | Não | String; valores permitidos: Total, Desktop, MobileWeb |
timeGranularity | Não | String; valores permitidos: Daily, Monthly |
latest | Não | String; 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 consulta | Obrigatório | Tipo e restrições |
|---|---|---|
keys | Sim | String; 1-2048 bytes UTF-8 após remover espaços nas extremidades |
country | Não | String 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. |
from | Não | String; data válida nos formatos acima |
to | Não | String; data válida nos formatos acima |
includeSubDomains | Não | String booleana: true ou false |
isWindow | Não | String booleana: true ou false |
timeGranularity | Não | String; valores permitidos: Monthly |
orderBy | Não | String; 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 consulta | Obrigatório | Tipo e restrições |
|---|---|---|
key | Sim | String; 1-2048 bytes UTF-8 após remover espaços nas extremidades |
limit | Não | String de inteiro; 1-20 |
country | Não | String 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. |
webSource | Não | String; 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 consulta | Obrigatório | Tipo e restrições |
|---|---|---|
keys | Sim | String; 1-2048 bytes UTF-8 após remover espaços nas extremidades |
country | Não | String 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. |
from | Não | String; data válida nos formatos acima |
to | Não | String; data válida nos formatos acima |
includeSubDomains | Não | String booleana: true ou false |
isWindow | Não | String booleana: true ou false |
webSource | Não | String; valores permitidos: Total, Desktop, MobileWeb |
timeGranularity | Não | String; valores permitidos: Monthly |
latest | Não | String; 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 consulta | Obrigatório | Tipo e restrições |
|---|---|---|
keys | Sim | String; 1-2048 bytes UTF-8 após remover espaços nas extremidades |
country | Não | String 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. |
from | Não | String; data válida nos formatos acima |
to | Não | String; data válida nos formatos acima |
includeSubDomains | Não | String booleana: true ou false |
isWindow | Não | String booleana: true ou false |
webSource | Não | String; valores permitidos: Total, Desktop, MobileWeb |
timeGranularity | Não | String; valores permitidos: Monthly |
latest | Não | String; 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 consulta | Obrigatório | Tipo e restrições |
|---|---|---|
keys | Sim | String; 1-2048 bytes UTF-8 após remover espaços nas extremidades |
country | Não | String 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. |
from | Não | String; data válida nos formatos acima |
to | Não | String; data válida nos formatos acima |
includeSubDomains | Não | String booleana: true ou false |
isWindow | Não | String booleana: true ou false |
webSource | Não | String; valores permitidos: Total, Desktop, MobileWeb |
timeGranularity | Não | String; valores permitidos: Monthly |
latest | Não | String; 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 consulta | Obrigatório | Tipo e restrições |
|---|---|---|
keys | Sim | String; 1-2048 bytes UTF-8 após remover espaços nas extremidades |
country | Não | String 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. |
from | Não | String; data válida nos formatos acima |
to | Não | String; data válida nos formatos acima |
includeSubDomains | Não | String booleana: true ou false |
isWindow | Não | String booleana: true ou false |
webSource | Não | String; valores permitidos: Total, Desktop, MobileWeb |
timeGranularity | Não | String; valores permitidos: Monthly |
latest | Não | String; 1-2048 bytes UTF-8 após remover espaços nas extremidades |