Monitoring

Get a company-record monitor

get/monitors/{monitor_id}

Request

  • Base URL: https://vatfind.com/v1
  • URL: https://vatfind.com/v1/monitors/{monitor_id}
  • Auth: HTTP bearer

Response

Monitor

idstring required
object'vat_monitor' required
environment'live' | 'sandbox' required
status'active' | 'paused' | 'attention' required
health'healthy' | 'source_degraded' | 'needs_credits' required
company_namestring
client_referencestring
metadataobject
cadence'daily' | 'weekly' | 'monthly' required
watched_fieldsMonitorWatchedField[] required
webhook_urlstring uri
baseline_check_idstring required
latest_check_idstring required
last_checked_atstring date-time required
next_check_atstring date-time required
last_event_atstring date-time
failure_countinteger required
last_error_codestring
estimated_monthly_checks1 | 5 | 30 required
created_atstring date-time required
updated_atstring date-time required

Example response

{
  "identifier": {
    "country_code": "GB"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.