Deleted Polygon Events

The Deleted Polygon Event API exposes only the polygon events that have been removed from the server’s persistent store.

This lightweight stream allows a client to perform an incremental sync: by consuming the deleted events, the client can delete the corresponding records locally, keeping its view of the vessel‑zone activity in lock‑step with the server without pulling the entire dataset again.

How It Works

• Every time a polygon event is deleted on the server (e.g., a cleanup operation, data correction, or re‑processing), the event is pushed to this endpoint.
• The payload contains the event record that has been removed, including most of the fields that are returned by the Polygon Event API.
• Clients can consume the stream once, store a cursor (or last‑seen timestamp), and resume from that point in subsequent polls to avoid re‑processing the same records.

Key Features

Incremental Sync – Clients receive only the changes that matter (deletions), drastically reducing bandwidth and processing overhead.

Consistent State – By applying deletions exactly as they happen, the client’s local dataset stays in perfect sync with the server.

Low Latency – Polling the deleted‑only stream is lightweight and can be performed frequently (e.g., every 30 min) without impacting overall API throughput.

Simplified Logic – Clients don’t need to maintain a full event store; they only need to delete or update entries based on the received payload.

Auditability – Each deleted record includes the deleted_at timestamp, enabling traceability and rollback if needed.

Integration Checklist

1. Authenticate with your API key/token (the same credentials used for the full Polygon Event API).
2. Poll the endpoint at your chosen interval (e.g., every 30 minutes).
3. Store the latest deleted_at value as a cursor for the next request.
4. Apply deletions to your local data store:
   1. Remove the record identified by event_id.
   2. Optionally, archive the deleted event for audit purposes.
5. Handle Errors: If a request fails, retry after a back‑off period; on repeated failures, log and alert.

What This API Does Not Provide

• Full polygon event data (only deleted events are returned).
• Real‑time live “open” events or incremental additions or updates.
• Historical aggregation or analytics (use the full Polygon Event API for those purposes).

Data Retention

For storage management, data accessed through this API is retained for 12 months only. Any data older than one year will be automatically deleted.

Recommended Usage Pattern

1. Initial Sync – Perform a full pull from the standard Polygon Event API to seed the local store.
2. Continuous Sync – After the initial sync, switch to the Deleted‑Only stream to catch up with any deletions.
3. Periodic Re‑Sync – Every few weeks, perform a full pull again to guard against drift (e.g., missed deletions, client outages).