Websites

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
Search by. Possible values are: domain for Domain. Defaults to: domain.
sort_by
optional string
Sort by. Possible values are: id for Date created, domain for Domain. Defaults to: id.
sort
optional string
Sort. Possible values are: desc for Descending, asc for Ascending. Defaults to: desc.
per_page
optional integer
Results per 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 Private, 2 for Password. Defaults to: 0.
password
optional string
The password for the statistics page. Only works with privacy set to 2.
email
optional integer
Periodic email reports. Possible values are: 0 for Disabled, 1 for Enabled. Defaults to: 0.
exclude_bots
optional integer
Exclude common bots from being tracked. Possible values are: 0 for Disabled, 1 for Enabled. 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

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 Private, 2 for Password.
password
optional string
The password for the statistics page. Only works with privacy set to 2.
email
optional integer
Periodic email reports. Possible values are: 0 for Disabled, 1 for Enabled.
exclude_bots
optional integer
Exclude common bots from being tracked. Possible values are: 0 for Disabled, 1 for Enabled.
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..
Delete

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}'