Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Newscatcher Monitors API

Operations to create, operate and retrieve monitor results.

Newscatcher Monitors API is one of 16 APIs that Newscatcher publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Monitors. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 9 operations across 8 paths, and defines 23 schemas. It is described by OpenAPI 3.0.3, at version 1.2.0.

Requests are made against a single base URL, https://local-news.newscatcherapi.com.

9 operations 8 paths 23 schemas 1 DELETE4 GET1 PATCH3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.2.0
Base URL
https://v3-api.newscatcherapi.com/api
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

Newscatcher Monitors API declares 1 security scheme for authenticating requests. An API key is passed in the header as x-api-token (ApiKeyAuth). By default, every request must be authenticated.

  • ApiKeyAuth — API Key to authenticate requests. To access the API, include your API key in the x-api-token header. To obtain your API key, complete the [form](https://www.ne…

Paths & Operations 9

Across 8 paths, the API surfaces 9 operations — 1 DELETE, 4 GET, 1 PATCH, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Monitors 9

Operations to create, operate and retrieve monitor results.

GET
/catchAll/monitors
List monitors
listMonitors 5 params → 200403422
POST
/catchAll/monitors/create
Create monitor
createMonitor body → 200422
GET
/catchAll/monitors/pull/{monitor_id}
Get monitor results
pullMonitorResults 1 param → 200404422
GET
/catchAll/monitors/{monitor_id}/jobs
List monitor jobs
listMonitorJobs 2 params → 200404422
GET
/catchAll/monitors/{monitor_id}/status
Get monitor status history
getMonitorStatusHistory 1 param → 200401404
POST
/catchAll/monitors/{monitor_id}/enable
Enable monitor
enableMonitor 1 param body → 200403404422
POST
/catchAll/monitors/{monitor_id}/disable
Disable monitor
disableMonitor 1 param → 200403404422
PATCH
/catchAll/monitors/{monitor_id}
Update monitor
updateMonitor 1 param body → 200403404422
DELETE
/catchAll/monitors/{monitor_id}
Delete monitor
deleteMonitor 1 param → 200401404

Schemas 23

The contract defines 23 schemas that model the data the API accepts and returns. The most detailed are MonitorListItemDto (11 properties), PullMonitorResponseDto (9 properties), CreateMonitorRequestDto (7 properties), MonitorStatusHistoryResponseDto (5 properties). Each schema is shown below with its type and property counts.

Citation
object
3 properties 3 required
MonitorListItemDto
object
11 properties 4 required
CreateMonitorRequestDto
object
7 properties 2 required
BaseRecord
object
3 properties 3 required
MonitorCitation
Citation with monitor-specific metadata. Used in monitor results and webhook payloads. Extends base citation with tracking information for jobid and timestamps.
ValidationErrorDetail
object
3 properties
PullMonitorResponseDto
object
9 properties 3 required
ValidationErrorResponse
object
1 property
MonitorStatusEntry
object
3 properties 2 required
SharingInfo
object
Present on resources shared with the authenticated user by another organization member. Omitted entirely on resources the user owns.
3 properties 3 required
MonitorStatusHistoryResponseDto
object
5 properties 4 required
Error
object
1 property
CreateMonitorResponseDto
object
2 properties 1 required
ListMonitorsResponseDto
object
5 properties 5 required
DeleteMonitorResponseDto
object
3 properties 3 required
UpdateMonitorRequestDto
object
2 properties
MonitorRecord
Record with monitor-specific metadata. Used in monitor results and webhook payloads. Includes timestamps tracking when records were added and updated, and cita…
UpdateMonitorResponseDto
object
2 properties 2 required
EnableMonitorRequestDto
object
Optional request body for enabling a monitor.
1 property
MonitorJobItem
object
3 properties 3 required
OwnershipFilter
string
Controls which resources are returned based on ownership. - all: Returns resources owned by the user and resources shared with them (default, backward compatib…
WebhookDto
object
5 properties 1 required
ReferenceJob
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

newscatcher-monitors-api-openapi.yml Raw ↑

Other APIs Newscatcher publishes across the network.

Newscatcher AggregationCount API
Newscatcher Authors API
Newscatcher BreakingNews API
Newscatcher Datasets API
Newscatcher Entities API
Newscatcher Jobs API
Newscatcher LatestHeadlines API
Newscatcher Meta API
Newscatcher Projects API
Newscatcher Search API
Newscatcher SearchBy API
Newscatcher SearchByLink API