https://stats.smartertools.com:443/Services/Diagnostics.asmx
This web service contains methods that check the status of sites.
WSDL Definition
GetSiteStatusForServer
Returns current status for all sites on a server. View the full specification
Inputs
| Input Parameters | Description |
|---|
authUserName | String | Username with permissions to call this web service. |
authPassword | String | Password of the account used in authUserName parameter. |
ServerID | Int32 | The numerical ID of the server to check, as defined in SmarterStats. On Professional and Free Editions, 1 should be passed. |
Returns SiteStatusResultGroup
| SiteStatusResultGroup | Description |
|---|
Items | SiteStatusResult[] | The individual result items, as detailed in the SiteStatusResult class. |
Message | String | A text message explaining the results of the operation, including the reason for any failures. |
Result | Boolean | Returns true if the function call was successful. |
ResultCode | Int32 | A result code, which differs by function. |
| SiteStatusResult | Description |
|---|
Errors | String | Indicates any errors that are present on the site. If this field is empty, there are no errors. |
SiteID | Int32 | The numerical ID of the site. |
StatusCode | String | The current action being performed by the site, in short form. |
StatusMessage | String | The current action being performed by the site, in long, human readable form. |
StatusObject | String | The item or file currently being operated on. |
https://stats.smartertools.com:443/Services/ProductInfo.asmx
This web service contains methods that can be used to automatically activate a license key during automated installations.
WSDL Definition
| Functions |
|---|
| ActivateLicenseKey | Activates the license key set by the SetLicenseKey function. |
| GetLicenseInfo | Returns information about the current product license. |
| GetProductInfo | Returns the product name, version, and edition of the SmarterStats installation. |
| SetLicenseKey | Sets a license key to ready it for activation. This should be followed with a call to ActivateLicenseKey. |
ActivateLicenseKey
Activates the license key set by the SetLicenseKey function. View the full specification
Inputs
| Input Parameters | Description |
|---|
authUserName | String | Username with permissions to call this web service. |
authPassword | String | Password of the account used in authUserName parameter. |
UserName | String | The email address of the user account with SmarterTools associated with the license key. |
Password | String | The password associated with the license key. |
Returns GenericResult
| GenericResult | Description |
|---|
Message | String | A text message explaining the results of the operation, including the reason for any failures. |
Result | Boolean | Returns true if the function call was successful. |
ResultCode | Int32 | A result code, which differs by function. |
GetLicenseInfo
Returns information about the current product license. View the full specification
Inputs
| Input Parameters | Description |
|---|
authUserName | String | Username with permissions to call this web service. |
authPassword | String | Password of the account used in authUserName parameter. |
Returns LicenseInfoResult
| LicenseInfoResult | Description |
|---|
LicenseKey | String | The license key currently active on this SmarterStats installation. |
Message | String | A text message explaining the results of the operation, including the reason for any failures. |
Result | Boolean | Returns true if the function call was successful. |
ResultCode | Int32 | A result code, which differs by function. |
GetProductInfo
Returns the product name, version, and edition of the SmarterStats installation. View the full specification
Inputs
| Input Parameters | Description |
|---|
authUserName | String | Username with permissions to call this web service. |
authPassword | String | Password of the account used in authUserName parameter. |
Returns ProductInfoResult
| ProductInfoResult | Description |
|---|
FeatureSet | String | Indicates what edition of the product is running on this installation. Can be one of the following:- Enterprise
- Professional
- Free
|
Message | String | A text message explaining the results of the operation, including the reason for any failures. |
ProductName | String | The full product name. |
ProductVersion | String | The 3 part version of the product, in the format ###.###.###. |
Result | Boolean | Returns true if the function call was successful. |
ResultCode | Int32 | A result code, which differs by function. |
SetLicenseKey
Sets a license key to ready it for activation. This should be followed with a call to ActivateLicenseKey. View the full specification
Inputs
| Input Parameters | Description |
|---|
authUserName | String | Username with permissions to call this web service. |
authPassword | String | Password of the account used in authUserName parameter. |
key | String | The license key to set for the product. |
Returns GenericResult
| GenericResult | Description |
|---|
Message | String | A text message explaining the results of the operation, including the reason for any failures. |
Result | Boolean | Returns true if the function call was successful. |
ResultCode | Int32 | A result code, which differs by function. |
https://stats.smartertools.com:443/Services/Query.asmx
This web service contains methods that allows arbitrary data queries to be run against a SmarterStats site.
Because of the nature of these queries, the operation of this web service is subject to continual change. Systems should not depend on the results of this function being the same from version to version.
WSDL Definition
| Functions |
|---|
| AvailableQueries | Returns the available queries in SmarterStats. |
| AvailableQueriesWithInputs | Returns the available queries with corresponding inputs in SmarterStats. |
| ExecuteQuery | Returns the results of a query for a site. In order for this function to work, you must manually add a unique authorization code into the AuthorizationCode element of the App_Data\Config\AppConfig.xml file. This code must be at least 10 alphanumeric characters long. For the highest security, it is recommended that this be a GUID. |
AvailableQueries
Returns the available queries in SmarterStats. View the full specification
Inputs
| Input Parameters | Description |
|---|
authUserName | String | Username with permissions to call this web service. |
authPassword | String | Password of the account used in authUserName parameter. |
Returns List`1
Returns the available queries with corresponding inputs in SmarterStats. View the full specification
Inputs
| Input Parameters | Description |
|---|
authUserName | String | Username with permissions to call this web service. |
authPassword | String | Password of the account used in authUserName parameter. |
Returns List`1
| AvailableQueryResult | Description |
|---|
QueryDescription | String | |
QueryInputs | AvailableQueryInputs[] | |
QueryUrl | String | |
| AvailableQueryInputs | Description |
|---|
InputDescription | String | |
InputName | String | |
ExecuteQuery
Returns the results of a query for a site. In order for this function to work, you must manually add a unique authorization code into the AuthorizationCode element of the App_Data\Config\AppConfig.xml file. This code must be at least 10 alphanumeric characters long. For the highest security, it is recommended that this be a GUID. View the full specification
Inputs
| Input Parameters | Description |
|---|
authUserName | String | Username with permissions to call this web service. |
authPassword | String | Password of the account used in authUserName parameter. |
authorizationCode | String | The unique authorization code that you set in AppConfig.xml as explained above |
queryName | String | The name of the query that will be ran. A full list of queries available can be found by calling the "AvailableQueries" web service |
keyValuePairs | String[] | The QueryInputs to be used in a KEY=VALUE pair. Also include a 'ServerID' key with the value of the server |
Returns QueryResult
| QueryResult | Description |
|---|
AsyncGuid | String | |
Completed | Boolean | |
CompletedPercent | Int32 | |
FooterOtherItems | QueryResultRow | |
FooterTotals | QueryResultRow | |
FooterUnknown | QueryResultRow | |
QueryTimeMilliseconds | Int64 | |
Success | Boolean | |
TableData | QueryResultRow[] | |
| QueryResultRow | Description |
|---|
AvgBandwidthBytes | Double | |
AvgBandwidthGb | Double | |
AvgBandwidthKb | Double | |
AvgBandwidthMb | Double | |
AvgTimeTakenMs | Double | |
BandwidthBytes | Int64 | |
BandwidthGb | Int64 | |
BandwidthIn | Int64 | |
BandwidthKb | Int64 | |
BandwidthMb | Double | |
BandwidthOut | Int64 | |
BouncePercentage | Double | |
Bounces | Int64 | |
Browser | String | |
BrowserVersion | String | |
City | String | |
CityWithRegion | String | |
CountryCode | String | |
CountryName | String | |
Date | Nullable<DateTime> | |
DateFirst | Nullable<DateTime> | |
DateLast | Nullable<DateTime> | |
DateOfLog | Nullable<DateTime> | |
DateTicks | Int64 | |
Device | String | |
EntrancePercentage | Double | |
Entrances | Int64 | |
ExitPercentage | Double | |
Exits | Int64 | |
FileBandwidth | Int64 | |
Hits | Int64 | |
ID | Int32 | |
IpAddress | String | |
Item | Object | |
ItemCount | Int64 | |
Keyword | String | |
Location | Location | |
Name | String | |
NewVisits | Int64 | |
Phrase | String | |
Platform | String | |
ProtocolStatus | String | |
RawBandwidthBytes | Int64 | |
RawBandwidthGb | Int64 | |
RawBandwidthKb | Int64 | |
RawBandwidthMb | Int64 | |
RegionCode | String | |
RegionFipsCode | String | |
RegionName | String | |
ResultCount | Int64 | |
ReturnVisits | Int64 | |
SearchEngine | String | |
SearchRank | Int32 | |
ServerName | String | |
SiteUrl | String | |
SiteUrlLink | String | |
TimeTakenMs | Int64 | |
UniqueVisits | Int64 | |
URIStemText | String | |
Username | String | |
Views | Int64 | |
ViewsDuringVisit | Int64 | |
VisitLength | TimeSpan | |
VisitLengthPerVisit | TimeSpan | |
VisitLengthSeconds | Int64 | |
Visitors | Int64 | |
Visits | Int64 | |
| Location | Description |
|---|
area_code | Int32 | |
city | String | |
CountryCode | String | |
CountryName | String | |
DmaCode | Int32 | |
Latitude | Double | |
Longitude | Double | |
PostalCode | String | |
region | String | |
https://stats.smartertools.com:443/Services/ServerAdmin.asmx
This web service contains methods that retrieve and set properties of servers connected to SmarterStats. Multiple servers are only supported by SmarterStats Enteprise, and as a result, most of these functions will only operate under SmarterStats Enterprise.
WSDL Definition
| Functions |
|---|
| AddServer | Adds a server to SmarterStats. Note that the remove SmarterStats service must be installed on that server already. This function only functions properly when SmarterStats is licensed as SmarterStats Enterprise. |
| DeleteServer | Deletes a server from SmarterStats. Note that this function will fail if there are any sites assigned to the server, as they must first be removed through the corresponding function in the SiteAdmin web service. |
| GetGlobalDefaults | Returns the global settings for SmarterStats, as configured in the application. |
| GetServers | Returns all servers associated with this instance of SmarterStats. |
| PingServer | Checks to ensure that a server configured in SmarterStats can be reached by the primary server. |
| UpdateServer | Updates the Name or IP Address of an already existing server in SmarterStats. |
AddServer
Adds a server to SmarterStats. Note that the remove SmarterStats service must be installed on that server already. This function only functions properly when SmarterStats is licensed as SmarterStats Enterprise. View the full specification
Inputs
| Input Parameters | Description |
|---|
authUserName | String | Username with permissions to call this web service. |
authPassword | String | Password of the account used in authUserName parameter. |
ServerID | Int32 | The new ID of the server. This number must be unique from other configured servers. |
ServerIP | String | The IP Address of the remote server. |
ServerName | String | The display name of the server. |
Returns GenericResult
| GenericResult | Description |
|---|
Message | String | A text message explaining the results of the operation, including the reason for any failures. |
Result | Boolean | Returns true if the function call was successful. |
ResultCode | Int32 | A result code, which differs by function. |
DeleteServer
Deletes a server from SmarterStats. Note that this function will fail if there are any sites assigned to the server, as they must first be removed through the corresponding function in the SiteAdmin web service. View the full specification
Inputs
| Input Parameters | Description |
|---|
authUserName | String | Username with permissions to call this web service. |
authPassword | String | Password of the account used in authUserName parameter. |
ServerID | Int32 | The ID of the server to remove, as defined in the SmarterStats interface or in a call to GetServers. |
Returns GenericResult
| GenericResult | Description |
|---|
Message | String | A text message explaining the results of the operation, including the reason for any failures. |
Result | Boolean | Returns true if the function call was successful. |
ResultCode | Int32 | A result code, which differs by function. |
GetGlobalDefaults
Returns the global settings for SmarterStats, as configured in the application. View the full specification
Inputs
| Input Parameters | Description |
|---|
authUserName | String | Username with permissions to call this web service. |
authPassword | String | Password of the account used in authUserName parameter. |
Returns GlobalDefaultsResult
| GlobalDefaultsResult | Description |
|---|
ActivationKey | String | The encrypted activation string for this installation. |
DefaultCustomReportDayRange | Int32 | The maximum number of days that a custom report item can report on. |
DefaultCustomReportItemLimit | Int32 | The maximum number of items that can be added to each custom report. |
DefaultLengthToKeepDNSCache | Int32 | This variable is now unused. |
DefaultLogFileDays | Int32 | The default number of days to keep original log files before auto-deleting them. A value of 0 means never auto-delete. |
DefaultMaxMonthsHistory | Int32 | This variable is now unused. |
DefaultMaxSpaceMegs | Int32 | This variable is now unused. |
DefaultNumberOfIPToResolve | Int32 | The default maximum number of IP Addresses to run through DNS resolution for each report run. |
DefaultNumberOfMiliSecondsToTryResolveIP | Int32 | The default maximum time allowed to resolve IP Addresses through DNS (in milliseconds). |
DefaultSmarterLogFileMonths | Int32 | The default number of months to keep SmarterLog files before auto-deleting them. A value of 0 means never auto-delete. |
DefaultSMTPServer | String | The default SMTP server for sites. |
DefaultStandardReportDayRange | Int32 | This variable is now unused. |
DocumentExtensions | ArrayList | An array of strings with Extensions that signify documents. |
DownloadExtensions | ArrayList | An array of strings with Extensions that signify downloads. |
DynamicPageExtensions | ArrayList | An array of strings with Extensions that signify dynamic pages. |
EmailReportsMaxRowsToReturn | Int32 | Maximum number of rows that can be returned for a report item in email reports. |
EmailReportsSendErrorEmails | Boolean | This variable is true if emails should be sent to the administrator on errors. |
EmailReportsSendInterval | Int32 | The interval, in hours, in which email reports should be processed. |
EmailReportsSendOverTimeEmail | Boolean | This variable is now unused. |
EmailReportsSleepTime | Int32 | The number of milliseconds that will be waited between each email report. |
EmailReportsThreadsToRunAtOnce | Int32 | The number of email reporting threads that run concurrently. |
EmailReportsTotalTimeToProcess | String | This variable is now unused. |
FromEmailAddress | String | The default from address for emails. |
HackAttemptExtensions | ArrayList | This variable is unused |
ImageExtensions | ArrayList | An array of strings with Extensions that signify images. |
LicenseKey | String | The license key activated on this SmarterStats installation. |
MaxThreadsToResolveAtOnce | Int32 | The number of DNS Resolutions that can occur simultaneously. |
Message | String | A text message explaining the results of the operation, including the reason for any failures. |
PageExtensions | ArrayList | An array of strings with Extensions that signify pages. |
ProblemEmailAddress | String | The email address that will receive notifications of system problems. |
ProblemSMTPServer | String | The SMTP server used to send problem notification emails. |
Result | Boolean | Returns true if the function call was successful. |
ResultCode | Int32 | A result code, which differs by function. |
RowOptionsList | String | A comma-separated list of options that show up in the 'rows' dropdown in reports. |
SmarterStatsAdmin | String | This variable is unused |
SmarterStatsPassword | String | This variable is deprecated and will always return an empty string |
StandardFontSize | Int32 | This variable is unused |
GetServers
Returns all servers associated with this instance of SmarterStats. View the full specification
Inputs
| Input Parameters | Description |
|---|
authUserName | String | Username with permissions to call this web service. |
authPassword | String | Password of the account used in authUserName parameter. |
Returns ServerInfoArrayResult
| ServerInfoArrayResult | Description |
|---|
Message | String | A text message explaining the results of the operation, including the reason for any failures. |
Result | Boolean | Returns true if the function call was successful. |
ResultCode | Int32 | A result code, which differs by function. |
Servers | ServerInfo[] | An array of information about each server, as defined in the ServerInfo class. |
| ServerInfo | Description |
|---|
IP | String | The IP Address of the server. |
Name | String | The display name for the server. |
ServerID | Int32 | The numerical ID of the server, as defined in SmarterStats. |
PingServer
Checks to ensure that a server configured in SmarterStats can be reached by the primary server. View the full specification
Inputs
| Input Parameters | Description |
|---|
authUserName | String | Username with permissions to call this web service. |
authPassword | String | Password of the account used in authUserName parameter. |
ServerID | Int32 | The ID of the server, as found in the Manage Servers list within the application, or from the call to GetServers. |
Returns GenericResult
| GenericResult | Description |
|---|
Message | String | A text message explaining the results of the operation, including the reason for any failures. |
Result | Boolean | Returns true if the function call was successful. |
ResultCode | Int32 | A result code, which differs by function. |
UpdateServer
Updates the Name or IP Address of an already existing server in SmarterStats. View the full specification
Inputs
| Input Parameters | Description |
|---|
authUserName | String | Username with permissions to call this web service. |
authPassword | String | Password of the account used in authUserName parameter. |
ServerID | Int32 | The ID of the server to change, as defined in the SmarterStats interface or in a call to GetServers. |
ServerIP | String | The new IP Address of the remote server. |
ServerName | String | The new display name of the server. |
Returns GenericResult
| GenericResult | Description |
|---|
Message | String | A text message explaining the results of the operation, including the reason for any failures. |
Result | Boolean | Returns true if the function call was successful. |
ResultCode | Int32 | A result code, which differs by function. |
https://stats.smartertools.com:443/Services/SiteAdmin.asmx
This web service contains methods that add, update, and remove sites from a SmarterStats configuration.
WSDL Definition
| Functions |
|---|
| AddSite5 | Adds a new site to SmarterStats. In the following variables, 'site owner' refers to the primary user for the site. |
| AddSiteWithFTP3 | Adds a site that pulls log files from FTP to SmarterStats. |
| DeleteSite | Deletes a site that exists in the SmarterStats installation. |
| DeleteSiteByName | Deletes a site that exists in the SmarterStats installation by site name instead of site ID. |
| GetAllSites2 | Returns all sites that exist in the SmarterStats installation. |
| GetRequestedSettings | Gets the values of named settings for a site. |
| GetSite2 | Returns the configuration details about one site in SmarterStats. |
| GetSiteByName | Returns the configuration details about one site in SmarterStats (identified by name). |
| GetSitesForServer2 | Returns details about all sites for a single server in SmarterStats. |
| GetSiteStatus | Returns the status for one site in SmarterStats. |
| MoveSite2 | Moves one site from one server to another within a single SmarterStats installation. Note that this function will only function properly when SmarterStats is licensed as Enterprise Edition. |
| SetRequestedSettings | Sets the passed configuration settings for a site. |
| UpdateSite4 | Updates the configuration of a site within SmarterStats. |
AddSite
View the full specification
OBSOLETE: This function is now obsolete and has been replaced with the function AddSite5. Support of obsolete functions will be discontinued in future versions, so continued use is not recommended.
AddSite2
View the full specification
OBSOLETE: This function is now obsolete and has been replaced with the function AddSite5. Support of obsolete functions will be discontinued in future versions, so continued use is not recommended.
AddSite3
View the full specification
OBSOLETE: This function is now obsolete and has been replaced with the function AddSite5. Support of obsolete functions will be discontinued in future versions, so continued use is not recommended.
AddSite4
View the full specification
OBSOLETE: This function is now obsolete and has been replaced with the function AddSite5. Support of obsolete functions will be discontinued in future versions, so continued use is not recommended.
AddSite5
Adds a new site to SmarterStats. In the following variables, 'site owner' refers to the primary user for the site. View the full specification
Inputs
| Input Parameters | Description |
|---|
authUserName | String | Username with permissions to call this web service. |
authPassword | String | Password of the account used in authUserName parameter. |
soUserName | String | The username for the site owner. |
soPassword | String | The desired password for the site owner. |
soFirstName | String | The first name of the site owner. |
soLastName | String | The last name of the site owner. |
ServerID | Int32 | The ID of the server, as shown in the SmarterStats interface. If you are using a Professional or Free Edition of SmarterStats, pass 1 for this value. |
SiteID | Int32 | A numerical ID for the new site. To have one auto-assigned, pass 0 for this value. |
DomainName | String | The display name for the site. Typically, this will be in the format 'example.com' |
DomainUrl | String | The URL for the site. Typically this will be in the format 'http://www.example.com' |
LogFormat | String | The format of the log files for the site. The value can be one of the following: - ApacheCLF
- ApacheNCSAEx
- CLF
- IIS
- IPlanetCLF
- NCSA
- W3Cex
|
LogLocations | ConfigLogLocation[] | A list of objects defining where log files for the site are located. |
SmarterLogDirectory | String | The folder that should be used to store the SmarterStats data files for the site. Typically, this is 'C:\SmarterLogs\'. |
SmarterLogMonthsBeforeDelete | Int32 | The number of months to store SmarterStats data for the site before auto-deleting it. Passing -1 will use the default setting for the SmarterStats installation. Passing 0 will never auto-delete. |
ExportPath | String | This option is now deprecated and callers should pass an empty string. |
ExportPathURL | String | This option is now deprecated and callers should pass an empty string. |
TimeZoneIndex | Int32 | The numerical index of a timezone for the site. Possible values for this can be found by opening the registry key 'HKLM\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Time Zones' and finding the Index value for the time zone you wish to pass. You may also pass -1 to use the default time zone for the server. |
AuthenticationMethod | Int32 | The Authentication Method to use for the site. 1 = internal, 2 = external |
| ConfigLogLocation | Description |
|---|
CompressDays | Int32 | The number of days before compressing the log files. Pass -1 to never compress. |
FilePath | String | The directory of the log source. |
FileWildcard | String | The file mask used to determine what files are included in this log source. |
IncludeArchiveFiles | Boolean | True to search for log files inside of .zip and .gz archives. |
IncludeSubdirectories | Boolean | True to include log files stored in subdirectories of the log location. |
LocationGuid | String | The internal unique identifier for this log source. For new entries, this should be left blank. |
MaxDays | Int32 | The maximum number of days to keep log files. Pass -1 to keep forever. |
Returns GenericResult
| GenericResult | Description |
|---|
Message | String | A text message explaining the results of the operation, including the reason for any failures. |
Result | Boolean | Returns true if the function call was successful. |
ResultCode | Int32 | A result code, which differs by function. |
AddSiteWithFTP
View the full specification
OBSOLETE: This function is now obsolete and has been replaced with the function AddSiteWithFTP3. Support of obsolete functions will be discontinued in future versions, so continued use is not recommended.
AddSiteWithFTP2
View the full specification
OBSOLETE: This function is now obsolete and has been replaced with the function AddSiteWithFTP3. Support of obsolete functions will be discontinued in future versions, so continued use is not recommended.
AddSiteWithFTP3
Adds a site that pulls log files from FTP to SmarterStats. View the full specification
Inputs
| Input Parameters | Description |
|---|
authUserName | String | Username with permissions to call this web service. |
authPassword | String | Password of the account used in authUserName parameter. |
soUserName | String | The username for the site owner. |
soPassword | String | The desired password for the site owner. |
soFirstName | String | The first name of the site owner. |
soLastName | String | The last name of the site owner. |
ServerID | Int32 | The ID of the server, as shown in the SmarterStats interface. If you are using a Professional or Free Edition of SmarterStats, pass 1 for this value. |
SiteID | Int32 | A numerical ID for the new site. To have one auto-assigned, pass 0 for this value. |
DomainName | String | The display name for the site. Typically, this will be in the format 'example.com' |
LogFormat | String | The format of the log files for the site. The value can be one of the following: - ApacheCLF
- ApacheNCSAEx
- CLF
- IIS
- IPlanetCLF
- NCSA
- W3Cex
|
LogWildcard | String | The wildcard of log files that will be searched for on the FTP server. This should be in the format '*.log' or something similar. |
LogDaysBeforeDelete | Int32 | This setting does not apply to FTP sites. Set value to 0 |
SmarterLogDirectory | String | The folder that should be used to store the SmarterStats data files for the site. Typically, this is 'C:\SmarterLogs\'. |
SmarterLogMonthsBeforeDelete | Int32 | The number of months to store SmarterStats data for the site before auto-deleting it. Passing -1 will use the default setting for the SmarterStats installation. Passing 0 will never auto-delete. |
ExportPath | String | This option is now deprecated and callers should pass an empty string. |
ExportPathURL | String | This option is now deprecated and callers should pass an empty string. |
TimeZoneIndex | Int32 | The numerical index of a timezone for the site. Possible values for this can be found by opening the registry key 'HKLM\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Time Zones' and finding the Index value for the time zone you wish to pass. You may also pass -1 to use the default time zone for the server. |
Directory | String | The directory in which the logs are stored on the FTP server. |
ProxyType | String | This setting is currently unused. |
ProxyAddress | String | This setting is currently unused. |
ProxyPort | Int32 | This setting is currently unused. |
ProxyUserName | String | This setting is currently unused. |
ProxyPassword | String | This setting is currently unused. |
Server | String | The hostname or IP Address of the FTP server. |
Port | Int32 | The port used to connect to the FTP server. |
Username | String | The username used to authenticate on the FTP server. |
Password | String | The password used to authenticate on the FTP server. |
IntervalHours | Int32 | The number of hours between FTP download attempts. |
AuthenticationMethod | Int32 | The Authentication Method to use for the site. 1 = internal, 2 = external |
Returns GenericResult
| GenericResult | Description |
|---|
Message | String | A text message explaining the results of the operation, including the reason for any failures. |
Result | Boolean | Returns true if the function call was successful. |
ResultCode | Int32 | A result code, which differs by function. |
DeleteSite
Deletes a site that exists in the SmarterStats installation. View the full specification
Inputs
| Input Parameters | Description |
|---|
authUserName | String | Username with permissions to call this web service. |
authPassword | String | Password of the account used in authUserName parameter. |
SiteID | Int32 | The numerical ID of the site to delete, as defined in your SmarterStats installation. |
DeleteFiles | Boolean | Pass true to delete the SmarterStats data files for the site, or false to retain them. In most cases, this parameter should be true. |
Returns GenericResult
| GenericResult | Description |
|---|
Message | String | A text message explaining the results of the operation, including the reason for any failures. |
Result | Boolean | Returns true if the function call was successful. |
ResultCode | Int32 | A result code, which differs by function. |
DeleteSiteByName
Deletes a site that exists in the SmarterStats installation by site name instead of site ID. View the full specification
Inputs
| Input Parameters | Description |
|---|
authUserName | String | Username with permissions to call this web service. |
authPassword | String | Password of the account used in authUserName parameter. |
SiteName | String | The name of the site to delete, as defined in your SmarterStats installation. |
DeleteFiles | Boolean | Pass true to delete the SmarterStats data files for the site, or false to retain them. In most cases, this parameter should be true. |
Returns GenericResult
| GenericResult | Description |
|---|
Message | String | A text message explaining the results of the operation, including the reason for any failures. |
Result | Boolean | Returns true if the function call was successful. |
ResultCode | Int32 | A result code, which differs by function. |
GetAllSites
View the full specification
OBSOLETE: This function is now obsolete and has been replaced with the function GetAllSites2. Support of obsolete functions will be discontinued in future versions, so continued use is not recommended.
GetAllSites2
Returns all sites that exist in the SmarterStats installation. View the full specification
Inputs
| Input Parameters | Description |
|---|
authUserName | String | Username with permissions to call this web service. |
authPassword | String | Password of the account used in authUserName parameter. |
IncludeDetails | Boolean | Pass true to get details about each site, such as log file location and other configuration data. Pass false if you just want a list of sites and their IDs. |
Returns SiteSettingInfoArrayResult
| SiteSettingInfoArrayResult | Description |
|---|
Message | String | A text message explaining the results of the operation, including the reason for any failures. |
Result | Boolean | Returns true if the function call was successful. |
ResultCode | Int32 | A result code, which differs by function. |
Sites | SiteSettingInfo[] | An array of details about the sites, as defined in the SiteSettingInfo class. |
| SiteSettingInfo | Description |
|---|
authenticationType | String | The Authentication type the site is using. |
DomainName | String | The display name for the site. Typically, this will be in the format 'example.com'. |
ExportPath | String | The file path that is used for exporting log files. This path should be accessible through the file system and also through a website URL. |
ExportPathURL | String | The web site URL that corresponds to the ExportPath value. |
ftp_Directory | String | The directory in which the logs are stored on the FTP server. |
ftp_Enabled | Boolean | True if FTP downloaded logs are enabled for the site. |
ftp_Interval | Int32 | The number of hours between FTP download attempts. |
ftp_LogMaxDays | Int32 | The number of days old original log files should be before SmarterStats attempts to delete them automatically. 0 indicates logs will never be auto-deleted. |
ftp_LogWildcard | String | The wildcard of log files that will be searched for on the FTP server. This should be in the format '*.log' or something similar. |
ftp_Password | String | The password to be used to login to the FTP server. |
ftp_port | Int32 | The port number to use to connect to the FTP server. |
ftp_ProxyAddress | String | This setting is currently unused. |
ftp_ProxyPassword | String | This setting is currently unused. |
ftp_ProxyPort | Int32 | This setting is currently unused. |
ftp_ProxyType | String | This setting is currently unused. |
ftp_ProxyUsername | String | This setting is currently unused. |
ftp_Server | String | The hostname or IP Address of the FTP server. |
ftp_Username | String | The username to be used to login to the FTP server. |
LogFormat | String | The format of the log files for the site. The value can be one of the following: - ApacheCLF
- ApacheNCSAEx
- CLF
- IIS
- IPlanetCLF
- NCSA
- W3Cex
|
LogLocations | ConfigLogLocation[] | A list of objects defining where log files for the site are located. |
ServerID | Int32 | The numerical ID of the server on which the site resides, as defined in SmarterStats. |
SiteID | Int32 | The numerical ID that identifies this site within SmarterStats. |
SiteStatus | String | An indicator of the current status of the site. |
SmarterLogDirectory | String | The folder that is used to store the SmarterStats data files for the site. Typically, this is 'C:\SmarterLogs\'. |
SmarterLogMonthsBeforeDelete | Int32 | The number of months to store SmarterStats data for the site before auto-deleting it. 0 indicates data will never be auto-deleted. |
TimeZoneIndex | Int32 | The numerical index of a timezone for the site. Possible values for this can be found by opening the registry key 'HKLM\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Time Zones' and referring to the Index value for the time zones. -1 indicates to use the default time zone for the server. |
| ConfigLogLocation | Description |
|---|
CompressDays | Int32 | The number of days before compressing the log files. Pass -1 to never compress. |
FilePath | String | The directory of the log source. |
FileWildcard | String | The file mask used to determine what files are included in this log source. |
IncludeArchiveFiles | Boolean | True to search for log files inside of .zip and .gz archives. |
IncludeSubdirectories | Boolean | True to include log files stored in subdirectories of the log location. |
LocationGuid | String | The internal unique identifier for this log source. For new entries, this should be left blank. |
MaxDays | Int32 | The maximum number of days to keep log files. Pass -1 to keep forever. |
GetRequestedSettings
Gets the values of named settings for a site. View the full specification
Inputs
| Input Parameters | Description |
|---|
authUserName | String | Username with permissions to call this web service. |
authPassword | String | Password of the account used in authUserName parameter. |
SiteID | Int32 | The numerical ID of the site, as defined in your SmarterStats installation. |
keys | String[] | The settings that you wish to retrieve from the installation. Possible keys are:- SiteUrl: The base URL of the site
|
values | String[]& | (OUT) The values of the keys requested, in the format 'key=value' |
Returns GenericResult
| GenericResult | Description |
|---|
Message | String | A text message explaining the results of the operation, including the reason for any failures. |
Result | Boolean | Returns true if the function call was successful. |
ResultCode | Int32 | A result code, which differs by function. |
GetSite
View the full specification
OBSOLETE: This function is now obsolete and has been replaced with the function GetSite2. Support of obsolete functions will be discontinued in future versions, so continued use is not recommended.
GetSite2
Returns the configuration details about one site in SmarterStats. View the full specification
Inputs
| Input Parameters | Description |
|---|
authUserName | String | Username with permissions to call this web service. |
authPassword | String | Password of the account used in authUserName parameter. |
SiteID | Int32 | The numerical ID of the site to get information about, as defined in your SmarterStats installation. |
Returns SiteSettingInfoResult
| SiteSettingInfoResult | Description |
|---|
Message | String | A text message explaining the results of the operation, including the reason for any failures. |
Result | Boolean | Returns true if the function call was successful. |
ResultCode | Int32 | A result code, which differs by function. |
Site | SiteSettingInfo | Information about the site, as defined in the SiteSettingInfo class. |
| SiteSettingInfo | Description |
|---|
authenticationType | String | The Authentication type the site is using. |
DomainName | String | The display name for the site. Typically, this will be in the format 'example.com'. |
ExportPath | String | The file path that is used for exporting log files. This path should be accessible through the file system and also through a website URL. |
ExportPathURL | String | The web site URL that corresponds to the ExportPath value. |
ftp_Directory | String | The directory in which the logs are stored on the FTP server. |
ftp_Enabled | Boolean | True if FTP downloaded logs are enabled for the site. |
ftp_Interval | Int32 | The number of hours between FTP download attempts. |
ftp_LogMaxDays | Int32 | The number of days old original log files should be before SmarterStats attempts to delete them automatically. 0 indicates logs will never be auto-deleted. |
ftp_LogWildcard | String | The wildcard of log files that will be searched for on the FTP server. This should be in the format '*.log' or something similar. |
ftp_Password | String | The password to be used to login to the FTP server. |
ftp_port | Int32 | The port number to use to connect to the FTP server. |
ftp_ProxyAddress | String | This setting is currently unused. |
ftp_ProxyPassword | String | This setting is currently unused. |
ftp_ProxyPort | Int32 | This setting is currently unused. |
ftp_ProxyType | String | This setting is currently unused. |
ftp_ProxyUsername | String | This setting is currently unused. |
ftp_Server | String | The hostname or IP Address of the FTP server. |
ftp_Username | String | The username to be used to login to the FTP server. |
LogFormat | String | The format of the log files for the site. The value can be one of the following: - ApacheCLF
- ApacheNCSAEx
- CLF
- IIS
- IPlanetCLF
- NCSA
- W3Cex
|
LogLocations | ConfigLogLocation[] | A list of objects defining where log files for the site are located. |
ServerID | Int32 | The numerical ID of the server on which the site resides, as defined in SmarterStats. |
SiteID | Int32 | The numerical ID that identifies this site within SmarterStats. |
SiteStatus | String | An indicator of the current status of the site. |
SmarterLogDirectory | String | The folder that is used to store the SmarterStats data files for the site. Typically, this is 'C:\SmarterLogs\'. |
SmarterLogMonthsBeforeDelete | Int32 | The number of months to store SmarterStats data for the site before auto-deleting it. 0 indicates data will never be auto-deleted. |
TimeZoneIndex | Int32 | The numerical index of a timezone for the site. Possible values for this can be found by opening the registry key 'HKLM\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Time Zones' and referring to the Index value for the time zones. -1 indicates to use the default time zone for the server. |
| ConfigLogLocation | Description |
|---|
CompressDays | Int32 | The number of days before compressing the log files. Pass -1 to never compress. |
FilePath | String | The directory of the log source. |
FileWildcard | String | The file mask used to determine what files are included in this log source. |
IncludeArchiveFiles | Boolean | True to search for log files inside of .zip and .gz archives. |
IncludeSubdirectories | Boolean | True to include log files stored in subdirectories of the log location. |
LocationGuid | String | The internal unique identifier for this log source. For new entries, this should be left blank. |
MaxDays | Int32 | The maximum number of days to keep log files. Pass -1 to keep forever. |
GetSiteByName
Returns the configuration details about one site in SmarterStats (identified by name). View the full specification
Inputs
| Input Parameters | Description |
|---|
authUserName | String | Username with permissions to call this web service. |
authPassword | String | Password of the account used in authUserName parameter. |
siteName | String | The name of the site to get information about, as defined in your SmarterStats installation. |
Returns SiteSettingInfoResult
| SiteSettingInfoResult | Description |
|---|
Message | String | A text message explaining the results of the operation, including the reason for any failures. |
Result | Boolean | Returns true if the function call was successful. |
ResultCode | Int32 | A result code, which differs by function. |
Site | SiteSettingInfo | Information about the site, as defined in the SiteSettingInfo class. |
| SiteSettingInfo | Description |
|---|
authenticationType | String | The Authentication type the site is using. |
DomainName | String | The display name for the site. Typically, this will be in the format 'example.com'. |
ExportPath | String | The file path that is used for exporting log files. This path should be accessible through the file system and also through a website URL. |
ExportPathURL | String | The web site URL that corresponds to the ExportPath value. |
ftp_Directory | String | The directory in which the logs are stored on the FTP server. |
ftp_Enabled | Boolean | True if FTP downloaded logs are enabled for the site. |
ftp_Interval | Int32 | The number of hours between FTP download attempts. |
ftp_LogMaxDays | Int32 | The number of days old original log files should be before SmarterStats attempts to delete them automatically. 0 indicates logs will never be auto-deleted. |
ftp_LogWildcard | String | The wildcard of log files that will be searched for on the FTP server. This should be in the format '*.log' or something similar. |
ftp_Password | String | The password to be used to login to the FTP server. |
ftp_port | Int32 | The port number to use to connect to the FTP server. |
ftp_ProxyAddress | String | This setting is currently unused. |
ftp_ProxyPassword | String | This setting is currently unused. |
ftp_ProxyPort | Int32 | This setting is currently unused. |
ftp_ProxyType | String | This setting is currently unused. |
ftp_ProxyUsername | String | This setting is currently unused. |
ftp_Server | String | The hostname or IP Address of the FTP server. |
ftp_Username | String | The username to be used to login to the FTP server. |
LogFormat | String | The format of the log files for the site. The value can be one of the following: - ApacheCLF
- ApacheNCSAEx
- CLF
- IIS
- IPlanetCLF
- NCSA
- W3Cex
|
LogLocations | ConfigLogLocation[] | A list of objects defining where log files for the site are located. |
ServerID | Int32 | The numerical ID of the server on which the site resides, as defined in SmarterStats. |
SiteID | Int32 | The numerical ID that identifies this site within SmarterStats. |
SiteStatus | String | An indicator of the current status of the site. |
SmarterLogDirectory | String | The folder that is used to store the SmarterStats data files for the site. Typically, this is 'C:\SmarterLogs\'. |
SmarterLogMonthsBeforeDelete | Int32 | The number of months to store SmarterStats data for the site before auto-deleting it. 0 indicates data will never be auto-deleted. |
TimeZoneIndex | Int32 | The numerical index of a timezone for the site. Possible values for this can be found by opening the registry key 'HKLM\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Time Zones' and referring to the Index value for the time zones. -1 indicates to use the default time zone for the server. |
| ConfigLogLocation | Description |
|---|
CompressDays | Int32 | The number of days before compressing the log files. Pass -1 to never compress. |
FilePath | String | The directory of the log source. |
FileWildcard | String | The file mask used to determine what files are included in this log source. |
IncludeArchiveFiles | Boolean | True to search for log files inside of .zip and .gz archives. |
IncludeSubdirectories | Boolean | True to include log files stored in subdirectories of the log location. |
LocationGuid | String | The internal unique identifier for this log source. For new entries, this should be left blank. |
MaxDays | Int32 | The maximum number of days to keep log files. Pass -1 to keep forever. |
GetSitesForServer
View the full specification
OBSOLETE: This function is now obsolete and has been replaced with the function GetSitesForServer2. Support of obsolete functions will be discontinued in future versions, so continued use is not recommended.
GetSitesForServer2
Returns details about all sites for a single server in SmarterStats. View the full specification
Inputs
| Input Parameters | Description |
|---|
authUserName | String | Username with permissions to call this web service. |
authPassword | String | Password of the account used in authUserName parameter. |
ServerID | Int32 | The numerical ID of the server, as defined in your SmarterStats installation. For Professional and Free Edition, pass 1 as the value. |
IncludeDetails | Boolean | Pass true to get details about each site, such as log file location and other configuration data. Pass false if you just want a list of sites and their IDs. |
Returns SiteSettingInfoArrayResult
| SiteSettingInfoArrayResult | Description |
|---|
Message | String | A text message explaining the results of the operation, including the reason for any failures. |
Result | Boolean | Returns true if the function call was successful. |
ResultCode | Int32 | A result code, which differs by function. |
Sites | SiteSettingInfo[] | An array of details about the sites, as defined in the SiteSettingInfo class. |
| SiteSettingInfo | Description |
|---|
authenticationType | String | The Authentication type the site is using. |
DomainName | String | The display name for the site. Typically, this will be in the format 'example.com'. |
ExportPath | String | The file path that is used for exporting log files. This path should be accessible through the file system and also through a website URL. |
ExportPathURL | String | The web site URL that corresponds to the ExportPath value. |
ftp_Directory | String | The directory in which the logs are stored on the FTP server. |
ftp_Enabled | Boolean | True if FTP downloaded logs are enabled for the site. |
ftp_Interval | Int32 | The number of hours between FTP download attempts. |
ftp_LogMaxDays | Int32 | The number of days old original log files should be before SmarterStats attempts to delete them automatically. 0 indicates logs will never be auto-deleted. |
ftp_LogWildcard | String | The wildcard of log files that will be searched for on the FTP server. This should be in the format '*.log' or something similar. |
ftp_Password | String | The password to be used to login to the FTP server. |
ftp_port | Int32 | The port number to use to connect to the FTP server. |
ftp_ProxyAddress | String | This setting is currently unused. |
ftp_ProxyPassword | String | This setting is currently unused. |
ftp_ProxyPort | Int32 | This setting is currently unused. |
ftp_ProxyType | String | This setting is currently unused. |
ftp_ProxyUsername | String | This setting is currently unused. |
ftp_Server | String | The hostname or IP Address of the FTP server. |
ftp_Username | String | The username to be used to login to the FTP server. |
LogFormat | String | The format of the log files for the site. The value can be one of the following: - ApacheCLF
- ApacheNCSAEx
- CLF
- IIS
- IPlanetCLF
- NCSA
- W3Cex
|
LogLocations | ConfigLogLocation[] | A list of objects defining where log files for the site are located. |
ServerID | Int32 | The numerical ID of the server on which the site resides, as defined in SmarterStats. |
SiteID | Int32 | The numerical ID that identifies this site within SmarterStats. |
SiteStatus | String | An indicator of the current status of the site. |
SmarterLogDirectory | String | The folder that is used to store the SmarterStats data files for the site. Typically, this is 'C:\SmarterLogs\'. |
SmarterLogMonthsBeforeDelete | Int32 | The number of months to store SmarterStats data for the site before auto-deleting it. 0 indicates data will never be auto-deleted. |
TimeZoneIndex | Int32 | The numerical index of a timezone for the site. Possible values for this can be found by opening the registry key 'HKLM\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Time Zones' and referring to the Index value for the time zones. -1 indicates to use the default time zone for the server. |
| ConfigLogLocation | Description |
|---|
CompressDays | Int32 | The number of days before compressing the log files. Pass -1 to never compress. |
FilePath | String | The directory of the log source. |
FileWildcard | String | The file mask used to determine what files are included in this log source. |
IncludeArchiveFiles | Boolean | True to search for log files inside of .zip and .gz archives. |
IncludeSubdirectories | Boolean | True to include log files stored in subdirectories of the log location. |
LocationGuid | String | The internal unique identifier for this log source. For new entries, this should be left blank. |
MaxDays | Int32 | The maximum number of days to keep log files. Pass -1 to keep forever. |
GetSiteStatus
Returns the status for one site in SmarterStats. View the full specification
Inputs
| Input Parameters | Description |
|---|
authUserName | String | Username with permissions to call this web service. |
authPassword | String | Password of the account used in authUserName parameter. |
SiteID | Int32 | The numerical ID of the site to get information about, as defined in your SmarterStats installation. |
Returns SiteInfoResult
| SiteInfoResult | Description |
|---|
Message | String | A text message explaining the results of the operation, including the reason for any failures. |
Result | Boolean | Returns true if the function call was successful. |
ResultCode | Int32 | A result code, which differs by function. |
Site | SiteInfo | Details about the site, as defined in the SiteInfo class. |
| SiteInfo | Description |
|---|
AuthenticationType | String | The Authentication type the site is using. |
DomainName | String | The display name for the site. Typically, this will be in the format 'example.com'. |
ExportPath | String | The file path that is used for exporting log files. This path should be accessible through the file system and also through a website URL. |
ExportPathURL | String | The web site URL that corresponds to the ExportPath value. |
ftp_Directory | String | The directory in which the logs are stored on the FTP server. |
ftp_Enabled | Boolean | True if FTP downloaded logs are enabled for the site. |
ftp_Interval | Int32 | The number of hours between FTP download attempts. |
ftp_Password | String | The password to be used to login to the FTP server. |
ftp_port | Int32 | The port number to use to connect to the FTP server. |
ftp_ProxyAddress | String | This setting is currently unused. |
ftp_ProxyPassword | String | This setting is currently unused. |
ftp_ProxyPort | Int32 | This setting is currently unused. |
ftp_ProxyType | String | This setting is currently unused. |
ftp_ProxyUsername | String | This setting is currently unused. |
ftp_Server | String | The hostname or IP Address of the FTP server. |
ftp_Username | String | The username to be used to login to the FTP server. |
LogDaysBeforeDelete | Int32 | The number of days old original log files should be before SmarterStats attempts to delete them automatically. 0 indicates logs will never be auto-deleted. |
LogDirectory | String | The directory in which original log files reside. |
LogFormat | String | The format of the log files for the site. The value can be one of the following: - ApacheCLF
- ApacheNCSAEx
- CLF
- IIS
- IPlanetCLF
- NCSA
- W3Cex
|
LogWildcard | String | The wildcard of log files that will be searched for on the FTP server. This should be in the format '*.log' or something similar. |
ServerID | Int32 | The numerical ID of the server on which the site resides, as defined in SmarterStats. |
SiteID | Int32 | The numerical ID that identifies this site within SmarterStats. |
SiteStatus | String | An indicator of the current status of the site. |
SmarterLogDirectory | String | The folder that is used to store the SmarterStats data files for the site. Typically, this is 'C:\SmarterLogs\'. |
SmarterLogMonthsBeforeDelete | Int32 | The number of months to store SmarterStats data for the site before auto-deleting it. 0 indicates data will never be auto-deleted. |
TimeZoneIndex | Int32 | The numerical index of a timezone for the site. Possible values for this can be found by opening the registry key 'HKLM\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Time Zones' and referring to the Index value for the time zones. -1 indicates to use the default time zone for the server. |
MoveSite
View the full specification
OBSOLETE: This function is now obsolete and has been replaced with the function MoveSite2. Support of obsolete functions will be discontinued in future versions, so continued use is not recommended.
MoveSite2
Moves one site from one server to another within a single SmarterStats installation. Note that this function will only function properly when SmarterStats is licensed as Enterprise Edition. View the full specification
Inputs
| Input Parameters | Description |
|---|
authUserName | String | Username with permissions to call this web service. |
authPassword | String | Password of the account used in authUserName parameter. |
SiteID | Int32 | The numerical ID of the site to move, as defined in your SmarterStats installation. |
DestServerID | Int32 | The numerical ID of the server to which the site should be moved, as defined in SmarterStats. |
DestSmarterLogPath | String | The SmarterLog path that should be used on the new server. |
DestConfigLogPaths | ConfigLogLocation[] | The new log locations as they should be configured once the site move is complete. Paths should be relative to the new server. |
DestExportPath | String | The new export log file path relative to the new server. |
DestExportPathURL | String | The web site URL that represents the DestExportPath. |
CopyFiles | Boolean | Pass true to have SmarterStats copy all SmarterLog data from the source server to the destination. Pass false if you only wish to have the configuration changed without any data files being moved. (Note that passing false may result in a loss of data) |
| ConfigLogLocation | Description |
|---|
CompressDays | Int32 | The number of days before compressing the log files. Pass -1 to never compress. |
FilePath | String | The directory of the log source. |
FileWildcard | String | The file mask used to determine what files are included in this log source. |
IncludeArchiveFiles | Boolean | True to search for log files inside of .zip and .gz archives. |
IncludeSubdirectories | Boolean | True to include log files stored in subdirectories of the log location. |
LocationGuid | String | The internal unique identifier for this log source. For new entries, this should be left blank. |
MaxDays | Int32 | The maximum number of days to keep log files. Pass -1 to keep forever. |
Returns GenericResult
| GenericResult | Description |
|---|
Message | String | A text message explaining the results of the operation, including the reason for any failures. |
Result | Boolean | Returns true if the function call was successful. |
ResultCode | Int32 | A result code, which differs by function. |
SetRequestedSettings
Sets the passed configuration settings for a site. View the full specification
Inputs
| Input Parameters | Description |
|---|
authUserName | String | Username with permissions to call this web service. |
authPassword | String | Password of the account used in authUserName parameter. |
SiteID | Int32 | The numerical ID of the site to modify, as defined in your SmarterStats installation. |
keyValuePairs | String[] | A list of variables to set, formatted as key=value pairs. Possible keys are:- SiteUrl: The base URL of the site
|
Returns GenericResult
| GenericResult | Description |
|---|
Message | String | A text message explaining the results of the operation, including the reason for any failures. |
Result | Boolean | Returns true if the function call was successful. |
ResultCode | Int32 | A result code, which differs by function. |
UpdateSite
View the full specification
OBSOLETE: This function is now obsolete and has been replaced with the function UpdateSite3. Support of obsolete functions will be discontinued in future versions, so continued use is not recommended.
UpdateSite2
View the full specification
OBSOLETE: This function is now obsolete and has been replaced with the function UpdateSite4. Support of obsolete functions will be discontinued in future versions, so continued use is not recommended.
UpdateSite3
View the full specification
OBSOLETE: This function is now obsolete and has been replaced with the function UpdateSite4. Support of obsolete functions will be discontinued in future versions, so continued use is not recommended.
UpdateSite4
Updates the configuration of a site within SmarterStats. View the full specification
Inputs
| Input Parameters | Description |
|---|
authUserName | String | Username with permissions to call this web service. |
authPassword | String | Password of the account used in authUserName parameter. |
SiteID | Int32 | The numerical ID of the site to modify, as defined in your SmarterStats installation. |
DomainName | String | The display name for the site. Typically, this will be in the format 'example.com' |
LogFormat | String | The format of the log files for the site. The value can be one of the following: - ApacheCLF
- ApacheNCSAEx
- CLF
- IIS
- IPlanetCLF
- NCSA
- W3Cex
|
LogLocations | ConfigLogLocation[] | A list of objects defining where log files for the site are located. |
SmarterLogDirectory | String | The folder that should be used to store the SmarterStats data files for the site. Typically, this is 'C:\SmarterLogs\'. |
SmarterLogMonthsBeforeDelete | Int32 | The number of months to store SmarterStats data for the site before auto-deleting it. Passing -1 will use the default setting for the SmarterStats installation. Passing 0 will never auto-delete. |
ExportPath | String | This option is now deprecated and callers should pass an empty string. |
ExportPathURL | String | This option is now deprecated and callers should pass an empty string. |
TimeZoneIndex | Int32 | The numerical index of a timezone for the site. Possible values for this can be found by opening the registry key 'HKLM\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Time Zones' and finding the Index value for the time zone you wish to pass. You may also pass -1 to use the default time zone for the server. |
AuthenticationMethod | Int32 | The Authentication Method to use for the site. 1 = internal, 2 = external |
| ConfigLogLocation | Description |
|---|
CompressDays | Int32 | The number of days before compressing the log files. Pass -1 to never compress. |
FilePath | String | The directory of the log source. |
FileWildcard | String | The file mask used to determine what files are included in this log source. |
IncludeArchiveFiles | Boolean | True to search for log files inside of .zip and .gz archives. |
IncludeSubdirectories | Boolean | True to include log files stored in subdirectories of the log location. |
LocationGuid | String | The internal unique identifier for this log source. For new entries, this should be left blank. |
MaxDays | Int32 | The maximum number of days to keep log files. Pass -1 to keep forever. |
Returns GenericResult
| GenericResult | Description |
|---|
Message | String | A text message explaining the results of the operation, including the reason for any failures. |
Result | Boolean | Returns true if the function call was successful. |
ResultCode | Int32 | A result code, which differs by function. |
https://stats.smartertools.com:443/Services/SiteTuning.asmx
This web service contains methods that control site tuning for sites on your SmarterStats installation.
WSDL Definition
GetSiteTuningIssues
View the full specification
OBSOLETE: This function is now obsolete and has been replaced with the function GetSiteTuningIssues2. Support of obsolete functions will be discontinued in future versions, so continued use is not recommended.
GetSiteTuningIssues2
Returns a list of issues found in site tuning for a specific site. View the full specification
Inputs
| Input Parameters | Description |
|---|
authUserName | String | Username with permissions to call this web service. |
authPassword | String | Password of the account used in authUserName parameter. |
SiteID | Int32 | The numerical ID of the site, as defined in your SmarterStats installation. |
Returns TuningIssueResult
| TuningIssueResult | Description |
|---|
Message | String | A text message explaining the results of the operation, including the reason for any failures. |
Result | Boolean | Returns true if the function call was successful. |
ResultCode | Int32 | A result code, which differs by function. |
TuningIssues | SiteTuningIssue[] | List of issues found in site tuning scan. |
| SiteTuningIssue | Description |
|---|
Description | String | The textual description of an issue. |
Severity | String | The severity of an issue. Possible values are: |
Type | String | The type/category of an issue. |
Url | String | The URL in which the issue occurred. |
GetSiteTuningSettings
View the full specification
OBSOLETE: This function is now obsolete and has been replaced with the function GetSiteTuningSettings2. Support of obsolete functions will be discontinued in future versions, so continued use is not recommended.
GetSiteTuningSettings2
Get site tuning settings for a specific site. View the full specification
Inputs
| Input Parameters | Description |
|---|
authUserName | String | Username with permissions to call this web service. |
authPassword | String | Password of the account used in authUserName parameter. |
SiteID | Int32 | The numerical ID of the site, as defined in your SmarterStats installation. |
Returns TuningResult
| TuningResult | Description |
|---|
Message | String | A text message explaining the results of the operation, including the reason for any failures. |
Result | Boolean | Returns true if the function call was successful. |
ResultCode | Int32 | A result code, which differs by function. |
TuningSettings | SiteTuningSettings | Contains all the tuning settings for a specific site. |
| SiteTuningSettings | Description |
|---|
Enabled | Boolean | True if site tuning is enabled for the site. |
MaxPages | Int32 | The maximum number of pages that will be scanned for the site during a site tuning session. |
MaxPagesPerMinute | Int32 | The maximum rate at which pages will be scanned in a site tuning session. |
MaxQueryPages | Int32 | The maximum number of query string variants that can be passed to a page before site tuning starts ignoring the page. |
ScanFrequency | Int32 | This variable is currently unused. |
SiteId | Int32 | The numerical ID of the site, as defined in SmarterStats. |
PauseSiteTuning
View the full specification
OBSOLETE: This function is now obsolete. Support of obsolete functions will be discontinued in future versions, so continued use is not recommended.
ResumeSiteTuning
View the full specification
OBSOLETE: This function is now obsolete. Support of obsolete functions will be discontinued in future versions, so continued use is not recommended.
SetSiteTuningSettings
View the full specification
OBSOLETE: This function is now obsolete and has been replaced with the function SetSiteTuningSettings2. Support of obsolete functions will be discontinued in future versions, so continued use is not recommended.
SetSiteTuningSettings2
Set site tuning settings. View the full specification
Inputs
| Input Parameters | Description |
|---|
authUserName | String | Username with permissions to call this web service. |
authPassword | String | Password of the account used in authUserName parameter. |
SiteID | Int32 | The numerical ID of the site, as defined in your SmarterStats installation. |
Enabled | Boolean | Pass a value of true to enable site tuning on the site. Pass false to disable site tuning for the site. |
ScanFrequency | Int32 | This property is reserved for future use. Implementors should pass a value of 30. |
MaxPages | Int32 | The maximum number of pages that will be scanned during a site tuning pass. Once this number of pages is hit, site tuning will abort the scan. |
MaxPagesPerMinute | Int32 | The pages per minute that will be scanned during a site tuning pass. Set this value higher than 10 if you control the web server and do not mind the higher load of requests. |
MaxQueryPages | Int32 | The maximum number of query string variants that will be scanned for a page before the site tuning scanner ignores that page. |
Returns GenericResult
| GenericResult | Description |
|---|
Message | String | A text message explaining the results of the operation, including the reason for any failures. |
Result | Boolean | Returns true if the function call was successful. |
ResultCode | Int32 | A result code, which differs by function. |
StartSiteTuning
View the full specification
OBSOLETE: This function is now obsolete and has been replaced with the function StartSiteTuning2. Support of obsolete functions will be discontinued in future versions, so continued use is not recommended.
StartSiteTuning2
Start site tuning scan for a site. View the full specification
Inputs
| Input Parameters | Description |
|---|
authUserName | String | Username with permissions to call this web service. |
authPassword | String | Password of the account used in authUserName parameter. |
SiteID | Int32 | The numerical ID of the site, as defined in your SmarterStats installation. |
Returns GenericResult
| GenericResult | Description |
|---|
Message | String | A text message explaining the results of the operation, including the reason for any failures. |
Result | Boolean | Returns true if the function call was successful. |
ResultCode | Int32 | A result code, which differs by function. |
https://stats.smartertools.com:443/Services/Statistics.asmx
This web service contains methods that return basic activity statistics (hits, visits, views, and bandwidth) for sites and servers in your SmarterStats installation.
WSDL Definition
| Functions |
|---|
| GetActivityForServer | Returns grand total activity stats for all the sites on a single server. |
| GetActivityForSite | Returns grand total activity stats for a single site. This function can be called by the system administrator or by a site administrator. |
| GetActivityForSiteGrouped | Returns activity stats for a site, grouped by a specific time period. This allows you to retrieve activity by day, month, etc. This function can be called by the system administrator or a site user. |
| GetVisitsForSite | Returns information about unique, new, and return visitors to a site, grouped by a specific time period. This allows you to retrieve activity by day, month, etc. This function can be called by the system administrator or a site user. |
GetActivityForServer
Returns grand total activity stats for all the sites on a single server. View the full specification
Inputs
| Input Parameters | Description |
|---|
authUserName | String | Username with permissions to call this web service. |
authPassword | String | Password of the account used in authUserName parameter. |
ServerID | Int32 | The numerical ID of the server to query, as defined in your SmarterStats installation. |
StartDate | DateTime | The date from which the query should start calculating (inclusive). |
EndDate | DateTime | The date to which the query should calculate (inclusive). |
Returns ActivityResultGroup
| ActivityResultGroup | Description |
|---|
Items | ActivityResult[] | A list of results, as defined in the ActivityResult class. |
Message | String | A text message explaining the results of the operation, including the reason for any failures. |
Result | Boolean | Returns true if the function call was successful. |
ResultCode | Int32 | A result code, which differs by function. |
| ActivityResult | Description |
|---|
BandwidthBytes | Int64 | Bandwidth in bytes. |
Hits | Int64 | Hits. |
RawBandwidthBytes | Int64 | Raw Bandwidth in bytes (raw bandwidth ignores import filters and exclusions). |
SiteID | Int32 | The numerical ID of the site, as defined in SmarterStats. |
SiteName | String | The display name for the site. |
Views | Int64 | Page Views. |
Visits | Int64 | Visits (sessions). |
GetActivityForSite
Returns grand total activity stats for a single site. This function can be called by the system administrator or by a site administrator. View the full specification
Inputs
| Input Parameters | Description |
|---|
authUserName | String | Username with permissions to call this web service. |
authPassword | String | Password of the account used in authUserName parameter. |
SiteID | Int32 | The numerical ID of the site to query, as defined in your SmarterStats installation. |
StartDate | DateTime | The date from which the query should start calculating (inclusive). |
EndDate | DateTime | The date to which the query should calculate (inclusive). |
Returns ActivityResultGroup
| ActivityResultGroup | Description |
|---|
Items | ActivityResult[] | A list of results, as defined in the ActivityResult class. |
Message | String | A text message explaining the results of the operation, including the reason for any failures. |
Result | Boolean | Returns true if the function call was successful. |
ResultCode | Int32 | A result code, which differs by function. |
| ActivityResult | Description |
|---|
BandwidthBytes | Int64 | Bandwidth in bytes. |
Hits | Int64 | Hits. |
RawBandwidthBytes | Int64 | Raw Bandwidth in bytes (raw bandwidth ignores import filters and exclusions). |
SiteID | Int32 | The numerical ID of the site, as defined in SmarterStats. |
SiteName | String | The display name for the site. |
Views | Int64 | Page Views. |
Visits | Int64 | Visits (sessions). |
GetActivityForSiteGrouped
Returns activity stats for a site, grouped by a specific time period. This allows you to retrieve activity by day, month, etc. This function can be called by the system administrator or a site user. View the full specification
Inputs
| Input Parameters | Description |
|---|
authUserName | String | Username with permissions to call this web service. |
authPassword | String | Password of the account used in authUserName parameter. |
siteId | Int32 | The numerical ID of the site to query, as defined in your SmarterStats installation. |
startDate | DateTime | The date from which the query should start calculating (inclusive). |
endDate | DateTime | The date to which the query should calculate (inclusive). |
groupBy | String | The method of grouping the resulting data. The values for this variable can be one of:- hour
- day
- week
- month
- quarter
- dayofweek
- oneresult
|
Returns ActivityItemResult
| ActivityItemResult | Description |
|---|
Items | ActivityItem[] | A list of results, as defined in the ActivityItem class. |
Message | String | A text message explaining the results of the operation, including the reason for any failures. |
Result | Boolean | Returns true if the function call was successful. |
ResultCode | Int32 | A result code, which differs by function. |
| ActivityItem | Description |
|---|
BandwidthBytes | Int64 | Bandwidth in bytes. |
Date | DateTime | The date this record represents. |
Hits | Int64 | Hits. |
RawBandwidthBytes | Int64 | Raw Bandwidth in bytes (raw bandwidth ignores import filters and exclusions). |
SiteID | Int32 | The numerical ID of the site, as defined in SmarterStats. |
SiteName | String | The display name for the site. |
Views | Int64 | Page Views. |
Visits | Int64 | Visits (sessions). |
GetVisitsForSite
Returns information about unique, new, and return visitors to a site, grouped by a specific time period. This allows you to retrieve activity by day, month, etc. This function can be called by the system administrator or a site user. View the full specification
Inputs
| Input Parameters | Description |
|---|
authUserName | String | Username with permissions to call this web service. |
authPassword | String | Password of the account used in authUserName parameter. |
siteId | Int32 | The numerical ID of the site to query, as defined in your SmarterStats installation. |
startDate | DateTime | The date from which the query should start calculating (inclusive). |
endDate | DateTime | The date to which the query should calculate (inclusive). |
groupBy | String | The method of grouping the resulting data. The values for this variable can be one of:- hourly
- daily
- weekly
- dayofweek
- monthly
- quarterly
- oneresult: returns a single row with a grand total
|
Returns VisitsItemResult
| VisitsItemResult | Description |
|---|
Items | VisitsItem[] | A list of results, as defined in the VisitsItem class. |
Message | String | A text message explaining the results of the operation, including the reason for any failures. |
Result | Boolean | Returns true if the function call was successful. |
ResultCode | Int32 | A result code, which differs by function. |
| VisitsItem | Description |
|---|
Date | DateTime | The date this record represents. |
NewVisits | Int64 | New Visitors. |
ReturningVisits | Int64 | Return Visitors. |
SiteID | Int32 | The numerical ID of the site, as defined in SmarterStats. |
SiteName | String | The display name for the site. |
UniqueVisits | Int64 | Unique Visitors. |
Visits | Int64 | Visits (sessions). |
https://stats.smartertools.com:443/Services/svcGlobalUpdate.asmx
This web service contains methods that allow you to quickly update the settings for all sites at once.
WSDL Definition
| Functions |
|---|
| GetGlobalUpdateStatus | Gets the status of the process that is performing the action previously started in UpdateAllDomainSettings. |
| ListGlobalUpdateFields | Returns a list of all fields that can be globally configured using the UpdateAllDomainSettings function. |
| UpdateAllDomainSettings | Begins the process of setting the specified properties on all sites of the installation. This function will return quickly, then continue to apply the settings in a background process. The status of the process can be retrieved by using the GetGlobalUpdateStatus function. |
GetGlobalUpdateStatus
Gets the status of the process that is performing the action previously started in UpdateAllDomainSettings. View the full specification
Inputs
| Input Parameters | Description |
|---|
AuthUserName | String | Username with permissions to call this web service. |
AuthPassword | String | Password of the account used in authUserName parameter. |
Returns GlobalUpdateStatusResult
| GlobalUpdateStatusResult | Description |
|---|
finishedCount | Int32 | The number of updates that have been completed. |
isRunning | Boolean | True if the update process is still running. |
Message | String | A text message explaining the results of the operation, including the reason for any failures. |
Result | Boolean | Returns true if the function call was successful. |
ResultCode | Int32 | A result code, which differs by function. |
totalUpdateCount | Int32 | The total number of updates to perform. |
ListGlobalUpdateFields
Returns a list of all fields that can be globally configured using the UpdateAllDomainSettings function. View the full specification
Inputs
| Input Parameters | Description |
|---|
AuthUserName | String | Username with permissions to call this web service. |
AuthPassword | String | Password of the account used in authUserName parameter. |
Returns GlobalUpdateFieldListResult
| GlobalUpdateFieldListResult | Description |
|---|
fields | GlobalUpdateFieldInfoResult[] | A list of fields, as defined in GlobalUpdateFieldInfoResult. |
Message | String | A text message explaining the results of the operation, including the reason for any failures. |
Result | Boolean | Returns true if the function call was successful. |
ResultCode | Int32 | A result code, which differs by function. |
| GlobalUpdateFieldInfoResult | Description |
|---|
defaultValue | String | The default value of the field in SmarterStats. |
description | String | A description of what the field represents. |
name | String | The name of the field. |
type | String | The data type of the field. |
UpdateAllDomainSettings
Begins the process of setting the specified properties on all sites of the installation. This function will return quickly, then continue to apply the settings in a background process. The status of the process can be retrieved by using the GetGlobalUpdateStatus function. View the full specification
Inputs
| Input Parameters | Description |
|---|
AuthUserName | String | Username with permissions to call this web service. |
AuthPassword | String | Password of the account used in authUserName parameter. |
fields | DomainSettingFieldStruct[] | An array of structures that define names and values of properties to set. The possible names of properties that can be set by this function are available by calling ListGlobalUpdateFields. |
| DomainSettingFieldStruct | Description |
|---|
name | String | The name of the variable. |
val | String | The value of the variable. |
Returns GenericResult
| GenericResult | Description |
|---|
Message | String | A text message explaining the results of the operation, including the reason for any failures. |
Result | Boolean | Returns true if the function call was successful. |
ResultCode | Int32 | A result code, which differs by function. |
https://stats.smartertools.com:443/Services/UserAdmin.asmx
This web service contains methods that add, edit, and delete authenticated users from SmarterStats sites.
WSDL Definition
| Functions |
|---|
| AddUser2 | Adds a site user or site administrator to a SmarterStats site. If site is set to use an external provider for authentication, it must be added there as well before user can log in. |
| DeleteUser | Deletes a user from a site. The user to be deleted must not be the site owner. If you wish to delete a site owner, you must first use the SiteSiteOwner function to assign a different user. |
| GetUser | Returns information about a specific user for a site. |
| GetUser2 | Returns information about a specific user for a site. |
| GetUsers | Returns a list of all users for a site. |
| GetUsers2 | Returns a list of all users for a site. |
| SetSiteOwner | Sets a user to be the site owner for a site. Every site must have one and only one site owner, and the site owner cannot be deleted without another user taking its place. |
| UpdateUser2 | Updates the properties for a user of a SmarterStats site. If site is set to use an external provider for authentication, it must be added there as well before user can log in. |
| ValidateLogin | Validates the login credentials for a specific site user. |
AddUser
View the full specification
OBSOLETE: This function is now obsolete and has been replaced with the function AddUser2. Support of obsolete functions will be discontinued in future versions, so continued use is not recommended.
AddUser2
Adds a site user or site administrator to a SmarterStats site. If site is set to use an external provider for authentication, it must be added there as well before user can log in. View the full specification
Inputs
| Input Parameters | Description |
|---|
authUserName | String | Username with permissions to call this web service. |
authPassword | String | Password of the account used in authUserName parameter. |
SiteID | Int32 | The numerical ID of the site to which the user should be added. |
UserName | String | The username that will be used by the user to login to SmarterStats. |
Password | String | The password with which the user will authenticate. Ignored if external provider is used for authentication. |
FirstName | String | The first name of the new user. |
LastName | String | The last name of the new user. |
IsAdmin | Boolean | If this variable is set to true, the user will be added as a site administrator. If false, the user will be added as a standard site user. |
properties | String[] | A list of 'name=value' pairs of variables to set. The available variable names are: - EmailAddress: Used for password recovery
|
Returns GenericResult
| GenericResult | Description |
|---|
Message | String | A text message explaining the results of the operation, including the reason for any failures. |
Result | Boolean | Returns true if the function call was successful. |
ResultCode | Int32 | A result code, which differs by function. |
DeleteUser
Deletes a user from a site. The user to be deleted must not be the site owner. If you wish to delete a site owner, you must first use the SiteSiteOwner function to assign a different user. View the full specification
Inputs
| Input Parameters | Description |
|---|
authUserName | String | Username with permissions to call this web service. |
authPassword | String | Password of the account used in authUserName parameter. |
SiteID | Int32 | The numerical ID of the site to which the user belongs. |
UserName | String | The username for the user you wish to delete. |
Returns GenericResult
| GenericResult | Description |
|---|
Message | String | A text message explaining the results of the operation, including the reason for any failures. |
Result | Boolean | Returns true if the function call was successful. |
ResultCode | Int32 | A result code, which differs by function. |
GetUser
Returns information about a specific user for a site. View the full specification
Inputs
| Input Parameters | Description |
|---|
authUserName | String | Username with permissions to call this web service. |
authPassword | String | Password of the account used in authUserName parameter. |
SiteID | Int32 | The numerical ID of the site to which the user belongs. |
UserName | String | The username for the user you wish to inspect. |
Returns UserInfoResult
| UserInfoResult | Description |
|---|
Message | String | A text message explaining the results of the operation, including the reason for any failures. |
Result | Boolean | Returns true if the function call was successful. |
ResultCode | Int32 | A result code, which differs by function. |
user | UserInfo | A user detail record, as defined in the UserInfo class. |
| UserInfo | Description |
|---|
FirstName | String | The first name of the user. |
IsAdmin | Boolean | True if the user is a site administrator. |
IsSiteOwner | Boolean | True if the user is the site owner for a site (primary administrator). |
LastName | String | The last name of the user. |
Password | String | The login password for the user. |
SiteID | Int32 | The numerical ID of the site, as defined in SmarterStats. |
UserName | String | The login username for the user. |
GetUser2
Returns information about a specific user for a site. View the full specification
Inputs
| Input Parameters | Description |
|---|
authUserName | String | Username with permissions to call this web service. |
authPassword | String | Password of the account used in authUserName parameter. |
SiteID | Int32 | The numerical ID of the site to which the user belongs. |
UserName | String | The username for the user you wish to inspect. |
Returns UserInfoResult2
| UserInfoResult2 | Description |
|---|
Message | String | A text message explaining the results of the operation, including the reason for any failures. |
Result | Boolean | Returns true if the function call was successful. |
ResultCode | Int32 | A result code, which differs by function. |
User | UserInfo2 | A user detail record, as defined in the UserInfo2 class. |
| UserInfo2 | Description |
|---|
EmailAddress | String | The email address of the user. |
FirstName | String | The first name of the user. |
IsAdmin | Boolean | True if the user is a site administrator. |
IsSiteOwner | Boolean | True if the user is the site owner for a site (primary administrator). |
LastName | String | The last name of the user. |
Password | String | The login password for the user. |
Properties | String[] | Other properties of a user |
SiteID | Int32 | The numerical ID of the site, as defined in SmarterStats. |
UserName | String | The login username for the user. |
GetUsers
Returns a list of all users for a site. View the full specification
Inputs
| Input Parameters | Description |
|---|
authUserName | String | Username with permissions to call this web service. |
authPassword | String | Password of the account used in authUserName parameter. |
SiteID | Int32 | The numerical ID of the site. |
Returns UserInfoResultArray
| UserInfoResultArray | Description |
|---|
Message | String | A text message explaining the results of the operation, including the reason for any failures. |
Result | Boolean | Returns true if the function call was successful. |
ResultCode | Int32 | A result code, which differs by function. |
user | UserInfo[] | A list of user details, as defined in the UserInfo class. |
| UserInfo | Description |
|---|
FirstName | String | The first name of the user. |
IsAdmin | Boolean | True if the user is a site administrator. |
IsSiteOwner | Boolean | True if the user is the site owner for a site (primary administrator). |
LastName | String | The last name of the user. |
Password | String | The login password for the user. |
SiteID | Int32 | The numerical ID of the site, as defined in SmarterStats. |
UserName | String | The login username for the user. |
GetUsers2
Returns a list of all users for a site. View the full specification
Inputs
| Input Parameters | Description |
|---|
authUserName | String | Username with permissions to call this web service. |
authPassword | String | Password of the account used in authUserName parameter. |
SiteID | Int32 | The numerical ID of the site. |
Returns UserInfoResultArray2
| UserInfoResultArray2 | Description |
|---|
Message | String | A text message explaining the results of the operation, including the reason for any failures. |
Result | Boolean | Returns true if the function call was successful. |
ResultCode | Int32 | A result code, which differs by function. |
Users | UserInfo2[] | A list of user details, as defined in the UserInfo class. |
| UserInfo2 | Description |
|---|
EmailAddress | String | The email address of the user. |
FirstName | String | The first name of the user. |
IsAdmin | Boolean | True if the user is a site administrator. |
IsSiteOwner | Boolean | True if the user is the site owner for a site (primary administrator). |
LastName | String | The last name of the user. |
Password | String | The login password for the user. |
Properties | String[] | Other properties of a user |
SiteID | Int32 | The numerical ID of the site, as defined in SmarterStats. |
UserName | String | The login username for the user. |
SetSiteOwner
Sets a user to be the site owner for a site. Every site must have one and only one site owner, and the site owner cannot be deleted without another user taking its place. View the full specification
Inputs
| Input Parameters | Description |
|---|
authUserName | String | Username with permissions to call this web service. |
authPassword | String | Password of the account used in authUserName parameter. |
SiteID | Int32 | The numerical ID of the site. |
UserName | String | The username for the user that should become the new site owner. |
Returns GenericResult
| GenericResult | Description |
|---|
Message | String | A text message explaining the results of the operation, including the reason for any failures. |
Result | Boolean | Returns true if the function call was successful. |
ResultCode | Int32 | A result code, which differs by function. |
UpdateUser
View the full specification
OBSOLETE: This function is now obsolete and has been replaced with the function UpdateUser. Support of obsolete functions will be discontinued in future versions, so continued use is not recommended.
UpdateUser2
Updates the properties for a user of a SmarterStats site. If site is set to use an external provider for authentication, it must be added there as well before user can log in. View the full specification
Inputs
| Input Parameters | Description |
|---|
authUserName | String | Username with permissions to call this web service. |
authPassword | String | Password of the account used in authUserName parameter. |
SiteID | Int32 | The numerical ID of the site to which the user belongs. |
UserName | String | The username for the user you wish to modify. |
Password | String | The new password with which the user will authenticate. Ignored if the site is set to use external provider for authentication. |
FirstName | String | The new first name of the new user. |
LastName | String | The new last name of the new user. |
IsAdmin | Boolean | If this variable is set to true, the user will be changed to be a site administrator. If false, the user will changed to be a standard site user. |
properties | String[] | A list of 'name=value' pairs of variables to set. The available variable names are: - EmailAddress: Used for password recovery
|
Returns GenericResult
| GenericResult | Description |
|---|
Message | String | A text message explaining the results of the operation, including the reason for any failures. |
Result | Boolean | Returns true if the function call was successful. |
ResultCode | Int32 | A result code, which differs by function. |
ValidateLogin
Validates the login credentials for a specific site user. View the full specification
Inputs
| Input Parameters | Description |
|---|
authUserName | String | Username with permissions to call this web service. |
authPassword | String | Password of the account used in authUserName parameter. |
SiteID | Int32 | The numerical ID of the site. |
UserName | String | The username for the user for which you want to attempt a login. |
Password | String | The password entered by the user. |
Returns LoginResult
| LoginResult | Description |
|---|
Message | String | A text message explaining the results of the operation, including the reason for any failures. |
Result | Boolean | Returns true if the function call was successful. |
ResultCode | Int32 | A result code, which differs by function. |