download — Bulk download reports

The download method will be deprecated in the future. We recommend that you use bulkReports to download reports.

The download method pulls scan status and risk score reports from the SiteLock servers. SiteLock keeps up to three reports, generated in the past 72 hours. Large data sets are pulled in chunks—the row limit per file is 1,000,000.

The reports are CSV files with the header row definition on the first chunk, served as gzip compressed HTTP content with an HTTP header determining if more content must be pulled.

The general flow of downloading a report is as follows:

Send a request with an empty file_id value.
Write the received content to a file.

While the returned Sitelock-Next-File-Id header is not equal to EOF, continue appending the returned content to the file. In further requests, set the file_id element to the value of Sitelock-Next-File-Id.
Extract the content of the file using the gunzip command.

Data may change without notice. Make sure to read the header and reference the rows using the header as a guide.

The API endpoint is:

https://api.sitelock.com/v1/partner

Request format

SiteLockOnlineRequest: This element is used to delineate the full API request.
- authentication: The partner’s username, password, and branding
  - username: The partner’s API username
  - password: The partner’s API password
  - partner: (Optional) The brand name to use in messaging
- download: The method name
  - report: The name of the report to download. The possible values are:
    
    test: A test report consisting of two files for use in a non-production environment to test chunked file download
    
    scan_status: The most recent scan status report
    
    risk_score: The most recent risk score
  - group_resellers: Specifies whether to group resellers into a single report if multiple reseller IDs are used. The possible values are yes and no. The default value is yes.
  - file_id: Leave this element empty on the first call. If the report is too large to fit a single file or to be transferred in a single response, you’ll get the name of the second file in the Sitelock-Next-File-Id header, which you can pass as file_id in subsequent calls.
    
    The row limit per file is 1,000,000.

Example request

<SiteLockOnlineRequest>
    <authentication>
        <user>Username</user>
        <password>Password</password>
    </authentication>
    <download>
        <report>test</report>
        <group_resellers>yes</group_resellers>
        <file_id>2022071100_2</file_id>
    </download>
</SiteLockOnlineRequest>

Response format

A successful call returns a 200 HTTP response and gzipped data. Additionally, it contains two headers:

Sitelock-Gen-Time: The approximate time the report was generated in the format YYYYMMDDHH. The report is generated once a day at midnight. For example, 2022071100.
Sitelock-Next-File-Id: The string that should be sent in the next method call. For example, 2022071100_2. The value will be "EOF" if all data has been returned.

In the case of an error the API will respond with a 500 HTTP response and an XML payload that includes an error element describing the issue.

Scan status report

This report is a snapshot of the most recent scan statuses and their results at the time of report generation:

verified: The scan found no issues.
pending: The scan hasn’t run yet or the site doesn’t have this product.
warning: The scan found issues, but the user is still within the 3-day grace period to resolve them. The Trust Seal is displayed.
noncompliant: The scan found that at least one issue remains unresolved after the 3-day grace period (the status was warning before). The Trust Seal isn’t displayed.

The header row in a CSV file includes the following:

reseller_login: The partner’s username associated with their reseller account
partner: The partner’s API username
account_id: The user’s account ID
site_id: The user’s site ID
advisories: The status of the Risk Score Scan
advisories_issues: The number of issues found during the Risk Score Scan
malware: The status of the Webpage Scan
malware_issues: The number of issues found during the Webpage Scan
malware_link_issues: The number of malicious links found during the Webpage Scan
platform: The status of the Platform Scan
platform_issues: The number of issues found during the Platform Scan
spam: The status of the Email Reputation Scan
spam_issues: The number of issues found during the Email Reputation Scan
smart: The status of the SMART File Scan
smart_issues: The number of issues found during the SMART File Scan
smart_db: The status of the SMART Database Scan
smart_db_issues: The number of issues found during the SMART Database Scan
smart_patch: The status of the SMART Patch Scan
smart_patch_issues: The number of issues found during the SMART Patch Scan
sql_injection: The status of the SQL Injection Scan
sql_injection_issues: The number of issues found during the SQL Injection Scan
xss: The status of the Cross-Site Scripting Scan
xss_issues: The number of issues found during the Cross-Site Scripting Scan

Sample scan status report

reseller_login,partner,account_id,site_id,advisories,advisories_issues,malware,malware_issues,malware_link_issues,platform,platform_issues,spam,spam_issues,smart,smart_issues,smart_db,smart_db_issues,smart_patch,smart_patch_issues,sql_injection,sql_injection_issues,xss,xss_issues
daisyhost,Daisyhost,8036274,15752721,verified,,verified,,,verified,,verified,,warning,18,verified,,noncompliant,8,verified,,verified,
daisyhost,Daisyhost,16378562,34275058,verified,12,warning,18,,verified,3,verified,,warning,139,verified,,noncompliant,32,verified,,verified,
daisyhost,Daisyhost,16378562,34275064,verified,14,warning,20,,warning,3,verified,,warning,0,warning,,noncompliant,32,verified,,verified,

Risk score report

This report is a snapshot of the most recent risk score scans at the time of report generation.

The header row in a CSV file includes the following:

reseller_login: The partner’s username associated with their reseller account
partner: The partner’s API username
account_id: The user’s account ID
site_id: The user’s site ID
risk_score: The risk score on a scale from 1 to 3 (low to high)
website: The risk score determined by the complexity of the website, measured in 0-100%
popularity: The risk score determined by popularity of the website, measured in 0-100%
complexity: The risk score determined by the structure and composition of the website, measured in 0-100%

Sample risk score report

reseller_login,partner,account_id,site_id,risk_score,website,popularity,complexity
daisyhost,Daisyhost,83573,81541,1,100,0,0
daisyhost,Daisyhost,83886,81793,1,100,0,0
daisyhost,Daisyhost,84106,81981,1,100,0,0