Skip to main content

๐Ÿ“Š JSON API Monitor

The JSON API monitor extends the HTTP monitor with features specific to monitoring JSON APIs โ€” checking response structure, values, and more.


๐ŸŽฏ What It Doesโ€‹

  • Makes HTTP requests to a JSON API endpoint
  • Verifies the response is valid JSON
  • Checks for specific keys or values in the response
  • Supports all HTTP methods and authentication

โš™๏ธ Configurationโ€‹

Same as the HTTP monitor, tailored for APIs:

SettingDescription
URLYour API endpoint
MethodGET, POST, etc.
HeadersUsually includes Accept: application/json
KeywordCheck for a JSON key/value like "status":"ok"
AuthenticationBearer token, Basic Auth

๐Ÿ’ก Tipsโ€‹

  • Add Accept: application/json in custom headers to ensure you get JSON responses.
  • Use keyword checks to verify the response structure, not just HTTP status.