Status

Check the processing status of a site using a process identifier (PID) from the Platform API.

The status endpoint returns the current processing state of a site for a given process identifier (PID). You obtain a PID when you call the Process endpoint.

The platform validates only the PID format — it does not check whether the PID exists. If you pass a valid but non-existent PID, the status is always queued.

Get

Request

curl -i -L -X GET \
  'https://platform-api.productsup.io/platform/v2/sites/<siteId>/status/<pid>'

Response

{
    "success": true,
    "status": "failed",
    "datetime": "2024-04-29T10:30:00Z",
    "links": [
        {
            "errors": "https://platform-api.productsup.io/platform/v2/sites/<siteId>/errors?pid=<pid>"
        },
        {
            "self": "https://platform-api.productsup.io/platform/v2/sites/<siteId>/status/<pid>"
        }
    ]
}

HTTP request

GET https://platform-api.productsup.io/platform/v2/sites/<siteId>/status/<pid>

URL parameters

Field	Type	Description
`siteId`	integer	Site to which the PID belongs
`pid`	string	Process identifier to check

Response fields

Field	Type	Description
`success`	boolean	Indicates request status
`status`	string	See status values
`datetime`	string	ISO 8601 timestamp. For `queued` and `running` processes, when the process started. For `success` and `failed`, when it ended. Not present when the status is `unknown`.
`links`	array	Link to this resource and, when status is `failed`, to the site errors resource

Status values

Value	Description
`queued`	The PID is valid but the site has not started processing yet.
`running`	The platform is currently processing the site's content.
`success`	Processing completed without errors.
`failed`	Processing completed with errors. Use the `errors` link in the response to retrieve details.
`unknown`	The platform cannot determine the state of this process. No `datetime` is returned.

Status

Get

HTTP request

URL parameters

Response fields

Status values

On this page