Websites

Notas
Nível de Especialista
A chave de API deve ser enviada como um token de portador no cabeçalho de autorização da solicitação. Obtenha sua chave de API.
List

Ponto de extremidade da API::

GET 
https://analitico.raveshclub.com.br/api/v1/websites

Exemplo de solicitação: 

curl --location --request GET 'https://analitico.raveshclub.com.br/api/v1/websites' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Parâmetro
Tipo
Descrição
search
optional string
A consulta de pesquisa.
search_by
optional string
Procurar por. Os valores possíveis são: domain for :nome. Defaults to: domain.
sort_by
optional string
Ordenar por. Os valores possíveis são: id for :nome, domain for :nome. Defaults to: id.
sort
optional string
Ordenar. Os valores possíveis são: desc for :nome, asc for :nome. Defaults to: desc.
per_page
optional int
Resultados por página. Os valores possíveis são: 10, 25, 50, 100. Defaults to: 10.
exposição

Ponto de extremidade da API::

GET 
https://analitico.raveshclub.com.br/api/v1/websites/{id}

Exemplo de solicitação: 

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

Ponto de extremidade da API::

POST 
https://analitico.raveshclub.com.br/api/v1/websites

Exemplo de solicitação: 

curl --location --request POST 'https://analitico.raveshclub.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
required string
o nome de domínio.
privacy
optional integer
Stats page privacy. Os valores possíveis são: 0 for :nome, 1 for :nome, 2 for :nome. Defaults to: 1.
password
optional string
The password for the statistics page. Only works with privacy set to 2.
email
optional integer
Periodic email reports. Os valores possíveis são: 0 for :nome, 1 for :nome. Defaults to: 0.
exclude_bots
optional integer
Exclude common bots from being tracked. Os valores possíveis são: 0 for :nome, 1 for :nome. Defaults to: 1.
exclude_params
optional string
Exclude URL query parameters from being tracked. One per line..
exclude_ips
optional string
Exclude IPs from being tracked. One per line..
Update

Ponto de extremidade da API::

PUT PATCH 
https://analitico.raveshclub.com.br/api/v1/websites/{id}

Exemplo de solicitação: 

curl --location --request PUT 'https://analitico.raveshclub.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
optional integer
Stats page privacy. Os valores possíveis são: 0 for :nome, 1 for :nome, 2 for :nome.
password
optional string
The password for the statistics page. Only works with privacy set to 2.
email
optional integer
Periodic email reports. Os valores possíveis são: 0 for :nome, 1 for :nome.
exclude_bots
optional integer
Exclude common bots from being tracked. Os valores possíveis são: 0 for :nome, 1 for :nome.
exclude_params
optional string
Exclude URL query parameters from being tracked. One per line..
exclude_ips
optional string
Exclude IPs from being tracked. One per line..
Excluir

Ponto de extremidade da API::

DELETE 
https://analitico.raveshclub.com.br/api/v1/websites/{id}

Exemplo de solicitação: 

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