Sites Internet

Notes
Expert level
The API key should be sent as a Bearer token in the Authorization header of the request. Get your API key.
List

API endpoint:

GET 
https://analytics.sprkly.me/api/v1/websites

Request example: 

curl --location --request GET 'https://analytics.sprkly.me/api/v1/websites' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Parameter
Type
Description
search
optional string
The search query.
search_by
optional string
Rechercher par. Possible values are: domain for Nom de domaine. Defaults to: domain.
sort_by
optional string
Trier par. Possible values are: id for Date de création, domain for Nom de domaine. Defaults to: id.
sort
optional string
Trier. Possible values are: desc for Descendant, asc for Ascendant. Defaults to: desc.
per_page
optional integer
Résultats par page. Possible values are: 10, 25, 50, 100. Defaults to: 10.
Show

API endpoint:

GET 
https://analytics.sprkly.me/api/v1/websites/{id}

Request example: 

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

API endpoint:

POST 
https://analytics.sprkly.me/api/v1/websites

Request example: 

curl --location --request POST 'https://analytics.sprkly.me/api/v1/websites' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'domain={domain}'
Parameter
Type
Description
domain
required string
The domain name.
privacy
optional integer
Stats page privacy. Possible values are: 0 for Public, 1 for Privé, 2 for Mot de passe. Defaults to: 0.
password
optional string
The password for the statistics page. Only works with privacy set to 2.
email
optional integer
Rapports périodiques par e-mail. Possible values are: 0 for Désactivé, 1 for Activé. Defaults to: 0.
exclude_bots
optional integer
Excluez les robots courants du suivi. Possible values are: 0 for Désactivé, 1 for Activé. Defaults to: 1.
exclude_params
optional string
Exclude URL query parameters from being tracked. Un par ligne..
exclude_ips
optional string
Excluez des adresses IP du suivi. Un par ligne..
Update

API endpoint:

PUT PATCH 
https://analytics.sprkly.me/api/v1/websites/{id}

Request example: 

curl --location --request PUT 'https://analytics.sprkly.me/api/v1/websites/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}'
Parameter
Type
Description
privacy
optional integer
Stats page privacy. Possible values are: 0 for Public, 1 for Privé, 2 for Mot de passe.
password
optional string
The password for the statistics page. Only works with privacy set to 2.
email
optional integer
Rapports périodiques par e-mail. Possible values are: 0 for Désactivé, 1 for Activé.
exclude_bots
optional integer
Excluez les robots courants du suivi. Possible values are: 0 for Désactivé, 1 for Activé.
exclude_params
optional string
Exclude URL query parameters from being tracked. Un par ligne..
exclude_ips
optional string
Excluez des adresses IP du suivi. Un par ligne..
Supprimer

API endpoint:

DELETE 
https://analytics.sprkly.me/api/v1/websites/{id}

Request example: 

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