Monitoring Results in Audisto API 2.0

The Monitoring API allows retrieving the results of Checks and Requirements ands the status of Alerts for a given crawl.

Monitoring results are bound to a crawl. For historic data, use the History API.

Routes

The monitoring API offers the following routes

Get all Checks of this crawl as array:

/2.0/crawls/{id}/checks

Get all Checks of this crawl as array, including Requirements:

/2.0/crawls/{id}/checks?deep=1

Get Check with given ID:

/2.0/crawls/{id}/checks/{id_check}/

Get all Requirements of this crawl as array:

/2.0/crawls/{id}/checks/requirements/

Get Requirement with given ID:

/2.0/crawls/{id}/checks/requirements/{id_requirement}/

Get all Triggered Alerts of this crawl as array:

/2.0/crawls/{id}/checks/alerts/

Get Triggered Alert with given ID.

/2.0/crawls/{id}/checks/alerts/{id_alert}/

Return values

Check Object

A Check is represented by an object with the following properties:

  • id: The unique ID
  • code: Definition as text
  • description: User defined description
  • name: User defined name
  • refid: The reference ID of the Check
  • critical: True if Check is critical, else false
  • failed: How many pages failed the Check
  • passed: How many pages passed the Check
  • requirements: An array of Requirement objects. Only available for deep responses (with query parameter deep=1)

Requirement Object

A Requirement is represented by an object with the following properties:

  • id: The unique ID
  • code: Definition as text
  • description: User defined description
  • name: User defined name
  • refid: The reference ID of the Check
  • failed: How many pages failed the Check
  • passed: How many pages passed the Check

Triggered Alert Object

An Alert that has been raised is represented by an object with the following properties:

  • id: The unique ID
  • creation_date: The time the alert was triggered
  • id_check: The Check that triggered the alert
  • idx_alert: Which defined alert triggered, zero based offset into list of defined alerts
  • mail_to: Email address to receive notification. Several addresses are separated by a linebreak.
  • num_failed: Number of failed pages
  • num_passed: Number of passed pages
  • trigger_time: Enum of either "Critical" (ID: 1) or "Summary" (ID: 2). This corresponds to the "Critical Alert" setting when defining an Alert.