Websites
GET https://china.tn/api/websites/
curl --request GET \
--url 'https://china.tn/api/websites/' \
--header 'Authorization: Bearer {api_key}' \
--url 'https://china.tn/api/websites/' \
--header 'Authorization: Bearer {api_key}' \
Parameters | Details | Description |
---|---|---|
page | Optional Integer | The page number that you want results from. Defaults to 1 . |
results_per_page | Optional Integer | How many results you want per page. Allowed values are: 10 , 25 , 50 , 100 , 250 , 500 , 1000 . Defaults to 25 . |
{
"data": [
{
"id": 1,
"pixel_key": "1234567890123456",
"name": "Localhost",
"scheme": "https://",
"host": "example.com",
"path": "/",
"tracking_type": "normal",
"excluded_ips": "",
"events_children_is_enabled": false,
"sessions_replays_is_enabled": false,
"email_reports_is_enabled": false,
"email_reports_last_date": "2020-06-23 19:01:22",
"is_enabled": true,
"date": "2019-11-01 12:00:30"
},
],
"meta": {
"page": 1,
"results_per_page": 25,
"total": 1,
"total_pages": 1
},
"links": {
"first": "https://china.tn/api/websites?&page=1",
"last": "https://china.tn/api/websites?&page=1",
"next": null,
"prev": null,
"self": "https://china.tn/api/websites?&page=1"
}
}
GET https://china.tn/api/websites/{website_id}
curl --request GET \
--url 'https://china.tn/api/websites/{website_id}' \
--header 'Authorization: Bearer {api_key}' \
--url 'https://china.tn/api/websites/{website_id}' \
--header 'Authorization: Bearer {api_key}' \
{
"data": {
"id": 1,
"pixel_key": "1234567890123456",
"name": "Localhost",
"scheme": "https://",
"host": "example.com",
"path": "/",
"tracking_type": "normal",
"excluded_ips": "",
"events_children_is_enabled": false,
"sessions_replays_is_enabled": false,
"email_reports_is_enabled": false,
"email_reports_last_date": "2020-06-23 19:01:22",
"is_enabled": true,
"date": "2019-11-01 12:00:30"
}
}
POST https://china.tn/api/websites
Parameters | Details | Description |
---|---|---|
name | Required String | - |
scheme | Optional String | Allowed values: http:// , https:// |
host | Required String | Website Host & Path. Example: https://example.com/path . |
tracking_type | Optional String | Allowed values: lightweight , normal |
excluded_ips | Optional String | Exclude IPs from tracking. Enter comma separated values. |
events_children_is_enabled | Optional Boolean | Track visitor events (mouse clicks, resizes, scrolls, form submissions). Allowed values are: 0 or 1 . Only available for normal tracking type. |
sessions_replays_is_enabled | Optional Boolean | Session replays. Allowed values are: 0 or 1 . Only available for normal tracking type. |
email_reports_is_enabled | Optional Boolean | Email reports. Allowed values are: 0 or 1 . |
curl --request POST \
--url 'https://china.tn/api/websites' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'host=website.com' \
--form 'name=Example' \
--url 'https://china.tn/api/websites' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'host=website.com' \
--form 'name=Example' \
{
"data": {
"id": 1
}
}
POST https://china.tn/api/websites/{website_id}
Parameters | Details | Description |
---|---|---|
name | Optional String | - |
scheme | Optional String | Allowed values: http:// , https:// |
host | Optional String | Website Host & Path. Example: https://example.com/path . |
excluded_ips | Optional String | Exclude IPs from tracking. Enter comma separated values. |
events_children_is_enabled | Optional Boolean | Track visitor events (mouse clicks, resizes, scrolls, form submissions). Allowed values are: 0 or 1 . Only available for normal tracking type. |
sessions_replays_is_enabled | Optional Boolean | Session replays. Allowed values are: 0 or 1 . Only available for normal tracking type. |
email_reports_is_enabled | Optional Boolean | Email reports. Allowed values are: 0 or 1 . |
is_enabled | Optional Boolean | Website tracking status. Allowed values are: 0 or 1 . |
curl --request POST \
--url 'https://china.tn/api/websites/{website_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example' \
--form 'is_enabled=0' \
--url 'https://china.tn/api/websites/{website_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example' \
--form 'is_enabled=0' \
{
"data": {
"id": 1
}
}
DELETE https://china.tn/api/websites/{website_id}
curl --request DELETE \
--url 'https://china.tn/api/websites/{website_id}' \
--header 'Authorization: Bearer {api_key}' \
--url 'https://china.tn/api/websites/{website_id}' \
--header 'Authorization: Bearer {api_key}' \