> For the complete documentation index, see [llms.txt](https://docs.payshield.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.payshield.ai/merchant-monitoring-api/manage-monitoring.md).

# Manage Monitoring

### Managing Monitoring

#### Stop Monitoring

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

#### Start/Restart Monitoring

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

## Get monitoring alerts

> 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.<br>

```json
{"openapi":"3.0.3","info":{"title":"Domain Monitor API - Merchant Portal","version":"1.0.0"},"tags":[],"servers":[{"url":"https://uat-monitor.payshield.ai","description":"Uat server"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT access token obtained from login endpoint"}},"schemas":{"Pagination":{"type":"object","properties":{"limit":{"type":"integer"},"offset":{"type":"integer"},"total":{"type":"integer"}}},"Error":{"type":"object","properties":{"message":{"type":"string"},"code":{"type":"string"},"details":{"type":"object"}}}},"responses":{"ValidationError":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"UnauthorizedError":{"description":"Authentication required or token invalid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"paths":{"/api/v1/monitoring-alerts":{"get":{"tags":["Monitoring Alerts"],"summary":"Get monitoring alerts","description":"Retrieve monitoring alerts list.\n\nReturns alerts list, even if you don't have webhooks configured.\nThis allows you to see all monitoring events for your domains in a consistent format.\nYou can filter by provider, domain, and date range to analyze monitoring activity.\n\nNote: This is different from `/api/v1/user-webhooks/deliveries` which shows the delivery logs of outbound webhooks sent to your registered endpoints.\n","operationId":"getMonitoringAlerts","parameters":[{"name":"domainId","in":"query","schema":{"type":"string","format":"uuid"},"description":"Filter by domain ID"},{"name":"dateFrom","in":"query","schema":{"type":"string","format":"date-time"},"description":"Filter events from this date (ISO 8601 format, e.g., 2025-01-01 or 2025-01-01T00:00:00Z)"},{"name":"dateTo","in":"query","schema":{"type":"string","format":"date-time"},"description":"Filter events until this date (ISO 8601 format, e.g., 2025-01-31 or 2025-01-31T23:59:59Z)"},{"name":"page","in":"query","schema":{"type":"integer","default":1,"minimum":1},"description":"Page number"},{"name":"limit","in":"query","schema":{"type":"integer","default":20,"minimum":1,"maximum":100},"description":"Number of items per page"},{"name":"sortBy","in":"query","schema":{"type":"string","enum":["timestamp","domain","event","description"],"default":"created_at"},"description":"Field to sort by"},{"name":"sortOrder","in":"query","schema":{"type":"string","enum":["asc","desc"],"default":"desc"},"description":"Sort order"}],"responses":{"200":{"description":"Monitoring alerts retrieved successfully","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"data":{"type":"array","items":{"type":"object","properties":{"event":{"type":"string","description":"Event category/type"},"description":{"type":"string","description":"Human-readable event description"},"timestamp":{"type":"string","format":"date-time","description":"When the event was received"},"data":{"type":"object","properties":{"domainId":{"type":"string","format":"uuid","nullable":true,"description":"Associated domain ID"},"domain":{"type":"string","nullable":true,"description":"Domain name"},"status":{"type":"string","nullable":true,"description":"Current domain status"},"provider":{"type":"string","description":"Provider name"}}}}}},"pagination":{"$ref":"#/components/schemas/Pagination"}}}}}},"400":{"$ref":"#/components/responses/ValidationError"},"401":{"$ref":"#/components/responses/UnauthorizedError"}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.payshield.ai/merchant-monitoring-api/manage-monitoring.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.