Project groups

GET 
/project/:id/areas

Return list of project groups/areas

Request

Path Parameters

id stringrequired
A unique project ID
Example: 5e9602e7a39e5a46428b457f

Responses

200

List of project areas/groups

application/json

Schema

Schema

• Array [

id string
A unique Areas/Group ID
Example: 54c0fe237c3391ac488b4567
projectId string
A unique parent Project ID
Example: 50a9f72f14db3be812000233
name string
Name of group
Example: Public
public boolean
Are the Test target URLs in the Group accessible without password protected or HTTP authentication?
• true means they are freely accessible
• false means yes, they are protected.
Default value: true
rules array[]
Group rules that are applied to all tests in the Group. This is mostly empty array.
Example: []

form

object

HTML Form

checksum string

enabled boolean

action string

originalAction string

relativeAction string

method string

params string

html string

baseUrl string

identifier string

httpAuth

object

Password-protected areas may have a saved HTTP auth authentications

user string

password string

HTTP

url string

HTTP Auth URL address

period string
Check period interval as string (mostly se to true - same as parent Project)
Possible values: [5 minutes, 30 minutes, 1 hour, 8 hours, 1 day, 7 days, true]
Default value: true

result

object

Response object (optional) show only when some some Rules are evaluated as an error

prop string

options

object

w string

Extra HTTP headers

Default value:
nextRun integer
Next run in seconds (Can be negative if we don't have new results yet)
Example: 150
periodInt integer
Period of automatic startup in seconds
Example: 300

• ]

Example (from schema)

[
  {
    "id": "54c0fe237c3391ac488b4567",
    "projectId": "50a9f72f14db3be812000233",
    "name": "Public",
    "public": true,
    "rules": [],
    "form": {
      "checksum": "string",
      "enabled": true,
      "action": "string",
      "originalAction": "string",
      "relativeAction": "string",
      "method": "string",
      "params": "string",
      "html": "string",
      "baseUrl": "string",
      "identifier": "string"
    },
    "httpAuth": {
      "user": "nice",
      "password": "test",
      "url": "https://www.testomato.com/httpauth"
    },
    "period": true,
    "result": {
      "prop": "string"
    },
    "options": {
      "w": "string"
    },
    "nextRun": 150,
    "periodInt": 300
  }
]