Websites
Website list
Get a list of the websites in your account.
GET /websites
The result looks like this:
200 OK
{
"result": {
"list": [
{
"id": "7ghms6smu5",
"displayName": "pagevitals.com",
"domain": "pagevitals.com"
},
{
"id": "jk43bcmtwo",
"displayName": "PageVitals App",
"domain": "app.pagevitals.com"
}
]
}
}Each website item has these properties:
| Property | Description |
|---|---|
| id | The internal ID of the website |
| displayName | The displayed name of the website in the admin UI |
| domain | The domain of the website, without "https://" and paths |
Add website
Add a new website to your account admin
POST /account/websites
{
"domain": "google.com", # remember "www" if that is in the domain
"displayName": "Google" # optional, defaults to domain
}
Note that the URL for creating the website starts with "/account". The arguments used are described here:
| Argument | Description |
|---|---|
| domain | The domain of the website, without "https://" and paths |
| displayName | Optional. The displayed name of the website in the admin UI. Defaults to the domain |
The response looks like this:
201 Created
{
"id": "f6h2n8svr5",
"displayName": "Google",
"domain": "google.com"
}The id is the internal ID for the website. You'll use this ID when making API calls for that website. We will use {website-id} as the placeholder for the website ID. Example: /{website-id}/vitals should in this case be /f6h2n8svr5/vitals.
Edit website
Editing the domain or display name of an existing website is done under Settings / Website.
Remove website
Delete a website from your account admin
Note that you will receive no warning and you won't be asked for confirmation. So use this call with care.
DELETE /{website-id}
All test data, metrics, analytics associated with the website will be removed irreversibly. The response is:
204 No Content