@gscdump/contracts 1.0.3 → 1.0.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -5723,6 +5723,997 @@ declare function createGscdumpV1Protocol(): {
5723
5723
  };
5724
5724
  };
5725
5725
  };
5726
+ readonly getCanonicalMismatches: {
5727
+ readonly id: "partner.sites.canonical.mismatches.get";
5728
+ readonly method: "GET";
5729
+ readonly path: "/sites/{siteId}/canonical-mismatches";
5730
+ readonly visibility: "public";
5731
+ readonly semantics: {
5732
+ readonly kind: "query";
5733
+ readonly sideEffects: "none";
5734
+ readonly idempotent: true;
5735
+ readonly retry: "idempotent";
5736
+ readonly readConsistency: "primary";
5737
+ };
5738
+ readonly auth: {
5739
+ readonly credentials: readonly ["user_key", "partner_key"];
5740
+ readonly scopes: readonly ["indexing:read"];
5741
+ readonly ownership: readonly [{
5742
+ readonly credential: "user_key";
5743
+ readonly rule: "authorized_site";
5744
+ }, {
5745
+ readonly credential: "partner_key";
5746
+ readonly rule: "authorized_site";
5747
+ }];
5748
+ };
5749
+ readonly request: {
5750
+ readonly params: z.ZodObject<{
5751
+ siteId: z.ZodString;
5752
+ }, z.core.$strict>;
5753
+ readonly query: null;
5754
+ readonly headers: z.ZodObject<{
5755
+ 'x-request-id': z.ZodOptional<z.ZodString>;
5756
+ }, z.core.$strict>;
5757
+ readonly body: null;
5758
+ };
5759
+ readonly responses: {
5760
+ readonly 200: CompatibleResponseSchema<z.ZodObject<{
5761
+ data: z.ZodObject<{
5762
+ mismatches: z.ZodArray<z.ZodObject<{
5763
+ url: z.ZodString;
5764
+ userCanonical: z.ZodString;
5765
+ googleCanonical: z.ZodString;
5766
+ verdict: z.ZodNullable<z.ZodString>;
5767
+ coverageState: z.ZodNullable<z.ZodString>;
5768
+ lastCrawlTime: z.ZodNullable<z.ZodString>;
5769
+ lastCheckedAt: z.ZodNullable<z.ZodString>;
5770
+ }, z.core.$loose>>;
5771
+ totalCount: z.ZodNumber;
5772
+ consolidationTargets: z.ZodArray<z.ZodObject<{
5773
+ google_canonical: z.ZodString;
5774
+ count: z.ZodNumber;
5775
+ }, z.core.$loose>>;
5776
+ trend: z.ZodArray<z.ZodObject<{
5777
+ date: z.ZodString;
5778
+ count: z.ZodNumber;
5779
+ }, z.core.$loose>>;
5780
+ meta: z.ZodObject<{
5781
+ siteUrl: z.ZodString;
5782
+ syncStatus: z.ZodNullable<z.ZodString>;
5783
+ }, z.core.$loose>;
5784
+ }, z.core.$strip>;
5785
+ meta: z.ZodObject<{
5786
+ readonly requestId: z.ZodString;
5787
+ readonly surface: z.ZodLiteral<"partner">;
5788
+ readonly version: z.ZodLiteral<"1.0">;
5789
+ }, z.core.$strip>;
5790
+ }, z.core.$strip>, z.ZodObject<{
5791
+ data: z.ZodObject<{
5792
+ mismatches: z.ZodArray<z.ZodObject<{
5793
+ url: z.ZodString;
5794
+ userCanonical: z.ZodString;
5795
+ googleCanonical: z.ZodString;
5796
+ verdict: z.ZodNullable<z.ZodString>;
5797
+ coverageState: z.ZodNullable<z.ZodString>;
5798
+ lastCrawlTime: z.ZodNullable<z.ZodString>;
5799
+ lastCheckedAt: z.ZodNullable<z.ZodString>;
5800
+ }, z.core.$loose>>;
5801
+ totalCount: z.ZodNumber;
5802
+ consolidationTargets: z.ZodArray<z.ZodObject<{
5803
+ google_canonical: z.ZodString;
5804
+ count: z.ZodNumber;
5805
+ }, z.core.$loose>>;
5806
+ trend: z.ZodArray<z.ZodObject<{
5807
+ date: z.ZodString;
5808
+ count: z.ZodNumber;
5809
+ }, z.core.$loose>>;
5810
+ meta: z.ZodObject<{
5811
+ siteUrl: z.ZodString;
5812
+ syncStatus: z.ZodNullable<z.ZodString>;
5813
+ }, z.core.$loose>;
5814
+ }, z.core.$strip>;
5815
+ meta: z.ZodObject<{
5816
+ readonly requestId: z.ZodString;
5817
+ readonly surface: z.ZodLiteral<"partner">;
5818
+ readonly version: z.ZodLiteral<"1.0">;
5819
+ }, z.core.$strip>;
5820
+ }, z.core.$strip>>;
5821
+ };
5822
+ readonly errors: readonly ["invalid_request", "unauthorized", "forbidden", "site_not_found", "rate_limited", "internal_error", "contract_violation"];
5823
+ readonly errorResponse: CompatibleResponseSchema<z.ZodObject<{
5824
+ readonly error: z.ZodObject<{
5825
+ code: z.ZodEnum<{
5826
+ internal_error: "internal_error";
5827
+ invalid_request: "invalid_request";
5828
+ unauthorized: "unauthorized";
5829
+ forbidden: "forbidden";
5830
+ site_not_found: "site_not_found";
5831
+ rate_limited: "rate_limited";
5832
+ contract_violation: "contract_violation";
5833
+ }>;
5834
+ message: z.ZodString;
5835
+ requestId: z.ZodString;
5836
+ retryable: z.ZodBoolean;
5837
+ details: z.ZodRecord<z.ZodString, z.ZodJSONSchema>;
5838
+ }, z.core.$strict>;
5839
+ }, z.core.$strip>, z.ZodObject<{
5840
+ readonly error: z.ZodObject<{
5841
+ code: z.ZodEnum<{
5842
+ internal_error: "internal_error";
5843
+ invalid_request: "invalid_request";
5844
+ unauthorized: "unauthorized";
5845
+ forbidden: "forbidden";
5846
+ site_not_found: "site_not_found";
5847
+ rate_limited: "rate_limited";
5848
+ contract_violation: "contract_violation";
5849
+ }>;
5850
+ message: z.ZodString;
5851
+ requestId: z.ZodString;
5852
+ retryable: z.ZodBoolean;
5853
+ details: z.ZodRecord<z.ZodString, z.ZodJSONSchema>;
5854
+ }, z.core.$loose>;
5855
+ }, z.core.$strip>>;
5856
+ readonly resources: {
5857
+ readonly reads: readonly [{
5858
+ readonly type: "site.indexing";
5859
+ readonly idFrom: "params.siteId";
5860
+ }];
5861
+ readonly changes: readonly [];
5862
+ };
5863
+ readonly lifecycle: {
5864
+ readonly introduced: "1.1.0";
5865
+ };
5866
+ readonly docs: {
5867
+ readonly summary: "List canonical mismatches";
5868
+ readonly description: "Returns sitemap-scoped URLs whose Google-chosen canonical diverges from the declared canonical, with consolidation targets and trend.";
5869
+ readonly tags: readonly ["Indexing"];
5870
+ readonly examples: {
5871
+ readonly request: {
5872
+ readonly params: {
5873
+ readonly siteId: "s_01";
5874
+ };
5875
+ };
5876
+ readonly response: {
5877
+ readonly data: {
5878
+ readonly mismatches: readonly [];
5879
+ readonly totalCount: 0;
5880
+ readonly consolidationTargets: readonly [];
5881
+ readonly trend: readonly [];
5882
+ readonly meta: {
5883
+ readonly siteUrl: "sc-domain:example.com";
5884
+ readonly syncStatus: "synced";
5885
+ };
5886
+ };
5887
+ readonly meta: {
5888
+ readonly requestId: "req_01";
5889
+ readonly surface: "partner";
5890
+ readonly version: "1.0";
5891
+ };
5892
+ };
5893
+ };
5894
+ };
5895
+ };
5896
+ readonly inspectSiteUrls: {
5897
+ readonly id: "partner.sites.indexing.inspect.create";
5898
+ readonly method: "POST";
5899
+ readonly path: "/sites/{siteId}/indexing/inspect";
5900
+ readonly visibility: "public";
5901
+ readonly semantics: {
5902
+ readonly kind: "mutation";
5903
+ readonly sideEffects: "state";
5904
+ readonly idempotent: false;
5905
+ readonly retry: "never";
5906
+ readonly readConsistency: null;
5907
+ };
5908
+ readonly auth: {
5909
+ readonly credentials: readonly ["user_key", "partner_key"];
5910
+ readonly scopes: readonly ["indexing:write"];
5911
+ readonly ownership: readonly [{
5912
+ readonly credential: "user_key";
5913
+ readonly rule: "authorized_site";
5914
+ }, {
5915
+ readonly credential: "partner_key";
5916
+ readonly rule: "authorized_site";
5917
+ }];
5918
+ };
5919
+ readonly request: {
5920
+ readonly params: z.ZodObject<{
5921
+ siteId: z.ZodString;
5922
+ }, z.core.$strict>;
5923
+ readonly query: null;
5924
+ readonly headers: z.ZodObject<{
5925
+ 'x-request-id': z.ZodOptional<z.ZodString>;
5926
+ }, z.core.$strict>;
5927
+ readonly body: z.ZodObject<{
5928
+ urls: z.ZodArray<z.ZodString>;
5929
+ }, z.core.$strict>;
5930
+ };
5931
+ readonly responses: {
5932
+ readonly 200: CompatibleResponseSchema<z.ZodObject<{
5933
+ data: z.ZodObject<{
5934
+ readonly siteId: z.ZodString;
5935
+ readonly rateLimit: z.ZodObject<{
5936
+ reserved: z.ZodNumber;
5937
+ remaining: z.ZodNumber;
5938
+ limit: z.ZodNumber;
5939
+ }, z.core.$strict>;
5940
+ readonly results: z.ZodArray<z.ZodObject<{
5941
+ url: z.ZodString;
5942
+ verdict: z.ZodNullable<z.ZodString>;
5943
+ coverageState: z.ZodNullable<z.ZodString>;
5944
+ indexingState: z.ZodNullable<z.ZodString>;
5945
+ robotsTxtState: z.ZodNullable<z.ZodString>;
5946
+ pageFetchState: z.ZodNullable<z.ZodString>;
5947
+ lastCrawlTime: z.ZodNullable<z.ZodString>;
5948
+ crawlingUserAgent: z.ZodNullable<z.ZodString>;
5949
+ userCanonical: z.ZodNullable<z.ZodString>;
5950
+ googleCanonical: z.ZodNullable<z.ZodString>;
5951
+ sitemaps: z.ZodNullable<z.ZodString>;
5952
+ referringUrls: z.ZodNullable<z.ZodString>;
5953
+ mobileVerdict: z.ZodNullable<z.ZodString>;
5954
+ mobileIssues: z.ZodNullable<z.ZodString>;
5955
+ richResultsVerdict: z.ZodNullable<z.ZodString>;
5956
+ richResultsItems: z.ZodNullable<z.ZodString>;
5957
+ ampVerdict: z.ZodNullable<z.ZodString>;
5958
+ ampUrl: z.ZodNullable<z.ZodString>;
5959
+ ampIndexingState: z.ZodNullable<z.ZodString>;
5960
+ ampIndexStatusVerdict: z.ZodNullable<z.ZodString>;
5961
+ ampRobotsTxtState: z.ZodNullable<z.ZodString>;
5962
+ ampPageFetchState: z.ZodNullable<z.ZodString>;
5963
+ ampLastCrawlTime: z.ZodNullable<z.ZodString>;
5964
+ ampIssues: z.ZodNullable<z.ZodString>;
5965
+ inspectionResultLink: z.ZodNullable<z.ZodString>;
5966
+ }, z.core.$strip>>;
5967
+ readonly errors: z.ZodArray<z.ZodObject<{
5968
+ url: z.ZodString;
5969
+ error: z.ZodString;
5970
+ }, z.core.$strict>>;
5971
+ readonly skipped: z.ZodArray<z.ZodObject<{
5972
+ url: z.ZodString;
5973
+ reason: z.ZodEnum<{
5974
+ rate_limited: "rate_limited";
5975
+ domain_mismatch: "domain_mismatch";
5976
+ }>;
5977
+ }, z.core.$strict>>;
5978
+ }, z.core.$strip>;
5979
+ meta: z.ZodObject<{
5980
+ readonly requestId: z.ZodString;
5981
+ readonly surface: z.ZodLiteral<"partner">;
5982
+ readonly version: z.ZodLiteral<"1.0">;
5983
+ }, z.core.$strip>;
5984
+ }, z.core.$strip>, z.ZodObject<{
5985
+ data: z.ZodObject<{
5986
+ readonly siteId: z.ZodString;
5987
+ readonly rateLimit: z.ZodObject<{
5988
+ reserved: z.ZodNumber;
5989
+ remaining: z.ZodNumber;
5990
+ limit: z.ZodNumber;
5991
+ }, z.core.$strict>;
5992
+ readonly results: z.ZodArray<z.ZodObject<{
5993
+ url: z.ZodString;
5994
+ verdict: z.ZodNullable<z.ZodString>;
5995
+ coverageState: z.ZodNullable<z.ZodString>;
5996
+ indexingState: z.ZodNullable<z.ZodString>;
5997
+ robotsTxtState: z.ZodNullable<z.ZodString>;
5998
+ pageFetchState: z.ZodNullable<z.ZodString>;
5999
+ lastCrawlTime: z.ZodNullable<z.ZodString>;
6000
+ crawlingUserAgent: z.ZodNullable<z.ZodString>;
6001
+ userCanonical: z.ZodNullable<z.ZodString>;
6002
+ googleCanonical: z.ZodNullable<z.ZodString>;
6003
+ sitemaps: z.ZodNullable<z.ZodString>;
6004
+ referringUrls: z.ZodNullable<z.ZodString>;
6005
+ mobileVerdict: z.ZodNullable<z.ZodString>;
6006
+ mobileIssues: z.ZodNullable<z.ZodString>;
6007
+ richResultsVerdict: z.ZodNullable<z.ZodString>;
6008
+ richResultsItems: z.ZodNullable<z.ZodString>;
6009
+ ampVerdict: z.ZodNullable<z.ZodString>;
6010
+ ampUrl: z.ZodNullable<z.ZodString>;
6011
+ ampIndexingState: z.ZodNullable<z.ZodString>;
6012
+ ampIndexStatusVerdict: z.ZodNullable<z.ZodString>;
6013
+ ampRobotsTxtState: z.ZodNullable<z.ZodString>;
6014
+ ampPageFetchState: z.ZodNullable<z.ZodString>;
6015
+ ampLastCrawlTime: z.ZodNullable<z.ZodString>;
6016
+ ampIssues: z.ZodNullable<z.ZodString>;
6017
+ inspectionResultLink: z.ZodNullable<z.ZodString>;
6018
+ }, z.core.$strip>>;
6019
+ readonly errors: z.ZodArray<z.ZodObject<{
6020
+ url: z.ZodString;
6021
+ error: z.ZodString;
6022
+ }, z.core.$strict>>;
6023
+ readonly skipped: z.ZodArray<z.ZodObject<{
6024
+ url: z.ZodString;
6025
+ reason: z.ZodEnum<{
6026
+ rate_limited: "rate_limited";
6027
+ domain_mismatch: "domain_mismatch";
6028
+ }>;
6029
+ }, z.core.$strict>>;
6030
+ }, z.core.$strip>;
6031
+ meta: z.ZodObject<{
6032
+ readonly requestId: z.ZodString;
6033
+ readonly surface: z.ZodLiteral<"partner">;
6034
+ readonly version: z.ZodLiteral<"1.0">;
6035
+ }, z.core.$strip>;
6036
+ }, z.core.$strip>>;
6037
+ };
6038
+ readonly errors: readonly ["invalid_request", "unauthorized", "forbidden", "site_not_found", "rate_limited", "internal_error", "contract_violation"];
6039
+ readonly errorResponse: CompatibleResponseSchema<z.ZodObject<{
6040
+ readonly error: z.ZodObject<{
6041
+ code: z.ZodEnum<{
6042
+ internal_error: "internal_error";
6043
+ invalid_request: "invalid_request";
6044
+ unauthorized: "unauthorized";
6045
+ forbidden: "forbidden";
6046
+ site_not_found: "site_not_found";
6047
+ rate_limited: "rate_limited";
6048
+ contract_violation: "contract_violation";
6049
+ }>;
6050
+ message: z.ZodString;
6051
+ requestId: z.ZodString;
6052
+ retryable: z.ZodBoolean;
6053
+ details: z.ZodRecord<z.ZodString, z.ZodJSONSchema>;
6054
+ }, z.core.$strict>;
6055
+ }, z.core.$strip>, z.ZodObject<{
6056
+ readonly error: z.ZodObject<{
6057
+ code: z.ZodEnum<{
6058
+ internal_error: "internal_error";
6059
+ invalid_request: "invalid_request";
6060
+ unauthorized: "unauthorized";
6061
+ forbidden: "forbidden";
6062
+ site_not_found: "site_not_found";
6063
+ rate_limited: "rate_limited";
6064
+ contract_violation: "contract_violation";
6065
+ }>;
6066
+ message: z.ZodString;
6067
+ requestId: z.ZodString;
6068
+ retryable: z.ZodBoolean;
6069
+ details: z.ZodRecord<z.ZodString, z.ZodJSONSchema>;
6070
+ }, z.core.$loose>;
6071
+ }, z.core.$strip>>;
6072
+ readonly resources: {
6073
+ readonly reads: readonly [{
6074
+ readonly type: "site.indexing";
6075
+ readonly idFrom: "params.siteId";
6076
+ }];
6077
+ readonly changes: readonly [{
6078
+ readonly type: "site.indexing";
6079
+ readonly idFrom: "params.siteId";
6080
+ }];
6081
+ };
6082
+ readonly lifecycle: {
6083
+ readonly introduced: "1.1.0";
6084
+ };
6085
+ readonly docs: {
6086
+ readonly summary: "Inspect URLs on demand";
6087
+ readonly description: "Runs live URL inspections against the daily per-site quota; URLs outside the site domain and over-quota URLs are reported as skipped. Exhausted quota fails with rate_limited.";
6088
+ readonly tags: readonly ["Indexing"];
6089
+ readonly examples: {
6090
+ readonly request: {
6091
+ readonly params: {
6092
+ readonly siteId: "s_01";
6093
+ };
6094
+ readonly body: {
6095
+ readonly urls: readonly ["https://example.com/"];
6096
+ };
6097
+ };
6098
+ readonly response: {
6099
+ readonly data: {
6100
+ readonly siteId: "s_01";
6101
+ readonly rateLimit: {
6102
+ readonly reserved: 1;
6103
+ readonly remaining: 199;
6104
+ readonly limit: 200;
6105
+ };
6106
+ readonly results: readonly [];
6107
+ readonly errors: readonly [];
6108
+ readonly skipped: readonly [];
6109
+ };
6110
+ readonly meta: {
6111
+ readonly requestId: "req_01";
6112
+ readonly surface: "partner";
6113
+ readonly version: "1.0";
6114
+ };
6115
+ };
6116
+ };
6117
+ };
6118
+ };
6119
+ readonly recoverSitePermission: {
6120
+ readonly id: "partner.sites.permission.recover";
6121
+ readonly method: "POST";
6122
+ readonly path: "/sites/{siteId}/permission/recover";
6123
+ readonly visibility: "public";
6124
+ readonly semantics: {
6125
+ readonly kind: "mutation";
6126
+ readonly sideEffects: "state";
6127
+ readonly idempotent: true;
6128
+ readonly retry: "idempotent";
6129
+ readonly readConsistency: null;
6130
+ };
6131
+ readonly auth: {
6132
+ readonly credentials: readonly ["user_key", "partner_key"];
6133
+ readonly scopes: readonly ["sites:write"];
6134
+ readonly ownership: readonly [{
6135
+ readonly credential: "user_key";
6136
+ readonly rule: "authorized_site";
6137
+ }, {
6138
+ readonly credential: "partner_key";
6139
+ readonly rule: "authorized_site";
6140
+ }];
6141
+ };
6142
+ readonly request: {
6143
+ readonly params: z.ZodObject<{
6144
+ siteId: z.ZodString;
6145
+ }, z.core.$strict>;
6146
+ readonly query: null;
6147
+ readonly headers: z.ZodObject<{
6148
+ 'x-request-id': z.ZodOptional<z.ZodString>;
6149
+ }, z.core.$strict>;
6150
+ readonly body: null;
6151
+ };
6152
+ readonly responses: {
6153
+ readonly 200: CompatibleResponseSchema<z.ZodObject<{
6154
+ data: z.ZodObject<{
6155
+ readonly success: z.ZodBoolean;
6156
+ readonly permissionLevel: z.ZodNullable<z.ZodString>;
6157
+ readonly jobsQueued: z.ZodNumber;
6158
+ readonly message: z.ZodString;
6159
+ }, z.core.$strip>;
6160
+ meta: z.ZodObject<{
6161
+ readonly requestId: z.ZodString;
6162
+ readonly surface: z.ZodLiteral<"partner">;
6163
+ readonly version: z.ZodLiteral<"1.0">;
6164
+ }, z.core.$strip>;
6165
+ }, z.core.$strip>, z.ZodObject<{
6166
+ data: z.ZodObject<{
6167
+ readonly success: z.ZodBoolean;
6168
+ readonly permissionLevel: z.ZodNullable<z.ZodString>;
6169
+ readonly jobsQueued: z.ZodNumber;
6170
+ readonly message: z.ZodString;
6171
+ }, z.core.$strip>;
6172
+ meta: z.ZodObject<{
6173
+ readonly requestId: z.ZodString;
6174
+ readonly surface: z.ZodLiteral<"partner">;
6175
+ readonly version: z.ZodLiteral<"1.0">;
6176
+ }, z.core.$strip>;
6177
+ }, z.core.$strip>>;
6178
+ };
6179
+ readonly errors: readonly ["invalid_request", "unauthorized", "forbidden", "site_not_found", "rate_limited", "internal_error", "contract_violation"];
6180
+ readonly errorResponse: CompatibleResponseSchema<z.ZodObject<{
6181
+ readonly error: z.ZodObject<{
6182
+ code: z.ZodEnum<{
6183
+ internal_error: "internal_error";
6184
+ invalid_request: "invalid_request";
6185
+ unauthorized: "unauthorized";
6186
+ forbidden: "forbidden";
6187
+ site_not_found: "site_not_found";
6188
+ rate_limited: "rate_limited";
6189
+ contract_violation: "contract_violation";
6190
+ }>;
6191
+ message: z.ZodString;
6192
+ requestId: z.ZodString;
6193
+ retryable: z.ZodBoolean;
6194
+ details: z.ZodRecord<z.ZodString, z.ZodJSONSchema>;
6195
+ }, z.core.$strict>;
6196
+ }, z.core.$strip>, z.ZodObject<{
6197
+ readonly error: z.ZodObject<{
6198
+ code: z.ZodEnum<{
6199
+ internal_error: "internal_error";
6200
+ invalid_request: "invalid_request";
6201
+ unauthorized: "unauthorized";
6202
+ forbidden: "forbidden";
6203
+ site_not_found: "site_not_found";
6204
+ rate_limited: "rate_limited";
6205
+ contract_violation: "contract_violation";
6206
+ }>;
6207
+ message: z.ZodString;
6208
+ requestId: z.ZodString;
6209
+ retryable: z.ZodBoolean;
6210
+ details: z.ZodRecord<z.ZodString, z.ZodJSONSchema>;
6211
+ }, z.core.$loose>;
6212
+ }, z.core.$strip>>;
6213
+ readonly resources: {
6214
+ readonly reads: readonly [{
6215
+ readonly type: "site.auth";
6216
+ readonly idFrom: "params.siteId";
6217
+ }];
6218
+ readonly changes: readonly [{
6219
+ readonly type: "site.auth";
6220
+ readonly idFrom: "params.siteId";
6221
+ }, {
6222
+ readonly type: "site.lifecycle";
6223
+ readonly idFrom: "params.siteId";
6224
+ }];
6225
+ };
6226
+ readonly lifecycle: {
6227
+ readonly introduced: "1.1.0";
6228
+ };
6229
+ readonly docs: {
6230
+ readonly summary: "Re-check and recover site permission";
6231
+ readonly description: "Force-rechecks Google Search Console access for a permission-lost site; on recovery resets sync state and queues fresh sync jobs.";
6232
+ readonly tags: readonly ["Sites"];
6233
+ readonly examples: {
6234
+ readonly request: {
6235
+ readonly params: {
6236
+ readonly siteId: "s_01";
6237
+ };
6238
+ };
6239
+ readonly response: {
6240
+ readonly data: {
6241
+ readonly success: true;
6242
+ readonly permissionLevel: "siteFullUser";
6243
+ readonly jobsQueued: 3;
6244
+ readonly message: "Permission restored (siteFullUser). Queued 3 sync jobs.";
6245
+ };
6246
+ readonly meta: {
6247
+ readonly requestId: "req_01";
6248
+ readonly surface: "partner";
6249
+ readonly version: "1.0";
6250
+ };
6251
+ };
6252
+ };
6253
+ };
6254
+ };
6255
+ readonly queryKeywordSparklines: {
6256
+ readonly id: "partner.sites.keyword.sparklines.query";
6257
+ readonly method: "POST";
6258
+ readonly path: "/sites/{siteId}/keyword-sparklines";
6259
+ readonly visibility: "public";
6260
+ readonly semantics: {
6261
+ readonly kind: "query";
6262
+ readonly sideEffects: "none";
6263
+ readonly idempotent: true;
6264
+ readonly retry: "idempotent";
6265
+ readonly readConsistency: "primary";
6266
+ };
6267
+ readonly auth: {
6268
+ readonly credentials: readonly ["user_key", "partner_key"];
6269
+ readonly scopes: readonly ["analytics:read"];
6270
+ readonly ownership: readonly [{
6271
+ readonly credential: "user_key";
6272
+ readonly rule: "authorized_site";
6273
+ }, {
6274
+ readonly credential: "partner_key";
6275
+ readonly rule: "authorized_site";
6276
+ }];
6277
+ };
6278
+ readonly request: {
6279
+ readonly params: z.ZodObject<{
6280
+ siteId: z.ZodString;
6281
+ }, z.core.$strict>;
6282
+ readonly query: null;
6283
+ readonly headers: z.ZodObject<{
6284
+ 'x-request-id': z.ZodOptional<z.ZodString>;
6285
+ }, z.core.$strict>;
6286
+ readonly body: z.ZodObject<{
6287
+ keywords: z.ZodArray<z.ZodString>;
6288
+ startDate: z.ZodString;
6289
+ endDate: z.ZodString;
6290
+ searchType: z.ZodOptional<z.ZodEnum<{
6291
+ web: "web";
6292
+ image: "image";
6293
+ video: "video";
6294
+ news: "news";
6295
+ discover: "discover";
6296
+ googleNews: "googleNews";
6297
+ }>>;
6298
+ }, z.core.$strict>;
6299
+ };
6300
+ readonly responses: {
6301
+ readonly 200: CompatibleResponseSchema<z.ZodObject<{
6302
+ data: z.ZodObject<{
6303
+ sparklines: z.ZodRecord<z.ZodString, z.ZodArray<z.ZodNumber>>;
6304
+ }, z.core.$strip>;
6305
+ meta: z.ZodObject<{
6306
+ readonly requestId: z.ZodString;
6307
+ readonly surface: z.ZodLiteral<"partner">;
6308
+ readonly version: z.ZodLiteral<"1.0">;
6309
+ }, z.core.$strip>;
6310
+ }, z.core.$strip>, z.ZodObject<{
6311
+ data: z.ZodObject<{
6312
+ sparklines: z.ZodRecord<z.ZodString, z.ZodArray<z.ZodNumber>>;
6313
+ }, z.core.$strip>;
6314
+ meta: z.ZodObject<{
6315
+ readonly requestId: z.ZodString;
6316
+ readonly surface: z.ZodLiteral<"partner">;
6317
+ readonly version: z.ZodLiteral<"1.0">;
6318
+ }, z.core.$strip>;
6319
+ }, z.core.$strip>>;
6320
+ };
6321
+ readonly errors: readonly ["invalid_request", "unauthorized", "forbidden", "site_not_found", "rate_limited", "internal_error", "contract_violation"];
6322
+ readonly errorResponse: CompatibleResponseSchema<z.ZodObject<{
6323
+ readonly error: z.ZodObject<{
6324
+ code: z.ZodEnum<{
6325
+ internal_error: "internal_error";
6326
+ invalid_request: "invalid_request";
6327
+ unauthorized: "unauthorized";
6328
+ forbidden: "forbidden";
6329
+ site_not_found: "site_not_found";
6330
+ rate_limited: "rate_limited";
6331
+ contract_violation: "contract_violation";
6332
+ }>;
6333
+ message: z.ZodString;
6334
+ requestId: z.ZodString;
6335
+ retryable: z.ZodBoolean;
6336
+ details: z.ZodRecord<z.ZodString, z.ZodJSONSchema>;
6337
+ }, z.core.$strict>;
6338
+ }, z.core.$strip>, z.ZodObject<{
6339
+ readonly error: z.ZodObject<{
6340
+ code: z.ZodEnum<{
6341
+ internal_error: "internal_error";
6342
+ invalid_request: "invalid_request";
6343
+ unauthorized: "unauthorized";
6344
+ forbidden: "forbidden";
6345
+ site_not_found: "site_not_found";
6346
+ rate_limited: "rate_limited";
6347
+ contract_violation: "contract_violation";
6348
+ }>;
6349
+ message: z.ZodString;
6350
+ requestId: z.ZodString;
6351
+ retryable: z.ZodBoolean;
6352
+ details: z.ZodRecord<z.ZodString, z.ZodJSONSchema>;
6353
+ }, z.core.$loose>;
6354
+ }, z.core.$strip>>;
6355
+ readonly resources: {
6356
+ readonly reads: readonly [{
6357
+ readonly type: "site.analytics";
6358
+ readonly idFrom: "params.siteId";
6359
+ }];
6360
+ readonly changes: readonly [];
6361
+ };
6362
+ readonly lifecycle: {
6363
+ readonly introduced: "1.1.0";
6364
+ };
6365
+ readonly docs: {
6366
+ readonly summary: "Query keyword sparklines";
6367
+ readonly description: "Returns per-keyword daily click series for up to 20 keywords over the requested window.";
6368
+ readonly tags: readonly ["Analytics"];
6369
+ readonly examples: {
6370
+ readonly request: {
6371
+ readonly params: {
6372
+ readonly siteId: "s_01";
6373
+ };
6374
+ readonly body: {
6375
+ readonly keywords: readonly ["nuxt seo"];
6376
+ readonly startDate: "2026-06-01";
6377
+ readonly endDate: "2026-06-28";
6378
+ };
6379
+ };
6380
+ readonly response: {
6381
+ readonly data: {
6382
+ readonly sparklines: {
6383
+ readonly 'nuxt seo': readonly [0, 1, 2];
6384
+ };
6385
+ };
6386
+ readonly meta: {
6387
+ readonly requestId: "req_01";
6388
+ readonly surface: "partner";
6389
+ readonly version: "1.0";
6390
+ };
6391
+ };
6392
+ };
6393
+ };
6394
+ };
6395
+ readonly getQueryTrend: {
6396
+ readonly id: "partner.sites.query.trend.get";
6397
+ readonly method: "GET";
6398
+ readonly path: "/sites/{siteId}/query-trend";
6399
+ readonly visibility: "public";
6400
+ readonly semantics: {
6401
+ readonly kind: "query";
6402
+ readonly sideEffects: "none";
6403
+ readonly idempotent: true;
6404
+ readonly retry: "idempotent";
6405
+ readonly readConsistency: "primary";
6406
+ };
6407
+ readonly auth: {
6408
+ readonly credentials: readonly ["user_key", "partner_key"];
6409
+ readonly scopes: readonly ["analytics:read"];
6410
+ readonly ownership: readonly [{
6411
+ readonly credential: "user_key";
6412
+ readonly rule: "authorized_site";
6413
+ }, {
6414
+ readonly credential: "partner_key";
6415
+ readonly rule: "authorized_site";
6416
+ }];
6417
+ };
6418
+ readonly request: {
6419
+ readonly params: z.ZodObject<{
6420
+ siteId: z.ZodString;
6421
+ }, z.core.$strict>;
6422
+ readonly query: z.ZodObject<{
6423
+ startDate: z.ZodString;
6424
+ endDate: z.ZodString;
6425
+ searchType: z.ZodOptional<z.ZodEnum<{
6426
+ web: "web";
6427
+ image: "image";
6428
+ video: "video";
6429
+ news: "news";
6430
+ discover: "discover";
6431
+ googleNews: "googleNews";
6432
+ }>>;
6433
+ prevStartDate: z.ZodOptional<z.ZodString>;
6434
+ prevEndDate: z.ZodOptional<z.ZodString>;
6435
+ }, z.core.$strict>;
6436
+ readonly headers: z.ZodObject<{
6437
+ 'x-request-id': z.ZodOptional<z.ZodString>;
6438
+ }, z.core.$strict>;
6439
+ readonly body: null;
6440
+ };
6441
+ readonly responses: {
6442
+ readonly 200: CompatibleResponseSchema<z.ZodObject<{
6443
+ data: z.ZodObject<{
6444
+ daily: z.ZodArray<z.ZodObject<{
6445
+ date: z.ZodString;
6446
+ queryCount: z.ZodNumber;
6447
+ }, z.core.$loose>>;
6448
+ total: z.ZodNumber;
6449
+ previousTotal: z.ZodOptional<z.ZodNumber>;
6450
+ meta: z.ZodObject<{
6451
+ siteUrl: z.ZodString;
6452
+ syncStatus: z.ZodNullable<z.ZodString>;
6453
+ }, z.core.$loose>;
6454
+ }, z.core.$strip>;
6455
+ meta: z.ZodObject<{
6456
+ readonly requestId: z.ZodString;
6457
+ readonly surface: z.ZodLiteral<"partner">;
6458
+ readonly version: z.ZodLiteral<"1.0">;
6459
+ }, z.core.$strip>;
6460
+ }, z.core.$strip>, z.ZodObject<{
6461
+ data: z.ZodObject<{
6462
+ daily: z.ZodArray<z.ZodObject<{
6463
+ date: z.ZodString;
6464
+ queryCount: z.ZodNumber;
6465
+ }, z.core.$loose>>;
6466
+ total: z.ZodNumber;
6467
+ previousTotal: z.ZodOptional<z.ZodNumber>;
6468
+ meta: z.ZodObject<{
6469
+ siteUrl: z.ZodString;
6470
+ syncStatus: z.ZodNullable<z.ZodString>;
6471
+ }, z.core.$loose>;
6472
+ }, z.core.$strip>;
6473
+ meta: z.ZodObject<{
6474
+ readonly requestId: z.ZodString;
6475
+ readonly surface: z.ZodLiteral<"partner">;
6476
+ readonly version: z.ZodLiteral<"1.0">;
6477
+ }, z.core.$strip>;
6478
+ }, z.core.$strip>>;
6479
+ };
6480
+ readonly errors: readonly ["invalid_request", "unauthorized", "forbidden", "site_not_found", "rate_limited", "internal_error", "contract_violation"];
6481
+ readonly errorResponse: CompatibleResponseSchema<z.ZodObject<{
6482
+ readonly error: z.ZodObject<{
6483
+ code: z.ZodEnum<{
6484
+ internal_error: "internal_error";
6485
+ invalid_request: "invalid_request";
6486
+ unauthorized: "unauthorized";
6487
+ forbidden: "forbidden";
6488
+ site_not_found: "site_not_found";
6489
+ rate_limited: "rate_limited";
6490
+ contract_violation: "contract_violation";
6491
+ }>;
6492
+ message: z.ZodString;
6493
+ requestId: z.ZodString;
6494
+ retryable: z.ZodBoolean;
6495
+ details: z.ZodRecord<z.ZodString, z.ZodJSONSchema>;
6496
+ }, z.core.$strict>;
6497
+ }, z.core.$strip>, z.ZodObject<{
6498
+ readonly error: z.ZodObject<{
6499
+ code: z.ZodEnum<{
6500
+ internal_error: "internal_error";
6501
+ invalid_request: "invalid_request";
6502
+ unauthorized: "unauthorized";
6503
+ forbidden: "forbidden";
6504
+ site_not_found: "site_not_found";
6505
+ rate_limited: "rate_limited";
6506
+ contract_violation: "contract_violation";
6507
+ }>;
6508
+ message: z.ZodString;
6509
+ requestId: z.ZodString;
6510
+ retryable: z.ZodBoolean;
6511
+ details: z.ZodRecord<z.ZodString, z.ZodJSONSchema>;
6512
+ }, z.core.$loose>;
6513
+ }, z.core.$strip>>;
6514
+ readonly resources: {
6515
+ readonly reads: readonly [{
6516
+ readonly type: "site.analytics";
6517
+ readonly idFrom: "params.siteId";
6518
+ }];
6519
+ readonly changes: readonly [];
6520
+ };
6521
+ readonly lifecycle: {
6522
+ readonly introduced: "1.1.0";
6523
+ };
6524
+ readonly docs: {
6525
+ readonly summary: "Get unique-query trend";
6526
+ readonly description: "Returns the daily unique-query count series for a window, with an optional previous-period total for comparison.";
6527
+ readonly tags: readonly ["Analytics"];
6528
+ readonly examples: {
6529
+ readonly request: {
6530
+ readonly params: {
6531
+ readonly siteId: "s_01";
6532
+ };
6533
+ readonly query: {
6534
+ readonly startDate: "2026-06-01";
6535
+ readonly endDate: "2026-06-28";
6536
+ };
6537
+ };
6538
+ readonly response: {
6539
+ readonly data: {
6540
+ readonly daily: readonly [];
6541
+ readonly total: 0;
6542
+ readonly meta: {
6543
+ readonly siteUrl: "sc-domain:example.com";
6544
+ readonly syncStatus: "synced";
6545
+ };
6546
+ };
6547
+ readonly meta: {
6548
+ readonly requestId: "req_01";
6549
+ readonly surface: "partner";
6550
+ readonly version: "1.0";
6551
+ };
6552
+ };
6553
+ };
6554
+ };
6555
+ };
6556
+ readonly getPageTrend: {
6557
+ readonly id: "partner.sites.page.trend.get";
6558
+ readonly method: "GET";
6559
+ readonly path: "/sites/{siteId}/page-trend";
6560
+ readonly visibility: "public";
6561
+ readonly semantics: {
6562
+ readonly kind: "query";
6563
+ readonly sideEffects: "none";
6564
+ readonly idempotent: true;
6565
+ readonly retry: "idempotent";
6566
+ readonly readConsistency: "primary";
6567
+ };
6568
+ readonly auth: {
6569
+ readonly credentials: readonly ["user_key", "partner_key"];
6570
+ readonly scopes: readonly ["analytics:read"];
6571
+ readonly ownership: readonly [{
6572
+ readonly credential: "user_key";
6573
+ readonly rule: "authorized_site";
6574
+ }, {
6575
+ readonly credential: "partner_key";
6576
+ readonly rule: "authorized_site";
6577
+ }];
6578
+ };
6579
+ readonly request: {
6580
+ readonly params: z.ZodObject<{
6581
+ siteId: z.ZodString;
6582
+ }, z.core.$strict>;
6583
+ readonly query: z.ZodObject<{
6584
+ startDate: z.ZodString;
6585
+ endDate: z.ZodString;
6586
+ searchType: z.ZodOptional<z.ZodEnum<{
6587
+ web: "web";
6588
+ image: "image";
6589
+ video: "video";
6590
+ news: "news";
6591
+ discover: "discover";
6592
+ googleNews: "googleNews";
6593
+ }>>;
6594
+ prevStartDate: z.ZodOptional<z.ZodString>;
6595
+ prevEndDate: z.ZodOptional<z.ZodString>;
6596
+ }, z.core.$strict>;
6597
+ readonly headers: z.ZodObject<{
6598
+ 'x-request-id': z.ZodOptional<z.ZodString>;
6599
+ }, z.core.$strict>;
6600
+ readonly body: null;
6601
+ };
6602
+ readonly responses: {
6603
+ readonly 200: CompatibleResponseSchema<z.ZodObject<{
6604
+ data: z.ZodObject<{
6605
+ daily: z.ZodArray<z.ZodObject<{
6606
+ date: z.ZodString;
6607
+ pageCount: z.ZodNumber;
6608
+ }, z.core.$loose>>;
6609
+ total: z.ZodNumber;
6610
+ previousTotal: z.ZodOptional<z.ZodNumber>;
6611
+ meta: z.ZodObject<{
6612
+ siteUrl: z.ZodString;
6613
+ syncStatus: z.ZodNullable<z.ZodString>;
6614
+ }, z.core.$loose>;
6615
+ }, z.core.$strip>;
6616
+ meta: z.ZodObject<{
6617
+ readonly requestId: z.ZodString;
6618
+ readonly surface: z.ZodLiteral<"partner">;
6619
+ readonly version: z.ZodLiteral<"1.0">;
6620
+ }, z.core.$strip>;
6621
+ }, z.core.$strip>, z.ZodObject<{
6622
+ data: z.ZodObject<{
6623
+ daily: z.ZodArray<z.ZodObject<{
6624
+ date: z.ZodString;
6625
+ pageCount: z.ZodNumber;
6626
+ }, z.core.$loose>>;
6627
+ total: z.ZodNumber;
6628
+ previousTotal: z.ZodOptional<z.ZodNumber>;
6629
+ meta: z.ZodObject<{
6630
+ siteUrl: z.ZodString;
6631
+ syncStatus: z.ZodNullable<z.ZodString>;
6632
+ }, z.core.$loose>;
6633
+ }, z.core.$strip>;
6634
+ meta: z.ZodObject<{
6635
+ readonly requestId: z.ZodString;
6636
+ readonly surface: z.ZodLiteral<"partner">;
6637
+ readonly version: z.ZodLiteral<"1.0">;
6638
+ }, z.core.$strip>;
6639
+ }, z.core.$strip>>;
6640
+ };
6641
+ readonly errors: readonly ["invalid_request", "unauthorized", "forbidden", "site_not_found", "rate_limited", "internal_error", "contract_violation"];
6642
+ readonly errorResponse: CompatibleResponseSchema<z.ZodObject<{
6643
+ readonly error: z.ZodObject<{
6644
+ code: z.ZodEnum<{
6645
+ internal_error: "internal_error";
6646
+ invalid_request: "invalid_request";
6647
+ unauthorized: "unauthorized";
6648
+ forbidden: "forbidden";
6649
+ site_not_found: "site_not_found";
6650
+ rate_limited: "rate_limited";
6651
+ contract_violation: "contract_violation";
6652
+ }>;
6653
+ message: z.ZodString;
6654
+ requestId: z.ZodString;
6655
+ retryable: z.ZodBoolean;
6656
+ details: z.ZodRecord<z.ZodString, z.ZodJSONSchema>;
6657
+ }, z.core.$strict>;
6658
+ }, z.core.$strip>, z.ZodObject<{
6659
+ readonly error: z.ZodObject<{
6660
+ code: z.ZodEnum<{
6661
+ internal_error: "internal_error";
6662
+ invalid_request: "invalid_request";
6663
+ unauthorized: "unauthorized";
6664
+ forbidden: "forbidden";
6665
+ site_not_found: "site_not_found";
6666
+ rate_limited: "rate_limited";
6667
+ contract_violation: "contract_violation";
6668
+ }>;
6669
+ message: z.ZodString;
6670
+ requestId: z.ZodString;
6671
+ retryable: z.ZodBoolean;
6672
+ details: z.ZodRecord<z.ZodString, z.ZodJSONSchema>;
6673
+ }, z.core.$loose>;
6674
+ }, z.core.$strip>>;
6675
+ readonly resources: {
6676
+ readonly reads: readonly [{
6677
+ readonly type: "site.analytics";
6678
+ readonly idFrom: "params.siteId";
6679
+ }];
6680
+ readonly changes: readonly [];
6681
+ };
6682
+ readonly lifecycle: {
6683
+ readonly introduced: "1.1.0";
6684
+ };
6685
+ readonly docs: {
6686
+ readonly summary: "Get unique-page trend";
6687
+ readonly description: "Returns the daily unique-page count series for a window, with an optional previous-period total for comparison.";
6688
+ readonly tags: readonly ["Analytics"];
6689
+ readonly examples: {
6690
+ readonly request: {
6691
+ readonly params: {
6692
+ readonly siteId: "s_01";
6693
+ };
6694
+ readonly query: {
6695
+ readonly startDate: "2026-06-01";
6696
+ readonly endDate: "2026-06-28";
6697
+ };
6698
+ };
6699
+ readonly response: {
6700
+ readonly data: {
6701
+ readonly daily: readonly [];
6702
+ readonly total: 0;
6703
+ readonly meta: {
6704
+ readonly siteUrl: "sc-domain:example.com";
6705
+ readonly syncStatus: "synced";
6706
+ };
6707
+ };
6708
+ readonly meta: {
6709
+ readonly requestId: "req_01";
6710
+ readonly surface: "partner";
6711
+ readonly version: "1.0";
6712
+ };
6713
+ };
6714
+ };
6715
+ };
6716
+ };
5726
6717
  }>;
5727
6718
  analytics: HttpV1Surface<{
5728
6719
  readonly queryRows: {