API-referanse

Et lite, stabilt REST-API for å administrere overvåkere og kanaler og hente endringer ved polling. Samme omfang som dashbordet.

Base-URL

Produksjon: https://api.pagedeltas.com. Alle endepunkter er prefikset med /api. Vellykkede svar er JSON.

Autentisering

Opprett en nøkkel fra Settings → API keys (redaktør- eller administratorrolle kreves). Nøkkelen vises kun én gang ved opprettelse — kopier den umiddelbart. For å oppheve en nøkkel sletter du den fra samme side.

Authorization: Bearer pdt_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Nøkler er begrenset til organisasjonen som opprettet dem, og handler med administratornivå-tilgang innenfor den organisasjonen, uavhengig av enhver bruker. De er ikke knyttet til et medlem, så å fjerne et teammedlem opphever ikke organisasjonens nøkler — slett nøkkelen selv for å kutte tilgangen.

Feil

Feil returnerer en ikke-2xx-status. Autentiserings- og tillatelsesfeil kommer tilbake som en kort ren tekstmelding (f.eks. unauthorized, forbidden); kvote- og hastighetsbegrensningsfeil returnerer en liten JSON-body med en melding og de relevante tallene. Ikke pars en fast feilstruktur — forgren på HTTP-statuskoden:

  • 400 — feilformatert forespørsel (ugyldig JSON, ugyldig URL, manglende felt).
  • 401 — manglende eller ugyldig legitimasjon.
  • 403 — autentisert, men rollen din mangler tillatelse for denne handlingen.
  • 404 — ressursen mangler eller er ikke i organisasjonen din.
  • 409 — konflikt (f.eks. overvåkeren er pauset på grunn av gjentatte blokkeringer).
  • 422 — en kvote ville bli overskredet (f.eks. abonnementets grense for overvåkere). JSON-body-en inkluderer current og limit.
  • 429 — hastighetsbegrenset (manuelle kontroller). Trekk deg tilbake og prøv på nytt etter forsinkelsen i Retry-After.

Eksempel på kvotefeil (422):

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

Endepunktreferanse

Metode og stiBeskrivelse
GET /api/monitorsList opp overvåkere i organisasjonen din.
POST /api/monitorsOpprett én enkelt overvåker.
GET /api/monitors/{id}Hent én enkelt overvåker.
PATCH /api/monitors/{id}Oppdater url, nl_description, filter_prompt, css_selector, xpath_selector, status.
DELETE /api/monitors/{id}Slett en overvåker og dens historikk.
POST /api/monitors/{id}/check-nowSett en umiddelbar kontroll i kø, og omgå planen (hastighetsbegrenset, se nedenfor).
GET /api/monitors/{id}/changesList opp oppdagede endringer for en overvåker (støtter ?limit=, maks 100).
POST /api/monitors/importMasseimport via multipart CSV-opplasting (file-felt).
POST /api/monitors/bulk-pause, bulk-resume, bulk-deleteBruk en handling på en liste med overvåker-ID-er.
GET|PUT /api/monitors/{id}/alert-channelsLes eller erstatt en overvåkers kanaloverstyringer.
GET /api/alert-channelsList opp varslingskanaler.
POST /api/alert-channelsOpprett en kanal.
PATCH|DELETE /api/alert-channels/{id}Oppdater eller slett en kanal.
POST /api/alert-channels/{id}/testSend en testnyttelast for å verifisere levering.
GET|POST /api/sitemap-monitorsList opp eller opprett sitemap-overvåkere.
POST /api/sitemap-monitors/importMasseopprett sitemap-overvåkere via multipart CSV-opplasting (file-felt).
GET|POST|DELETE /api/tokensList opp, opprett og slett API-nøkler.
GET /api/billing/planOrganisasjonens nåværende abonnement og grenser.
GET /api/plansOffentlig — list opp tilgjengelige abonnementer (ingen autentisering kreves).

Eksempel — opprett en overvåker

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

Valgfrie felt: filter_prompt, css_selector, xpath_selector, is_pdf og channel_ids (kanaloverstyringer per overvåker; utelat for å bruke organisasjonens standardverdier). Det finnes ingen frequency — planlegging er adaptiv.

Eksempel — hent endringer ved polling

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

Returnerer de nyeste endringene først (standard 50, maks 100). Det finnes ingen markør — bla ved å justere limit og spore den siste detected_at du allerede har sett.

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

Hastighetsbegrensninger

Det finnes for øyeblikket ingen hastighetsbegrensninger per nøkkel på lese- og skriveendepunktene. Det ene unntaket er manuelle kontroller:

  • Check-now: 1 forespørsel / minutt / overvåker.

Når du når den grensen, er svaret 429 med en Retry-After-header i sekunder. Vennligst begrens deg selv fornuftig på de andre endepunktene likevel.

Versjonering

Vi tar sikte på å holde dette omfanget stabilt. Nye felt og endepunkter kan legges til uten varsel, så skriv klienter som ignorerer ukjente JSON-felt.

API-referanse · Dokumentasjon · Page Deltas