@passband/sdk - v0.0.0
    Preparing search index...

    Class EngagementResource

    Engagement resource — GET/POST /engagement.

    Index

    Constructors

    Methods

    Constructors

    Methods

    • Engagement summary with top posts and per-format/platform breakdowns. GET /engagement returns a single summary object (not a list), so this is named summary rather than list.

      Parameters

      Returns Promise<
          {
              avgEngagementRate?: number
              | null;
              byFormat?: {
                  avgEngagementRate?: number | null;
                  count?: number;
                  format?: string;
              }[];
              byPlatform?: {
                  avgEngagementRate?: number
                  | null;
                  count?: number;
                  platform?: string;
              }[];
              topPosts?: {
                  draftId?: string;
                  draftText?: string;
                  engagementRate?: number
                  | null;
                  format?: string;
                  impressions?: number;
                  likes?: number;
                  platform?: string;
                  postedAt?: string | null;
                  replies?: number;
                  reposts?: number;
              }[];
              totalImpressions?: number;
              totalLikes?: number;
              totalPosted?: number;
              totalReplies?: number;
              totalReposts?: number;
              totalWithMetrics?: number;
          },
      >

    • Record or update engagement metrics for a draft. POST /engagement

      Parameters

      • body: {
            clicks?: number;
            draftId: string;
            errorMessage?: string;
            impressions?: number;
            likes?: number;
            platform: string;
            postId?: string;
            replies?: number;
            reposts?: number;
            status?: "posted" | "pending" | "failed" | "abandoned";
        }

      Returns Promise<
          {
              clicks?: number;
              createdAt?: string;
              draftId?: string;
              engagementRate?: number
              | null;
              errorMessage?: string | null;
              failedAt?: string | null;
              id?: string;
              impressions?: number;
              likes?: number;
              measuredAt?: string;
              platform?: string;
              postId?: string | null;
              replies?: number;
              reposts?: number;
              retryAfter?: string | null;
              retryCount?: number;
              status?: "posted" | "pending" | "failed" | "abandoned";
          },
      >