@adcp/sdk API Reference - v10.0.1
    Preparing search index...

    Interface FeedHeartbeat

    heartbeat event payload. Emitted while caught up; does not advance the cursor.

    interface FeedHeartbeat {
        generated_at: string;
        cursor: string | null;
        freshness?: {
            generated_at: string;
            latest_event_created_at: string | null;
            lag_seconds: number | null;
            retention_days: number;
        };
    }
    Index

    Properties

    generated_at cursor freshness?

    Properties

    generated_at: string
    cursor: string | null
    freshness?: {
        generated_at: string;
        latest_event_created_at: string | null;
        lag_seconds: number | null;
        retention_days: number;
    }

    Type Declaration

    • generated_at: string

      Format: date-time

      Server timestamp when this feed page was generated.

    • latest_event_created_at: string | null

      Format: date-time

      Newest event creation timestamp currently visible in the feed for the requested type filter. Null when no matching event exists inside retention.

    • lag_seconds: number | null

      Seconds between generated_at and latest_event_created_at. Null when no matching event exists.

    • retention_days: number

      Number of days the registry retains feed cursors and events.

    Settings

    Member Visibility

    On This Page

    Properties