List Monitors

GET /v1/monitors

Free (0 credits) Permission: monitors:read

Returns all monitors configured by the authenticated user.

Authorization

bearerAuth: optional HTTP

apiKeyAuth: optional API key in header

Returns

200

List of monitors

JSON

items: optional array ofobject
- id: required string
- name: required string
- keywords: required array ofstring
- include_posts: required boolean
- include_comments: required boolean
- nsfw: required boolean
- status: required active|paused|paused_balance|deleted
- next_charge_at: required string
  
  format: date-time
- created_at: required string
  
  format: date-time
- updated_at: required string
  
  format: date-time
- exclude: optional array ofstring
- subreddits: optional array ofstring
- webhook_url: optional string | null
- webhook_kind: optional generic|slack|discord|telegram|null
- webhook_failing: optional boolean
- last_match_at: optional string | null
  
  format: date-time
limit: optional integer
used: optional integer
daily_match_cap: optional integer

401

Missing or invalid API key or OAuth access token

JSON

One of the following:

ErrorResponse
- error: required string
  
  Human-readable error message
- error_code: optional forbidden_scope|rate_limited|daily_quota_exceeded|insufficient_credits|duplicate_transaction
  
  Machine-readable error code. Known values include: forbidden_scope, rate_limited, daily_quota_exceeded, insufficient_credits, duplicate_transaction. Additional codes may be introduced in future releases.
Error
- error: required object
  
  code: required string
  
  message: required string
  
  retryable: required boolean
  
  retry_after: optional integer
  
  Seconds to wait before retrying.

{ "items": [ { "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" } ], "limit": 0, "used": 0, "daily_match_cap": 0 }