@graph8/sdk 0.245.0 → 0.260.0

package/docs/api/marketingIntelligence.d.ts

@@ -0,0 +1,256 @@
+/* Generated by sdk/js/scripts/generate-agent-docs.ts from developer-contract/openapi.json. Regenerated on every build. */
+
+/**
+ * Types for `g8.api.marketingIntelligence` (Marketing Intelligence): 10 operations.
+ *
+ * For reading. In code, import from the package instead:
+ *   import type { ApiInput, ApiOutput, G8Contract } from "@graph8/sdk";
+ *   type In = ApiInput<"get_campaigns_with_attribution_analytics_marketing_campaigns_get">;
+ *
+ * Reference with examples: marketingIntelligence.md
+ */
+/* eslint-disable */
+
+/** `g8.api.marketingIntelligence.<member>` -> the operationId it calls. */
+export interface MarketingIntelligenceMembers {
+  getCampaignsWithAttribution: "get_campaigns_with_attribution_analytics_marketing_campaigns_get";
+  getContentWithAttribution: "get_content_with_attribution_analytics_marketing_content_get";
+  getLandingPagesWithAttribution: "get_landing_pages_with_attribution_analytics_marketing_content_by_landing_get";
+  getMarketingOverview: "get_marketing_overview_analytics_marketing_overview_get";
+  getOutboundBridgeByCampaign: "get_outbound_bridge_by_campaign_analytics_marketing_outbound_bridge_by_campaign_get";
+  getOutboundBridgeByChannel: "get_outbound_bridge_by_channel_analytics_marketing_outbound_bridge_by_channel_get";
+  getOutboundBridgeByLandingPage: "get_outbound_bridge_by_landing_page_analytics_marketing_outbound_bridge_by_landing_page_get";
+  getOutboundBridgeOverview: "get_outbound_bridge_overview_analytics_marketing_outbound_bridge_get";
+  getOutboundBridgeTrend: "get_outbound_bridge_trend_analytics_marketing_outbound_bridge_trend_get";
+  getTopPerformingSources: "get_top_performing_sources_analytics_marketing_outbound_bridge_top_sources_get";
+}
+
+/** Input and output of every `g8.api.marketingIntelligence` operation, keyed by operationId. */
+export interface MarketingIntelligenceOperations {
+  /**
+   * GET /analytics/marketing/campaigns
+   * Get Campaigns With Attribution
+   * tier: read · scope: analytics:read
+   */
+  get_campaigns_with_attribution_analytics_marketing_campaigns_get: {
+    input: {
+    query?: {
+      /** Number of days to analyze */
+      days?: number;
+      /** Number of campaigns to return */
+      limit?: number;
+      /** Sort by this metric (descending) */
+      sort_by?: "visitors" | "meetings_booked" | "reply_rate" | "engaged_pct";
+      /** Comma-separated public keys to filter by */
+      write_key?: string | null;
+    };
+    headers?: {
+      "X-Org-Id"?: string | null;
+    };
+  };
+    output: MarketingResponse;
+  };
+  /**
+   * GET /analytics/marketing/content
+   * Get Content With Attribution
+   * tier: read · scope: analytics:read
+   */
+  get_content_with_attribution_analytics_marketing_content_get: {
+    input: {
+    query?: {
+      /** Number of days to analyze */
+      days?: number;
+      /** Number of pages to return */
+      limit?: number;
+      /** Sort by this metric (descending) */
+      sort_by?: "views" | "meetings_booked" | "reply_rate" | "unique_visitors";
+      /** Comma-separated public keys to filter by */
+      write_key?: string | null;
+    };
+    headers?: {
+      "X-Org-Id"?: string | null;
+    };
+  };
+    output: MarketingResponse;
+  };
+  /**
+   * GET /analytics/marketing/content/by-landing
+   * Get Landing Pages With Attribution
+   * tier: read · scope: analytics:read
+   */
+  get_landing_pages_with_attribution_analytics_marketing_content_by_landing_get: {
+    input: {
+    query?: {
+      /** Number of days to analyze */
+      days?: number;
+      /** Number of pages to return */
+      limit?: number;
+      /** Comma-separated public keys to filter by */
+      write_key?: string | null;
+    };
+    headers?: {
+      "X-Org-Id"?: string | null;
+    };
+  };
+    output: MarketingResponse;
+  };
+  /**
+   * GET /analytics/marketing/overview
+   * Get Marketing Overview
+   * tier: read · scope: analytics:read
+   */
+  get_marketing_overview_analytics_marketing_overview_get: {
+    input: {
+    query?: {
+      /** Number of days to analyze */
+      days?: number;
+      /** Comma-separated public keys to filter by */
+      write_key?: string | null;
+    };
+    headers?: {
+      "X-Org-Id"?: string | null;
+    };
+  };
+    output: MarketingResponse;
+  };
+  /**
+   * GET /analytics/marketing/outbound-bridge/by-campaign
+   * Get Outbound Bridge By Campaign
+   * tier: read · scope: analytics:read
+   */
+  get_outbound_bridge_by_campaign_analytics_marketing_outbound_bridge_by_campaign_get: {
+    input: {
+    query?: {
+      /** Number of days to analyze */
+      days?: number;
+      /** Number of campaigns to return */
+      limit?: number;
+      /** Comma-separated public keys to filter by */
+      write_key?: string | null;
+    };
+    headers?: {
+      "X-Org-Id"?: string | null;
+    };
+  };
+    output: MarketingResponse;
+  };
+  /**
+   * GET /analytics/marketing/outbound-bridge/by-channel
+   * Get Outbound Bridge By Channel
+   * tier: read · scope: analytics:read
+   */
+  get_outbound_bridge_by_channel_analytics_marketing_outbound_bridge_by_channel_get: {
+    input: {
+    query?: {
+      /** Number of days to analyze */
+      days?: number;
+      /** Comma-separated public keys to filter by */
+      write_key?: string | null;
+    };
+    headers?: {
+      "X-Org-Id"?: string | null;
+    };
+  };
+    output: MarketingResponse;
+  };
+  /**
+   * GET /analytics/marketing/outbound-bridge/by-landing-page
+   * Get Outbound Bridge By Landing Page
+   * tier: read · scope: analytics:read
+   */
+  get_outbound_bridge_by_landing_page_analytics_marketing_outbound_bridge_by_landing_page_get: {
+    input: {
+    query?: {
+      /** Number of days to analyze */
+      days?: number;
+      /** Number of pages to return */
+      limit?: number;
+      /** Comma-separated public keys to filter by */
+      write_key?: string | null;
+    };
+    headers?: {
+      "X-Org-Id"?: string | null;
+    };
+  };
+    output: MarketingResponse;
+  };
+  /**
+   * GET /analytics/marketing/outbound-bridge
+   * Get Outbound Bridge Overview
+   * tier: read · scope: analytics:read
+   */
+  get_outbound_bridge_overview_analytics_marketing_outbound_bridge_get: {
+    input: {
+    query?: {
+      /** Number of days to analyze */
+      days?: number;
+      /** Comma-separated public keys to filter by */
+      write_key?: string | null;
+    };
+    headers?: {
+      "X-Org-Id"?: string | null;
+    };
+  };
+    output: MarketingResponse;
+  };
+  /**
+   * GET /analytics/marketing/outbound-bridge/trend
+   * Get Outbound Bridge Trend
+   * tier: read · scope: analytics:read
+   */
+  get_outbound_bridge_trend_analytics_marketing_outbound_bridge_trend_get: {
+    input: {
+    query?: {
+      /** Number of days to analyze */
+      days?: number;
+      /** Comma-separated public keys to filter by */
+      write_key?: string | null;
+    };
+    headers?: {
+      "X-Org-Id"?: string | null;
+    };
+  };
+    output: MarketingResponse;
+  };
+  /**
+   * GET /analytics/marketing/outbound-bridge/top-sources
+   * Get Top Performing Sources
+   * tier: read · scope: analytics:read
+   */
+  get_top_performing_sources_analytics_marketing_outbound_bridge_top_sources_get: {
+    input: {
+    query?: {
+      /** Number of days to analyze */
+      days?: number;
+      /** Number of sources to return */
+      limit?: number;
+      /** Comma-separated public keys to filter by */
+      write_key?: string | null;
+    };
+    headers?: {
+      "X-Org-Id"?: string | null;
+    };
+  };
+    output: MarketingResponse;
+  };
+}
+
+// 2 schemas referenced above (the same as G8Contract.<Name>).
+
+/** Metadata for marketing analytics responses. */
+export interface MarketingMeta {
+  cache_ttl?: number;
+  cached: boolean;
+  days: number;
+  org_id: string;
+  query_time_ms?: number | null;
+  stale?: boolean;
+  timestamp: string;
+}
+
+/** Standard marketing analytics response wrapper. */
+export interface MarketingResponse {
+  data: Record<string, unknown> | Array<unknown>;
+  meta: MarketingMeta;
+  success?: boolean;
+}