Site na versão Beta 1.5

Sites

Notas
Nível de especialista
A chave da API deve ser enviada como um token Bearer no cabeçalho de Autorização da solicitação. Obtenha sua chave API.
Lista

Ponto final da API:

GET 
https://analise.baraagencia.com.br/api/v1/websites

Exemplo de solicitação: 

curl --location --request GET 'https://analise.baraagencia.com.br/api/v1/websites' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Parâmetro
Tipo
Descrição
search
opcional string
A consulta de pesquisa.
search_by
opcional string
Buscar por. Os valores possíveis são: :valor para :nome. Padrão: domain.
favorite
opcional boolean
Filter by favorite.
sort_by
opcional string
Ordenar por. Os valores possíveis são: :valor para :nome, :valor para :nome. Padrão: id.
sort
opcional string
Ordenar. Os valores possíveis são: :valor para :nome, :valor para :nome. Padrão: desc.
per_page
opcional integer
Resultados por página. Os valores possíveis são: 10, 25, 50, 100. Padrão: 50.
Mostrar

Ponto final da API:

GET 
https://analise.baraagencia.com.br/api/v1/websites/{id}

Exemplo de solicitação: 

curl --location --request GET 'https://analise.baraagencia.com.br/api/v1/websites/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Armazenar

Ponto final da API:

POST 
https://analise.baraagencia.com.br/api/v1/websites

Exemplo de solicitação: 

curl --location --request POST 'https://analise.baraagencia.com.br/api/v1/websites' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'domain={domain}'
Parâmetro
Tipo
Descrição
domain
necessário string
O nome do domínio.
privacy
opcional integer
Privacidade da página de estatísticas. Os valores possíveis são: :valor para :nome, :valor para :nome, :valor para :nome. Padrão: 0.
password
opcional string
A senha para a página de estatísticas. Funciona apenas com privacy definido como 2.
email
opcional integer
Relatórios periódicos por e-mail. Os valores possíveis são: :valor para :nome, :valor para :nome. Padrão: 0.
exclude_bots
opcional integer
Excluir bots comuns de serem rastreados. Os valores possíveis são: :valor para :nome, :valor para :nome. Padrão: 1.
exclude_params
opcional string
Exclude URL query parameters from being tracked. Um por linha..
exclude_ips
opcional string
Excluir IPs de serem rastreados. Um por linha..
Atualizar

Ponto final da API:

PUT PATCH 
https://analise.baraagencia.com.br/api/v1/websites/{id}

Exemplo de solicitação: 

curl --location --request PUT 'https://analise.baraagencia.com.br/api/v1/websites/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}'
Parâmetro
Tipo
Descrição
privacy
opcional integer
Privacidade da página de estatísticas. Os valores possíveis são: :valor para :nome, :valor para :nome, :valor para :nome.
password
opcional string
A senha para a página de estatísticas. Funciona apenas com privacy definido como 2.
email
opcional integer
Relatórios periódicos por e-mail. Os valores possíveis são: :valor para :nome, :valor para :nome.
exclude_bots
opcional integer
Excluir bots comuns de serem rastreados. Os valores possíveis são: :valor para :nome, :valor para :nome.
exclude_params
opcional string
Exclude URL query parameters from being tracked. Um por linha..
exclude_ips
opcional string
Excluir IPs de serem rastreados. Um por linha..
favorite
opcional boolean
Whether the website is favorite or not.
Excluir

Ponto final da API:

DELETE 
https://analise.baraagencia.com.br/api/v1/websites/{id}

Exemplo de solicitação: 

curl --location --request DELETE 'https://analise.baraagencia.com.br/api/v1/websites/{id}' \
--header 'Authorization: Bearer {api_key}'