API-referens

Ett litet, stabilt REST-API för att hantera bevakningar och kanaler samt hämta ändringar. Samma omfattning som instrumentpanelen.

Bas-URL

Produktion: https://api.pagedeltas.com. Alla slutpunkter har prefixet /api. Lyckade svar är JSON.

Autentisering

Skapa en nyckel från Settings → API keys (redigerar- eller administratörsroll krävs). Nyckeln visas en gång vid skapandet — kopiera den omedelbart. För att återkalla en nyckel tar du bort den från samma sida.

Authorization: Bearer pdt_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Nycklar är begränsade till den organisation som skapade dem och agerar med administratörsåtkomst inom den organisationen, oberoende av någon användare. De är inte knutna till en medlem, så att ta bort en kollega återkallar inte organisationens nycklar — ta bort själva nyckeln för att stänga av åtkomst.

Fel

Fel returnerar en status som inte är 2xx. Autentiserings- och behörighetsfel kommer tillbaka som ett kort meddelande i klartext (t.ex. unauthorized, forbidden); kvot- och hastighetsbegränsningsfel returnerar en liten JSON-body med ett meddelande och de relevanta talen. Tolka inte ett fast felkuvert — förgrena dig på HTTP-statuskoden:

400 — felformad förfrågan (felaktig JSON, ogiltig URL, fält saknas).
401 — saknade eller ogiltiga autentiseringsuppgifter.
403 — autentiserad men din roll saknar behörighet för denna åtgärd.
404 — resursen saknas eller finns inte i din organisation.
409 — konflikt (t.ex. bevakningen är pausad på grund av upprepade blockeringar).
422 — en kvot skulle överskridas (t.ex. ditt abonnemangs gräns för antal bevakningar). JSON-body:n innehåller current och limit.
429 — hastighetsbegränsad (manuella kontroller). Backa av och försök igen efter fördröjningen i Retry-After.

Exempel på kvotfel (422):

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

Slutpunktsreferens

Metod och sökväg	Beskrivning
`GET /api/monitors`	Lista bevakningar i din organisation.
`POST /api/monitors`	Skapa en enskild bevakning.
`GET /api/monitors/{id}`	Hämta en enskild bevakning.
`PATCH /api/monitors/{id}`	Uppdatera `url`, `nl_description`, `filter_prompt`, `css_selector`, `xpath_selector`, `status`.
`DELETE /api/monitors/{id}`	Ta bort en bevakning och dess historik.
`POST /api/monitors/{id}/check-now`	Köa en omedelbar kontroll och kringgå schemat (hastighetsbegränsad, se nedan).
`GET /api/monitors/{id}/changes`	Lista upptäckta ändringar för en bevakning (stöder `?limit=`, max 100).
`POST /api/monitors/import`	Massimport via CSV-uppladdning som multipart (`file`-fält).
`POST /api/monitors/bulk-pause`, `bulk-resume`, `bulk-delete`	Tillämpa en åtgärd på en lista med bevaknings-id:n.
`GET\|PUT /api/monitors/{id}/alert-channels`	Läs eller ersätt en bevaknings kanalåsidosättningar.
`GET /api/alert-channels`	Lista aviseringskanaler.
`POST /api/alert-channels`	Skapa en kanal.
`PATCH\|DELETE /api/alert-channels/{id}`	Uppdatera eller ta bort en kanal.
`POST /api/alert-channels/{id}/test`	Skicka en testnyttolast för att verifiera leverans.
`GET\|POST /api/sitemap-monitors`	Lista eller skapa sitemap-bevakningar.
`POST /api/sitemap-monitors/import`	Massa-skapa sitemap-bevakningar via CSV-uppladdning som multipart (`file`-fält).
`GET\|POST\|DELETE /api/tokens`	Lista, skapa och ta bort API-nycklar.
`GET /api/billing/plan`	Din organisations nuvarande abonnemang och gränser.
`GET /api/plans`	Offentlig — lista tillgängliga abonnemang (ingen autentisering krävs).

Exempel — skapa en bevakning

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": []
  }'

Valfria fält: filter_prompt, css_selector, xpath_selector, is_pdf och channel_ids (kanalåsidosättningar per bevakning; utelämna för att använda organisationens standardvärden). Det finns ingen frequency — schemaläggningen är adaptiv.

Exempel — hämta ändringar

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

Returnerar de senaste ändringarna först (standard 50, max 100). Det finns ingen markör — bläddra genom att justera limit och hålla reda på det senaste detected_at du redan har sett.

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

Hastighetsbegränsningar

Det finns för närvarande inga hastighetsbegränsningar per nyckel på läs- och skrivslutpunkterna. Det enda undantaget är manuella kontroller:

Check-now: 1 förfrågan / minut / bevakning.

När du når den gränsen är svaret 429 med en Retry-After-header i sekunder. Begränsa dig ändå förnuftigt på de andra slutpunkterna.

Versionshantering

Vi strävar efter att hålla denna yta stabil. Nya fält och slutpunkter kan läggas till utan förvarning, så skriv klienter som ignorerar okända JSON-fält.