Get early access
Documentation · Websites
Your websites,scripted
Everything you can do on the Websites page you can do here: add a domain, change its privacy, exclude bots and IPs, or remove it.
List
All websites in the account, paginated. Filter by domain, keep only favorites, sort by date or name.
GET
https://anltcs.com/api/v1/websites
Request example
curl 'https://anltcs.com/api/v1/websites' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Response200 OK
{
"data": [
{
"id": 12,
"domain": "arasaka.corp",
"privacy": 0,
"email": 1,
"password": false,
"exclude_bots": 1,
"exclude_ips": null,
"favorite": true,
"favorited_at": "2026-09-10T08:12:44.000000Z",
"created_at": "2026-08-01T14:03:19.000000Z",
"updated_at": "2026-09-10T08:12:44.000000Z"
}
],
"links": { "first": "…?page=1", "last": "…?page=1", "prev": null, "next": null },
"meta": { "current_page": 1, "per_page": 25, "total": 3 }
}
Parameter
Type
Description
search
optional
string
Search query.
search_by
optional
string
Search by. Possible values are:
domain for Domain. Defaults to: domain.favorite
optional
boolean
Filter by favorite.
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
A single website by ID.
GET
https://anltcs.com/api/v1/websites/{id}
Request example
curl 'https://anltcs.com/api/v1/websites/{id}' \ --header 'Accept: application/json' \ --header 'Authorization: Bearer {api_key}'
Response200 OK
{
"data": {
"id": 12,
"domain": "arasaka.corp",
"privacy": 0,
"email": 1,
"password": false,
"exclude_bots": 1,
"exclude_ips": null,
"favorite": true,
"favorited_at": "2026-09-10T08:12:44.000000Z",
"created_at": "2026-08-01T14:03:19.000000Z",
"updated_at": "2026-09-10T08:12:44.000000Z"
}
}
Store
Adds a website to the account. The domain must be unique across the account and is validated before it is saved.
POST
https://anltcs.com/api/v1/websites
Request example
curl --request POST 'https://anltcs.com/api/v1/websites' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --header 'Accept: application/json' \ --header 'Authorization: Bearer {api_key}' \ --data-urlencode 'domain={domain}' \ --data-urlencode 'exclude_bots=1'
Response200 OK
{
"data": {
"id": 12,
"domain": "arasaka.corp",
"privacy": 0,
"email": 1,
"password": false,
"exclude_bots": 1,
"exclude_ips": null,
"favorite": true,
"favorited_at": "2026-09-10T08:12:44.000000Z",
"created_at": "2026-08-01T14:03:19.000000Z",
"updated_at": "2026-09-10T08:12:44.000000Z"
}
}
Parameter
Type
Description
domain
required
string
Domain name
privacy
optional
integer
Privacy. Possible values are:
0 for Public, 1 for Private, 2 for Password. Defaults to: 0.password
optional
string
Password. Only works with
privacy field 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
Changes one or more settings of a website. Only the fields you send are updated.
PUT
PATCH
https://anltcs.com/api/v1/websites/{id}
Request example
curl --request PUT 'https://anltcs.com/api/v1/websites/{id}' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --header 'Accept: application/json' \ --header 'Authorization: Bearer {api_key}' \ --data-urlencode 'privacy=1' \ --data-urlencode 'favorite=1'
Response200 OK
{
"data": {
"id": 12,
"domain": "arasaka.corp",
"privacy": 0,
"email": 1,
"password": false,
"exclude_bots": 1,
"exclude_ips": null,
"favorite": true,
"favorited_at": "2026-09-10T08:12:44.000000Z",
"created_at": "2026-08-01T14:03:19.000000Z",
"updated_at": "2026-09-10T08:12:44.000000Z"
}
}
Parameter
Type
Description
privacy
optional
integer
Privacy. Possible values are:
0 for Public, 1 for Private, 2 for Password.password
optional
string
Password. Only works with
privacy field 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..
favorite
optional
boolean
Favorite.
Delete
Removes the website and all of its statistics. This cannot be undone.
DELETE
https://anltcs.com/api/v1/websites/{id}
Request example
curl --request DELETE 'https://anltcs.com/api/v1/websites/{id}' \ --header 'Accept: application/json' \ --header 'Authorization: Bearer {api_key}'
Response200 OK
{
"id": 12,
"object": "website",
"deleted": true,
"status": 200
}