ILuxScript API Command Reference Guide
Using the ILux Server API
Filter Attribute Reference
Printing this Guide
Table Of Contents
Commands Dealing with the Connection
Commands Dealing with Filters
- CREATE FILTER name opt_ref_filter_commalist
- CREATE COMPLEX FILTER name opt_parameter_commalist
- DELETE FILTER name
- LIST FILTERS
Commands Dealing with Reports
- ADD ANALYSISOBJECT name TO REPORT name
- ADD SECTION name TO REPORT name opt_parameter_commalist
- CREATE REPORT name opt_parameter_commalist
- DELETE REPORT name
- LIST REPORTS
- RUN REPORT name opt_parameter_commalist
- RUN FOLDER name opt_parameter_commalist
Commands Dealing with Folders
- CREATE FOLDER name opt_parameter_commalist
- DELETE FOLDER name
- LIST FOLDERS
- LIST REPORTS IN FOLDER name
- DELETE REPORT name FROM FOLDER name
Commands Dealing With Database Entities
Commands Dealing With Service Configuration
- CREATE ALERT opt_parameter_commalist
- DELETE ALERT number
- DETAIL ALERT number
- LIST ALERTS
- DELETE EVENT number
- SCHEDULE REPORT name opt_parameter_commalist
- LIST SCHEDULED REPORTS
- LIST SCHEDULED REPORT name
Commands Dealing With Groups of Domains
- ADD DOMAIN name TO GROUP name
- CREATE GROUP OF DOMAINS name
- DELETE GROUP OF DOMAINS name
- REMOVE DOMAIN name FROM GROUP name
Command Formats
The ILuxScript API operates by accepting commands over a Telnet interface. Each command must be entered on a single line, and must be terminated by a line feed. Commands are case-sensitive, and must be entered in the case shown. Many commands accept parameters or parameter=value pairs.Any string of characters which contains anything other than letters (e.g. space, numbers, punctuation) must be enclosed in single or double quotes. For example:
Correct:
AutoReport = AFolderNameAutoReport = 'AFolderName'AutoReport = "AFolderName"AutoReport = 'A Folder Name'AutoReport = "A Folder Name/A Report Name"Incorrect:
AutoReport = A Folder Name
If the parameter includes a single or double quote, use the opposite quote to enclose it. For example: "John's Report".
All values in the parameter=value pairs are considered to be strings of characters, so a number value must be enclosed by quotes, as above. For example:
Correct:
Day = '31'
Incorrect:
Day = 31
In this document, the following command syntax is used when defining commands:
CREATE REPORT name opt_parameter_commalist
The part in upper case is the command (which must be entered in upper case), name is a required parameter, and opt_parameter_commalist indicates that a list of optional parameter=value pairs may be specified, separated by commas. In the case of this example, the correctly formed command would look as follows:
CREATE REPORT 'Weekly Traffic Analysis' Filter = 'Last Week', Description = 'Weekly Traffic Summary'
ILux API Messages and Return Codes
The ILux server responds to each API command with one or more messages indicating the outcome of processing the command. Each message contains a return code containing additional information about the message. For example:200 Created Report [name]
Generally, it is clear from the message text whether a command succeeded or failed, and if it failed, what caused the failure. The return codes can also be useful, especially in diagnosing errors. The meaning of each digit in the return code is explained below.
There are five values, and five meanings, for the first digit of the reply code:
1xx Positive Preliminary reply
The requested action is being initiated; expect another reply before proceeding with a new command. This type of reply is used to indicate that the command was accepted and is being processed.
2xx Positive Completion reply
The requested action has been successfully completed. A new command may be entered.
3xx Positive Intermediate reply
The command has been accepted, but the requested action is being held in abeyance, pending receipt of further information. You should send another command specifying this information. This reply is used in command sequence groups.
4xx Transient Negative Completion reply
The command was not accepted and the requested action did not take place, but the error condition is temporary and the action may be requested again. For example, you may have tried to delete something that is currently in use. You should return to the beginning of the command sequence, if any.
5xx Permanent Negative Completion reply
The command was not accepted and the requested action did not take place. This may be caused by misspelled or missing parameters.
The following function groupings are encoded in the second digit:
- x0x
- Syntax - These replies refer to syntax errors, syntactically correct commands that don't fit any functional category, unimplemented or superfluous commands.
- x1x
- Information - These are replies to requests for information, such as status or help.
- x2x
- Connections - Replies referring to connections.
- x3x
- Authentication and accounting - Replies for the login process and accounting procedures.
- x4x
- Currently Unused.
- x5x
- File system - These replies indicate the status of the Server file system or database vis-a-vis the requested transfer or other file system action.
The third digit gives a finer gradation of meaning in each of the function categories, specified by the second digit
Commands Dealing with the Connection
QUIT
Syntax:
QUIT
Description:
The QUIT command terminates the connection with the ILux server and ends the API session.Successful Return:
221 GoodbyeExample:
QUIT 108 Command Received 221 Goodbye [EOR]VERSION
Syntax:
VERSION
Description:
Returns versioning and license information from the server.Successful Return:
List of attribute = value pairsExample:
VERSION 108 Command Received Name = ILuxd Description = ILux Log Reporting Service Copyright = CoPyRiGhT (c) Portfolio Technologies, Inc. 1996, 1997 Major = 2 Minor = 20 Build = 430 SerialNumber = 1234567890 UserName = Name CompanyName = Company LicensedNumberOfSites = 31 HostName = emwac.officeiq.com LegalNotice = SQLAnywhere® copyright© 1986-1996 Sybase®, Inc.\ and its subsidiaries. All rights reserved. [EOR]ADD WEBSITE parameter_commalist
Syntax:
ADD WEBSITE parameter_commalist
Parameters:
HostName = IpAddress = WebRoot = LogFileDirectory = LogFileSpecification = IsCaseSensitive = Port = IncludeFilter = Description:
ADD WEBSITE is used to define a web site to be monitored. Any number of web sites can be added, up to the limit of the product license. The web site must exist before ADD WEBSITE can be used.HostName is the domain name of the web site to be monitored. IpAddress is the web server's IP address. WebRoot is the path to the web server's root HTML document directory. LogFileDirectory is the directory where the servers log files are located.
LogFileSpecification is used to supply the name of the log file(s) to be processed. Wildcards can be used to have ILux process multiple files. For example, if the filename 'access' is specified, only that file will be processed. However if 'access*' is specified, all files whose name begins with 'access' will be read.
IsCaseSensitive is set to 0 (false) or 1 (true) to indicate whether the file system where the log files are stored is case-sensitive. This will be false on Windows or NT, and true on UNIX systems. The default is 0. Port is the port address of the web server being monitored. The default is 80.
Successful Return:
200 Added web site [site-name]Return Codes:
410 Missing parameters 530 Invalid site parameters 550 Could not find/create domain record [domain-name] 550 Site [site-name] already existsExample:
ADD WEBSITE HostName = 'www.officeiq.com', IpAddress = '205.187.9.1', WebRoot = '\\Master\http', LogFileDirectory = '\\Master\ns-home\httpd-master\logs', LogFileSpecification = 'access', IsCaseSensitive = '0', Port = '80' 108 Command Received 200 Added web site [http://www.officeiq.com] [EOR]Commands Dealing with Filters
CREATE FILTER name opt_ref_filter_commalist
Syntax:
CREATE FILTER name opt_ref_filter_commalist
Description:
Creates a simple filter with the specified name, using 'attribute relationship value' pairs to set the conditions for the filter. Click here for a list of valid filter attributes. If more than one attribute pair is specified, the attribute pairs (conditions) are implicitly ANDed together. That is the filter is considered true if ALL conditions are met. More complex filters can be created with the CREATE COMPLEX FILTER command.Parameters:
Attribute [is|is not] Value, ... Successful Return:
200 Created Filter name [where-clause]Return Codes:
551 Could not create FilterExample:
CREATE FILTER FilterName DomainType is 'COM', WhenHit is 'Last Week' 108 Command Received 200 Created Filter FilterName [ ( DomainType is 'COM' ) AND ( WhenHit is 'Last Week' ) ] [EOR]CREATE COMPLEX FILTER name opt_parameter_commalist
Syntax:
CREATE COMPLEX FILTER name opt_parameter_commalist
Description:
Creates a complex filter using SQL. Use of this command requires a knowledge of SQL syntax and relational databases. The SQL WHERE clause is entered directly in SQL format. Filters created with this command cannot be edited with the ILux client GUI. Please note that you should use the same attribute names as with other Filter creation, but the aliases for relationships such as 'is' or 'is not' are not valid. Click here for a list of valid filter attributes.Parameters:
Where = Successful Return:
200 Created Filter name [where-clause]Return Codes:
501 Could not create Filter, no Where clause specified 551 Could not create FilterExample:
CREATE COMPLEX FILTER ComplexFilterExample Where = " (DomainType = 'COM' OR DomainType = 'EDU') AND WhenHit = 'Last Week'" 108 Command Received 200 Created Filter ComplexFilterExample [ (DomainType = 'COM' OR DomainType = 'EDU') AND WhenHit is 'Last Week'] [EOR]DELETE FILTER name
Syntax:
DELETE FILTER name
Description:
Deletes the specified filter from the ILux database. In order to be successfully deleted, the filter must not currently be in use by any report, event, or alert.Successful Return:
200 Deleted Filter nameReturn Codes:
410 Filter [FilterName] is used in n1 Reports, n2 Events and n3 Alerts. Not deleted 550 Could not find Filter nameExample:
DELETE FILTER 'FilterName' 108 Command Received 200 Deleted Filter [FilterName] [EOR]LIST FILTERS
Syntax:
LIST FILTERS
Description:
Lists all filters defined in the ILux database.Successful Return:
list of Filters by NameExample:
LIST FILTERS 108 Command Received Commercial Last Week Today Yesterday This Week This Month Last Month This Quarter Last Quarter This Year Last Year Test FilterName [EOR]Commands Dealing with Reports
ADD ANALYSISOBJECT name TO REPORT name
Syntax:
ADD ANALYSISOBJECT name TO REPORT name
Description:
Adds the specified analysis object to the end of the report. A report name is expected in the form 'foldername/reportname'.Successful Return:
200 Added Analysis Object to ReportReturn Codes:
550 Could not find [name] 550 Could not find Analysis Object [name]Example:
ADD ANALYSISOBJECT 'Top 10 Hits' TO REPORT 'Example/Example Report' 108 Command Received 200 Added Analysis Object to Report [EOR]ADD SECTION name TO REPORT name opt_parameter_commalist
Syntax:
ADD SECTION name TO REPORT name opt_parameter_commalist
Optional Parameters:
Description =Description:
Adds the specified section to the end of the report. Sections may be used to break up reports into logical sections. A report name is expected in the form 'foldername/reportname'. An optional description can be supplied using the Description parameter.Successful Return:
200 Added Section to ReportReturn Codes:
550 Could not find [name]Example:
ADD SECTION 'Section 1' TO REPORT 'Folder 1/Example Report' Description = 'The First section in the report' 108 Command Received 200 Added Section to Report [EOR]CREATE REPORT name opt_parameter_commalist
Syntax:
CREATE REPORT name opt_parameter_commalist
Optional Parameters:
Filter = Description = StyleSheet = Summary = 1|0 [Default = 1(true)]Description:
Creates a report in the specified folder. The folder must exist prior to issuing the CREATE REPORT command. Use the CREATE FOLDER command to create a folder. A report filter may be specified using the optional Filter parameter. If the Filter parameter is used, the filter must exist before issuing the CREATE REPORT command. An optional Description and StyleSheet may also be specified.The Summary parameter specifies whether the Report Summary analysis object should automatically be added to the report at position 1. The default is to add the Report Summary analysis object.
Successful Return:
* 110 Filter set to name 200 Created Report name Return Codes:
550 Invalid Folder/Report name [name] 550 Cannot find Report Folder [name] 550 Invalid Filter specified [name] 551 Could not create Report 552 Report [name] already exists in Folder [name]Example:
CREATE REPORT 'Folder 1/Example Report' Filter = 'Last Week' 108 Command Received 200 Created Report Example Report [EOR]DELETE REPORT name
Syntax:
DELETE REPORT name
Description:
Deletes the specified report from the ILux database. The report name is specified in the form 'foldername/reportname'. If the report has been scheduled ( i.e. is part of an event ) then the event is deleted. If the report is attached to an alert, then the alert is converted to a simple e-mail notification.Successful Return:
200 Deleted Report [name]Return Codes:
550 Could not find [name]Example:
DELETE REPORT 'Folder 1/Example' 108 Command Received 200 Deleted Report [Folder 1/Example] [EOR]LIST REPORTS
Syntax:
LIST REPORTS
Description:
Returns a list of all reports contained in the ILux database.Successful Return:
list of foldername/reportnameExample:
LIST REPORTS 108 Command Received Periodic Reports/Daily Activity Report Periodic Reports/Weekly Activity Report Periodic Reports/Monthly Activity Report Periodic Reports/Quarterly Activity Report In Depth Reports/Geographical Domain Analysis In Depth Reports/Entry and Exit Analysis In Depth Reports/Content Analysis In Depth Reports/Browser Analysis In Depth Reports/Error Analysis In Depth Reports/Traffic Analysis In Depth Reports/Page Request Analysis In Depth Reports/Referrer Analysis In Depth Reports/Visitor Quality Analysis In Depth Reports/Trend Analysis In Depth Reports/Visit Analysis Example/One [EOR]RUN REPORT name opt_parameter_commalist
Syntax:
RUN REPORT name opt_parameter_commalist
Optional Parameters:
Filter = filter-name MailTo = e-mail address list CcTo = e-mail address list Output = path Language = [en | es | fr | de | jp] StyleSheet = stylesheet-nameDescription:
Runs the specified report immediately. The report name is specified in the form 'foldername/reportname'.The optional Filter parameter allows a filter to be specified, which will override any filter specified when the report was created. A specification of Filter = "" may be used to indicate that no filter should be used.
The MailTo and CcTo parameters are used to define who should receive email notification of the reports location when processing is completed. Both parameters accept one or more email addresses, separated by commas.
The Output parameter allows the specification of a fully qualified path to the web site directory where the report should be placed. If not specified, the default path is 'foldername/reportname/MM-DD-YY_HH-MM-SS' under the ILux Reports directory defined during installation.
The Language parameter is used to define the report language. The default is English (en). Spanish (es), French (fr), German (de), and Japanese (jp) are also available.
The optional StyleSheet parameter may be used to specify a style sheet other than the default.
Successful Return:
* 110 Filter overridden with filter-nameOR* 110 Using Report Filter filter-name Progress 0% x mins/y mins remaining . . . Progress 90% x mins/y mins remaining 200 url to reportReturn Codes:
550 Could not find [name] 550 Invalid filter specified filter-nameExample:
RUN REPORT 'Example/One' MailTo = 'user@domain.com', Filter = 'Last Week' 108 Command Received Progress 0% 4 mins remaining of 4 mins Progress 25% 3 mins remaining of 4 mins Progress 50% 2 mins remaining of 4 mins [Report Summary] Progress 75% 1 mins remaining of 4 mins [Top 10 Hits] Progress 100% Completed 200 http://emwac.officeiq.com/ilux/reports/Example/One/1997-09-03_22-07-47/default.htm [EOR]RUN FOLDER name opt_parameter_commalist
Syntax:
RUN FOLDER name opt_parameter_commalist
Optional Parameters:
Filter = filter-name MailTo = email-address(es) CcTo = [e-mail CC:] Output = report-output-path Language = [en | es | fr | de | jp] StyleSheet = stylesheet-nameDescription:
Runs all the reports contained in the specified folder. The folder name is specified in the form 'foldername'.The optional Filter parameter allows a filter to be specified, which will override any filter specified in the reports contained in the folder. A specification of Filter = "" may be used to indicate that no filter should be used.
The MailTo and CcTo parameters are used to define who should receive email notification of the reports location when processing is completed. Both parameters accept one or more email addresses, separated by commas.
The Output parameter allows the specification of a fully qualified path to the web site directory where the reports should be placed. If not specified, the default path is 'foldername/reportname/MM-DD-YY_HH-MM-SS' under the ILux Reports directory defined during installation.
The Language parameter is used to define the report language. The default is English (en). Spanish (es), French (fr), German (de), and Japanese (jp) are also available.
The optional StyleSheet parameter may be used to specify a style sheet other than the default.
Successful Return:
110 Filter overridden with filter-nameOR 110 Using Report Filter filter-name Progress 0% x mins/y mins remaining . . . Progress 90% x mins/y mins remaining 200 url to reportReturn Codes:
550 Invalid Folder name [name] 550 Cannot find Report Folder [name] 550 Invalid filter specified filter-nameExample:
RUN FOLDER 'In Depth Reports' Filter = 'Last Week' 108 Command Received 110 Filter overridden with Last WeekCommands Dealing with Folders
CREATE FOLDER name opt_parameter_commalist
Syntax:
CREATE FOLDER name opt_parameter_commalist
Optional Parameters:
Description =Description:
Creates a folder in the database with the name specified.Successful Return:
200 Created Report Folder nameReturn Codes:
551 Could not create Report Folder 552 Report Folder [name] already existsExample:
CREATE FOLDER 'Example' 108 Command Received 200 Created Report Folder Example [EOR]DELETE FOLDER name
Syntax:
DELETE FOLDER name
Description:
Deletes the specified folder from the ILux database. Each report which it contains is also deleted. Any events ( including schedules ) referring to any of these reports and folders are also deleted. Alerts are converted to simple e-mail notifications.Successful Return:
200 Deleted Report Folder [name]Return Codes:
550 Could not find Report Folder: [name]Example:
DELETE FOLDER 'New' 108 Command Received 200 Deleted Report Folder [New] [EOR]LIST FOLDERS
Syntax:
LIST FOLDERS
Description:
Returns a list of all folders defined in the ILux database.Successful Return:
list of folder-namesExample:
LIST FOLDERS 108 Command Received In Depth Reports Periodic Reports [EOR]LIST REPORTS IN FOLDER name
Syntax:
LIST REPORTS IN FOLDER name
Description:
Returns a list of all reports contained in the specified folder.Successful Return:
list of report namesReturn Codes:
550 Could not find Report Folder: [name]Example:
LIST REPORTS IN FOLDER 'In Depth Reports' 108 Command Received Browser Analysis Content Analysis Entry and Exit Analysis Error Analysis Geographical Domain Analysis Page Request Analysis Referrer Analysis Traffic Analysis Trend Analysis Visit Analysis Visitor Quality Analysis [EOR]DELETE REPORT name FROM FOLDER name
Syntax:
DELETE REPORT name FROM FOLDER name
Description:
Removes the specified report from the folder. Any scheduled reports referencing this report are also deleted.Successful Return:
200 Deleted Report [name]Return Codes:
550 Could not find Report Folder [name] 550 Could not find Report [name]Example:
DELETE REPORT 'One' FROM FOLDER 'Example' 108 Command Received 200 Deleted Report [One] [EOR]Commands Dealing With Database Entities
LIST HTTPMETHODS
Syntax:
LIST HTTPMETHODS
Description:
Returns a list of valid HTTP Methods.Successful Return:
List of HTTP MethodsExample:
LIST HTTP METHODS 108 Command Received DELETE GET HEAD OPTIONS POST PUT TRACE [EOR]LIST HTTPSTATUSCODES
Syntax:
LIST HTTPSTATUSCODES
Description:
Returns a list of recognized HTTP status codes and their descriptions. HTTP status codes indicate the result of a request to the web server.Successful Return:
List of HTTP Status Codes.Example:
LIST HTTPSTATUSCODES 108 Command Received ... 400 - [Bad Request] 401 - [Unauthorized] 402 - [Payment Required] 403 - [Forbidden] 404 - [Not Found] 405 - [Method Not Allowed] 406 - [Not Acceptable] 407 - [Proxy Authentication Required] 408 - [Request Time-out] 409 - [Conflict] 410 - [Gone] 411 - [Length Required] 412 - [Precondition Failed] 413 - [Request Entity Too Large] 414 - [Request-URI Too Long] 415 - [Unsupported Media Type] 500 - [Internal Server Error] ... [EOR]LIST MIMECATEGORIES
Syntax:
LIST MIMECATEGORIES
Description:
Returns a list of MIME Categories known to the database.Successful Return:
List of MIME Categories.Example:
108 Command Received application audio image text unknown video x-conference x-world [EOR]LIST MIMETYPES
Syntax:
LIST MIMETYPES
Description:
Returns a list of known MIME types.Successful Return:
A list of MIME types.Example:
LIST MIMETYPES 108 Command Received ... list of MIME types ... [EOR]LIST SITES
Syntax:
LIST SITES
Description:
Returns a list of all web sites being monitored by the ILux server.Successful Return:
list of site-namesExample:
LIST SITES 108 Command Received http://www.ilux.com [EOR]Commands Dealing With Service Configuration
CREATE ALERT opt_parameter_commalist
Syntax:
CREATE ALERT opt_parameter_commalist
Parameters:
AlertType = [PageUpdate | DomainVisit | HostVisit | HitsPerHour | BytesPerHour | Inactivity | ErrorsPerHour | FileAccess] Parameters = [depends on alert type] If PageUpdate: a fully qualified URL e.g 'http://www.ilux.com/default.html' If DomainVisit: a domain or domain group name e.g. 'lotus.com' or 'competitors' If HostVisit: a host or host group name e.g. '205.187.9.10' or 'emwac.officeiq.com' or 'webcrawlers' If HitsPerHour: a number of hits e.g. '200' If BytesPerHour: a number of bytes e.g. '20000' If Inactivity: the number of minutes inactive e.g. '30' If ErrorsPerHour: a number of server errors e.g. '10' If FileAccess: a fully qualified URL e.g 'http://www.ilux.com/default.html'Optional Parameters:
MailTo = [e-mail address to receive alert, note that the report recipient may be different] CcTo = [e-mail CC:] LogResults = [true | false] AutoReport = [folder-name/report-name | folder-name] Filter = filtername Output = report-output-path Language = [en | es | fr | de | jp] StyleSheet = stylesheet-name Command = [any command which can be sent to the server] e.g. "RUN REPORT 'Standard Reports/WebMaster' MailTo = 'kshepherd@officeiq.com'"Description:
Creates an alert in the ILux database. Alerts are used to request notification, and optionally the running of a report, when a certain condition occurs on the website being monitored. ILux can send a notification when a web page is updated, when the website is visited by a specific domain or host, or when a threshold is exceeded for hits per hour, bytes per hour, errors per hour, or server inactivity. Alerts remain in effect until deleted.The AlertType parameter defines the type of alert being created. The Parameters parameter is related to the AlertType parameter and provides information about what should trigger the particular alert. The MailTo parameter specifies who should receive email notification when the alert is triggered. One or more email addresses, separated by commas, may be specified. The CcTo parameter, similar to the MailTo parameter, specifies who should be copied on the alert notification.
The AutoReport parameter allows the specification of a report, or folder of reports, to be run automatically when the alert is triggered. If AutoReport is specified, the parameters Filter, Output, Language, and StyleSheet can be used to define the characteristics of the report. Specifing a filter name will override any filter defined when the report was created with the one specified. Filter = '' may be specified to indicate that no filter should be used.
The Command parameter can be used to have ILux automatically execute any ILuxScript API command when the alert is triggered.
As alerts are created in the ILux database they are sequentially numbered. In order to delete an alert, you must know its number. This can be determined with the LIST ALERTS command.
Successful Return:
200 Alert created: alertnumber description - commandReturn Codes:
501 Parameters required 501 Invalid parameters 550 Could not find Report name 550 Could not find Report Folder nameExample:
CREATE ALERT AlertType = HostVisit, MailTo = 'support@ilux.com', Parameters = 'emwac.officeiq.com', AutoReport = 'In Depth Reports/Traffic Analysis' 108 Command Received 200 Alert created: 1 Notification when a user visits from host emwac.officeiq.com - RUN REPORT "In Depth Reports/Traffic Analysis" [EOR]DELETE ALERT number
Syntax:
DELETE ALERT number
Description:
Removes the specified alert from the ILux database. The parameter "number" refers the to alert number assigned by ILux when the alert was created. This can be determined with the LIST ALERTS command.Successful Return:
200 Deleted Alert number description - commandReturn Codes:
550 Could not find Alert numberExample:
DELETE ALERT 1 108 Command Received 200 Deleted Alert 1 Notification when a user visits from host emwac.officeiq.com - RUN REPORT "In Depth Reports/Traffic Analysis" [EOR]DETAIL ALERT number
Syntax:
DETAIL ALERT number
Description:
Returns details about the specified alert. The parameter "number" refers the to alert number assigned by ILux when the alert was created. This can be determined with the LIST ALERTS command.Successful Return:
list of attribute = value pairsReturn Codes:
550 Could not find Alert numberExample:
DETAIL ALERT 3 108 Command Received Description = Notification when a user visits from host emwac.officeiq.com Command = RUN REPORT "In Depth Reports/Traffic Analysis" LogResults = false AlertType = HostVisit StyleSheet = MailTo = support@ilux.com CcTo = AutoReport = In Depth Reports/Traffic Analysis Output = Language = en Parameters = emwac.officeiq.com Has never run [EOR]LIST ALERTS
Syntax:
LIST ALERTS
Description:
Returns a list of all alerts defined in the ILux database, along with the alert number ILux has assigned to them.Successful Return:
list of 'number alerttype parameters command'Example:
LIST ALERTS 108 Command Received 3 Notification when a user visits from host emwac.officeiq.com - RUN REPORT "In Depth Reports/Traffic Analysis" [EOR]DELETE EVENT number
Syntax:
DELETE EVENT number
Description:
Removes the specified scheduled event from the ILux database. The parameter "number" refers the to event number assigned by ILux when the event was created. This can be determined with the LIST EVENTS command.Successful Return:
200 Deleted Event number command time-descriptionReturn Codes:
550 Could not find Event numberExample:
DELETE EVENT 2 108 Command Received 200 Deleted Event 2 RUN REPORT "In Depth Reports/Traffic Analysis" - Every Sunday at 00:00:00 [EOR]SCHEDULE REPORT name opt_parameter_commalist
Syntax:
SCHEDULE REPORT name opt_parameter_commalist
Optional Parameters:
Period = [Once | Hourly | Daily | Weekly | Monthly | Periodic] LogResults = [true | false] Day = [Depends on Period Type Selected] If Period = Once: Date of the form 'YYYY-MM-DD' If Hourly: Unused If Daily: Which Days e.g. 'Mon, Tue, Wed, Thu' or just 'Mon' If Weekly: Which Day, e.g. 'Monday' or 'Wednesday' If Monthly: The number of the day of the month from 1->31 If Periodic: Date and time of first run 'YYYY-MM-DD HH:MM' Time = [Depends on Period Type Selected] All HH are 24-hour If Once: Time of the form 'HH:MM' If Hourly: Minutes past the hour 'MM' If Daily: Time of the form 'HH:MM' If Weekly: Time of the form 'HH:MM' If Monthly: Time of the form 'HH:MM' If Periodic: Time between runs in hours and minutes 'HHHH:MM' MailTo = [e-mail address to mail the event notification to, note that the report recipient may be different] CcTo = [e-mail CC:] Filter = Output = report-output-path Language = [en | es | fr | de | jp] StyleSheet = stylesheet-nameDescription:
Sets up a scheduled event to run a report, or folder of reports, at a specified time. The required parameter 'name' is expected in the form 'foldername' or 'foldername/reportname'.Successful Return:
110 Next run: date/time 200 Event created number time-description commandReturn Codes:
550 Could not find Report [name] 550 Could not find Report Folder [name] 550 Invalid filter specified filter-nameExample:
SCHEDULE REPORT 'In Depth Reports/Traffic Analysis' Period = Weekly, Day = Sunday, MailTo = 'support@ilux.com' 108 Command Received 110 Next Run: 1997-09-07 00:00:00 200 Event created: 3 Every Sunday at 00:00:00 RUN REPORT "In Depth Reports/Traffic Analysis" [EOR]LIST SCHEDULED REPORTS
Syntax:
LIST SCHEDULED REPORTS
Description:
Returns a list of all scheduled reports in the ILux database.Successful Return:
list of 'number report-name - time description' and 'number FOLDER report-folder-name - time-description'Example:
LIST SCHEDULED REPORTS 108 Command Received 2 Geographical Domain Analysis - Once at 1997-09-11 13:00:00 3 Traffic Analysis - Once at 1997-09-12 00:00:00 5 Content Analysis - Once at 1997-09-12 00:00:00 4 FOLDER In Depth Reports - Once at 1997-09-12 00:00:00 6 FOLDER Periodic Reports - Once at 1997-09-12 00:00:00 [EOR]Notes:
This function also lists scheduled folders in this form: list of 'number FOLDER report folder name - time description'LIST SCHEDULED REPORT name
Syntax:
LIST SCHEDULED REPORT name
Description:
Lists the scheduling events for the specified report or folder.Successful Return:
list of 'number time-description'Return Codes:
550 Cannot find Report Folder [name] 550 Could not find Report: [name] in Folder nameExample:
LIST SCHEDULED REPORT 'In Depth Reports' 108 Command Received 4 Once at 1997-09-12 00:00:00 [EOR] LIST SCHEDULED REPORT 'In Depth Reports/Traffic Analysis' 108 Command Received 3 Once at 1997-09-12 00:00:00 [EOR]Notes:
This function accepts a folder name or a report name.Commands Dealing With Groups of Domains
ADD DOMAIN name TO GROUP name
Syntax:
ADD DOMAIN name TO GROUP name
Description:
Adds a new domain to an existing group of domains.Successful Return:
200 Added member name to group group-nameReturn Codes:
510 Not a valid Domain Type name [domain-type-name] 520 Not a valid Domain name [name] 530 [name] is already a member of group [group-name] 550 Could not find group [group-name]Example:
ADD DOMAIN 'worldbank.org' TO GROUP 'Customers' 108 Command Received 200 Added member worldbank.org to group Customers [EOR]CREATE GROUP OF DOMAINS name
Syntax:
CREATE GROUP OF DOMAINS name
Description:
Creates a new domain group. Domain groups are useful for filtering in or filtering out a related group of domains. For example the domain group 'webcrawlers' could be established to filter out all known webcrawlers from a report on visits. Once the domain group is created with CREATE GROUP OF DOMAINS, the ADD DOMAIN TO GROUP command can be used to add domains to the group.Successful Return:
200 Created Group [name]Return Codes:
520 Group [name] already exists 550 Could not create group [name] Example:
CREATE GROUP OF DOMAINS 'Customers' 108 Command Received 200 Created Group [Customers] [EOR]DELETE GROUP OF DOMAINS name
Syntax:
DELETE GROUP OF DOMAINS name
Description:
Deletes the specified domain group.Successful Return:
200 Deleted Group [groupname]Return Codes:
200 Deleted Group [groupname] 520 Could not find group [groupname]Example:
DELETE GROUP OF DOMAINS 'Competition' 108 Command Received 200 Deleted Group [Competition] [EOR]REMOVE DOMAIN name FROM GROUP name
Syntax:
REMOVE DOMAIN name FROM GROUP name
Description:
Removes the specified domain from the domain group.Successful Return:
200 Removed member from groupReturn Codes:
200 Removed member from group 520 Could not find group [groupname] 530 Could not find [domainname] 540 Could not find member in groupExample:
REMOVE DOMAIN 'vitro.com' FROM GROUP 'Customers' 108 Command Received 200 Removed member from group [EOR]Related Topics