@gscdump/contracts 3.4.4 → 3.5.0

package/dist/v1/operations.mjs

@@ -2,6 +2,7 @@ import { addPartnerTeamMemberSchema, bindPartnerSiteTeamSchema, bindPartnerTeamC
 import { bingConnectionV1Schemas } from "./bing.mjs";
 import "./version.mjs";
 import { HTTP_V1_ERROR_CODES, defineHttpOperation, defineHttpSurface, defineResponseObject, defineSuccessResponse } from "./http-core.mjs";
+import { bingDataQueryV1Schema, bingDataV1Schemas } from "./bing-data.mjs";
 import { GSCDUMP_REALTIME_ACK_POLICY, GSCDUMP_REALTIME_CLOSE_CODES, GSCDUMP_REALTIME_CONNECTION_POLICY, GSCDUMP_REALTIME_LIMITS, GSCDUMP_REALTIME_PING, GSCDUMP_REALTIME_PONG, GSCDUMP_REALTIME_REPLAY_POLICY, GSCDUMP_REALTIME_SUBPROTOCOL, GSCDUMP_REALTIME_TICKET_AUDIENCE, GSCDUMP_REALTIME_TICKET_ISSUER, GSCDUMP_REALTIME_TICKET_POLICY, GSCDUMP_REALTIME_TICKET_PREFIX, REALTIME_V1_EVENT_SEMANTICS, createRealtimeV1Schemas } from "./realtime.mjs";
 import { GSCDUMP_V1_ANALYTICS_DIMENSIONS, createGscdumpV1BrowserSchemas } from "./browser.mjs";
 import { gscdumpV1OperationRoute, gscdumpV1Surface } from "./route-catalog.mjs";
@@ -1185,6 +1186,83 @@ function createGscdumpV1Protocol() {
 					}
 				}
 			}),
+			getSiteBingData: defineHttpOperation({
+				...gscdumpV1OperationRoute("partner.sites.bing.data.get"),
+				visibility: "public",
+				semantics: {
+					kind: "query",
+					sideEffects: "none",
+					idempotent: true,
+					retry: "idempotent",
+					readConsistency: "primary"
+				},
+				auth: {
+					credentials: ["user_key", "partner_key"],
+					scopes: ["analytics:read"],
+					ownership: [{
+						credential: "user_key",
+						rule: "authorized_site"
+					}, {
+						credential: "partner_key",
+						rule: "authorized_site"
+					}]
+				},
+				request: {
+					params: z.strictObject({ siteId: realtimeSchemas.publicSiteId }),
+					query: bingDataQueryV1Schema,
+					headers: requestHeaders,
+					body: null
+				},
+				responses: { 200: defineSuccessResponse(bingDataV1Schemas, partnerResponseMeta) },
+				errors: partnerSiteErrors,
+				errorResponse: errorEnvelopeSchemas(partnerSiteErrors, realtimeSchemas.publicRequestId),
+				resources: {
+					reads: [{
+						type: "site.analytics",
+						idFrom: "params.siteId"
+					}],
+					changes: []
+				},
+				lifecycle: { introduced: "1.6.0" },
+				docs: {
+					summary: "Read Bing search data",
+					description: "Reads a bounded provider-date range from the latest successful dataset. Ranked rows are not complete Site totals.",
+					tags: ["Analytics"],
+					examples: {
+						request: {
+							params: { siteId: "s_01" },
+							query: {
+								dataset: "traffic",
+								startDate: "2026-08-01",
+								endDate: "2026-08-31",
+								limit: 100,
+								offset: 0
+							}
+						},
+						response: {
+							data: {
+								searchEngine: "bing",
+								siteUrl: "https://example.com/",
+								dataset: "traffic",
+								semantics: "site-totals",
+								sync: { _tag: "missing" },
+								rows: [],
+								pagination: {
+									total: 0,
+									limit: 100,
+									offset: 0,
+									hasMore: false
+								}
+							},
+							meta: {
+								requestId: "req_01",
+								surface: "partner",
+								version: "1.0"
+							}
+						}
+					}
+				}
+			}),
 			listSiteBingIndexingEvidence: defineHttpOperation({
 				...gscdumpV1OperationRoute("partner.sites.indexing.bing.evidence.list"),
 				visibility: "public",

package/dist/v1/route-catalog.d.mts

@@ -51,6 +51,11 @@ declare const GSCDUMP_V1_ROUTE_CATALOG: {
       readonly method: "GET";
       readonly template: "/sites/{siteId}/indexing/urls";
     };
+    readonly 'partner.sites.bing.data.get': {
+      readonly surface: "partner";
+      readonly method: "GET";
+      readonly template: "/sites/{siteId}/bing/data";
+    };
     readonly 'partner.sites.indexing.bing.evidence.list': {
       readonly surface: "partner";
       readonly method: "GET";

package/dist/v1/route-catalog.mjs

@@ -38,6 +38,11 @@ const GSCDUMP_V1_ROUTE_CATALOG = {
 			method: "GET",
 			template: "/sites/{siteId}/indexing/urls"
 		},
+		"partner.sites.bing.data.get": {
+			surface: "partner",
+			method: "GET",
+			template: "/sites/{siteId}/bing/data"
+		},
 		"partner.sites.indexing.bing.evidence.list": {
 			surface: "partner",
 			method: "GET",

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@gscdump/contracts",
   "type": "module",
-  "version": "3.4.4",
+  "version": "3.5.0",
   "description": "Shared gscdump.com API, webhook, realtime, and lifecycle contracts.",
   "author": {
     "name": "Harlan Wilton",