Site errors

The site errors endpoint lets you retrieve the most recent errors for a site or look up errors from a specific process run.

Get

Use a GET request to list errors for a site. See Sites for how to identify sites.

curl https://platform-api.productsup.io/platform/v2/sites/123/errors

{
    "success": true,
    "Errors": [
        {
            "id": "1802017",
            "pid": "537cb0659a7dc",
            "error": "10012",
            "data": {"FTP Host":"sftp://example.org","User":"sftpuser"},
            "site_id": "123",
            "datetime": "2003-11-15 00:00:00",
            "type": "Error",
            "classification": "medium",
            "links": [{...}]
        },
        ...
    ]
}

HTTP request

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

GET https://platform-api.productsup.io/platform/v2/sites/<siteId>/errors?pid=<pid>&limit=<limit>&offset=<offset>

URL parameters

Name	Type	Description
`siteId`	integer	Site to retrieve errors for

Optional query parameters

Name	Example	Default	Description
`pid`	`abc456def`	(latest)	Process ID. Defaults to the latest process.
`limit`	`10`	`50`	Maximum number of results
`offset`	`20`	`0`	Results begin at this position

Response fields

Field	Type	Description
`success`	boolean	Indicates request status
`Errors`	array	List of errors

Error fields

Field	Type	Description
`id`	integer	Internal identifier
`pid`	string	Process identifier
`error`	integer	Error identifier
`data`	array	Additional information about the error
`site_id`	integer	Site identifier
`message`	string	User-facing error message
`datetime`	string	Date and time the error occurred
`type`	string	Type of error (`Error`, `Warning`, or `Info`)
`classification`	string	Severity of the error (`low`, `medium`, or `high`)
`links`	array	See link fields

Links fields and values

Name	Description
`self`	Link to the error endpoint