API documentation → Import

Get website block import status available since version 4.1.0 On-Premises

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

Once import task is finished further "Get website block 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).

Make sure to do periodic "Get website block 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-blocks/import-status.

Call API URL: http://your-builder-domain.com/api/website-blocks/import-status (builderApiUrl + "website-blocks/import-status")
Authorisation: HTTP Basic
Username: [API Username from brand]
Password: [API Password from brand]
Method: POST
Content Type: application/json
Return Content Type: application/json

JSON request Object Properties:

String loginHash - login hash you received from "Create session" API call;
String id - import task ID received from "Import website" API call;

JSON response Object Properties:

Boolean ok - (optional) returned on success, contains value true, indicates successfully executed action;
TaskStatus status - (optional) returned on success, contains status of import task;
String error - (optional) returned on error, contains error message, indicates failure to execute action;

TaskStatus object properties:

Boolean complete - value of true indicates that import task was completed successfully and website was replaced with imported one;
Object error - (optional) returned only if there is an error related to import task. This object has following properties:
- Boolean allowRetry - value of true indicates that potentially the error is only temporary and trying to import same URL again has a chance to succeed;
- String message - 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 code - numeric code of error message from import service (see table below);
String text - (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 progress - (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 steps - (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 waiting - progress of waiting in import service queue;
- StepProgress reading - progress of reading (crawling) website;
- StepProgress processing - progress of processing found HTML pages;
- StepProgress downloadingGallery - progress of downloading resources (images, documents, etc.) into media library;
- StepProgress finalizing - progress of loading imported website into builder;

StepProgress object properties:

String state - 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 text - step name as displayed in builder (may be translated and contain HTML code);
Number progress - step progress percentage (0 to 100);
String progressText - 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.