@nuxtseo/protocol 0.1.5 → 0.2.0
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.
- package/dist/v1/account.d.ts +8 -0
- package/dist/v1/actions.d.ts +348 -0
- package/dist/v1/actions.js +76 -0
- package/dist/v1/audit.d.ts +32 -0
- package/dist/v1/audit.js +8 -0
- package/dist/v1/backlinks.d.ts +2826 -193
- package/dist/v1/backlinks.js +415 -6
- package/dist/v1/core.d.ts +1 -1
- package/dist/v1/core.js +10 -0
- package/dist/v1/gsc.d.ts +792 -0
- package/dist/v1/gsc.js +189 -0
- package/dist/v1/pages.d.ts +1085 -0
- package/dist/v1/pages.js +239 -0
- package/dist/v1/performance.d.ts +3868 -245
- package/dist/v1/performance.js +643 -1
- package/dist/v1/research.d.ts +1803 -489
- package/dist/v1/research.js +173 -0
- package/dist/v1/sites.d.ts +1025 -0
- package/dist/v1/sites.js +230 -0
- package/dist/v1/timeline.d.ts +1540 -70
- package/dist/v1/timeline.js +244 -0
- package/generated/openapi.v1.json +1 -1
- package/package.json +1 -1
package/dist/v1/gsc.d.ts
CHANGED
|
@@ -3834,6 +3834,528 @@ export declare const urlInspectionReadOperation: {
|
|
|
3834
3834
|
}];
|
|
3835
3835
|
};
|
|
3836
3836
|
};
|
|
3837
|
+
export declare const indexCohortsQuerySchema: z.ZodObject<{
|
|
3838
|
+
limit: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
|
|
3839
|
+
minSectionPages: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
|
|
3840
|
+
}, z.core.$strict>;
|
|
3841
|
+
export declare const establishedCohortSchema: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
|
|
3842
|
+
readonly family: z.ZodString;
|
|
3843
|
+
readonly dimension: z.ZodString;
|
|
3844
|
+
/**
|
|
3845
|
+
* Null when the cohort is not expressible as one path prefix. Every
|
|
3846
|
+
* `lifecycle` cohort is: version-pinned pages span the whole Site, so a
|
|
3847
|
+
* drill-through must fall back to the unfiltered not-indexed list.
|
|
3848
|
+
*/
|
|
3849
|
+
readonly pathPrefix: z.ZodNullable<z.ZodString>;
|
|
3850
|
+
readonly pages: z.ZodNumber;
|
|
3851
|
+
readonly notIndexed: z.ZodNumber;
|
|
3852
|
+
readonly notIndexedPercent: z.ZodNumber;
|
|
3853
|
+
readonly restOfSitePercent: z.ZodNumber;
|
|
3854
|
+
readonly restOfSitePages: z.ZodNumber;
|
|
3855
|
+
readonly confidenceIntervalLower: z.ZodNumber;
|
|
3856
|
+
readonly confidenceIntervalUpper: z.ZodNumber;
|
|
3857
|
+
/** Families nest, so subtract this before summing notIndexed down the list. */
|
|
3858
|
+
readonly alreadyCountedAbove: z.ZodNumber;
|
|
3859
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
3860
|
+
readonly family: z.ZodString;
|
|
3861
|
+
readonly dimension: z.ZodString;
|
|
3862
|
+
readonly pathPrefix: z.ZodNullable<z.ZodString>;
|
|
3863
|
+
readonly pages: z.ZodNumber;
|
|
3864
|
+
readonly notIndexed: z.ZodNumber;
|
|
3865
|
+
readonly notIndexedPercent: z.ZodNumber;
|
|
3866
|
+
readonly restOfSitePercent: z.ZodNumber;
|
|
3867
|
+
readonly restOfSitePages: z.ZodNumber;
|
|
3868
|
+
readonly confidenceIntervalLower: z.ZodNumber;
|
|
3869
|
+
readonly confidenceIntervalUpper: z.ZodNumber;
|
|
3870
|
+
readonly alreadyCountedAbove: z.ZodNumber;
|
|
3871
|
+
}, z.core.$strip>>;
|
|
3872
|
+
export declare const rankedCohortSchema: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
|
|
3873
|
+
readonly family: z.ZodString;
|
|
3874
|
+
readonly pages: z.ZodNumber;
|
|
3875
|
+
readonly notIndexed: z.ZodNumber;
|
|
3876
|
+
readonly notIndexedPercent: z.ZodNumber;
|
|
3877
|
+
/** False means this family has NOT been shown to differ from the rest of the Site. */
|
|
3878
|
+
readonly statisticallyEstablished: z.ZodBoolean;
|
|
3879
|
+
readonly belowMinimumSample: z.ZodBoolean;
|
|
3880
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
3881
|
+
readonly family: z.ZodString;
|
|
3882
|
+
readonly pages: z.ZodNumber;
|
|
3883
|
+
readonly notIndexed: z.ZodNumber;
|
|
3884
|
+
readonly notIndexedPercent: z.ZodNumber;
|
|
3885
|
+
readonly statisticallyEstablished: z.ZodBoolean;
|
|
3886
|
+
readonly belowMinimumSample: z.ZodBoolean;
|
|
3887
|
+
}, z.core.$strip>>;
|
|
3888
|
+
/**
|
|
3889
|
+
* Two lists that mean different things and must never be merged.
|
|
3890
|
+
* `established` holds only families whose Wilson score interval clears the
|
|
3891
|
+
* not-indexed rate of their own complement after a Bonferroni correction; those
|
|
3892
|
+
* are the only rows that may be reported as a finding. `ranked` orders every
|
|
3893
|
+
* family by raw rate with no test applied, so it always answers "where is
|
|
3894
|
+
* indexing worst" — a high rate there is a lead to verify, never a conclusion.
|
|
3895
|
+
*/
|
|
3896
|
+
export declare const indexCohortsDataSchema: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
|
|
3897
|
+
readonly analysed: z.ZodBoolean;
|
|
3898
|
+
readonly reason: z.ZodNullable<z.ZodString>;
|
|
3899
|
+
readonly message: z.ZodNullable<z.ZodString>;
|
|
3900
|
+
readonly asOf: z.ZodNullable<z.ZodString>;
|
|
3901
|
+
readonly baseline: z.ZodNullable<z.ZodObject<{
|
|
3902
|
+
pages: z.ZodNumber;
|
|
3903
|
+
notIndexed: z.ZodNumber;
|
|
3904
|
+
notIndexedPercent: z.ZodNumber;
|
|
3905
|
+
}, z.core.$strict>>;
|
|
3906
|
+
readonly coverage: z.ZodNullable<z.ZodObject<{
|
|
3907
|
+
analysed: z.ZodNumber;
|
|
3908
|
+
notIndexedButNeverCrawled: z.ZodNumber;
|
|
3909
|
+
excludedFragments: z.ZodNumber;
|
|
3910
|
+
}, z.core.$strict>>;
|
|
3911
|
+
readonly method: z.ZodNullable<z.ZodString>;
|
|
3912
|
+
readonly familiesTested: z.ZodNumber;
|
|
3913
|
+
readonly established: z.ZodArray<z.ZodObject<{
|
|
3914
|
+
readonly family: z.ZodString;
|
|
3915
|
+
readonly dimension: z.ZodString;
|
|
3916
|
+
/**
|
|
3917
|
+
* Null when the cohort is not expressible as one path prefix. Every
|
|
3918
|
+
* `lifecycle` cohort is: version-pinned pages span the whole Site, so a
|
|
3919
|
+
* drill-through must fall back to the unfiltered not-indexed list.
|
|
3920
|
+
*/
|
|
3921
|
+
readonly pathPrefix: z.ZodNullable<z.ZodString>;
|
|
3922
|
+
readonly pages: z.ZodNumber;
|
|
3923
|
+
readonly notIndexed: z.ZodNumber;
|
|
3924
|
+
readonly notIndexedPercent: z.ZodNumber;
|
|
3925
|
+
readonly restOfSitePercent: z.ZodNumber;
|
|
3926
|
+
readonly restOfSitePages: z.ZodNumber;
|
|
3927
|
+
readonly confidenceIntervalLower: z.ZodNumber;
|
|
3928
|
+
readonly confidenceIntervalUpper: z.ZodNumber;
|
|
3929
|
+
/** Families nest, so subtract this before summing notIndexed down the list. */
|
|
3930
|
+
readonly alreadyCountedAbove: z.ZodNumber;
|
|
3931
|
+
}, z.core.$strip>>;
|
|
3932
|
+
readonly establishedNote: z.ZodNullable<z.ZodString>;
|
|
3933
|
+
readonly ranked: z.ZodArray<z.ZodObject<{
|
|
3934
|
+
readonly family: z.ZodString;
|
|
3935
|
+
readonly pages: z.ZodNumber;
|
|
3936
|
+
readonly notIndexed: z.ZodNumber;
|
|
3937
|
+
readonly notIndexedPercent: z.ZodNumber;
|
|
3938
|
+
/** False means this family has NOT been shown to differ from the rest of the Site. */
|
|
3939
|
+
readonly statisticallyEstablished: z.ZodBoolean;
|
|
3940
|
+
readonly belowMinimumSample: z.ZodBoolean;
|
|
3941
|
+
}, z.core.$strip>>;
|
|
3942
|
+
readonly rankedTotal: z.ZodNumber;
|
|
3943
|
+
readonly minSectionPages: z.ZodNumber;
|
|
3944
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
3945
|
+
readonly analysed: z.ZodBoolean;
|
|
3946
|
+
readonly reason: z.ZodNullable<z.ZodString>;
|
|
3947
|
+
readonly message: z.ZodNullable<z.ZodString>;
|
|
3948
|
+
readonly asOf: z.ZodNullable<z.ZodString>;
|
|
3949
|
+
readonly baseline: z.ZodNullable<z.ZodObject<{
|
|
3950
|
+
pages: z.ZodNumber;
|
|
3951
|
+
notIndexed: z.ZodNumber;
|
|
3952
|
+
notIndexedPercent: z.ZodNumber;
|
|
3953
|
+
}, z.core.$loose>>;
|
|
3954
|
+
readonly coverage: z.ZodNullable<z.ZodObject<{
|
|
3955
|
+
analysed: z.ZodNumber;
|
|
3956
|
+
notIndexedButNeverCrawled: z.ZodNumber;
|
|
3957
|
+
excludedFragments: z.ZodNumber;
|
|
3958
|
+
}, z.core.$loose>>;
|
|
3959
|
+
readonly method: z.ZodNullable<z.ZodString>;
|
|
3960
|
+
readonly familiesTested: z.ZodNumber;
|
|
3961
|
+
readonly established: z.ZodArray<z.ZodObject<{
|
|
3962
|
+
readonly family: z.ZodString;
|
|
3963
|
+
readonly dimension: z.ZodString;
|
|
3964
|
+
readonly pathPrefix: z.ZodNullable<z.ZodString>;
|
|
3965
|
+
readonly pages: z.ZodNumber;
|
|
3966
|
+
readonly notIndexed: z.ZodNumber;
|
|
3967
|
+
readonly notIndexedPercent: z.ZodNumber;
|
|
3968
|
+
readonly restOfSitePercent: z.ZodNumber;
|
|
3969
|
+
readonly restOfSitePages: z.ZodNumber;
|
|
3970
|
+
readonly confidenceIntervalLower: z.ZodNumber;
|
|
3971
|
+
readonly confidenceIntervalUpper: z.ZodNumber;
|
|
3972
|
+
readonly alreadyCountedAbove: z.ZodNumber;
|
|
3973
|
+
}, z.core.$strip>>;
|
|
3974
|
+
readonly establishedNote: z.ZodNullable<z.ZodString>;
|
|
3975
|
+
readonly ranked: z.ZodArray<z.ZodObject<{
|
|
3976
|
+
readonly family: z.ZodString;
|
|
3977
|
+
readonly pages: z.ZodNumber;
|
|
3978
|
+
readonly notIndexed: z.ZodNumber;
|
|
3979
|
+
readonly notIndexedPercent: z.ZodNumber;
|
|
3980
|
+
readonly statisticallyEstablished: z.ZodBoolean;
|
|
3981
|
+
readonly belowMinimumSample: z.ZodBoolean;
|
|
3982
|
+
}, z.core.$strip>>;
|
|
3983
|
+
readonly rankedTotal: z.ZodNumber;
|
|
3984
|
+
readonly minSectionPages: z.ZodNumber;
|
|
3985
|
+
}, z.core.$strip>>;
|
|
3986
|
+
export declare const indexCohortsResponseEnvelopeSchema: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
|
|
3987
|
+
data: z.ZodObject<{
|
|
3988
|
+
readonly analysed: z.ZodBoolean;
|
|
3989
|
+
readonly reason: z.ZodNullable<z.ZodString>;
|
|
3990
|
+
readonly message: z.ZodNullable<z.ZodString>;
|
|
3991
|
+
readonly asOf: z.ZodNullable<z.ZodString>;
|
|
3992
|
+
readonly baseline: z.ZodNullable<z.ZodObject<{
|
|
3993
|
+
pages: z.ZodNumber;
|
|
3994
|
+
notIndexed: z.ZodNumber;
|
|
3995
|
+
notIndexedPercent: z.ZodNumber;
|
|
3996
|
+
}, z.core.$strict>>;
|
|
3997
|
+
readonly coverage: z.ZodNullable<z.ZodObject<{
|
|
3998
|
+
analysed: z.ZodNumber;
|
|
3999
|
+
notIndexedButNeverCrawled: z.ZodNumber;
|
|
4000
|
+
excludedFragments: z.ZodNumber;
|
|
4001
|
+
}, z.core.$strict>>;
|
|
4002
|
+
readonly method: z.ZodNullable<z.ZodString>;
|
|
4003
|
+
readonly familiesTested: z.ZodNumber;
|
|
4004
|
+
readonly established: z.ZodArray<z.ZodObject<{
|
|
4005
|
+
readonly family: z.ZodString;
|
|
4006
|
+
readonly dimension: z.ZodString;
|
|
4007
|
+
/**
|
|
4008
|
+
* Null when the cohort is not expressible as one path prefix. Every
|
|
4009
|
+
* `lifecycle` cohort is: version-pinned pages span the whole Site, so a
|
|
4010
|
+
* drill-through must fall back to the unfiltered not-indexed list.
|
|
4011
|
+
*/
|
|
4012
|
+
readonly pathPrefix: z.ZodNullable<z.ZodString>;
|
|
4013
|
+
readonly pages: z.ZodNumber;
|
|
4014
|
+
readonly notIndexed: z.ZodNumber;
|
|
4015
|
+
readonly notIndexedPercent: z.ZodNumber;
|
|
4016
|
+
readonly restOfSitePercent: z.ZodNumber;
|
|
4017
|
+
readonly restOfSitePages: z.ZodNumber;
|
|
4018
|
+
readonly confidenceIntervalLower: z.ZodNumber;
|
|
4019
|
+
readonly confidenceIntervalUpper: z.ZodNumber;
|
|
4020
|
+
/** Families nest, so subtract this before summing notIndexed down the list. */
|
|
4021
|
+
readonly alreadyCountedAbove: z.ZodNumber;
|
|
4022
|
+
}, z.core.$strip>>;
|
|
4023
|
+
readonly establishedNote: z.ZodNullable<z.ZodString>;
|
|
4024
|
+
readonly ranked: z.ZodArray<z.ZodObject<{
|
|
4025
|
+
readonly family: z.ZodString;
|
|
4026
|
+
readonly pages: z.ZodNumber;
|
|
4027
|
+
readonly notIndexed: z.ZodNumber;
|
|
4028
|
+
readonly notIndexedPercent: z.ZodNumber;
|
|
4029
|
+
/** False means this family has NOT been shown to differ from the rest of the Site. */
|
|
4030
|
+
readonly statisticallyEstablished: z.ZodBoolean;
|
|
4031
|
+
readonly belowMinimumSample: z.ZodBoolean;
|
|
4032
|
+
}, z.core.$strip>>;
|
|
4033
|
+
readonly rankedTotal: z.ZodNumber;
|
|
4034
|
+
readonly minSectionPages: z.ZodNumber;
|
|
4035
|
+
}, z.core.$strip>;
|
|
4036
|
+
meta: z.ZodObject<{
|
|
4037
|
+
requestId: z.ZodString;
|
|
4038
|
+
version: z.ZodLiteral<"1.0">;
|
|
4039
|
+
}, z.core.$strict>;
|
|
4040
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
4041
|
+
data: z.ZodObject<{
|
|
4042
|
+
readonly analysed: z.ZodBoolean;
|
|
4043
|
+
readonly reason: z.ZodNullable<z.ZodString>;
|
|
4044
|
+
readonly message: z.ZodNullable<z.ZodString>;
|
|
4045
|
+
readonly asOf: z.ZodNullable<z.ZodString>;
|
|
4046
|
+
readonly baseline: z.ZodNullable<z.ZodObject<{
|
|
4047
|
+
pages: z.ZodNumber;
|
|
4048
|
+
notIndexed: z.ZodNumber;
|
|
4049
|
+
notIndexedPercent: z.ZodNumber;
|
|
4050
|
+
}, z.core.$loose>>;
|
|
4051
|
+
readonly coverage: z.ZodNullable<z.ZodObject<{
|
|
4052
|
+
analysed: z.ZodNumber;
|
|
4053
|
+
notIndexedButNeverCrawled: z.ZodNumber;
|
|
4054
|
+
excludedFragments: z.ZodNumber;
|
|
4055
|
+
}, z.core.$loose>>;
|
|
4056
|
+
readonly method: z.ZodNullable<z.ZodString>;
|
|
4057
|
+
readonly familiesTested: z.ZodNumber;
|
|
4058
|
+
readonly established: z.ZodArray<z.ZodObject<{
|
|
4059
|
+
readonly family: z.ZodString;
|
|
4060
|
+
readonly dimension: z.ZodString;
|
|
4061
|
+
readonly pathPrefix: z.ZodNullable<z.ZodString>;
|
|
4062
|
+
readonly pages: z.ZodNumber;
|
|
4063
|
+
readonly notIndexed: z.ZodNumber;
|
|
4064
|
+
readonly notIndexedPercent: z.ZodNumber;
|
|
4065
|
+
readonly restOfSitePercent: z.ZodNumber;
|
|
4066
|
+
readonly restOfSitePages: z.ZodNumber;
|
|
4067
|
+
readonly confidenceIntervalLower: z.ZodNumber;
|
|
4068
|
+
readonly confidenceIntervalUpper: z.ZodNumber;
|
|
4069
|
+
readonly alreadyCountedAbove: z.ZodNumber;
|
|
4070
|
+
}, z.core.$strip>>;
|
|
4071
|
+
readonly establishedNote: z.ZodNullable<z.ZodString>;
|
|
4072
|
+
readonly ranked: z.ZodArray<z.ZodObject<{
|
|
4073
|
+
readonly family: z.ZodString;
|
|
4074
|
+
readonly pages: z.ZodNumber;
|
|
4075
|
+
readonly notIndexed: z.ZodNumber;
|
|
4076
|
+
readonly notIndexedPercent: z.ZodNumber;
|
|
4077
|
+
readonly statisticallyEstablished: z.ZodBoolean;
|
|
4078
|
+
readonly belowMinimumSample: z.ZodBoolean;
|
|
4079
|
+
}, z.core.$strip>>;
|
|
4080
|
+
readonly rankedTotal: z.ZodNumber;
|
|
4081
|
+
readonly minSectionPages: z.ZodNumber;
|
|
4082
|
+
}, z.core.$strip>;
|
|
4083
|
+
meta: z.ZodObject<{
|
|
4084
|
+
requestId: z.ZodString;
|
|
4085
|
+
version: z.ZodLiteral<"1.0">;
|
|
4086
|
+
}, z.core.$loose>;
|
|
4087
|
+
}, z.core.$strip>>;
|
|
4088
|
+
export type IndexCohorts = z.output<typeof indexCohortsDataSchema.producer>;
|
|
4089
|
+
export declare const indexCohortsReadOperation: {
|
|
4090
|
+
readonly id: 'sites.search.indexing.cohorts.read';
|
|
4091
|
+
readonly method: 'GET';
|
|
4092
|
+
readonly path: '/api/v1/sites/{siteId}/search/indexing/cohorts';
|
|
4093
|
+
readonly visibility: 'public';
|
|
4094
|
+
readonly semantics: {
|
|
4095
|
+
readonly kind: 'query';
|
|
4096
|
+
readonly sideEffects: 'none';
|
|
4097
|
+
readonly retry: 'idempotent';
|
|
4098
|
+
readonly readConsistency: 'primary';
|
|
4099
|
+
};
|
|
4100
|
+
readonly auth: {
|
|
4101
|
+
readonly credentials: readonly ["session", "api_token"];
|
|
4102
|
+
readonly scopes: readonly ["sites:read"];
|
|
4103
|
+
readonly minimumRole: 'viewer';
|
|
4104
|
+
readonly ownership: 'site';
|
|
4105
|
+
};
|
|
4106
|
+
readonly request: {
|
|
4107
|
+
readonly params: z.ZodObject<{
|
|
4108
|
+
siteId: z.ZodString;
|
|
4109
|
+
}, z.core.$strict>;
|
|
4110
|
+
readonly query: z.ZodObject<{
|
|
4111
|
+
limit: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
|
|
4112
|
+
minSectionPages: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
|
|
4113
|
+
}, z.core.$strict>;
|
|
4114
|
+
readonly headers: null;
|
|
4115
|
+
readonly body: null;
|
|
4116
|
+
};
|
|
4117
|
+
readonly responses: {
|
|
4118
|
+
readonly 200: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
|
|
4119
|
+
data: z.ZodObject<{
|
|
4120
|
+
readonly analysed: z.ZodBoolean;
|
|
4121
|
+
readonly reason: z.ZodNullable<z.ZodString>;
|
|
4122
|
+
readonly message: z.ZodNullable<z.ZodString>;
|
|
4123
|
+
readonly asOf: z.ZodNullable<z.ZodString>;
|
|
4124
|
+
readonly baseline: z.ZodNullable<z.ZodObject<{
|
|
4125
|
+
pages: z.ZodNumber;
|
|
4126
|
+
notIndexed: z.ZodNumber;
|
|
4127
|
+
notIndexedPercent: z.ZodNumber;
|
|
4128
|
+
}, z.core.$strict>>;
|
|
4129
|
+
readonly coverage: z.ZodNullable<z.ZodObject<{
|
|
4130
|
+
analysed: z.ZodNumber;
|
|
4131
|
+
notIndexedButNeverCrawled: z.ZodNumber;
|
|
4132
|
+
excludedFragments: z.ZodNumber;
|
|
4133
|
+
}, z.core.$strict>>;
|
|
4134
|
+
readonly method: z.ZodNullable<z.ZodString>;
|
|
4135
|
+
readonly familiesTested: z.ZodNumber;
|
|
4136
|
+
readonly established: z.ZodArray<z.ZodObject<{
|
|
4137
|
+
readonly family: z.ZodString;
|
|
4138
|
+
readonly dimension: z.ZodString;
|
|
4139
|
+
/**
|
|
4140
|
+
* Null when the cohort is not expressible as one path prefix. Every
|
|
4141
|
+
* `lifecycle` cohort is: version-pinned pages span the whole Site, so a
|
|
4142
|
+
* drill-through must fall back to the unfiltered not-indexed list.
|
|
4143
|
+
*/
|
|
4144
|
+
readonly pathPrefix: z.ZodNullable<z.ZodString>;
|
|
4145
|
+
readonly pages: z.ZodNumber;
|
|
4146
|
+
readonly notIndexed: z.ZodNumber;
|
|
4147
|
+
readonly notIndexedPercent: z.ZodNumber;
|
|
4148
|
+
readonly restOfSitePercent: z.ZodNumber;
|
|
4149
|
+
readonly restOfSitePages: z.ZodNumber;
|
|
4150
|
+
readonly confidenceIntervalLower: z.ZodNumber;
|
|
4151
|
+
readonly confidenceIntervalUpper: z.ZodNumber;
|
|
4152
|
+
/** Families nest, so subtract this before summing notIndexed down the list. */
|
|
4153
|
+
readonly alreadyCountedAbove: z.ZodNumber;
|
|
4154
|
+
}, z.core.$strip>>;
|
|
4155
|
+
readonly establishedNote: z.ZodNullable<z.ZodString>;
|
|
4156
|
+
readonly ranked: z.ZodArray<z.ZodObject<{
|
|
4157
|
+
readonly family: z.ZodString;
|
|
4158
|
+
readonly pages: z.ZodNumber;
|
|
4159
|
+
readonly notIndexed: z.ZodNumber;
|
|
4160
|
+
readonly notIndexedPercent: z.ZodNumber;
|
|
4161
|
+
/** False means this family has NOT been shown to differ from the rest of the Site. */
|
|
4162
|
+
readonly statisticallyEstablished: z.ZodBoolean;
|
|
4163
|
+
readonly belowMinimumSample: z.ZodBoolean;
|
|
4164
|
+
}, z.core.$strip>>;
|
|
4165
|
+
readonly rankedTotal: z.ZodNumber;
|
|
4166
|
+
readonly minSectionPages: z.ZodNumber;
|
|
4167
|
+
}, z.core.$strip>;
|
|
4168
|
+
meta: z.ZodObject<{
|
|
4169
|
+
requestId: z.ZodString;
|
|
4170
|
+
version: z.ZodLiteral<"1.0">;
|
|
4171
|
+
}, z.core.$strict>;
|
|
4172
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
4173
|
+
data: z.ZodObject<{
|
|
4174
|
+
readonly analysed: z.ZodBoolean;
|
|
4175
|
+
readonly reason: z.ZodNullable<z.ZodString>;
|
|
4176
|
+
readonly message: z.ZodNullable<z.ZodString>;
|
|
4177
|
+
readonly asOf: z.ZodNullable<z.ZodString>;
|
|
4178
|
+
readonly baseline: z.ZodNullable<z.ZodObject<{
|
|
4179
|
+
pages: z.ZodNumber;
|
|
4180
|
+
notIndexed: z.ZodNumber;
|
|
4181
|
+
notIndexedPercent: z.ZodNumber;
|
|
4182
|
+
}, z.core.$loose>>;
|
|
4183
|
+
readonly coverage: z.ZodNullable<z.ZodObject<{
|
|
4184
|
+
analysed: z.ZodNumber;
|
|
4185
|
+
notIndexedButNeverCrawled: z.ZodNumber;
|
|
4186
|
+
excludedFragments: z.ZodNumber;
|
|
4187
|
+
}, z.core.$loose>>;
|
|
4188
|
+
readonly method: z.ZodNullable<z.ZodString>;
|
|
4189
|
+
readonly familiesTested: z.ZodNumber;
|
|
4190
|
+
readonly established: z.ZodArray<z.ZodObject<{
|
|
4191
|
+
readonly family: z.ZodString;
|
|
4192
|
+
readonly dimension: z.ZodString;
|
|
4193
|
+
readonly pathPrefix: z.ZodNullable<z.ZodString>;
|
|
4194
|
+
readonly pages: z.ZodNumber;
|
|
4195
|
+
readonly notIndexed: z.ZodNumber;
|
|
4196
|
+
readonly notIndexedPercent: z.ZodNumber;
|
|
4197
|
+
readonly restOfSitePercent: z.ZodNumber;
|
|
4198
|
+
readonly restOfSitePages: z.ZodNumber;
|
|
4199
|
+
readonly confidenceIntervalLower: z.ZodNumber;
|
|
4200
|
+
readonly confidenceIntervalUpper: z.ZodNumber;
|
|
4201
|
+
readonly alreadyCountedAbove: z.ZodNumber;
|
|
4202
|
+
}, z.core.$strip>>;
|
|
4203
|
+
readonly establishedNote: z.ZodNullable<z.ZodString>;
|
|
4204
|
+
readonly ranked: z.ZodArray<z.ZodObject<{
|
|
4205
|
+
readonly family: z.ZodString;
|
|
4206
|
+
readonly pages: z.ZodNumber;
|
|
4207
|
+
readonly notIndexed: z.ZodNumber;
|
|
4208
|
+
readonly notIndexedPercent: z.ZodNumber;
|
|
4209
|
+
readonly statisticallyEstablished: z.ZodBoolean;
|
|
4210
|
+
readonly belowMinimumSample: z.ZodBoolean;
|
|
4211
|
+
}, z.core.$strip>>;
|
|
4212
|
+
readonly rankedTotal: z.ZodNumber;
|
|
4213
|
+
readonly minSectionPages: z.ZodNumber;
|
|
4214
|
+
}, z.core.$strip>;
|
|
4215
|
+
meta: z.ZodObject<{
|
|
4216
|
+
requestId: z.ZodString;
|
|
4217
|
+
version: z.ZodLiteral<"1.0">;
|
|
4218
|
+
}, z.core.$loose>;
|
|
4219
|
+
}, z.core.$strip>>;
|
|
4220
|
+
};
|
|
4221
|
+
readonly errors: readonly ["invalid_request", "unauthorized", "auth_expired", "forbidden", "not_found", "entitlement_required", "conflict", "rate_limited", "contract_violation", "internal_error"];
|
|
4222
|
+
readonly errorResponse: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
|
|
4223
|
+
readonly error: z.ZodObject<{
|
|
4224
|
+
code: z.ZodEnum<{
|
|
4225
|
+
auth_expired: "auth_expired";
|
|
4226
|
+
conflict: "conflict";
|
|
4227
|
+
contract_violation: "contract_violation";
|
|
4228
|
+
entitlement_required: "entitlement_required";
|
|
4229
|
+
forbidden: "forbidden";
|
|
4230
|
+
internal_error: "internal_error";
|
|
4231
|
+
invalid_request: "invalid_request";
|
|
4232
|
+
not_found: "not_found";
|
|
4233
|
+
provider_unavailable: "provider_unavailable";
|
|
4234
|
+
quota_exhausted: "quota_exhausted";
|
|
4235
|
+
rate_limited: "rate_limited";
|
|
4236
|
+
site_ambiguous: "site_ambiguous";
|
|
4237
|
+
stale_evidence: "stale_evidence";
|
|
4238
|
+
unauthorized: "unauthorized";
|
|
4239
|
+
}>;
|
|
4240
|
+
message: z.ZodString;
|
|
4241
|
+
requestId: z.ZodString;
|
|
4242
|
+
retryable: z.ZodBoolean;
|
|
4243
|
+
details: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
4244
|
+
}, z.core.$strict>;
|
|
4245
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
4246
|
+
readonly error: z.ZodObject<{
|
|
4247
|
+
code: z.ZodEnum<{
|
|
4248
|
+
auth_expired: "auth_expired";
|
|
4249
|
+
conflict: "conflict";
|
|
4250
|
+
contract_violation: "contract_violation";
|
|
4251
|
+
entitlement_required: "entitlement_required";
|
|
4252
|
+
forbidden: "forbidden";
|
|
4253
|
+
internal_error: "internal_error";
|
|
4254
|
+
invalid_request: "invalid_request";
|
|
4255
|
+
not_found: "not_found";
|
|
4256
|
+
provider_unavailable: "provider_unavailable";
|
|
4257
|
+
quota_exhausted: "quota_exhausted";
|
|
4258
|
+
rate_limited: "rate_limited";
|
|
4259
|
+
site_ambiguous: "site_ambiguous";
|
|
4260
|
+
stale_evidence: "stale_evidence";
|
|
4261
|
+
unauthorized: "unauthorized";
|
|
4262
|
+
}>;
|
|
4263
|
+
message: z.ZodString;
|
|
4264
|
+
requestId: z.ZodString;
|
|
4265
|
+
retryable: z.ZodBoolean;
|
|
4266
|
+
details: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
4267
|
+
}, z.core.$loose>;
|
|
4268
|
+
}, z.core.$strip>>;
|
|
4269
|
+
readonly resources: {
|
|
4270
|
+
readonly reads: readonly [{
|
|
4271
|
+
readonly type: 'site.collection';
|
|
4272
|
+
readonly idFrom: 'params.siteId';
|
|
4273
|
+
}];
|
|
4274
|
+
readonly changes: readonly [];
|
|
4275
|
+
};
|
|
4276
|
+
readonly policy: {
|
|
4277
|
+
readonly rate: {
|
|
4278
|
+
readonly name: 'public-v1-fixed-window';
|
|
4279
|
+
readonly limit: 50;
|
|
4280
|
+
readonly windowSeconds: 60;
|
|
4281
|
+
};
|
|
4282
|
+
readonly idempotency: {
|
|
4283
|
+
readonly _tag: 'none';
|
|
4284
|
+
};
|
|
4285
|
+
readonly entitlement: null;
|
|
4286
|
+
readonly meter: null;
|
|
4287
|
+
};
|
|
4288
|
+
readonly lifecycle: {
|
|
4289
|
+
readonly introduced: '1.2.0';
|
|
4290
|
+
};
|
|
4291
|
+
readonly docs: {
|
|
4292
|
+
readonly summary: 'Read indexing by route family';
|
|
4293
|
+
readonly description: 'Returns the not-indexed rate per route family, joined from the Site crawl to Google per-URL index state, so an indexing failure that clusters in one template surfaces as one finding instead of many page-level ones. Read it before listing individual not-indexed URLs. `established` holds only families proven worse than the rest of the Site after a Bonferroni correction; `ranked` orders every family by raw rate with no test applied and is leads only. `analysed: false` means there is no completed crawl or no index state to join, which is not the same as healthy indexing.';
|
|
4294
|
+
readonly tags: readonly ["Search Console"];
|
|
4295
|
+
readonly examples: readonly [{
|
|
4296
|
+
readonly request: {
|
|
4297
|
+
readonly params: {
|
|
4298
|
+
readonly siteId: 'site_01JXYZ';
|
|
4299
|
+
};
|
|
4300
|
+
readonly query: {
|
|
4301
|
+
readonly limit: 12;
|
|
4302
|
+
readonly minSectionPages: 5;
|
|
4303
|
+
};
|
|
4304
|
+
};
|
|
4305
|
+
readonly response: {
|
|
4306
|
+
readonly status: 200;
|
|
4307
|
+
readonly body: {
|
|
4308
|
+
readonly data: {
|
|
4309
|
+
readonly analysed: true;
|
|
4310
|
+
readonly reason: null;
|
|
4311
|
+
readonly message: null;
|
|
4312
|
+
readonly asOf: '2026-09-01T00:00:00.000Z';
|
|
4313
|
+
readonly baseline: {
|
|
4314
|
+
readonly pages: 1200;
|
|
4315
|
+
readonly notIndexed: 180;
|
|
4316
|
+
readonly notIndexedPercent: 15;
|
|
4317
|
+
};
|
|
4318
|
+
readonly coverage: {
|
|
4319
|
+
readonly analysed: 1200;
|
|
4320
|
+
readonly notIndexedButNeverCrawled: 40;
|
|
4321
|
+
readonly excludedFragments: 2;
|
|
4322
|
+
};
|
|
4323
|
+
readonly method: 'Wilson score interval per family against its own complement, Bonferroni-corrected across 9 tested families (critical value z=2.77).';
|
|
4324
|
+
readonly familiesTested: 9;
|
|
4325
|
+
readonly established: readonly [{
|
|
4326
|
+
readonly family: '/docs';
|
|
4327
|
+
readonly dimension: 'depth-1';
|
|
4328
|
+
readonly pathPrefix: '/docs';
|
|
4329
|
+
readonly pages: 420;
|
|
4330
|
+
readonly notIndexed: 150;
|
|
4331
|
+
readonly notIndexedPercent: 35.7;
|
|
4332
|
+
readonly restOfSitePercent: 3.8;
|
|
4333
|
+
readonly restOfSitePages: 780;
|
|
4334
|
+
readonly confidenceIntervalLower: 31.2;
|
|
4335
|
+
readonly confidenceIntervalUpper: 40.4;
|
|
4336
|
+
readonly alreadyCountedAbove: 0;
|
|
4337
|
+
}];
|
|
4338
|
+
readonly establishedNote: null;
|
|
4339
|
+
readonly ranked: readonly [{
|
|
4340
|
+
readonly family: '/docs';
|
|
4341
|
+
readonly pages: 420;
|
|
4342
|
+
readonly notIndexed: 150;
|
|
4343
|
+
readonly notIndexedPercent: 35.7;
|
|
4344
|
+
readonly statisticallyEstablished: true;
|
|
4345
|
+
readonly belowMinimumSample: false;
|
|
4346
|
+
}];
|
|
4347
|
+
readonly rankedTotal: 9;
|
|
4348
|
+
readonly minSectionPages: 5;
|
|
4349
|
+
};
|
|
4350
|
+
readonly meta: {
|
|
4351
|
+
readonly requestId: 'req_01JXYZ';
|
|
4352
|
+
readonly version: '1.0';
|
|
4353
|
+
};
|
|
4354
|
+
};
|
|
4355
|
+
};
|
|
4356
|
+
}];
|
|
4357
|
+
};
|
|
4358
|
+
};
|
|
3837
4359
|
export declare const searchV1Registry: import("./core.js").PublicV1Registry<{
|
|
3838
4360
|
readonly queryAnalytics: {
|
|
3839
4361
|
readonly visibility: 'public';
|
|
@@ -5593,6 +6115,276 @@ export declare const searchV1Registry: import("./core.js").PublicV1Registry<{
|
|
|
5593
6115
|
}];
|
|
5594
6116
|
};
|
|
5595
6117
|
};
|
|
6118
|
+
readonly readIndexingCohorts: {
|
|
6119
|
+
readonly id: 'sites.search.indexing.cohorts.read';
|
|
6120
|
+
readonly method: 'GET';
|
|
6121
|
+
readonly path: '/api/v1/sites/{siteId}/search/indexing/cohorts';
|
|
6122
|
+
readonly visibility: 'public';
|
|
6123
|
+
readonly semantics: {
|
|
6124
|
+
readonly kind: 'query';
|
|
6125
|
+
readonly sideEffects: 'none';
|
|
6126
|
+
readonly retry: 'idempotent';
|
|
6127
|
+
readonly readConsistency: 'primary';
|
|
6128
|
+
};
|
|
6129
|
+
readonly auth: {
|
|
6130
|
+
readonly credentials: readonly ["session", "api_token"];
|
|
6131
|
+
readonly scopes: readonly ["sites:read"];
|
|
6132
|
+
readonly minimumRole: 'viewer';
|
|
6133
|
+
readonly ownership: 'site';
|
|
6134
|
+
};
|
|
6135
|
+
readonly request: {
|
|
6136
|
+
readonly params: z.ZodObject<{
|
|
6137
|
+
siteId: z.ZodString;
|
|
6138
|
+
}, z.core.$strict>;
|
|
6139
|
+
readonly query: z.ZodObject<{
|
|
6140
|
+
limit: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
|
|
6141
|
+
minSectionPages: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
|
|
6142
|
+
}, z.core.$strict>;
|
|
6143
|
+
readonly headers: null;
|
|
6144
|
+
readonly body: null;
|
|
6145
|
+
};
|
|
6146
|
+
readonly responses: {
|
|
6147
|
+
readonly 200: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
|
|
6148
|
+
data: z.ZodObject<{
|
|
6149
|
+
readonly analysed: z.ZodBoolean;
|
|
6150
|
+
readonly reason: z.ZodNullable<z.ZodString>;
|
|
6151
|
+
readonly message: z.ZodNullable<z.ZodString>;
|
|
6152
|
+
readonly asOf: z.ZodNullable<z.ZodString>;
|
|
6153
|
+
readonly baseline: z.ZodNullable<z.ZodObject<{
|
|
6154
|
+
pages: z.ZodNumber;
|
|
6155
|
+
notIndexed: z.ZodNumber;
|
|
6156
|
+
notIndexedPercent: z.ZodNumber;
|
|
6157
|
+
}, z.core.$strict>>;
|
|
6158
|
+
readonly coverage: z.ZodNullable<z.ZodObject<{
|
|
6159
|
+
analysed: z.ZodNumber;
|
|
6160
|
+
notIndexedButNeverCrawled: z.ZodNumber;
|
|
6161
|
+
excludedFragments: z.ZodNumber;
|
|
6162
|
+
}, z.core.$strict>>;
|
|
6163
|
+
readonly method: z.ZodNullable<z.ZodString>;
|
|
6164
|
+
readonly familiesTested: z.ZodNumber;
|
|
6165
|
+
readonly established: z.ZodArray<z.ZodObject<{
|
|
6166
|
+
readonly family: z.ZodString;
|
|
6167
|
+
readonly dimension: z.ZodString;
|
|
6168
|
+
/**
|
|
6169
|
+
* Null when the cohort is not expressible as one path prefix. Every
|
|
6170
|
+
* `lifecycle` cohort is: version-pinned pages span the whole Site, so a
|
|
6171
|
+
* drill-through must fall back to the unfiltered not-indexed list.
|
|
6172
|
+
*/
|
|
6173
|
+
readonly pathPrefix: z.ZodNullable<z.ZodString>;
|
|
6174
|
+
readonly pages: z.ZodNumber;
|
|
6175
|
+
readonly notIndexed: z.ZodNumber;
|
|
6176
|
+
readonly notIndexedPercent: z.ZodNumber;
|
|
6177
|
+
readonly restOfSitePercent: z.ZodNumber;
|
|
6178
|
+
readonly restOfSitePages: z.ZodNumber;
|
|
6179
|
+
readonly confidenceIntervalLower: z.ZodNumber;
|
|
6180
|
+
readonly confidenceIntervalUpper: z.ZodNumber;
|
|
6181
|
+
/** Families nest, so subtract this before summing notIndexed down the list. */
|
|
6182
|
+
readonly alreadyCountedAbove: z.ZodNumber;
|
|
6183
|
+
}, z.core.$strip>>;
|
|
6184
|
+
readonly establishedNote: z.ZodNullable<z.ZodString>;
|
|
6185
|
+
readonly ranked: z.ZodArray<z.ZodObject<{
|
|
6186
|
+
readonly family: z.ZodString;
|
|
6187
|
+
readonly pages: z.ZodNumber;
|
|
6188
|
+
readonly notIndexed: z.ZodNumber;
|
|
6189
|
+
readonly notIndexedPercent: z.ZodNumber;
|
|
6190
|
+
/** False means this family has NOT been shown to differ from the rest of the Site. */
|
|
6191
|
+
readonly statisticallyEstablished: z.ZodBoolean;
|
|
6192
|
+
readonly belowMinimumSample: z.ZodBoolean;
|
|
6193
|
+
}, z.core.$strip>>;
|
|
6194
|
+
readonly rankedTotal: z.ZodNumber;
|
|
6195
|
+
readonly minSectionPages: z.ZodNumber;
|
|
6196
|
+
}, z.core.$strip>;
|
|
6197
|
+
meta: z.ZodObject<{
|
|
6198
|
+
requestId: z.ZodString;
|
|
6199
|
+
version: z.ZodLiteral<"1.0">;
|
|
6200
|
+
}, z.core.$strict>;
|
|
6201
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
6202
|
+
data: z.ZodObject<{
|
|
6203
|
+
readonly analysed: z.ZodBoolean;
|
|
6204
|
+
readonly reason: z.ZodNullable<z.ZodString>;
|
|
6205
|
+
readonly message: z.ZodNullable<z.ZodString>;
|
|
6206
|
+
readonly asOf: z.ZodNullable<z.ZodString>;
|
|
6207
|
+
readonly baseline: z.ZodNullable<z.ZodObject<{
|
|
6208
|
+
pages: z.ZodNumber;
|
|
6209
|
+
notIndexed: z.ZodNumber;
|
|
6210
|
+
notIndexedPercent: z.ZodNumber;
|
|
6211
|
+
}, z.core.$loose>>;
|
|
6212
|
+
readonly coverage: z.ZodNullable<z.ZodObject<{
|
|
6213
|
+
analysed: z.ZodNumber;
|
|
6214
|
+
notIndexedButNeverCrawled: z.ZodNumber;
|
|
6215
|
+
excludedFragments: z.ZodNumber;
|
|
6216
|
+
}, z.core.$loose>>;
|
|
6217
|
+
readonly method: z.ZodNullable<z.ZodString>;
|
|
6218
|
+
readonly familiesTested: z.ZodNumber;
|
|
6219
|
+
readonly established: z.ZodArray<z.ZodObject<{
|
|
6220
|
+
readonly family: z.ZodString;
|
|
6221
|
+
readonly dimension: z.ZodString;
|
|
6222
|
+
readonly pathPrefix: z.ZodNullable<z.ZodString>;
|
|
6223
|
+
readonly pages: z.ZodNumber;
|
|
6224
|
+
readonly notIndexed: z.ZodNumber;
|
|
6225
|
+
readonly notIndexedPercent: z.ZodNumber;
|
|
6226
|
+
readonly restOfSitePercent: z.ZodNumber;
|
|
6227
|
+
readonly restOfSitePages: z.ZodNumber;
|
|
6228
|
+
readonly confidenceIntervalLower: z.ZodNumber;
|
|
6229
|
+
readonly confidenceIntervalUpper: z.ZodNumber;
|
|
6230
|
+
readonly alreadyCountedAbove: z.ZodNumber;
|
|
6231
|
+
}, z.core.$strip>>;
|
|
6232
|
+
readonly establishedNote: z.ZodNullable<z.ZodString>;
|
|
6233
|
+
readonly ranked: z.ZodArray<z.ZodObject<{
|
|
6234
|
+
readonly family: z.ZodString;
|
|
6235
|
+
readonly pages: z.ZodNumber;
|
|
6236
|
+
readonly notIndexed: z.ZodNumber;
|
|
6237
|
+
readonly notIndexedPercent: z.ZodNumber;
|
|
6238
|
+
readonly statisticallyEstablished: z.ZodBoolean;
|
|
6239
|
+
readonly belowMinimumSample: z.ZodBoolean;
|
|
6240
|
+
}, z.core.$strip>>;
|
|
6241
|
+
readonly rankedTotal: z.ZodNumber;
|
|
6242
|
+
readonly minSectionPages: z.ZodNumber;
|
|
6243
|
+
}, z.core.$strip>;
|
|
6244
|
+
meta: z.ZodObject<{
|
|
6245
|
+
requestId: z.ZodString;
|
|
6246
|
+
version: z.ZodLiteral<"1.0">;
|
|
6247
|
+
}, z.core.$loose>;
|
|
6248
|
+
}, z.core.$strip>>;
|
|
6249
|
+
};
|
|
6250
|
+
readonly errors: readonly ["invalid_request", "unauthorized", "auth_expired", "forbidden", "not_found", "entitlement_required", "conflict", "rate_limited", "contract_violation", "internal_error"];
|
|
6251
|
+
readonly errorResponse: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
|
|
6252
|
+
readonly error: z.ZodObject<{
|
|
6253
|
+
code: z.ZodEnum<{
|
|
6254
|
+
auth_expired: "auth_expired";
|
|
6255
|
+
conflict: "conflict";
|
|
6256
|
+
contract_violation: "contract_violation";
|
|
6257
|
+
entitlement_required: "entitlement_required";
|
|
6258
|
+
forbidden: "forbidden";
|
|
6259
|
+
internal_error: "internal_error";
|
|
6260
|
+
invalid_request: "invalid_request";
|
|
6261
|
+
not_found: "not_found";
|
|
6262
|
+
provider_unavailable: "provider_unavailable";
|
|
6263
|
+
quota_exhausted: "quota_exhausted";
|
|
6264
|
+
rate_limited: "rate_limited";
|
|
6265
|
+
site_ambiguous: "site_ambiguous";
|
|
6266
|
+
stale_evidence: "stale_evidence";
|
|
6267
|
+
unauthorized: "unauthorized";
|
|
6268
|
+
}>;
|
|
6269
|
+
message: z.ZodString;
|
|
6270
|
+
requestId: z.ZodString;
|
|
6271
|
+
retryable: z.ZodBoolean;
|
|
6272
|
+
details: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
6273
|
+
}, z.core.$strict>;
|
|
6274
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
6275
|
+
readonly error: z.ZodObject<{
|
|
6276
|
+
code: z.ZodEnum<{
|
|
6277
|
+
auth_expired: "auth_expired";
|
|
6278
|
+
conflict: "conflict";
|
|
6279
|
+
contract_violation: "contract_violation";
|
|
6280
|
+
entitlement_required: "entitlement_required";
|
|
6281
|
+
forbidden: "forbidden";
|
|
6282
|
+
internal_error: "internal_error";
|
|
6283
|
+
invalid_request: "invalid_request";
|
|
6284
|
+
not_found: "not_found";
|
|
6285
|
+
provider_unavailable: "provider_unavailable";
|
|
6286
|
+
quota_exhausted: "quota_exhausted";
|
|
6287
|
+
rate_limited: "rate_limited";
|
|
6288
|
+
site_ambiguous: "site_ambiguous";
|
|
6289
|
+
stale_evidence: "stale_evidence";
|
|
6290
|
+
unauthorized: "unauthorized";
|
|
6291
|
+
}>;
|
|
6292
|
+
message: z.ZodString;
|
|
6293
|
+
requestId: z.ZodString;
|
|
6294
|
+
retryable: z.ZodBoolean;
|
|
6295
|
+
details: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
6296
|
+
}, z.core.$loose>;
|
|
6297
|
+
}, z.core.$strip>>;
|
|
6298
|
+
readonly resources: {
|
|
6299
|
+
readonly reads: readonly [{
|
|
6300
|
+
readonly type: 'site.collection';
|
|
6301
|
+
readonly idFrom: 'params.siteId';
|
|
6302
|
+
}];
|
|
6303
|
+
readonly changes: readonly [];
|
|
6304
|
+
};
|
|
6305
|
+
readonly policy: {
|
|
6306
|
+
readonly rate: {
|
|
6307
|
+
readonly name: 'public-v1-fixed-window';
|
|
6308
|
+
readonly limit: 50;
|
|
6309
|
+
readonly windowSeconds: 60;
|
|
6310
|
+
};
|
|
6311
|
+
readonly idempotency: {
|
|
6312
|
+
readonly _tag: 'none';
|
|
6313
|
+
};
|
|
6314
|
+
readonly entitlement: null;
|
|
6315
|
+
readonly meter: null;
|
|
6316
|
+
};
|
|
6317
|
+
readonly lifecycle: {
|
|
6318
|
+
readonly introduced: '1.2.0';
|
|
6319
|
+
};
|
|
6320
|
+
readonly docs: {
|
|
6321
|
+
readonly summary: 'Read indexing by route family';
|
|
6322
|
+
readonly description: 'Returns the not-indexed rate per route family, joined from the Site crawl to Google per-URL index state, so an indexing failure that clusters in one template surfaces as one finding instead of many page-level ones. Read it before listing individual not-indexed URLs. `established` holds only families proven worse than the rest of the Site after a Bonferroni correction; `ranked` orders every family by raw rate with no test applied and is leads only. `analysed: false` means there is no completed crawl or no index state to join, which is not the same as healthy indexing.';
|
|
6323
|
+
readonly tags: readonly ["Search Console"];
|
|
6324
|
+
readonly examples: readonly [{
|
|
6325
|
+
readonly request: {
|
|
6326
|
+
readonly params: {
|
|
6327
|
+
readonly siteId: 'site_01JXYZ';
|
|
6328
|
+
};
|
|
6329
|
+
readonly query: {
|
|
6330
|
+
readonly limit: 12;
|
|
6331
|
+
readonly minSectionPages: 5;
|
|
6332
|
+
};
|
|
6333
|
+
};
|
|
6334
|
+
readonly response: {
|
|
6335
|
+
readonly status: 200;
|
|
6336
|
+
readonly body: {
|
|
6337
|
+
readonly data: {
|
|
6338
|
+
readonly analysed: true;
|
|
6339
|
+
readonly reason: null;
|
|
6340
|
+
readonly message: null;
|
|
6341
|
+
readonly asOf: '2026-09-01T00:00:00.000Z';
|
|
6342
|
+
readonly baseline: {
|
|
6343
|
+
readonly pages: 1200;
|
|
6344
|
+
readonly notIndexed: 180;
|
|
6345
|
+
readonly notIndexedPercent: 15;
|
|
6346
|
+
};
|
|
6347
|
+
readonly coverage: {
|
|
6348
|
+
readonly analysed: 1200;
|
|
6349
|
+
readonly notIndexedButNeverCrawled: 40;
|
|
6350
|
+
readonly excludedFragments: 2;
|
|
6351
|
+
};
|
|
6352
|
+
readonly method: 'Wilson score interval per family against its own complement, Bonferroni-corrected across 9 tested families (critical value z=2.77).';
|
|
6353
|
+
readonly familiesTested: 9;
|
|
6354
|
+
readonly established: readonly [{
|
|
6355
|
+
readonly family: '/docs';
|
|
6356
|
+
readonly dimension: 'depth-1';
|
|
6357
|
+
readonly pathPrefix: '/docs';
|
|
6358
|
+
readonly pages: 420;
|
|
6359
|
+
readonly notIndexed: 150;
|
|
6360
|
+
readonly notIndexedPercent: 35.7;
|
|
6361
|
+
readonly restOfSitePercent: 3.8;
|
|
6362
|
+
readonly restOfSitePages: 780;
|
|
6363
|
+
readonly confidenceIntervalLower: 31.2;
|
|
6364
|
+
readonly confidenceIntervalUpper: 40.4;
|
|
6365
|
+
readonly alreadyCountedAbove: 0;
|
|
6366
|
+
}];
|
|
6367
|
+
readonly establishedNote: null;
|
|
6368
|
+
readonly ranked: readonly [{
|
|
6369
|
+
readonly family: '/docs';
|
|
6370
|
+
readonly pages: 420;
|
|
6371
|
+
readonly notIndexed: 150;
|
|
6372
|
+
readonly notIndexedPercent: 35.7;
|
|
6373
|
+
readonly statisticallyEstablished: true;
|
|
6374
|
+
readonly belowMinimumSample: false;
|
|
6375
|
+
}];
|
|
6376
|
+
readonly rankedTotal: 9;
|
|
6377
|
+
readonly minSectionPages: 5;
|
|
6378
|
+
};
|
|
6379
|
+
readonly meta: {
|
|
6380
|
+
readonly requestId: 'req_01JXYZ';
|
|
6381
|
+
readonly version: '1.0';
|
|
6382
|
+
};
|
|
6383
|
+
};
|
|
6384
|
+
};
|
|
6385
|
+
}];
|
|
6386
|
+
};
|
|
6387
|
+
};
|
|
5596
6388
|
}>;
|
|
5597
6389
|
export type SearchAnalyticsQuery = z.input<typeof searchAnalyticsQuerySchema>;
|
|
5598
6390
|
export type SearchAnalyticsData = z.output<typeof searchAnalyticsDataSchema.client>;
|