Project status

GET

/project/{id}/status

const url = 'https://testomato.com/api/project/5e9602e7a39e5a46428b457f/status';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://testomato.com/api/project/5e9602e7a39e5a46428b457f/status \
  --header 'Authorization: Bearer <token>'

Return project status

Authorizations

ApiToken

Parameters

Path Parameters

required

string

A unique project ID

Example

5e9602e7a39e5a46428b457f

Responses

200

Successful response - full project status

application/json

object

project

Basic project information

object

A unique project ID

string

lastRun

Unix timestamp of last run

integer

lastChange

Unix timestamp of last change

integer

reported

Reported status

string

status

string

msg

Detailed message about project status

string

shortMessage

Short project status message

string

total

Total count of checks

integer

failed

Number of failed checks

integer

now

Current datetime (unix timestamp)

integer

tests

Array<object>

A group of individual checks

object

Check id

string

enabled

boolean

default: true

areaId

Area ID

name

Name of check

string

url

URL of check

string

notice

Check notice

string

type

string

Allowed values: homepage simple favicon robots

run

string

Allowed values: completed running

flags

Test flags e.g. configured

Array<string>

status

object

status

string

failures

Array<string>

rules

Array<object>

object

type

Type of check. Accepted values:

Plain content: text, html, status, header, location, title, meta-description
Open Graph: meta-og:title, meta-og:description, meta-og:image, meta-og:type, meta-og:url, meta-og:site_name, meta-og:locale, meta-og:updated_time, meta-og:logo
Article: meta-article:modified_time, meta-article:published_time, meta-article:publisher, meta-article:section, meta-article:tag
Twitter: meta-twitter:title, meta-twitter:image, meta-twitter:description, meta-twitter:card, meta-twitter:site, meta-twitter:creator
Item prop: meta-itemprop:name, meta-itemprop:author, meta-itemprop:description, meta-itemprop:image

string

default: text

Allowed values: text html status header location title meta-description meta-og:title meta-og:description 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:description meta-twitter:card meta-twitter:site meta-twitter:creator meta-itemprop:name meta-itemprop:author meta-itemprop:description meta-itemprop:image

Operators can be:

eq — equal to
sub — contains
!sub — does not contain
match — exact match
!match — does not match
xpath — XPath checks.

string

Allowed values: eq sub !sub match !match xpath

val

Value that will be used for the check.

string

origin

Origin of the check.

string

templateId

Optional parameter if the check uses a template.

string

order

Order of the check

integer

response

object

status

string

httpStatus

string

baseUrl

string

contentType

string

httpHeader

string

processTime

number

size

Size of the response (may be false in case of an error)

number

redirects

List of redirections

Array<string>

timing

Array

object

metrics

string

value

integer

templateId

Template ID if any

string

templateVars

Template variables if any

Array<string>

options

object

Allow HTTP/1 requests only

boolean

Allow only IPv6 request

boolean

Do not accept gzip encoding

boolean

Do not follow redirects

boolean

Extra HTTP headers separated

string

Example

{
  "project": {
    "lastRun": 1665407081,
    "lastChange": 1665263416,
    "reported": "ok",
    "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": "homepage",
      "run": "completed",
      "flags": [
        "configured"
      ],
      "status": {
        "status": "ok",
        "rules": [
          {
            "type": "text",
            "op": "eq",
            "val": 123456,
            "origin": "check"
          }
        ],
        "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,
          "timing": [
            {
              "metrics": "DNS Lookup",
              "value": 1
            }
          ]
        }
      },
      "templateId": "",
      "templateVars": [],
      "options": {
        "2": false,
        "6": false,
        "g": false,
        "l": false,
        "w": ""
      }
    }
  ]
}

401

The API token is missing, malformed or expired. Request a new one from POST /api/authenticate.

application/json

object

message

Error message text

string

default: Access denied! Please log in to access this resource.

code

Error code number

integer

default: 401

boolean

error

boolean

default: true

Example

{
  "message": "Access denied! Please log in to access this resource.",
  "code": 401,
  "ok": false,
  "error": true
}

403

The token is valid but the operation is not allowed. Two distinct causes:

the subscription plan does not include API access — every endpoint returns this, regardless of the resource
the account lacks the required role on the project — reading needs read, changing checks needs editTests, and so on. See Project permissions.

application/json

object

message

Error message text

string

default: Sorry! Your current plan does not support access to Testomato API.

code

Error code number

integer

default: 403

boolean

error

boolean

default: true

Example

{
  "message": "Sorry! Your current plan does not support access to Testomato API.",
  "code": 403,
  "ok": false,
  "error": true
}