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

Example: 1665407081

lastChange integer

Unix timestamp of last change

Example: 1665263416

reported string

Was reported

Example: ok

status string

msg string

Longer message about project status

Example: Server returned HTTP status 200

shortMessage string

Short project status message

Example: 200
total integer
Total count of checks
Example: 12
failed integer
How much check has failed
Example: 0
now integer
Current date time unix timestamp
Example: 1665407098

tests

object[]

Array [

id string

Check id

Example: 50a9f73014db3ae812000234

enabled boolean

Default value: true

Example: true

areaId

Area ID

Example: 55ae166c25b395537a8b6030

name string

Name of check

Example: Homepage

url string

URL of check

Example: https://testomato.com

notice string

Check notice

Example:

type string

Possible values: [homepage, simple, favicon, robots]

Example: simple

run string

Possible values: [completed, running]

Example: completed

flags string[]

Test flags e.g. configured

Example: ["configured"]

status

object

status string

Example: ok

failures string[]

rules

object[]

Array [

type string

Type of check

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

Example: text

op string

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.

Possible values: [eq, sub, !sub, match, !match, xpath]

Example: sub

val string

Value that will be used for check

Example: 123456

origin string

Original of the check

Example: check

templateId string

Optional parameter if check use a Template

order integer

Order of the check

]

response

object

status string

Example: 200

httpStatus string

Example: 200

baseUrl string

Example: https://testomato.com

contentType string

Example: text/html

httpHeader string

Example: :status: 200 server: nginx date: Mon, 10 Oct 2022 15:04:05 GMT content-type: text/html;

processTime number

Example: 0.037

size number

Size of response in case of check error

Example: false

redirects string[]

List of redirections

timing

undefined[]

Array [

metrics string

value integer

]

templateId string

Template ID if any

Example:

templateVars string[]

Template variables if any

Example: []

options

object

2 boolean

Allow HTTP/1 requests only

Default value: false

6 boolean

Allow only IPv6 request

Default value: false

g boolean

Do not accept gzip encoding

Default value: false

l boolean

Do not follow redirects

Default value: false

w string

Extra HTTP headers separated

Default value:

]

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"
      }
    }
  ]
}