Websites

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

API endpoint:

GET 
https://track.soswebsites.com/api/v1/websites

Exemplo de solicitação: 

curl --location --request GET 'https://track.soswebsites.com/api/v1/websites' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Parâmetro
Tipo
Descrição
search
opcional string
The search query.
search_by
opcional string
Pesquisar por. Os valores possíveis são: domain para Domínio. Padrão para: domain.
favorite
opcional boolean
Filtrar por favorito.
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 Decrescente, asc para Crescente. 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.
Show

API endpoint:

GET 
https://track.soswebsites.com/api/v1/websites/{id}

Exemplo de solicitação: 

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

API endpoint:

POST 
https://track.soswebsites.com/api/v1/websites

Exemplo de solicitação: 

curl --location --request POST 'https://track.soswebsites.com/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
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: 0.
password
opcional string
A senha da página de estatísticas. Só funciona com privacy definido para 2.
email
opcional integer
Relatórios periódicos por e-mail. Os valores possíveis são: 0 para Inativo, 1 para Ativo. Padrão para: 0.
exclude_bots
opcional integer
Excluir bots comuns de serem rastreados. Os valores possíveis são: 0 para Inativo, 1 para Ativo. Padrão para: 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..
Update

API endpoint:

PUT PATCH 
https://track.soswebsites.com/api/v1/websites/{id}

Exemplo de solicitação: 

curl --location --request PUT 'https://track.soswebsites.com/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 da página de estatísticas. Só funciona com privacy definido para 2.
email
opcional integer
Relatórios periódicos por e-mail. Os valores possíveis são: 0 para Inativo, 1 para Ativo.
exclude_bots
opcional integer
Excluir bots comuns de serem rastreados. Os valores possíveis são: 0 para Inativo, 1 para Ativo.
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
Se o site é favorito ou não.
Excluir

API endpoint:

DELETE 
https://track.soswebsites.com/api/v1/websites/{id}

Exemplo de solicitação: 

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