Project status

GET 
/project/:id/status

Return project status

Request

Path Parameters

id stringrequired
A unique project ID
Example: 5e9602e7a39e5a46428b457f

Responses

200

Successful response - full project status

application/json

Schema

Schema

project object

Basic project information

id string

A unique Project ID

lastRun integer

Unix timestamp of last run

lastChange integer

Unix timestamp of last change

reported string

Was reported

status string

msg string

Longer message about project status

shortMessage string

Short project status message

total integer

Total count of checks

failed integer

How much check has failed

now integer

Current date time unix timestamp

tests object[]
Array [
id string
Check id
enabled boolean
Default value: true
areaId
Area ID
name string
Name of check
url string
URL of check
notice string
Check notice
type string
Possible values: [homepage, simple, favicon, robots]
run string
Possible values: [completed, running]
flags string[]
Test flags e.g. configured
status object
status string
failures string[]
rules object[]
Array [
type string
Possible values: [text html status header location title meta-description meta-og:title meta-og:description meta-og:image meta-og:image meta-og:image meta-og:type meta-og:url meta-og:site_name meta-og:locale meta-og:updated_time meta-og:logo meta-article:modified_time meta-article:published_time meta-article:publisher meta-article:section meta-article:tag meta-twitter:title meta-twitter:image meta-twitter:image meta-twitter:description meta-twitter:card meta-twitter:site meta-twitter:creator meta-itemprop:name meta-itemprop:author meta-itemprop:description meta-itemprop:image]
Default value: text
Type of check
op string
Possible values: [eq, sub, !sub, match, !match, xpath]
Operators can be: eq is equal to, sub contains, !sub does not contains, match for exact match, !match for does not match and xpath for Xpath checks.
val string
Value that will be used for check
origin string
Original of the check
templateId string
Optional parameter if check use a Template
order integer
Order of the check
]
response object
status string
httpStatus string
baseUrl string
contentType string
httpHeader string
processTime number
size number
Size of response in case of check error
redirects string[]
List of redirections
timing undefined[]
Array [
metrics string
value integer
]
templateId string
Template ID if any
templateVars string[]
Template variables if any
options object
2 boolean
Default value: false
Allow HTTP/1 requests only
6 boolean
Default value: false
Allow only IPv6 request
g boolean
Default value: false
Do not accept gzip encoding
l boolean
Default value: false
Do not follow redirects
w string
Extra HTTP headers separated
]

Example (from schema)

{
  "project": {
    "id": "string",
    "lastRun": 1665407081,
    "lastChange": 1665263416,
    "reported": "ok",
    "status": "string",
    "msg": "Server returned HTTP status 200",
    "shortMessage": 200
  },
  "total": 12,
  "failed": 0,
  "now": 1665407098,
  "tests": [
    {
      "id": "50a9f73014db3ae812000234",
      "enabled": true,
      "areaId": "55ae166c25b395537a8b6030",
      "name": "Homepage",
      "url": "https://testomato.com",
      "notice": "",
      "type": "simple",
      "run": "completed",
      "flags": [
        "configured"
      ],
      "status": {
        "status": "ok",
        "failures": [
          "string"
        ],
        "rules": [
          {
            "type": "text",
            "op": "sub",
            "val": 123456,
            "origin": "check",
            "templateId": "string",
            "order": 0
          }
        ],
        "response": {
          "status": 200,
          "httpStatus": 200,
          "baseUrl": "https://testomato.com",
          "contentType": "text/html",
          "httpHeader": ":status: 200\r\nserver: nginx\r\ndate: Mon, 10 Oct 2022 15:04:05 GMT\r\ncontent-type: text/html;",
          "processTime": 0.037,
          "size": false,
          "redirects": [
            "string"
          ],
          "timing": [
            {
              "metrics": "DNS Lookup",
              "value": 1
            }
          ]
        }
      },
      "templateId": "",
      "templateVars": [],
      "options": {
        "2": false,
        "6": false,
        "g": false,
        "l": false,
        "w": "string"
      }
    }
  ]
}

Loading...