---
title: "Get Monitor"
description: "Returns monitor configuration and 24-hour/7-day delivery and match statistics."
---

> Documentation Index
> Fetch the complete documentation index at: https://staging.threadapi.dev/llms.txt
> Use this file to discover all available pages before exploring further.

Path: ThreadAPI API › Monitors

`GET /v1/monitors/{id}`

Returns monitor configuration and 24-hour/7-day delivery and match statistics.

## Authentication

Requires one of the following:

- `bearerAuth`, http, header `Authorization`
- `apiKeyAuth`, apiKey, in header, header `x-api-key`

## Path parameters

- `id` (`getMonitor.path.id`; string, required)

## Code samples

### cURL

```bash
curl --request GET \
  --url 'https://api.threadapi.dev/v1/monitors/<id>' \
  --header 'Authorization: Bearer <token>'
```

### TypeScript

```typescript
const url = 'https://api.threadapi.dev/v1/monitors/<id>';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));
```

### Python

```python
import requests

url = "https://api.threadapi.dev/v1/monitors/<id>"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
```

## Responses

### 200

Monitor with statistics

#### Example

```json
{
  "monitor": {
    "id": "string",
    "name": "string",
    "keywords": [
      "string"
    ],
    "exclude": [
      "string"
    ],
    "subreddits": [
      "string"
    ],
    "include_posts": true,
    "include_comments": true,
    "nsfw": true,
    "webhook_url": "string",
    "webhook_kind": "generic",
    "status": "active",
    "webhook_failing": true,
    "next_charge_at": "2019-08-24T14:15:22Z",
    "last_match_at": "2019-08-24T14:15:22Z",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  },
  "stats": {
    "matches_today": 0,
    "suppressed_today": 0,
    "matches_7d": 0,
    "last_match_at": "2019-08-24T14:15:22Z",
    "delivery_failures_24h": 0
  }
}
```

- `monitor` (`getMonitor.response.200.monitor`; object, optional)
  - `id` (`getMonitor.response.200.monitor.id`; string, required)
  - `name` (`getMonitor.response.200.monitor.name`; string, required)
  - `keywords` (`getMonitor.response.200.monitor.keywords`; array<string>, required)
  - `include_posts` (`getMonitor.response.200.monitor.include_posts`; boolean, required)
  - `include_comments` (`getMonitor.response.200.monitor.include_comments`; boolean, required)
  - `nsfw` (`getMonitor.response.200.monitor.nsfw`; boolean, required)
  - `status` (`getMonitor.response.200.monitor.status`; string, required)
    - one of `"active"`, `"paused"`, `"paused_balance"`, `"deleted"`
  - `next_charge_at` (`getMonitor.response.200.monitor.next_charge_at`; string, required)
    - format `date-time`
  - `created_at` (`getMonitor.response.200.monitor.created_at`; string, required)
    - format `date-time`
  - `updated_at` (`getMonitor.response.200.monitor.updated_at`; string, required)
    - format `date-time`
  - `exclude` (`getMonitor.response.200.monitor.exclude`; array<string>, optional)
  - `subreddits` (`getMonitor.response.200.monitor.subreddits`; array<string>, optional)
  - `webhook_url` (`getMonitor.response.200.monitor.webhook_url`; string | null, optional)
  - `webhook_kind` (`getMonitor.response.200.monitor.webhook_kind`; string | null, optional)
    - one of `"generic"`, `"slack"`, `"discord"`, `"telegram"`, `null`
  - `webhook_failing` (`getMonitor.response.200.monitor.webhook_failing`; boolean, optional)
  - `last_match_at` (`getMonitor.response.200.monitor.last_match_at`; string | null, optional)
    - format `date-time`
- `stats` (`getMonitor.response.200.stats`; object, optional)
  - `matches_today` (`getMonitor.response.200.stats.matches_today`; integer, required)
  - `suppressed_today` (`getMonitor.response.200.stats.suppressed_today`; integer, required)
  - `matches_7d` (`getMonitor.response.200.stats.matches_7d`; integer, required)
  - `delivery_failures_24h` (`getMonitor.response.200.stats.delivery_failures_24h`; integer, required)
  - `last_match_at` (`getMonitor.response.200.stats.last_match_at`; string | null, optional)
    - format `date-time`

### 401

Missing or invalid API key or OAuth access token

#### Example

```json
{
  "error": "unauthorized: missing or invalid credentials",
  "error_code": "insufficient_credits"
}
```

One of:

- `ErrorResponse`
- `Error`

### 404

Requested user or resource not found

#### Example

```json
{
  "error": "unauthorized: missing or invalid credentials",
  "error_code": "insufficient_credits"
}
```

One of:

- `ErrorResponse`
- `Error`


Source: https://staging.threadapi.dev/api/Monitors/getMonitor/index.md