PaperpinPaperpin Docs
REST API

Insights

Retrieve aggregate Paperpin monitoring statistics, trend timelines, checks, failures, changes, and credit usage.

GET /insights

Insights aggregate monitor checks, successes, failures, detected changes, credits consumed, and daily timeline data.

Query parameterTypeDescription
monitor_idUUIDRepeat to include one or more monitor IDs.
group_idUUIDRepeat to include one or more group IDs.
fromUTC ISO-8601 datetimeInclusive range start. Defaults to 30 days ago.
toUTC ISO-8601 datetimeExclusive range end. Defaults to now.

When both monitor and group filters are supplied, a monitor must match both filters.

{
  "data": {
    "filters": {
      "monitor_ids": ["99b61a96-40d9-44a6-9fd5-e56e5d29e49f"],
      "group_ids": [],
      "from": "2026-07-01T00:00:00.000Z",
      "to": "2026-07-16T00:00:00.000Z"
    },
    "metrics": {
      "total_checks": 120,
      "successful_runs": 115,
      "failed_runs": 5,
      "changes_detected": 8,
      "credits_consumed": 120
    },
    "timeline": [
      {
        "date": "2026-07-15",
        "checks": 8,
        "successful_runs": 8,
        "failed_runs": 0,
        "changes_detected": 1
      }
    ]
  }
}

All IDs and dates are validated before aggregation. Invalid filters return 400.