SiteAdmin Web Service

SiteAdmin

Click here for a complete list of operations.

GetSiteByName

Returns the configuration details about one site in SmarterStats (identified by name).

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /Services/SiteAdmin.asmx HTTP/1.1
Host: stats.smartertools.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.smartertools.com/smarterstats/SiteAdmin.asmx/GetSiteByName"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetSiteByName xmlns="http://www.smartertools.com/smarterstats/SiteAdmin.asmx">
      <authUserName>string</authUserName>
      <authPassword>string</authPassword>
      <siteName>string</siteName>
    </GetSiteByName>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetSiteByNameResponse xmlns="http://www.smartertools.com/smarterstats/SiteAdmin.asmx">
      <GetSiteByNameResult>
        <Result>boolean</Result>
        <ResultCode>int</ResultCode>
        <Message>string</Message>
        <Site>
          <ServerID>int</ServerID>
          <SiteID>int</SiteID>
          <DomainName>string</DomainName>
          <LogFormat>string</LogFormat>
          <SmarterLogDirectory>string</SmarterLogDirectory>
          <SmarterLogMonthsBeforeDelete>int</SmarterLogMonthsBeforeDelete>
          <ExportPath>string</ExportPath>
          <ExportPathURL>string</ExportPathURL>
          <TimeZoneIndex>int</TimeZoneIndex>
          <LogLocations>
            <ConfigLogLocation xsi:nil="true" />
            <ConfigLogLocation xsi:nil="true" />
          </LogLocations>
          <SiteStatus>string</SiteStatus>
          <ftp_Enabled>boolean</ftp_Enabled>
          <ftp_Server>string</ftp_Server>
          <ftp_port>int</ftp_port>
          <ftp_Username>string</ftp_Username>
          <ftp_Password>string</ftp_Password>
          <ftp_Interval>int</ftp_Interval>
          <ftp_Directory>string</ftp_Directory>
          <ftp_LogWildcard>string</ftp_LogWildcard>
          <ftp_LogMaxDays>int</ftp_LogMaxDays>
          <ftp_ProxyType>string</ftp_ProxyType>
          <ftp_ProxyAddress>string</ftp_ProxyAddress>
          <ftp_ProxyPort>int</ftp_ProxyPort>
          <ftp_ProxyUsername>string</ftp_ProxyUsername>
          <ftp_ProxyPassword>string</ftp_ProxyPassword>
          <authenticationType>string</authenticationType>
        </Site>
      </GetSiteByNameResult>
    </GetSiteByNameResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /Services/SiteAdmin.asmx HTTP/1.1
Host: stats.smartertools.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetSiteByName xmlns="http://www.smartertools.com/smarterstats/SiteAdmin.asmx">
      <authUserName>string</authUserName>
      <authPassword>string</authPassword>
      <siteName>string</siteName>
    </GetSiteByName>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetSiteByNameResponse xmlns="http://www.smartertools.com/smarterstats/SiteAdmin.asmx">
      <GetSiteByNameResult>
        <Result>boolean</Result>
        <ResultCode>int</ResultCode>
        <Message>string</Message>
        <Site>
          <ServerID>int</ServerID>
          <SiteID>int</SiteID>
          <DomainName>string</DomainName>
          <LogFormat>string</LogFormat>
          <SmarterLogDirectory>string</SmarterLogDirectory>
          <SmarterLogMonthsBeforeDelete>int</SmarterLogMonthsBeforeDelete>
          <ExportPath>string</ExportPath>
          <ExportPathURL>string</ExportPathURL>
          <TimeZoneIndex>int</TimeZoneIndex>
          <LogLocations>
            <ConfigLogLocation xsi:nil="true" />
            <ConfigLogLocation xsi:nil="true" />
          </LogLocations>
          <SiteStatus>string</SiteStatus>
          <ftp_Enabled>boolean</ftp_Enabled>
          <ftp_Server>string</ftp_Server>
          <ftp_port>int</ftp_port>
          <ftp_Username>string</ftp_Username>
          <ftp_Password>string</ftp_Password>
          <ftp_Interval>int</ftp_Interval>
          <ftp_Directory>string</ftp_Directory>
          <ftp_LogWildcard>string</ftp_LogWildcard>
          <ftp_LogMaxDays>int</ftp_LogMaxDays>
          <ftp_ProxyType>string</ftp_ProxyType>
          <ftp_ProxyAddress>string</ftp_ProxyAddress>
          <ftp_ProxyPort>int</ftp_ProxyPort>
          <ftp_ProxyUsername>string</ftp_ProxyUsername>
          <ftp_ProxyPassword>string</ftp_ProxyPassword>
          <authenticationType>string</authenticationType>
        </Site>
      </GetSiteByNameResult>
    </GetSiteByNameResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

GET /Services/SiteAdmin.asmx/GetSiteByName?authUserName=string&authPassword=string&siteName=string HTTP/1.1
Host: stats.smartertools.com

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<SiteSettingInfoResult xmlns="http://www.smartertools.com/smarterstats/SiteAdmin.asmx">
  <Result>boolean</Result>
  <ResultCode>int</ResultCode>
  <Message>string</Message>
  <Site>
    <ServerID>int</ServerID>
    <SiteID>int</SiteID>
    <DomainName>string</DomainName>
    <LogFormat>string</LogFormat>
    <SmarterLogDirectory>string</SmarterLogDirectory>
    <SmarterLogMonthsBeforeDelete>int</SmarterLogMonthsBeforeDelete>
    <ExportPath>string</ExportPath>
    <ExportPathURL>string</ExportPathURL>
    <TimeZoneIndex>int</TimeZoneIndex>
    <LogLocations>
      <ConfigLogLocation>
        <LocationGuid>string</LocationGuid>
        <FileWildcard>string</FileWildcard>
        <MaxDays>int</MaxDays>
        <CompressDays>int</CompressDays>
        <IncludeArchiveFiles>boolean</IncludeArchiveFiles>
        <IncludeSubdirectories>boolean</IncludeSubdirectories>
        <FilePath>string</FilePath>
      </ConfigLogLocation>
      <ConfigLogLocation>
        <LocationGuid>string</LocationGuid>
        <FileWildcard>string</FileWildcard>
        <MaxDays>int</MaxDays>
        <CompressDays>int</CompressDays>
        <IncludeArchiveFiles>boolean</IncludeArchiveFiles>
        <IncludeSubdirectories>boolean</IncludeSubdirectories>
        <FilePath>string</FilePath>
      </ConfigLogLocation>
    </LogLocations>
    <SiteStatus>string</SiteStatus>
    <ftp_Enabled>boolean</ftp_Enabled>
    <ftp_Server>string</ftp_Server>
    <ftp_port>int</ftp_port>
    <ftp_Username>string</ftp_Username>
    <ftp_Password>string</ftp_Password>
    <ftp_Interval>int</ftp_Interval>
    <ftp_Directory>string</ftp_Directory>
    <ftp_LogWildcard>string</ftp_LogWildcard>
    <ftp_LogMaxDays>int</ftp_LogMaxDays>
    <ftp_ProxyType>string</ftp_ProxyType>
    <ftp_ProxyAddress>string</ftp_ProxyAddress>
    <ftp_ProxyPort>int</ftp_ProxyPort>
    <ftp_ProxyUsername>string</ftp_ProxyUsername>
    <ftp_ProxyPassword>string</ftp_ProxyPassword>
    <authenticationType>string</authenticationType>
  </Site>
</SiteSettingInfoResult>

HTTP POST

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

POST /Services/SiteAdmin.asmx/GetSiteByName HTTP/1.1
Host: stats.smartertools.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

authUserName=string&authPassword=string&siteName=string

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<SiteSettingInfoResult xmlns="http://www.smartertools.com/smarterstats/SiteAdmin.asmx">
  <Result>boolean</Result>
  <ResultCode>int</ResultCode>
  <Message>string</Message>
  <Site>
    <ServerID>int</ServerID>
    <SiteID>int</SiteID>
    <DomainName>string</DomainName>
    <LogFormat>string</LogFormat>
    <SmarterLogDirectory>string</SmarterLogDirectory>
    <SmarterLogMonthsBeforeDelete>int</SmarterLogMonthsBeforeDelete>
    <ExportPath>string</ExportPath>
    <ExportPathURL>string</ExportPathURL>
    <TimeZoneIndex>int</TimeZoneIndex>
    <LogLocations>
      <ConfigLogLocation>
        <LocationGuid>string</LocationGuid>
        <FileWildcard>string</FileWildcard>
        <MaxDays>int</MaxDays>
        <CompressDays>int</CompressDays>
        <IncludeArchiveFiles>boolean</IncludeArchiveFiles>
        <IncludeSubdirectories>boolean</IncludeSubdirectories>
        <FilePath>string</FilePath>
      </ConfigLogLocation>
      <ConfigLogLocation>
        <LocationGuid>string</LocationGuid>
        <FileWildcard>string</FileWildcard>
        <MaxDays>int</MaxDays>
        <CompressDays>int</CompressDays>
        <IncludeArchiveFiles>boolean</IncludeArchiveFiles>
        <IncludeSubdirectories>boolean</IncludeSubdirectories>
        <FilePath>string</FilePath>
      </ConfigLogLocation>
    </LogLocations>
    <SiteStatus>string</SiteStatus>
    <ftp_Enabled>boolean</ftp_Enabled>
    <ftp_Server>string</ftp_Server>
    <ftp_port>int</ftp_port>
    <ftp_Username>string</ftp_Username>
    <ftp_Password>string</ftp_Password>
    <ftp_Interval>int</ftp_Interval>
    <ftp_Directory>string</ftp_Directory>
    <ftp_LogWildcard>string</ftp_LogWildcard>
    <ftp_LogMaxDays>int</ftp_LogMaxDays>
    <ftp_ProxyType>string</ftp_ProxyType>
    <ftp_ProxyAddress>string</ftp_ProxyAddress>
    <ftp_ProxyPort>int</ftp_ProxyPort>
    <ftp_ProxyUsername>string</ftp_ProxyUsername>
    <ftp_ProxyPassword>string</ftp_ProxyPassword>
    <authenticationType>string</authenticationType>
  </Site>
</SiteSettingInfoResult>

Parameter	Value
authUserName:
authPassword:
siteName: