@nuxtseo/protocol 0.5.7 → 0.5.9
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 +2 -2
- package/dist/v1/account.js +1 -1
- package/dist/v1/actions.d.ts +31 -68
- package/dist/v1/actions.js +10 -21
- package/dist/v1/backlinks.d.ts +7 -7
- package/dist/v1/backlinks.js +2 -2
- package/dist/v1/gsc.d.ts +529 -0
- package/dist/v1/gsc.js +21 -1
- package/dist/v1/performance.d.ts +1452 -269
- package/dist/v1/performance.js +216 -44
- package/dist/v1/sitemaps.d.ts +1756 -160
- package/dist/v1/sitemaps.js +45 -0
- package/generated/openapi.v1.json +1 -1
- package/package.json +2 -2
package/dist/v1/account.d.ts
CHANGED
|
@@ -396,7 +396,7 @@ export declare const accountUsageOperation: {
|
|
|
396
396
|
readonly introduced: '1.0.0';
|
|
397
397
|
};
|
|
398
398
|
readonly docs: {
|
|
399
|
-
readonly summary: 'Read
|
|
399
|
+
readonly summary: 'Read Team usage';
|
|
400
400
|
readonly description: 'Returns current Team-scoped public meter readings without spending quota.';
|
|
401
401
|
readonly tags: readonly ["Account"];
|
|
402
402
|
readonly examples: readonly [{
|
|
@@ -1193,7 +1193,7 @@ export declare const accountV1Registry: import("./core.js").PublicV1Registry<{
|
|
|
1193
1193
|
readonly introduced: '1.0.0';
|
|
1194
1194
|
};
|
|
1195
1195
|
readonly docs: {
|
|
1196
|
-
readonly summary: 'Read
|
|
1196
|
+
readonly summary: 'Read Team usage';
|
|
1197
1197
|
readonly description: 'Returns current Team-scoped public meter readings without spending quota.';
|
|
1198
1198
|
readonly tags: readonly ["Account"];
|
|
1199
1199
|
readonly examples: readonly [{
|
package/dist/v1/account.js
CHANGED
|
@@ -85,7 +85,7 @@ export const accountUsageOperation = defineOperation({
|
|
|
85
85
|
},
|
|
86
86
|
lifecycle: { introduced: '1.0.0' },
|
|
87
87
|
docs: {
|
|
88
|
-
summary: 'Read
|
|
88
|
+
summary: 'Read Team usage',
|
|
89
89
|
description: 'Returns current Team-scoped public meter readings without spending quota.',
|
|
90
90
|
tags: ['Account'],
|
|
91
91
|
examples: [{
|
package/dist/v1/actions.d.ts
CHANGED
|
@@ -20,7 +20,7 @@ export declare const actionResolveBodySchema: z.ZodObject<{
|
|
|
20
20
|
}, z.core.$strict>;
|
|
21
21
|
export declare const actionDismissBodySchema: z.ZodObject<{
|
|
22
22
|
artifactVersion: z.ZodString;
|
|
23
|
-
note: z.
|
|
23
|
+
note: z.ZodString;
|
|
24
24
|
}, z.core.$strict>;
|
|
25
25
|
/**
|
|
26
26
|
* `url` is the URL the finding was observed on and stays exactly as observed —
|
|
@@ -1054,8 +1054,9 @@ export declare const actionEvidenceItemSchema: z.ZodDiscriminatedUnion<[z.ZodObj
|
|
|
1054
1054
|
}, z.core.$strict>, z.ZodObject<{
|
|
1055
1055
|
_tag: z.ZodLiteral<"element">;
|
|
1056
1056
|
id: z.ZodString;
|
|
1057
|
-
selector: z.ZodString
|
|
1057
|
+
selector: z.ZodOptional<z.ZodString>;
|
|
1058
1058
|
snippet: z.ZodNullable<z.ZodString>;
|
|
1059
|
+
explanation: z.ZodOptional<z.ZodString>;
|
|
1059
1060
|
page: z.ZodNullable<z.ZodString>;
|
|
1060
1061
|
}, z.core.$strict>], "_tag">;
|
|
1061
1062
|
export declare const actionEvidenceItemClientSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
|
|
@@ -1083,8 +1084,9 @@ export declare const actionEvidenceItemClientSchema: z.ZodDiscriminatedUnion<[z.
|
|
|
1083
1084
|
}, z.core.$loose>, z.ZodObject<{
|
|
1084
1085
|
_tag: z.ZodLiteral<"element">;
|
|
1085
1086
|
id: z.ZodString;
|
|
1086
|
-
selector: z.ZodString
|
|
1087
|
+
selector: z.ZodOptional<z.ZodString>;
|
|
1087
1088
|
snippet: z.ZodNullable<z.ZodString>;
|
|
1089
|
+
explanation: z.ZodOptional<z.ZodString>;
|
|
1088
1090
|
page: z.ZodNullable<z.ZodString>;
|
|
1089
1091
|
}, z.core.$loose>], "_tag">;
|
|
1090
1092
|
export declare const actionVerifierSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
|
|
@@ -1165,8 +1167,9 @@ export declare const actionEvidenceGroupSchema: import("./core.js").CompatibleRe
|
|
|
1165
1167
|
}, z.core.$strict>, z.ZodObject<{
|
|
1166
1168
|
_tag: z.ZodLiteral<"element">;
|
|
1167
1169
|
id: z.ZodString;
|
|
1168
|
-
selector: z.ZodString
|
|
1170
|
+
selector: z.ZodOptional<z.ZodString>;
|
|
1169
1171
|
snippet: z.ZodNullable<z.ZodString>;
|
|
1172
|
+
explanation: z.ZodOptional<z.ZodString>;
|
|
1170
1173
|
page: z.ZodNullable<z.ZodString>;
|
|
1171
1174
|
}, z.core.$strict>], "_tag">>;
|
|
1172
1175
|
readonly nextCursor: z.ZodNullable<z.ZodString>;
|
|
@@ -1224,8 +1227,9 @@ export declare const actionEvidenceGroupSchema: import("./core.js").CompatibleRe
|
|
|
1224
1227
|
}, z.core.$loose>, z.ZodObject<{
|
|
1225
1228
|
_tag: z.ZodLiteral<"element">;
|
|
1226
1229
|
id: z.ZodString;
|
|
1227
|
-
selector: z.ZodString
|
|
1230
|
+
selector: z.ZodOptional<z.ZodString>;
|
|
1228
1231
|
snippet: z.ZodNullable<z.ZodString>;
|
|
1232
|
+
explanation: z.ZodOptional<z.ZodString>;
|
|
1229
1233
|
page: z.ZodNullable<z.ZodString>;
|
|
1230
1234
|
}, z.core.$loose>], "_tag">>;
|
|
1231
1235
|
readonly nextCursor: z.ZodNullable<z.ZodString>;
|
|
@@ -1318,8 +1322,9 @@ export declare const actionShowDataSchema: import("./core.js").CompatibleRespons
|
|
|
1318
1322
|
}, z.core.$strict>, z.ZodObject<{
|
|
1319
1323
|
_tag: z.ZodLiteral<"element">;
|
|
1320
1324
|
id: z.ZodString;
|
|
1321
|
-
selector: z.ZodString
|
|
1325
|
+
selector: z.ZodOptional<z.ZodString>;
|
|
1322
1326
|
snippet: z.ZodNullable<z.ZodString>;
|
|
1327
|
+
explanation: z.ZodOptional<z.ZodString>;
|
|
1323
1328
|
page: z.ZodNullable<z.ZodString>;
|
|
1324
1329
|
}, z.core.$strict>], "_tag">>;
|
|
1325
1330
|
readonly nextCursor: z.ZodNullable<z.ZodString>;
|
|
@@ -1412,8 +1417,9 @@ export declare const actionShowDataSchema: import("./core.js").CompatibleRespons
|
|
|
1412
1417
|
}, z.core.$loose>, z.ZodObject<{
|
|
1413
1418
|
_tag: z.ZodLiteral<"element">;
|
|
1414
1419
|
id: z.ZodString;
|
|
1415
|
-
selector: z.ZodString
|
|
1420
|
+
selector: z.ZodOptional<z.ZodString>;
|
|
1416
1421
|
snippet: z.ZodNullable<z.ZodString>;
|
|
1422
|
+
explanation: z.ZodOptional<z.ZodString>;
|
|
1417
1423
|
page: z.ZodNullable<z.ZodString>;
|
|
1418
1424
|
}, z.core.$loose>], "_tag">>;
|
|
1419
1425
|
readonly nextCursor: z.ZodNullable<z.ZodString>;
|
|
@@ -1508,8 +1514,9 @@ export declare const actionShowResponseSchema: import("./core.js").CompatibleRes
|
|
|
1508
1514
|
}, z.core.$strict>, z.ZodObject<{
|
|
1509
1515
|
_tag: z.ZodLiteral<"element">;
|
|
1510
1516
|
id: z.ZodString;
|
|
1511
|
-
selector: z.ZodString
|
|
1517
|
+
selector: z.ZodOptional<z.ZodString>;
|
|
1512
1518
|
snippet: z.ZodNullable<z.ZodString>;
|
|
1519
|
+
explanation: z.ZodOptional<z.ZodString>;
|
|
1513
1520
|
page: z.ZodNullable<z.ZodString>;
|
|
1514
1521
|
}, z.core.$strict>], "_tag">>;
|
|
1515
1522
|
readonly nextCursor: z.ZodNullable<z.ZodString>;
|
|
@@ -1608,8 +1615,9 @@ export declare const actionShowResponseSchema: import("./core.js").CompatibleRes
|
|
|
1608
1615
|
}, z.core.$loose>, z.ZodObject<{
|
|
1609
1616
|
_tag: z.ZodLiteral<"element">;
|
|
1610
1617
|
id: z.ZodString;
|
|
1611
|
-
selector: z.ZodString
|
|
1618
|
+
selector: z.ZodOptional<z.ZodString>;
|
|
1612
1619
|
snippet: z.ZodNullable<z.ZodString>;
|
|
1620
|
+
explanation: z.ZodOptional<z.ZodString>;
|
|
1613
1621
|
page: z.ZodNullable<z.ZodString>;
|
|
1614
1622
|
}, z.core.$loose>], "_tag">>;
|
|
1615
1623
|
readonly nextCursor: z.ZodNullable<z.ZodString>;
|
|
@@ -2287,8 +2295,9 @@ export declare const actionShowOperation: {
|
|
|
2287
2295
|
}, z.core.$strict>, z.ZodObject<{
|
|
2288
2296
|
_tag: z.ZodLiteral<"element">;
|
|
2289
2297
|
id: z.ZodString;
|
|
2290
|
-
selector: z.ZodString
|
|
2298
|
+
selector: z.ZodOptional<z.ZodString>;
|
|
2291
2299
|
snippet: z.ZodNullable<z.ZodString>;
|
|
2300
|
+
explanation: z.ZodOptional<z.ZodString>;
|
|
2292
2301
|
page: z.ZodNullable<z.ZodString>;
|
|
2293
2302
|
}, z.core.$strict>], "_tag">>;
|
|
2294
2303
|
readonly nextCursor: z.ZodNullable<z.ZodString>;
|
|
@@ -2387,8 +2396,9 @@ export declare const actionShowOperation: {
|
|
|
2387
2396
|
}, z.core.$loose>, z.ZodObject<{
|
|
2388
2397
|
_tag: z.ZodLiteral<"element">;
|
|
2389
2398
|
id: z.ZodString;
|
|
2390
|
-
selector: z.ZodString
|
|
2399
|
+
selector: z.ZodOptional<z.ZodString>;
|
|
2391
2400
|
snippet: z.ZodNullable<z.ZodString>;
|
|
2401
|
+
explanation: z.ZodOptional<z.ZodString>;
|
|
2392
2402
|
page: z.ZodNullable<z.ZodString>;
|
|
2393
2403
|
}, z.core.$loose>], "_tag">>;
|
|
2394
2404
|
readonly nextCursor: z.ZodNullable<z.ZodString>;
|
|
@@ -2728,9 +2738,8 @@ export declare const actionDismissResponseSchema: import("./core.js").Compatible
|
|
|
2728
2738
|
}, z.core.$strip>>;
|
|
2729
2739
|
export type ActionDismiss = z.output<typeof actionDismissDataSchema.client>;
|
|
2730
2740
|
/**
|
|
2731
|
-
*
|
|
2732
|
-
*
|
|
2733
|
-
* Both paths retain the artifactVersion fence and never claim a verified fix.
|
|
2741
|
+
* A required note records the owner's decision to dismiss reviewed work. The
|
|
2742
|
+
* artifactVersion fence still applies, and dismissal never claims a verified fix.
|
|
2734
2743
|
*/
|
|
2735
2744
|
export declare const actionDismissOperation: {
|
|
2736
2745
|
readonly id: 'actions.dismiss';
|
|
@@ -2758,7 +2767,7 @@ export declare const actionDismissOperation: {
|
|
|
2758
2767
|
readonly headers: null;
|
|
2759
2768
|
readonly body: z.ZodObject<{
|
|
2760
2769
|
artifactVersion: z.ZodString;
|
|
2761
|
-
note: z.
|
|
2770
|
+
note: z.ZodString;
|
|
2762
2771
|
}, z.core.$strict>;
|
|
2763
2772
|
};
|
|
2764
2773
|
readonly responses: {
|
|
@@ -2859,33 +2868,9 @@ export declare const actionDismissOperation: {
|
|
|
2859
2868
|
};
|
|
2860
2869
|
readonly docs: {
|
|
2861
2870
|
readonly summary: 'Dismiss an action';
|
|
2862
|
-
readonly description: 'Records an owner decision to dismiss an action
|
|
2871
|
+
readonly description: 'Records an owner decision to dismiss an action. A note must explain why it is intentional or incorrect. Stale details and decided actions are rejected. Dismissal preserves observations and does not verify a fix. The action stays dismissed until a person restores it.';
|
|
2863
2872
|
readonly tags: readonly ["Actions"];
|
|
2864
2873
|
readonly examples: readonly [{
|
|
2865
|
-
readonly request: {
|
|
2866
|
-
readonly params: {
|
|
2867
|
-
readonly siteId: 'site_01JXYZ';
|
|
2868
|
-
readonly actionId: 'action_01JXYZ';
|
|
2869
|
-
};
|
|
2870
|
-
readonly body: {
|
|
2871
|
-
readonly artifactVersion: 'te2:action_01JXYZ:scope';
|
|
2872
|
-
};
|
|
2873
|
-
};
|
|
2874
|
-
readonly response: {
|
|
2875
|
-
readonly status: 200;
|
|
2876
|
-
readonly body: {
|
|
2877
|
-
readonly data: {
|
|
2878
|
-
readonly actionId: 'action_01JXYZ';
|
|
2879
|
-
readonly status: 'dismissed';
|
|
2880
|
-
readonly message: 'Dismissed. This page can stay removed.';
|
|
2881
|
-
};
|
|
2882
|
-
readonly meta: {
|
|
2883
|
-
readonly requestId: 'req_01JXYZ';
|
|
2884
|
-
readonly version: '1.0';
|
|
2885
|
-
};
|
|
2886
|
-
};
|
|
2887
|
-
};
|
|
2888
|
-
}, {
|
|
2889
2874
|
readonly request: {
|
|
2890
2875
|
readonly params: {
|
|
2891
2876
|
readonly siteId: 'site_01JXYZ';
|
|
@@ -3513,8 +3498,9 @@ export declare const actionsV1Registry: import("./core.js").PublicV1Registry<{
|
|
|
3513
3498
|
}, z.core.$strict>, z.ZodObject<{
|
|
3514
3499
|
_tag: z.ZodLiteral<"element">;
|
|
3515
3500
|
id: z.ZodString;
|
|
3516
|
-
selector: z.ZodString
|
|
3501
|
+
selector: z.ZodOptional<z.ZodString>;
|
|
3517
3502
|
snippet: z.ZodNullable<z.ZodString>;
|
|
3503
|
+
explanation: z.ZodOptional<z.ZodString>;
|
|
3518
3504
|
page: z.ZodNullable<z.ZodString>;
|
|
3519
3505
|
}, z.core.$strict>], "_tag">>;
|
|
3520
3506
|
readonly nextCursor: z.ZodNullable<z.ZodString>;
|
|
@@ -3613,8 +3599,9 @@ export declare const actionsV1Registry: import("./core.js").PublicV1Registry<{
|
|
|
3613
3599
|
}, z.core.$loose>, z.ZodObject<{
|
|
3614
3600
|
_tag: z.ZodLiteral<"element">;
|
|
3615
3601
|
id: z.ZodString;
|
|
3616
|
-
selector: z.ZodString
|
|
3602
|
+
selector: z.ZodOptional<z.ZodString>;
|
|
3617
3603
|
snippet: z.ZodNullable<z.ZodString>;
|
|
3604
|
+
explanation: z.ZodOptional<z.ZodString>;
|
|
3618
3605
|
page: z.ZodNullable<z.ZodString>;
|
|
3619
3606
|
}, z.core.$loose>], "_tag">>;
|
|
3620
3607
|
readonly nextCursor: z.ZodNullable<z.ZodString>;
|
|
@@ -3948,7 +3935,7 @@ export declare const actionsV1Registry: import("./core.js").PublicV1Registry<{
|
|
|
3948
3935
|
readonly headers: null;
|
|
3949
3936
|
readonly body: z.ZodObject<{
|
|
3950
3937
|
artifactVersion: z.ZodString;
|
|
3951
|
-
note: z.
|
|
3938
|
+
note: z.ZodString;
|
|
3952
3939
|
}, z.core.$strict>;
|
|
3953
3940
|
};
|
|
3954
3941
|
readonly responses: {
|
|
@@ -4049,33 +4036,9 @@ export declare const actionsV1Registry: import("./core.js").PublicV1Registry<{
|
|
|
4049
4036
|
};
|
|
4050
4037
|
readonly docs: {
|
|
4051
4038
|
readonly summary: 'Dismiss an action';
|
|
4052
|
-
readonly description: 'Records an owner decision to dismiss an action
|
|
4039
|
+
readonly description: 'Records an owner decision to dismiss an action. A note must explain why it is intentional or incorrect. Stale details and decided actions are rejected. Dismissal preserves observations and does not verify a fix. The action stays dismissed until a person restores it.';
|
|
4053
4040
|
readonly tags: readonly ["Actions"];
|
|
4054
4041
|
readonly examples: readonly [{
|
|
4055
|
-
readonly request: {
|
|
4056
|
-
readonly params: {
|
|
4057
|
-
readonly siteId: 'site_01JXYZ';
|
|
4058
|
-
readonly actionId: 'action_01JXYZ';
|
|
4059
|
-
};
|
|
4060
|
-
readonly body: {
|
|
4061
|
-
readonly artifactVersion: 'te2:action_01JXYZ:scope';
|
|
4062
|
-
};
|
|
4063
|
-
};
|
|
4064
|
-
readonly response: {
|
|
4065
|
-
readonly status: 200;
|
|
4066
|
-
readonly body: {
|
|
4067
|
-
readonly data: {
|
|
4068
|
-
readonly actionId: 'action_01JXYZ';
|
|
4069
|
-
readonly status: 'dismissed';
|
|
4070
|
-
readonly message: 'Dismissed. This page can stay removed.';
|
|
4071
|
-
};
|
|
4072
|
-
readonly meta: {
|
|
4073
|
-
readonly requestId: 'req_01JXYZ';
|
|
4074
|
-
readonly version: '1.0';
|
|
4075
|
-
};
|
|
4076
|
-
};
|
|
4077
|
-
};
|
|
4078
|
-
}, {
|
|
4079
4042
|
readonly request: {
|
|
4080
4043
|
readonly params: {
|
|
4081
4044
|
readonly siteId: 'site_01JXYZ';
|
package/dist/v1/actions.js
CHANGED
|
@@ -21,7 +21,7 @@ export const actionResolveBodySchema = schema.strictObject({
|
|
|
21
21
|
});
|
|
22
22
|
export const actionDismissBodySchema = schema.strictObject({
|
|
23
23
|
artifactVersion: schema.string().min(1),
|
|
24
|
-
note: schema.string().trim().min(1).max(2000)
|
|
24
|
+
note: schema.string().trim().min(1).max(2000),
|
|
25
25
|
});
|
|
26
26
|
/**
|
|
27
27
|
* `url` is the URL the finding was observed on and stays exactly as observed —
|
|
@@ -216,10 +216,11 @@ export const actionEvidenceItemSchema = schema.discriminatedUnion('_tag', [
|
|
|
216
216
|
schema.strictObject({
|
|
217
217
|
_tag: schema.literal('element'),
|
|
218
218
|
id: schema.string().min(1),
|
|
219
|
-
selector: schema.string().min(1),
|
|
219
|
+
selector: schema.string().min(1).optional(),
|
|
220
220
|
snippet: schema.string().min(1).nullable(),
|
|
221
|
+
explanation: schema.string().min(1).max(2048).optional(),
|
|
221
222
|
page: schema.string().url().nullable(),
|
|
222
|
-
}),
|
|
223
|
+
}).refine(item => Boolean(item.selector || item.snippet || item.explanation)),
|
|
223
224
|
]);
|
|
224
225
|
export const actionEvidenceItemClientSchema = schema.discriminatedUnion('_tag', [
|
|
225
226
|
schema.looseObject({
|
|
@@ -251,10 +252,11 @@ export const actionEvidenceItemClientSchema = schema.discriminatedUnion('_tag',
|
|
|
251
252
|
schema.looseObject({
|
|
252
253
|
_tag: schema.literal('element'),
|
|
253
254
|
id: schema.string().min(1),
|
|
254
|
-
selector: schema.string().min(1),
|
|
255
|
+
selector: schema.string().min(1).optional(),
|
|
255
256
|
snippet: schema.string().min(1).nullable(),
|
|
257
|
+
explanation: schema.string().min(1).max(2048).optional(),
|
|
256
258
|
page: schema.string().url().nullable(),
|
|
257
|
-
}),
|
|
259
|
+
}).refine(item => Boolean(item.selector || item.snippet || item.explanation)),
|
|
258
260
|
]);
|
|
259
261
|
export const actionVerifierSchema = schema.discriminatedUnion('_tag', [
|
|
260
262
|
schema.strictObject({ _tag: schema.literal('target-healthy'), url: schema.string().url() }),
|
|
@@ -533,9 +535,8 @@ export const actionDismissDataSchema = defineResponseObject({
|
|
|
533
535
|
});
|
|
534
536
|
export const actionDismissResponseSchema = defineSuccessEnvelope(actionDismissDataSchema);
|
|
535
537
|
/**
|
|
536
|
-
*
|
|
537
|
-
*
|
|
538
|
-
* Both paths retain the artifactVersion fence and never claim a verified fix.
|
|
538
|
+
* A required note records the owner's decision to dismiss reviewed work. The
|
|
539
|
+
* artifactVersion fence still applies, and dismissal never claims a verified fix.
|
|
539
540
|
*/
|
|
540
541
|
export const actionDismissOperation = defineOperation({
|
|
541
542
|
id: 'actions.dismiss',
|
|
@@ -578,21 +579,9 @@ export const actionDismissOperation = defineOperation({
|
|
|
578
579
|
lifecycle: { introduced: '1.2.0' },
|
|
579
580
|
docs: {
|
|
580
581
|
summary: 'Dismiss an action',
|
|
581
|
-
description: 'Records an owner decision to dismiss an action
|
|
582
|
+
description: 'Records an owner decision to dismiss an action. A note must explain why it is intentional or incorrect. Stale details and decided actions are rejected. Dismissal preserves observations and does not verify a fix. The action stays dismissed until a person restores it.',
|
|
582
583
|
tags: ['Actions'],
|
|
583
584
|
examples: [{
|
|
584
|
-
request: {
|
|
585
|
-
params: { siteId: 'site_01JXYZ', actionId: 'action_01JXYZ' },
|
|
586
|
-
body: { artifactVersion: 'te2:action_01JXYZ:scope' },
|
|
587
|
-
},
|
|
588
|
-
response: {
|
|
589
|
-
status: 200,
|
|
590
|
-
body: {
|
|
591
|
-
data: { actionId: 'action_01JXYZ', status: 'dismissed', message: 'Dismissed. This page can stay removed.' },
|
|
592
|
-
meta: { requestId: 'req_01JXYZ', version: '1.0' },
|
|
593
|
-
},
|
|
594
|
-
},
|
|
595
|
-
}, {
|
|
596
585
|
request: {
|
|
597
586
|
params: { siteId: 'site_01JXYZ', actionId: 'action_01JXYZ' },
|
|
598
587
|
body: {
|
package/dist/v1/backlinks.d.ts
CHANGED
|
@@ -1830,7 +1830,7 @@ export declare const referringDomainSchema: import("./core.js").CompatibleRespon
|
|
|
1830
1830
|
readonly spamScore: z.ZodNullable<z.ZodNumber>;
|
|
1831
1831
|
readonly firstSeen: z.ZodNullable<z.ZodString>;
|
|
1832
1832
|
readonly lostDate: z.ZodNullable<z.ZodString>;
|
|
1833
|
-
/** 90-day referral sessions
|
|
1833
|
+
/** Recorded 90-day referral sessions grouped by this domain, or null when unavailable or omitted from the capped response. */
|
|
1834
1834
|
readonly sessions: z.ZodNullable<z.ZodNumber>;
|
|
1835
1835
|
/**
|
|
1836
1836
|
* The id of the Link Spam Network this domain is a known member of, as in
|
|
@@ -1865,7 +1865,7 @@ export declare const referringDomainsDataSchema: import("./core.js").CompatibleR
|
|
|
1865
1865
|
readonly spamScore: z.ZodNullable<z.ZodNumber>;
|
|
1866
1866
|
readonly firstSeen: z.ZodNullable<z.ZodString>;
|
|
1867
1867
|
readonly lostDate: z.ZodNullable<z.ZodString>;
|
|
1868
|
-
/** 90-day referral sessions
|
|
1868
|
+
/** Recorded 90-day referral sessions grouped by this domain, or null when unavailable or omitted from the capped response. */
|
|
1869
1869
|
readonly sessions: z.ZodNullable<z.ZodNumber>;
|
|
1870
1870
|
/**
|
|
1871
1871
|
* The id of the Link Spam Network this domain is a known member of, as in
|
|
@@ -1953,7 +1953,7 @@ export declare const referringDomainsResponseSchema: import("./core.js").Compati
|
|
|
1953
1953
|
readonly spamScore: z.ZodNullable<z.ZodNumber>;
|
|
1954
1954
|
readonly firstSeen: z.ZodNullable<z.ZodString>;
|
|
1955
1955
|
readonly lostDate: z.ZodNullable<z.ZodString>;
|
|
1956
|
-
/** 90-day referral sessions
|
|
1956
|
+
/** Recorded 90-day referral sessions grouped by this domain, or null when unavailable or omitted from the capped response. */
|
|
1957
1957
|
readonly sessions: z.ZodNullable<z.ZodNumber>;
|
|
1958
1958
|
/**
|
|
1959
1959
|
* The id of the Link Spam Network this domain is a known member of, as in
|
|
@@ -2083,7 +2083,7 @@ export declare const referringDomainsOperation: {
|
|
|
2083
2083
|
readonly spamScore: z.ZodNullable<z.ZodNumber>;
|
|
2084
2084
|
readonly firstSeen: z.ZodNullable<z.ZodString>;
|
|
2085
2085
|
readonly lostDate: z.ZodNullable<z.ZodString>;
|
|
2086
|
-
/** 90-day referral sessions
|
|
2086
|
+
/** Recorded 90-day referral sessions grouped by this domain, or null when unavailable or omitted from the capped response. */
|
|
2087
2087
|
readonly sessions: z.ZodNullable<z.ZodNumber>;
|
|
2088
2088
|
/**
|
|
2089
2089
|
* The id of the Link Spam Network this domain is a known member of, as in
|
|
@@ -2246,7 +2246,7 @@ export declare const referringDomainsOperation: {
|
|
|
2246
2246
|
};
|
|
2247
2247
|
readonly docs: {
|
|
2248
2248
|
readonly summary: 'List referring domains';
|
|
2249
|
-
readonly description: 'Returns the domains that link to the Site, highest authority first, with spam score and broken-link counts. When a Web Analytics property is linked,
|
|
2249
|
+
readonly description: 'Returns the domains that link to the Site, highest authority first, with spam score and broken-link counts. When a Web Analytics property is linked, returned domain rows can carry recorded 90-day referral sessions. Missing or omitted domain counts remain null. These counts do not attribute sessions to individual backlinks. A row that is a known member of a link spam network carries its id. Cached reads consume no units.';
|
|
2250
2250
|
readonly tags: readonly ["Research"];
|
|
2251
2251
|
readonly examples: readonly [{
|
|
2252
2252
|
readonly request: {
|
|
@@ -3781,7 +3781,7 @@ export declare const backlinksV1Registry: import("./core.js").PublicV1Registry<{
|
|
|
3781
3781
|
readonly spamScore: z.ZodNullable<z.ZodNumber>;
|
|
3782
3782
|
readonly firstSeen: z.ZodNullable<z.ZodString>;
|
|
3783
3783
|
readonly lostDate: z.ZodNullable<z.ZodString>;
|
|
3784
|
-
/** 90-day referral sessions
|
|
3784
|
+
/** Recorded 90-day referral sessions grouped by this domain, or null when unavailable or omitted from the capped response. */
|
|
3785
3785
|
readonly sessions: z.ZodNullable<z.ZodNumber>;
|
|
3786
3786
|
/**
|
|
3787
3787
|
* The id of the Link Spam Network this domain is a known member of, as in
|
|
@@ -3944,7 +3944,7 @@ export declare const backlinksV1Registry: import("./core.js").PublicV1Registry<{
|
|
|
3944
3944
|
};
|
|
3945
3945
|
readonly docs: {
|
|
3946
3946
|
readonly summary: 'List referring domains';
|
|
3947
|
-
readonly description: 'Returns the domains that link to the Site, highest authority first, with spam score and broken-link counts. When a Web Analytics property is linked,
|
|
3947
|
+
readonly description: 'Returns the domains that link to the Site, highest authority first, with spam score and broken-link counts. When a Web Analytics property is linked, returned domain rows can carry recorded 90-day referral sessions. Missing or omitted domain counts remain null. These counts do not attribute sessions to individual backlinks. A row that is a known member of a link spam network carries its id. Cached reads consume no units.';
|
|
3948
3948
|
readonly tags: readonly ["Research"];
|
|
3949
3949
|
readonly examples: readonly [{
|
|
3950
3950
|
readonly request: {
|
package/dist/v1/backlinks.js
CHANGED
|
@@ -506,7 +506,7 @@ export const referringDomainSchema = defineResponseObject({
|
|
|
506
506
|
spamScore: nullableCount,
|
|
507
507
|
firstSeen: schema.string().nullable(),
|
|
508
508
|
lostDate: schema.string().nullable(),
|
|
509
|
-
/** 90-day referral sessions
|
|
509
|
+
/** Recorded 90-day referral sessions grouped by this domain, or null when unavailable or omitted from the capped response. */
|
|
510
510
|
sessions: nullableCount,
|
|
511
511
|
/**
|
|
512
512
|
* The id of the Link Spam Network this domain is a known member of, as in
|
|
@@ -559,7 +559,7 @@ export const referringDomainsOperation = defineOperation({
|
|
|
559
559
|
lifecycle: { introduced: '1.2.0' },
|
|
560
560
|
docs: {
|
|
561
561
|
summary: 'List referring domains',
|
|
562
|
-
description: 'Returns the domains that link to the Site, highest authority first, with spam score and broken-link counts. When a Web Analytics property is linked,
|
|
562
|
+
description: 'Returns the domains that link to the Site, highest authority first, with spam score and broken-link counts. When a Web Analytics property is linked, returned domain rows can carry recorded 90-day referral sessions. Missing or omitted domain counts remain null. These counts do not attribute sessions to individual backlinks. A row that is a known member of a link spam network carries its id. Cached reads consume no units.',
|
|
563
563
|
tags: ['Research'],
|
|
564
564
|
examples: [{
|
|
565
565
|
request: { params: { siteId: 'site_01JXYZ' }, query: { limit: 100 } },
|