WPX

Return WordPress installation activity

Changed on

This function reports whether the account has done meaningful work on a WordPress installation it owns. A WordPress site goes live the moment it installs, and WordPress sends no event when real setup work finishes. So the system compares the live site to a fresh installation and reports the differences as flags.

Note:

  • The has_user_activity field is the summary flag. It is 1 when the authored_content or uploaded_media field is 1. The remaining three flags are informational and do not affect it.
  • This function is expensive. It starts WordPress once to collect every signal, and the system stops the attempt after 30 seconds.
  • A site whose WordPress cannot start, or that does not answer within the 30-second limit, reports every flag as 0. This is not an error.
  • An id parameter that does not exist, or that belongs to another account, returns a failure status with a message in the errors field. The two cases are indistinguishable.
  • The system verifies that the caller owns the installation before it reads anything.
get/WPX/get_site_activity

Request

  • Base URL
    https://cpanel-server.tld:2083/execute
  • Auth
    HTTP basic

Query parameters

idinteger required

The WordPress Toolkit installation id, as returned in the wptk_id field of list_websites.

Response

The HTTP request was successful.

apiversioninteger

The version of the API.

funcstring

The name of the method called.

modulestring

The name of the module called.

Example response

{
  "apiversion": 3,
  "func": "get_site_activity",
  "module": "WPX",
  "result": {
    "data": {
      "authored_content": 1,
      "has_user_activity": 1,
      "personalized_identity": 1
    },
    "metadata": {
      "transformed": 1
    },
    "status": 1
  }
}

Changes