Skip to content
ThreadAPI
Navigation

Get Monitor Matches

GET /v1/monitors/{id}/matches
Free (0 credits) Permission: monitors:read

Returns matches collected by the monitor. Supports streaming pagination via after, or reverse chronological sorting with order=newest.

Authorization

  • bearerAuth: optional HTTP
  • apiKeyAuth: optional API key in header

Path parameters

  • id: required string

Query parameters

  • order: optional oldest|newest

    Sort ordering for returned matches.

    default: "oldest"
  • after: optional string

    With order=oldest, cursor for the next page of matches.

  • before: optional string

    With order=newest, cursor for the next page of matches.

  • limit: optional integer

    Maximum items to return.

    range: 1–200 · default: 100

Returns

200

List of matches

JSON
  • items: optional array ofobject
    • id: required string
    • monitor_id: required string
    • thing_id: required string
    • kind: required post|comment
    • subreddit: required string
    • author: required string
    • title: required string
    • body: required string
    • permalink: required string
    • post_id: required string
    • created_utc: required string
      format: date-time
    • matched_terms: required array ofstring
    • suppressed: required boolean
    • delivery_status: required none|pending|delivered|failed|skipped
    • created_at: required string
      format: date-time
    • delivered_at: optional string | null
      format: date-time
  • after: optional string

    With order=oldest, the cursor for the next page when one is waiting.

  • before: optional string

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.

404

Requested user or resource not found
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.

Type to search…

↑↓ navigate ↵ select Esc close