# webstat: Web Statistics

The `webstat` utility is used to manage Webalizer preferences through CLI. By using this utility, you can perform the following tasks:

- adding direct request or referrer records to or removing them from Webalizer preferences on a domain
- displaying the list of existing direct request or referrer records in Webalizer preferences on a domain

## Usage

    webstat <command> [<domain name>] [
    <option_1> [<param>]
    [<option_2> [<param>]]
    ...[<option_N> [<param>]]
    ]

## Example

The following command adds hidden referrer record *example.net/ to Webalizer preferences on the domain example.com:

    plesk bin webstat --add example.com -type hidden -url *example.net/

## Commands

Command | Parameter | Description | Example
--- | --- | --- | ---
`--add` or `-a` | `<domain_` `name>` | Adds a record to Webalizer preferences on a domain. | To add hidden referrer record *example.net/ to Webalizer preferences on the domain example.com:
    plesk bin webstat --add example.com -type hidden -url *example.net/
or
    plesk bin webstat --add example.com -type hidden -url *example.net/
`--remove` or `-r` | `<domain_` `name>` | Deletes a record from Webalizer preferences on a domain. | To remove hidden referrer record *example.net/ from Webalizer preferences on domain example.com:
    plesk bin webstat --remove example.com -type hidden -url *example.net/
or
    plesk bin webstat -r example.com -type hidden -url *example.net/
`--list` or `-l` | `<domain_` `name>` | Displays the list of records in Webalizer preferences on a domain. | To view the list of existing Webalizer records on the domain example.com:
    plesk bin webstat --list example.com
or
    plesk bin webstat -l example.com
`--del-all` or `-da` | `<domain_` `name>` | Deletes all records from Webalizer preferences on a domain. |
    plesk bin webstat --del-all example.com
or
    plesk bin webstat -da example.com
`--help` or `-h` |  | Displays help on the use of this utility. | To view the help info on the use of the webstat utility:
    plesk bin webstat --help
or
    plesk bin webstat -h

## Options

Option | Parameter | Description | Example
--- | --- | --- | ---
`-type` | `group|hidden|hidden_direct` | Specifies a type of a record in Webalizer preferences. Is to be used in conjunction with the `-url` option. `group` - grouped referrer `hidden` - hidden referrer `hidden_direct` - hidden direct request | To add hidden referrer record *example.net/ to Webalizer preferences on the domain example.com:
    plesk bin webstat --add example.com -type hidden -url *example.net/
`-url` | `<string>` | Specifies an URL or an URL pattern for a Webalizer record. |
`-group` | `<string>` | Specifies name of a grouped referrer record in Webalizer preferences. | To add grouped referrer record *example.net/ named example.net to Webalizer preferences on the domain example.com:
    plesk bin webstat --add example.com -type group -group example.net -url *example.net/