@zinn-digital/sdk 0.1.1413 → 0.1.1415

package/dist/generated/schema.d.ts

@@ -1566,6 +1566,26 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/v1/admin/acquisition/ad-sources": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Paid ad sources — sign-ups, trials, paid customers and MRR by source, campaign and placement.
+         * @description BHWTRACK (docs/21 §1a). One row per `utm_source` / `utm_medium` / `utm_campaign` / `utm_content` of each account's `touch` (`last` by default: the campaign that brought the account back to sign up; `first`: what introduced it), plus per-source totals. Sign-ups are root customer accounts created in the window; trials are trials started in the window; `paid` is accounts whose FIRST paid invoice (not refunded) fell in the window; `new_mrr_usd_minor` is the monthly-normalised recurring revenue of accounts that became paying in the window (a plan change of an existing customer is not new); `current_mrr_usd_minor` is read from the latest month-end snapshot (`mrr_month`). Money is integer USD minor units; rates are basis points. A configured source's link with no `utm_content` is credited to its default placement (`configured`). A touch with no `utm_source` is `(not tagged)`. Our own and test organisations are left out unless `include_tests=1`. Requires staff + `analytics.view`.
+         */
+        get: operations["getAdminAcquisitionAdSources"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/v1/admin/actors": {
         parameters: {
             query?: never;
@@ -56227,6 +56247,10 @@ export interface components {
             until: string;
         };
         AcquisitionTouchRequest: {
+            /** @description The campaign the visitor landed with most recently (the marketing edge's zinn_camp slot: the UTM parameters and landing_page), sent when it differs from `touch`. `touch` can still become the first touch; this becomes the last touch. Same kept keys as `touch`. */
+            latest?: {
+                [key: string]: string;
+            };
             /**
              * Format: uuid
              * @description The org to record against; optional when the caller owns exactly one.
@@ -64363,6 +64387,73 @@ export interface components {
             organic_weak_position?: number;
             site?: string;
         };
+        AdSourcesMeasures: {
+            /** Format: int64 */
+            current_mrr_usd_minor: number;
+            /** Format: int64 */
+            new_mrr_usd_minor: number;
+            paid: number;
+            paying_accounts: number;
+            signups: number;
+            trials: number;
+        };
+        AdSourcesReport: {
+            configured: {
+                default_content: string;
+                label: string;
+                source: string;
+            }[];
+            /** @enum {string} */
+            currency: "USD";
+            include_tests: boolean;
+            /** Format: date */
+            mrr_month: string | null;
+            rows: components["schemas"]["AdSourcesRow"][];
+            /** Format: date */
+            since: string;
+            sources: components["schemas"]["AdSourcesSource"][];
+            totals: components["schemas"]["AdSourcesMeasures"];
+            /** @enum {string} */
+            touch: "first" | "last";
+            /** @description Sign-ups in the window with no recorded touch at all. */
+            unattributed_signups: number;
+            /** Format: date */
+            until: string;
+        };
+        AdSourcesRow: {
+            campaign: string;
+            content: string;
+            /** @description The configured name of the placement */
+            content_label: string;
+            /** Format: int64 */
+            current_mrr_usd_minor: number;
+            medium: string;
+            /** Format: int64 */
+            new_mrr_usd_minor: number;
+            paid: number;
+            paying_accounts: number;
+            signup_to_paid_bp: number;
+            signups: number;
+            source: string;
+            source_label: string;
+            trial_to_paid_bp: number;
+            trials: number;
+        };
+        AdSourcesSource: {
+            /** Format: int64 */
+            current_mrr_usd_minor: number;
+            /** Format: int64 */
+            new_mrr_usd_minor: number;
+            paid: number;
+            paying_accounts: number;
+            signup_to_paid_bp: number;
+            signups: number;
+            source: string;
+            /** @description The configured display name */
+            source_label: string;
+            trial_to_paid_bp: number;
+            trials: number;
+        };
         AdsOutcome: {
             /** @description Masked to a prefix. */
             click_id: string;
@@ -108170,6 +108261,8 @@ export interface components {
              * @description The product-specific payload — the engine answers and mention rate for `ai_visibility`, the per-platform ratings for `reputation`, the crawl totals for `onpage`. For `onpage`, `crawl_truncated` says whether the crawl stopped at its page budget: "no issues found" after crawling 100 of 40,000 pages is not a clean site.
              *
              *     For `rank`, every run carries its **complete** `keywords` array — each phrase, its position, and both AI-citation readings — so a client can chart the history from the audit list without a second call. Each row also carries `ai_overview_change` and `ai_mode_change`: `"lost"`, `"gained"`, or `null`. ⛔ `null` is *"no comparison could be made"* — the surface was absent from one of the two runs, or the citation could not be read — and is **not** "unchanged". The run totals `ai_overview_citations_lost` / `_gained` and `ai_mode_citations_lost` / `_gained` count those transitions in both directions, per surface. A transition is what raises `visibility.ai_citation.lost` / `.gained` and is the only thing that notifies a customer; the `rank_ai_overview_missing` / `rank_ai_mode_missing` findings are the corresponding **states**, true on every run until they change.
+             *
+             *     For `ai_visibility`, each `answers[]` row says whether the target was **found** as well as **cited**: `found` is `true` when the target's site was among the pages the engine's web search returned (`found_url` is that page, `found_count` how many pages the search returned), `false` when the engine searched and the site was absent, and `null` when the engine did not search, which means unknown, not "not found". `found: true` with `linked: false` is *found but not cited*; `competitors` are the domains cited instead. Each `cited_<engine>` finding's detail counts `found_not_cited`.
              */
             summary?: {
                 [key: string]: unknown;
@@ -112822,6 +112915,36 @@ export interface operations {
             422: components["responses"]["UnprocessableEntity"];
         };
     };
+    getAdminAcquisitionAdSources: {
+        parameters: {
+            query?: {
+                include_tests?: "1" | "true" | "";
+                since?: string;
+                /** @description Only this `utm_source` (case-insensitive). */
+                source?: string;
+                touch?: "first" | "last";
+                until?: string;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Per-source totals and the full source / campaign / content table for one window. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AdSourcesReport"];
+                };
+            };
+            401: components["responses"]["Unauthorized"];
+            403: components["responses"]["Forbidden"];
+            422: components["responses"]["UnprocessableEntity"];
+        };
+    };
     resolveAdminActors: {
         parameters: {
             query?: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zinn-digital/sdk",
-  "version": "0.1.1413",
+  "version": "0.1.1415",
   "description": "Typed TypeScript client for the Zinn Digital Platform API, generated from its OpenAPI spec.",
   "license": "MIT",
   "author": "Neil Lock \u2014 CEO, Zinn Digital\u00ae Ltd <office@zinndigital.com>",