Sites

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

Endpoint da API:

GET 
https://analytics.cavock.com.br/api/v1/websites

Exemplo de solicitação: 

curl --location --request GET 'https://analytics.cavock.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
Pesquisar por. Os valores possíveis são: domain para Domínio. Padrão para: domain.
sort_by
opcional string
Ordenar por. Os valores possíveis são: id para Data de criação, domain para Domínio. Padrão para: id.
sort
opcional string
Ordenar. Os valores possíveis são: desc para Descendente, asc para Ascendente. Padrão para: desc.
per_page
opcional integer
Resultados por página. Os valores possíveis são: 10, 25, 50, 100. Padrão para: 10.
Mostrar

Endpoint da API:

GET 
https://analytics.cavock.com.br/api/v1/websites/{id}

Exemplo de solicitação: 

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

Endpoint da API:

POST 
https://analytics.cavock.com.br/api/v1/websites

Exemplo de solicitação: 

curl --location --request POST 'https://analytics.cavock.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
obrigatório string
O nome do domínio.
privacy
opcional integer
Privacidade da página de estatísticas. Os valores possíveis são: 0 para Público, 1 para Privado, 2 para Senha. Padrão para: 1.
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: 0 para Desativado, 1 para Ativado. Padrão para: 0.
exclude_bots
opcional integer
Exclua bots comuns do rastreamento. Os valores possíveis são: 0 para Desativado, 1 para Ativado. Padrão para: 1.
exclude_params
opcional string
Exclude URL query parameters from being tracked. Um por linha..
exclude_ips
opcional string
Excluir IPs do rastreamento. Um por linha..
Atualizar

Endpoint da API:

PUT PATCH 
https://analytics.cavock.com.br/api/v1/websites/{id}

Exemplo de solicitação: 

curl --location --request PUT 'https://analytics.cavock.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: 0 para Público, 1 para Privado, 2 para Senha.
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: 0 para Desativado, 1 para Ativado.
exclude_bots
opcional integer
Exclua bots comuns do rastreamento. Os valores possíveis são: 0 para Desativado, 1 para Ativado.
exclude_params
opcional string
Exclude URL query parameters from being tracked. Um por linha..
exclude_ips
opcional string
Excluir IPs do rastreamento. Um por linha..
Excluir

Endpoint da API:

DELETE 
https://analytics.cavock.com.br/api/v1/websites/{id}

Exemplo de solicitação: 

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