Page DeltasPage Deltas

APIリファレンス

モニターとチャネルの管理、および変更のポーリングを行うための、小規模で安定したREST APIです。ダッシュボードと同じ機能を備えています。

ベースURL

プロダクション: https://api.pagedeltas.com。すべてのエンドポイントには /api プレフィックスが付きます。成功時のレスポンスはJSON形式です。

認証

設定 → APIキー からキーを作成してください（編集者または管理者ロールが必要です）。キーは作成時に一度だけ表示されますので、すぐにコピーしてください。キーを無効にするには、同じページから削除してください。

Authorization: Bearer pdt_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

キーは作成した組織にスコープされ、ユーザーとは独立して、その組織内で管理者レベルのアクセス権を持って動作します。メンバーには紐付いていないため、チームメンバーを削除しても組織のキーは無効になりません。アクセスを遮断するにはキー自体を削除してください。

エラー

エラーが発生すると2xx以外のステータスが返されます。認証や権限のエラーは短いテキストメッセージ（例: unauthorized, forbidden）として返されます。クォータやレート制限のエラーは、メッセージと関連する数値を含む小さなJSONボディを返します。固定のエラー形式を解析するのではなく、HTTPステータスコードで分岐してください:

  • 400 — リクエストの形式が正しくありません（不正なJSON、無効なURL、必須フィールドの欠如）。
  • 401 — 資格情報が不足しているか無効です。
  • 403 — 認証されていますが、ロールにこのアクションの権限がありません。
  • 404 — リソースが存在しないか、あなたの組織に属していません。
  • 409 — コンフリクト（例: 繰り返しブロックされたためモニターが一時停止している）。
  • 422 — クォータを超過します（例: プランのモニター制限）。JSONボディには current と limit が含まれます。
  • 429 — レート制限（手動チェック）。Retry-After に示された遅延の後に再試行してください。

クォータエラーの例 (422):

{
  "error": "plan_url_limit exceeded",
  "current": 100,
  "limit": 100,
  "message": "Creating this monitor would exceed your plan's monitor limit (100)."
}

エンドポイントリファレンス

メソッド ＆ パス説明
GET /api/monitors組織内のモニターを一覧表示します。
POST /api/monitors単一のモニターを作成します。
GET /api/monitors/{id}単一のモニターを取得します。
PATCH /api/monitors/{id}url, nl_description, filter_prompt, css_selector, xpath_selector, status を更新します。
DELETE /api/monitors/{id}モニターとその履歴を削除します。
POST /api/monitors/{id}/check-nowスケジュールをバイパスして、即時のチェックをキューに入れます（レート制限あり、後述）。
GET /api/monitors/{id}/changesモニターで検出された変更を一覧表示します（?limit= をサポート、最大100）。
POST /api/monitors/importマルチパートCSVアップロード（file フィールド）による一括インポートを行います。
POST /api/monitors/bulk-pause, bulk-resume, bulk-deleteモニターIDのリストに対してアクションを一括適用します。
GET|PUT /api/monitors/{id}/alert-channelsモニターのチャネルオーバーライドを読み取る、または置換します。
GET /api/alert-channels通知チャネルを一覧表示します。
POST /api/alert-channelsチャネルを作成します。
PATCH|DELETE /api/alert-channels/{id}チャネルを更新または削除します。
POST /api/alert-channels/{id}/testテスト用のペイロードを送信して、配信を確認します。
GET|POST /api/sitemap-monitorsサイトマップモニターを一覧表示または作成します。
POST /api/sitemap-monitors/importマルチパートCSVアップロード（file フィールド）によりサイトマップモニターを一括作成します。
GET|POST|DELETE /api/tokensAPIキーを一覧表示、作成、削除します。
GET /api/billing/plan組織の現在のプランと制限を表示します。
GET /api/plans公開用 — 利用可能なプランを一覧表示します（認証不要）。

例 — モニターの作成

curl -X POST https://api.pagedeltas.com/api/monitors \
  -H "Authorization: Bearer $PAGEDELTAS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://example.com/pricing",
    "nl_description": "Competitor pricing; alert on plan or price changes",
    "filter_prompt": "Alert on plan or price changes; ignore copy tweaks",
    "channel_ids": []
  }'

オプションフィールド: filter_prompt, css_selector, xpath_selector, is_pdf, channel_ids（モニターごとのチャネルオーバーライド。組織のデフォルトを使用する場合は省略）。frequency フィールドはありません。スケジューリングは適応的に行われます。

例 — 変更のポーリング

GET /api/monitors/01HW2X.../changes?limit=50
Authorization: Bearer $PAGEDELTAS_TOKEN

最新の変更から順に返されます（デフォルト50、最大100）。カーソルはありません。limit を調整し、すでに確認した最新の detected_at を追跡することでページングを行ってください。

{
  "changes": [
    {
      "id": "01HW3...",
      "detected_at": "2026-06-01T08:42:00Z",
      "summary": "Pro plan increased from $29 to $39/month."
    }
  ]
}

レート制限

現在、読み取りおよび書き込みエンドポイントにはキーごとのレート制限はありません。唯一の例外は手動チェックです:

  • Check-now: 1リクエスト / 分 / モニター。

この制限に達すると、レスポンスは 429 となり、秒単位の Retry-After ヘッダーが返されます。その他のエンドポイントについても、常識的な範囲での利用をお願いします。

バージョニング

このインターフェースは安定性を維持することを目指しています。予告なく新しいフィールドやエンドポイントが追加される可能性があるため、未知のJSONフィールドを無視するようなクライアントを作成してください。

APIリファレンス · ドキュメント · Page Deltas