# Return WordPress task progress

This function returns the progress of a WordPress installation or import
for the supplied install_id parameter.

  Note:

  - Use this function to read progress with a cPanel API token. The
    equivalent Server-Sent Events stream (the sse_url field) is only
    available to an interactive cPanel session, not to an API token.
  - create_website and import_website return the install_id in
    their normal-start responses. Those are the only two functions that
    return one. create_nova_for_wordpress_website queues no
    installation task and returns no install_id value; a Nova walkthrough
    gets one when its later import_website callback starts the import.
  - This function is the authoritative source for progress and for
    success or failure, and it still works after the task finishes,
    because it reads the run's progress log. get_task_status reads the
    task queue instead, so it can only report whether the task is still
    queued, and it cannot tell success from failure.

Endpoint: GET /WPX/get_task_progress
Version: 11.138.0.10
Security: BasicAuth

## Query parameters:

  - `install_id` (string, required)
    The unique correlator for the install or import run. The function that started the task returns it.
    Example: "1784237244-988110-12345"

## Response 200 fields (application/json):

  - `apiversion` (integer)
    The version of the API.
    Example: 3

  - `func` (string)
    The name of the method called.
    Example: "get_task_progress"

  - `module` (string)
    The name of the module called.
    Example: "WPX"

  - `result` (object)

  - `result.data` (object)
    The latest progress for the run.

  - `result.data.message` (string)
    The most recent human-readable progress or outcome message. May be empty.
    Example: "Creating database"

  - `result.data.percentage` (integer)
    The install or import progress, from 0 to 100.
    Example: 42

  - `result.data.status` (string)
    The run state.
* unknown - No progress log exists yet, or the
  install_id value is not the caller's.
* running - The run is in progress. No terminal event yet.
* complete - The run finished successfully, or
  progress reached 100%.
* failed - The run reported a terminal failure.
    Enum: "unknown", "running", "complete", "failed"

  - `result.errors` (array,null)
    List of errors if the API failed.

  - `result.messages` (array,null)
    List of messages generated by the API.

  - `result.metadata` (object)

  - `result.metadata.transformed` (integer)
    Post-processing may have transformed the data.
    Enum: 1

  - `result.status` (integer)
    - 1 - Success.
- 0 - Failed: Check the errors field for more details.
    Enum: 1, 0

  - `result.warnings` (array,null)
    List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running an API.