Manage Monitoring

Managing Monitoring

Stop Monitoring

curl -X PATCH {baseurl}/api/v1/domains/{id}/stop \
  -H "Authorization: Bearer <token>"

Start/Restart Monitoring

curl -X PATCH {baseurl}/api/v1/domains/{id}/start \
  -H "Authorization: Bearer <token>"

Get monitoring alerts

get

Retrieve monitoring alerts list.

Returns alerts list, even if you don't have webhooks configured. This allows you to see all monitoring events for your domains in a consistent format. You can filter by provider, domain, and date range to analyze monitoring activity.

Note: This is different from /api/v1/user-webhooks/deliveries which shows the delivery logs of outbound webhooks sent to your registered endpoints.

Authorizations

BearerAuth

AuthorizationstringRequired

JWT access token obtained from login endpoint

Query parameters

domainIdstring · uuidOptional

Filter by domain ID

dateFromstring · date-timeOptional

Filter events from this date (ISO 8601 format, e.g., 2025-01-01 or 2025-01-01T00:00:00Z)

dateTostring · date-timeOptional

Filter events until this date (ISO 8601 format, e.g., 2025-01-31 or 2025-01-31T23:59:59Z)

pageinteger · min: 1Optional

Page number

Default: 1

limitinteger · min: 1 · max: 100Optional

Number of items per page

Default: 20

sortBystring · enumOptional

Field to sort by

Default: created_atPossible values:

sortOrderstring · enumOptional

Sort order

Default: descPossible values:

Responses

200

Monitoring alerts retrieved successfully

application/json

400

Validation failed

application/json

401

Authentication required or token invalid

application/json

get

/api/v1/monitoring-alerts

HTTPcURLJavaScriptPython

GET /api/v1/monitoring-alerts HTTP/1.1
Host: uat-monitor.payshield.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "message": "Monitoring alerts retrieved successfully",
  "data": [
    {
      "event": "business-closed",
      "description": "Business appears to be closed based on verification data",
      "timestamp": "2026-01-27T09:59:00Z",
      "data": {
        "domainId": "123e4567-e89b-12d3-a456-426614174000",
        "domain": "example.com",
        "status": "active",
        "provider": "truebiz"
      }
    }
  ],
  "pagination": {
    "limit": 1,
    "offset": 1,
    "total": 1
  }
}