Site.pro
  • Website Builder
    • Website Builder
    • Online Stores
    • Templates
    • Domains
    • Plugins
    • Languages
    • FAQ
    • Affiliate Program
    • Blog
    • Examples
    • For Design Studios
  • Prices
  • Website Import
  • For Resellers
    • White Label
    • Prices
    • Panels
    • How it Works
    • Free Websites
    • Marketing Kit
    • Mass Import
    • Our Partners
    • Free Website Builder
    • Documentation
    • Blog
    • Growth Hacking
    • Domainity
    • FAQ
  • Contact Sales
  • Website Builder
    • Website BuilderEverybody can easily make a website, landing page or e-commerce.
    • Online StoresSell your goods or services anywhere on the website
    • Templates200+ Awesome Templates. Responsive Design
    • DomainsBuy domain. Connect Your Domain. Transfer Domain.
    • Plugins
    • Languages
    • FAQ
    • Affiliate Program
    • Blog
    • Examples
    • For Design Studios
  • Prices
  • Website Import
  • For ResellersWhite Label
    • White LabelThe most popular white label tool is ideal for reselling
    • PricesStart reselling. Pay for live websites. Free Websites
    • PanelsOne product for all platforms. Download plugin for your panel
    • How it WorksCloud or On-Premises. Recommendations for Builder Server
    • Free WebsitesUnlimited Quantity of Free Websites
    • Marketing KitUse White Label Marketing Kit To Increase Your Sales
    • Mass Import
    • Our Partners
    • Free Website Builder
    • Documentation
    • Blog
    • Growth Hacking
    • Domainity
    • FAQ
  • Contact Sales
  • inputRegister
    Sign Up with Facebook
    Sign Up with Google
    or
  • faceLog In
    Sign in with Facebook Sign in with Google
    or
    Remind password
    A new password will be sent to the specified e-mail address.
    Return to login form
  • $
    • USD — $
    • EUR — €
    • GBP — £
    • BRL — R$
    • PLN — zł
    • INR — ₹
    • TRY — TL
    • AUD — A$
    • CAD — C$
    • CZK — Kč
    • DKK — kr
    • HKD — HK$
    • HUF — Ft
    • ILS — ₪
    • JPY — 円
    • MXN — Mex$
    • NOK — kr
    • NZD — NZ$
    • PHP — ₱
    • RUB — ₽
    • SGD — S$
    • SEK — kr
    • CHF — Fr
    • TWD — NT$
    • THB — ฿
    • CNY — ¥
    • RSD — din
    • BGN — лв.
    • RON — Lei
    • ZAR — R
    • BYN — p.
    • UAH — ₴
    • KZT — ₸
    • CLP — CH$
  • English
    • العربية
    • Azərbaycan
    • Bahasa Indonesia
    • Bahasa Malaysia
    • Беларуская
    • Български
    • Bosanski
    • Castellano
    • Čeština
    • Dansk
    • Deutsch
    • Eesti
    • Ελληνικά
    • English
    • Español
    • 繁體
    • فارسی
    • Français
    • Հայերեն
    • हिन्दी
    • Hrvatski
    • Italiano
    • עברית
    • 简体
    • ქართული
    • Қазақ
    • Latviešu
    • Lietuvių
    • Magyar
    • Nederlands
    • 日本語
    • Norsk
    • O'zbek
    • ภาษาไทย
    • ភាសាខ្មែរ
    • Polski
    • Português (BR)
    • Română
    • Русский
    • Schweizerdeutsch
    • Slovenčina
    • Slovenščina
    • Srpski
    • Suomi
    • Svenska
    • Tiếng Việt
    • Türkçe
    • Украї́нська
    • Wikang Tagalog
    • And additional 3 languages inside Site.pro website builder
Server Requirements
  • Published websites
  • Site.pro IPs
Builder installation / update
On-Premises
  • Server Requirements
  • Installation
  • CRON
  • Update
  • Migration to version v4
  • Extra configuration
  • Manual update
  • Changing PHP version
  • Support
Plugin installation
  • Hosting Panel
    • cPanel
    • DirectAdmin
    • Plesk
    • Sentora/ZPanel
    • ISPmanager
    • InterWorx
    • Vesta
    • Hestia
    • Hosting Controller
    • CentOS Web Panel
    • Custom hosting (API)
  • Billing Panel
    • WHMCS
    • Custom billing (API)
API documentation
  • Builder
    • Create session (SSO)
    • Remove existing session
    • Create website backup
    • Restore website backup
  • Templates
    • List template categories
    • List templates
    • Get page types available in templates
  • Import
    • Import website
    • Get website import status
    • Import website block
    • Get website block import status
    • Check if imported website is owned by user
  • Websites
    • Create website
    • Modify website
    • Rename website
    • Publish website
    • Edit website pages
    • Edit website settings
    • Enable/disable Auto Layout
    • Delete website
    • Get website template
    • Get website pages
    • Get website variables
    • Get website settings
    • Add pages to website
    • Duplicate pages in website
    • Remove pages from website
  • Website Blocks
    • Create empty website
    • Modify website
    • Inspect website
    • Add empty page
    • Modify page
    • Remove page
    • Inspect page
    • Inspect composition
    • Modification descriptor structure by element type
    • Add blocks from compositions
    • Remove blocks
    • Move blocks
    • Modify blocks
    • Inspect block
  • Licenses
    • Get list of published websites
    • Get statistics of publications/openings
    • Block/unblock published website
    • Controlling IP list
  • Integration with your system
    • Allow/disallow domain in builder
    • Check if domains are allowed in builder
  • FAQ
    • Get posts
    • Get categories
Add-ons documentation
  • For Website
    • Public demo URL
    • Editing plans
    • User registration from public demo
    • Website import
  • For Builder
    • Adding custom templates
    • Adding custom builder plugins
    • Scripts
For developers
  • Programming reference
  • Directory structure
  • Meta information (main.json)
  • Frontend logic (main.js)
  • Element template (main.html)
  • Backend logic (main.php)
  • Plugin testing
  • Custom element plugin
  • E-commerce plugin
  • Overriding UI
  • Other examples
Change Log
API documentation → Import

Get website import status available since version 4.0.0 / 3.7.312 On-Premises

This API action returns status of import task created with "Import website" API call.

Once import task is finished further "Get website import status" API calls will return error "Import task not found.". Import task is considered finished on two conditions:

  • complete property of returned status object is set to true (successful import),
  • or error property exists in returned status object (unsuccessful import).

Please be aware that once import is successfully complete old website is fully replaced with imported one.

Make sure to do periodic "Get import status" API calls after starting import (recommended period is 3 to 10 seconds) since otherwise after 30 seconds of "silence" import service may consider the task to be abandoned and abort it.

This API action requires a loginHash, that can be received by using "Create session" API call with additional parameter more = true. Furthermore http://your-builder-domain.com/api/ in Call API URL should be replaced with builderApiUrl received from "Create session" API call, so new API url for this action would be builderApiUrl + website/import-status.

http://your-builder-domain.com/api/website/import-status (builderApiUrl + "website/import-status")
HTTP Basic
[API Username from brand]
[API Password from brand]
POST
application/json
application/json

JSON request Object Properties:

  • String - login hash you received from "Create session" API call;
  • String - import task ID received from "Import website" API call;
  • Boolean - (optional) if set to true response will contain extra parameter "pages" after importing is done;

JSON response Object Properties:

  • Boolean - (optional) returned on success, contains value true, indicates successfully executed action;
  • TaskStatus - (optional) returned on success, contains status of import task;
  • String - (optional) returned on error, contains error message, indicates failure to execute action;
  • Object - (optional) total list of website pages after importing is done (the same which can be retrieved from "Get website pages" API call); returned only when importing task is complete and if request has "getPages" property set to true;

TaskStatus object properties:

  • Boolean - value of true indicates that import task was completed successfully and website was replaced with imported one;
  • Object - (optional) returned only if there is an error related to import task. This object has following properties:
    • Boolean - value of true indicates that potentially the error is only temporary and trying to import same URL again has a chance to succeed;
    • String - error message from import service related to the import task. This message is displayed in builder to users, may be translated and may contain HTML code;
    • Number - numeric code of error message from import service (see table below);
  • String - (optional) current import task status text as displayed to users in builder (may be translated and contain HTML). This property will be available only if there are no errors and builder is still connected to import service;
  • Number - (optional) overall import task progress percentage (0 to 100). This property will be available only if there are no errors and builder is still connected to import service;
  • Object - (optional) import task progress information divided into steps (processes). This property will be available only if there are no errors and builder is still connected to import service. This object has following properties:
    • StepProgress - progress of waiting in import service queue;
    • StepProgress - progress of reading (crawling) website;
    • StepProgress - progress of processing found HTML pages;
    • StepProgress - progress of downloading resources (images, documents, etc.) into media library;
    • StepProgress - progress of loading imported website into builder;

StepProgress object properties:

  • String - status of step (process). Possible values are:
    • pending - not yet started,
    • active - currently in progress,
    • done - finished and will no longer be returned to.
  • String - step name as displayed in builder (may be translated and contain HTML code);
  • Number - step progress percentage (0 to 100);
  • String - step progress in form of text as displayed in builder over progress bar (may be translated and contain HTML code);

Possible values of TaskStatus.error.code:

Code Name Description
1 Service unavailable Import service is currently unavailable due to maintenance or network connectivity issues.
2 Refusal to serve Import service is not enabled for your account.
3 Internal error There was an internal import service error.
4 Invalid URL Invalid URL provided with "Import website" API call.
5 Cross-domain redirect Website redirects to a domain that differs from the one in URL provided with "Import website" API call. Redirects between www and non-www subdomains is not considered a cross-domain redirect.
6 Timeout There was a timeout in one of import service processes. Timeout usually happens due to slow website connection or due to very high website complexity.
7 Bad website There is a number of reasons, why this error may happen:
  • provided URL is valid, but domain name cannot be resolved;
  • import service is unable to connect to domain due to firewall or network connectivity issues;
  • requesting provided URL returns a HTTP status code that indicates an error;
  • URL points to a resource with Content-Type different than text/html;
  • URL points to a resource that is not a valid HTML page;
  • URL points to an attachment (Content-Disposition header received);
8 Bad website resources This is an extremely rare error when website cannot be imported into builder due to corruption in imported data (usually bad files imported into media library).
9 Website too complex This error happens when service is unable to handle import of website due to extremely high requirements to computational resources.
10 Website protected Imported website is located on a server belonging to one of our clients that has import protection enabled.
11 Task cancelled Import process was cancelled due to abandonment (no status requests received for 30 seconds). This error may also happen on rare occasions when import service detects that there is no progress for several minutes and import task gets cancelled to perform an automatic service maintenance (can be considered as timeout or too complex website).
12 Owner does not match This error may happen only if loginHash in current request differs from the one used in "Import website" API call.
© Site.pro Website Builder. United States, Washington. Terms of Service