@nuxtseo/protocol 0.2.0 → 0.3.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 +350 -92
- package/dist/v1/account.js +63 -2
- package/dist/v1/actions.d.ts +634 -0
- package/dist/v1/actions.js +6 -0
- package/dist/v1/audit.d.ts +402 -0
- package/dist/v1/audit.js +23 -1
- package/dist/v1/backlinks.d.ts +444 -0
- package/dist/v1/backlinks.js +51 -1
- package/dist/v1/content.d.ts +184 -0
- package/dist/v1/content.js +15 -0
- package/dist/v1/core.d.ts +51 -2
- package/dist/v1/core.js +40 -0
- package/dist/v1/gsc.d.ts +481 -69
- package/dist/v1/gsc.js +36 -5
- package/dist/v1/pages.d.ts +70 -0
- package/dist/v1/pages.js +16 -1
- package/dist/v1/performance.d.ts +10 -4
- package/dist/v1/performance.js +48 -29
- package/dist/v1/research.d.ts +168 -0
- package/dist/v1/research.js +42 -0
- package/dist/v1/sites.d.ts +298 -0
- package/dist/v1/sites.js +21 -2
- package/generated/openapi.v1.json +1 -1
- package/package.json +4 -4
package/dist/v1/backlinks.d.ts
CHANGED
|
@@ -37,6 +37,9 @@ export declare const recoverableBacklinkSchema: import("./core.js").CompatibleRe
|
|
|
37
37
|
readonly lastSeenAt: z.ZodNullable<z.ZodString>;
|
|
38
38
|
}, z.core.$strip>>;
|
|
39
39
|
export declare const recoverableBacklinksDataSchema: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
|
|
40
|
+
/**
|
|
41
|
+
* Deprecated alias of `rows`. Kept for one minor version, then removed.
|
|
42
|
+
*/
|
|
40
43
|
readonly items: z.ZodArray<z.ZodObject<{
|
|
41
44
|
readonly id: z.ZodString;
|
|
42
45
|
readonly destinationUrl: z.ZodString;
|
|
@@ -50,6 +53,25 @@ export declare const recoverableBacklinksDataSchema: import("./core.js").Compati
|
|
|
50
53
|
readonly firstSeenAt: z.ZodNullable<z.ZodString>;
|
|
51
54
|
readonly lastSeenAt: z.ZodNullable<z.ZodString>;
|
|
52
55
|
}, z.core.$strip>>;
|
|
56
|
+
readonly rows: z.ZodArray<z.ZodObject<{
|
|
57
|
+
readonly id: z.ZodString;
|
|
58
|
+
readonly destinationUrl: z.ZodString;
|
|
59
|
+
readonly referringUrl: z.ZodString;
|
|
60
|
+
readonly referringDomain: z.ZodString;
|
|
61
|
+
readonly anchor: z.ZodNullable<z.ZodString>;
|
|
62
|
+
readonly destinationStatus: z.ZodNullable<z.ZodNumber>;
|
|
63
|
+
readonly domainRank: z.ZodNullable<z.ZodNumber>;
|
|
64
|
+
readonly pageRank: z.ZodNullable<z.ZodNumber>;
|
|
65
|
+
readonly dofollow: z.ZodNullable<z.ZodBoolean>;
|
|
66
|
+
readonly firstSeenAt: z.ZodNullable<z.ZodString>;
|
|
67
|
+
readonly lastSeenAt: z.ZodNullable<z.ZodString>;
|
|
68
|
+
}, z.core.$strip>>;
|
|
69
|
+
readonly page: z.ZodObject<{
|
|
70
|
+
readonly total: z.ZodNumber;
|
|
71
|
+
readonly limit: z.ZodNumber;
|
|
72
|
+
readonly offset: z.ZodNumber;
|
|
73
|
+
readonly hasMore: z.ZodBoolean;
|
|
74
|
+
}, z.core.$strip>;
|
|
53
75
|
readonly total: z.ZodNumber;
|
|
54
76
|
readonly limit: z.ZodNumber;
|
|
55
77
|
readonly offset: z.ZodNumber;
|
|
@@ -67,12 +89,34 @@ export declare const recoverableBacklinksDataSchema: import("./core.js").Compati
|
|
|
67
89
|
readonly firstSeenAt: z.ZodNullable<z.ZodString>;
|
|
68
90
|
readonly lastSeenAt: z.ZodNullable<z.ZodString>;
|
|
69
91
|
}, z.core.$strip>>;
|
|
92
|
+
readonly rows: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
93
|
+
readonly id: z.ZodString;
|
|
94
|
+
readonly destinationUrl: z.ZodString;
|
|
95
|
+
readonly referringUrl: z.ZodString;
|
|
96
|
+
readonly referringDomain: z.ZodString;
|
|
97
|
+
readonly anchor: z.ZodNullable<z.ZodString>;
|
|
98
|
+
readonly destinationStatus: z.ZodNullable<z.ZodNumber>;
|
|
99
|
+
readonly domainRank: z.ZodNullable<z.ZodNumber>;
|
|
100
|
+
readonly pageRank: z.ZodNullable<z.ZodNumber>;
|
|
101
|
+
readonly dofollow: z.ZodNullable<z.ZodBoolean>;
|
|
102
|
+
readonly firstSeenAt: z.ZodNullable<z.ZodString>;
|
|
103
|
+
readonly lastSeenAt: z.ZodNullable<z.ZodString>;
|
|
104
|
+
}, z.core.$strip>>>;
|
|
105
|
+
readonly page: z.ZodOptional<z.ZodObject<{
|
|
106
|
+
readonly total: z.ZodNumber;
|
|
107
|
+
readonly limit: z.ZodNumber;
|
|
108
|
+
readonly offset: z.ZodNumber;
|
|
109
|
+
readonly hasMore: z.ZodBoolean;
|
|
110
|
+
}, z.core.$strip>>;
|
|
70
111
|
readonly total: z.ZodNumber;
|
|
71
112
|
readonly limit: z.ZodNumber;
|
|
72
113
|
readonly offset: z.ZodNumber;
|
|
73
114
|
}, z.core.$strip>>;
|
|
74
115
|
export declare const recoverableBacklinksResponseSchema: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
|
|
75
116
|
data: z.ZodObject<{
|
|
117
|
+
/**
|
|
118
|
+
* Deprecated alias of `rows`. Kept for one minor version, then removed.
|
|
119
|
+
*/
|
|
76
120
|
readonly items: z.ZodArray<z.ZodObject<{
|
|
77
121
|
readonly id: z.ZodString;
|
|
78
122
|
readonly destinationUrl: z.ZodString;
|
|
@@ -86,6 +130,25 @@ export declare const recoverableBacklinksResponseSchema: import("./core.js").Com
|
|
|
86
130
|
readonly firstSeenAt: z.ZodNullable<z.ZodString>;
|
|
87
131
|
readonly lastSeenAt: z.ZodNullable<z.ZodString>;
|
|
88
132
|
}, z.core.$strip>>;
|
|
133
|
+
readonly rows: z.ZodArray<z.ZodObject<{
|
|
134
|
+
readonly id: z.ZodString;
|
|
135
|
+
readonly destinationUrl: z.ZodString;
|
|
136
|
+
readonly referringUrl: z.ZodString;
|
|
137
|
+
readonly referringDomain: z.ZodString;
|
|
138
|
+
readonly anchor: z.ZodNullable<z.ZodString>;
|
|
139
|
+
readonly destinationStatus: z.ZodNullable<z.ZodNumber>;
|
|
140
|
+
readonly domainRank: z.ZodNullable<z.ZodNumber>;
|
|
141
|
+
readonly pageRank: z.ZodNullable<z.ZodNumber>;
|
|
142
|
+
readonly dofollow: z.ZodNullable<z.ZodBoolean>;
|
|
143
|
+
readonly firstSeenAt: z.ZodNullable<z.ZodString>;
|
|
144
|
+
readonly lastSeenAt: z.ZodNullable<z.ZodString>;
|
|
145
|
+
}, z.core.$strip>>;
|
|
146
|
+
readonly page: z.ZodObject<{
|
|
147
|
+
readonly total: z.ZodNumber;
|
|
148
|
+
readonly limit: z.ZodNumber;
|
|
149
|
+
readonly offset: z.ZodNumber;
|
|
150
|
+
readonly hasMore: z.ZodBoolean;
|
|
151
|
+
}, z.core.$strip>;
|
|
89
152
|
readonly total: z.ZodNumber;
|
|
90
153
|
readonly limit: z.ZodNumber;
|
|
91
154
|
readonly offset: z.ZodNumber;
|
|
@@ -109,6 +172,25 @@ export declare const recoverableBacklinksResponseSchema: import("./core.js").Com
|
|
|
109
172
|
readonly firstSeenAt: z.ZodNullable<z.ZodString>;
|
|
110
173
|
readonly lastSeenAt: z.ZodNullable<z.ZodString>;
|
|
111
174
|
}, z.core.$strip>>;
|
|
175
|
+
readonly rows: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
176
|
+
readonly id: z.ZodString;
|
|
177
|
+
readonly destinationUrl: z.ZodString;
|
|
178
|
+
readonly referringUrl: z.ZodString;
|
|
179
|
+
readonly referringDomain: z.ZodString;
|
|
180
|
+
readonly anchor: z.ZodNullable<z.ZodString>;
|
|
181
|
+
readonly destinationStatus: z.ZodNullable<z.ZodNumber>;
|
|
182
|
+
readonly domainRank: z.ZodNullable<z.ZodNumber>;
|
|
183
|
+
readonly pageRank: z.ZodNullable<z.ZodNumber>;
|
|
184
|
+
readonly dofollow: z.ZodNullable<z.ZodBoolean>;
|
|
185
|
+
readonly firstSeenAt: z.ZodNullable<z.ZodString>;
|
|
186
|
+
readonly lastSeenAt: z.ZodNullable<z.ZodString>;
|
|
187
|
+
}, z.core.$strip>>>;
|
|
188
|
+
readonly page: z.ZodOptional<z.ZodObject<{
|
|
189
|
+
readonly total: z.ZodNumber;
|
|
190
|
+
readonly limit: z.ZodNumber;
|
|
191
|
+
readonly offset: z.ZodNumber;
|
|
192
|
+
readonly hasMore: z.ZodBoolean;
|
|
193
|
+
}, z.core.$strip>>;
|
|
112
194
|
readonly total: z.ZodNumber;
|
|
113
195
|
readonly limit: z.ZodNumber;
|
|
114
196
|
readonly offset: z.ZodNumber;
|
|
@@ -119,6 +201,8 @@ export declare const recoverableBacklinksResponseSchema: import("./core.js").Com
|
|
|
119
201
|
}, z.core.$loose>;
|
|
120
202
|
}, z.core.$strip>>;
|
|
121
203
|
export type RecoverableBacklinks = z.output<typeof recoverableBacklinksDataSchema.producer>;
|
|
204
|
+
/** What a consumer receives. See `PageInspectData` for why it is looser. */
|
|
205
|
+
export type RecoverableBacklinksData = z.output<typeof recoverableBacklinksDataSchema.client>;
|
|
122
206
|
export declare const recoverableBacklinksOperation: {
|
|
123
207
|
readonly id: 'backlinks.recoverable';
|
|
124
208
|
readonly method: 'GET';
|
|
@@ -150,6 +234,9 @@ export declare const recoverableBacklinksOperation: {
|
|
|
150
234
|
readonly responses: {
|
|
151
235
|
readonly 200: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
|
|
152
236
|
data: z.ZodObject<{
|
|
237
|
+
/**
|
|
238
|
+
* Deprecated alias of `rows`. Kept for one minor version, then removed.
|
|
239
|
+
*/
|
|
153
240
|
readonly items: z.ZodArray<z.ZodObject<{
|
|
154
241
|
readonly id: z.ZodString;
|
|
155
242
|
readonly destinationUrl: z.ZodString;
|
|
@@ -163,6 +250,25 @@ export declare const recoverableBacklinksOperation: {
|
|
|
163
250
|
readonly firstSeenAt: z.ZodNullable<z.ZodString>;
|
|
164
251
|
readonly lastSeenAt: z.ZodNullable<z.ZodString>;
|
|
165
252
|
}, z.core.$strip>>;
|
|
253
|
+
readonly rows: z.ZodArray<z.ZodObject<{
|
|
254
|
+
readonly id: z.ZodString;
|
|
255
|
+
readonly destinationUrl: z.ZodString;
|
|
256
|
+
readonly referringUrl: z.ZodString;
|
|
257
|
+
readonly referringDomain: z.ZodString;
|
|
258
|
+
readonly anchor: z.ZodNullable<z.ZodString>;
|
|
259
|
+
readonly destinationStatus: z.ZodNullable<z.ZodNumber>;
|
|
260
|
+
readonly domainRank: z.ZodNullable<z.ZodNumber>;
|
|
261
|
+
readonly pageRank: z.ZodNullable<z.ZodNumber>;
|
|
262
|
+
readonly dofollow: z.ZodNullable<z.ZodBoolean>;
|
|
263
|
+
readonly firstSeenAt: z.ZodNullable<z.ZodString>;
|
|
264
|
+
readonly lastSeenAt: z.ZodNullable<z.ZodString>;
|
|
265
|
+
}, z.core.$strip>>;
|
|
266
|
+
readonly page: z.ZodObject<{
|
|
267
|
+
readonly total: z.ZodNumber;
|
|
268
|
+
readonly limit: z.ZodNumber;
|
|
269
|
+
readonly offset: z.ZodNumber;
|
|
270
|
+
readonly hasMore: z.ZodBoolean;
|
|
271
|
+
}, z.core.$strip>;
|
|
166
272
|
readonly total: z.ZodNumber;
|
|
167
273
|
readonly limit: z.ZodNumber;
|
|
168
274
|
readonly offset: z.ZodNumber;
|
|
@@ -186,6 +292,25 @@ export declare const recoverableBacklinksOperation: {
|
|
|
186
292
|
readonly firstSeenAt: z.ZodNullable<z.ZodString>;
|
|
187
293
|
readonly lastSeenAt: z.ZodNullable<z.ZodString>;
|
|
188
294
|
}, z.core.$strip>>;
|
|
295
|
+
readonly rows: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
296
|
+
readonly id: z.ZodString;
|
|
297
|
+
readonly destinationUrl: z.ZodString;
|
|
298
|
+
readonly referringUrl: z.ZodString;
|
|
299
|
+
readonly referringDomain: z.ZodString;
|
|
300
|
+
readonly anchor: z.ZodNullable<z.ZodString>;
|
|
301
|
+
readonly destinationStatus: z.ZodNullable<z.ZodNumber>;
|
|
302
|
+
readonly domainRank: z.ZodNullable<z.ZodNumber>;
|
|
303
|
+
readonly pageRank: z.ZodNullable<z.ZodNumber>;
|
|
304
|
+
readonly dofollow: z.ZodNullable<z.ZodBoolean>;
|
|
305
|
+
readonly firstSeenAt: z.ZodNullable<z.ZodString>;
|
|
306
|
+
readonly lastSeenAt: z.ZodNullable<z.ZodString>;
|
|
307
|
+
}, z.core.$strip>>>;
|
|
308
|
+
readonly page: z.ZodOptional<z.ZodObject<{
|
|
309
|
+
readonly total: z.ZodNumber;
|
|
310
|
+
readonly limit: z.ZodNumber;
|
|
311
|
+
readonly offset: z.ZodNumber;
|
|
312
|
+
readonly hasMore: z.ZodBoolean;
|
|
313
|
+
}, z.core.$strip>>;
|
|
189
314
|
readonly total: z.ZodNumber;
|
|
190
315
|
readonly limit: z.ZodNumber;
|
|
191
316
|
readonly offset: z.ZodNumber;
|
|
@@ -297,6 +422,25 @@ export declare const recoverableBacklinksOperation: {
|
|
|
297
422
|
readonly firstSeenAt: '2026-02-09T20:43:50.000Z';
|
|
298
423
|
readonly lastSeenAt: '2026-07-17T04:40:07.000Z';
|
|
299
424
|
}];
|
|
425
|
+
readonly rows: readonly [{
|
|
426
|
+
readonly id: 'bl_01JXYZ';
|
|
427
|
+
readonly destinationUrl: 'https://example.com/docs/utils';
|
|
428
|
+
readonly referringUrl: 'https://news.example/posts/seo';
|
|
429
|
+
readonly referringDomain: 'news.example';
|
|
430
|
+
readonly anchor: 'Read the full documentation';
|
|
431
|
+
readonly destinationStatus: 404;
|
|
432
|
+
readonly domainRank: 529;
|
|
433
|
+
readonly pageRank: 55;
|
|
434
|
+
readonly dofollow: true;
|
|
435
|
+
readonly firstSeenAt: '2026-02-09T20:43:50.000Z';
|
|
436
|
+
readonly lastSeenAt: '2026-07-17T04:40:07.000Z';
|
|
437
|
+
}];
|
|
438
|
+
readonly page: {
|
|
439
|
+
readonly total: 1;
|
|
440
|
+
readonly limit: 100;
|
|
441
|
+
readonly offset: 0;
|
|
442
|
+
readonly hasMore: false;
|
|
443
|
+
};
|
|
300
444
|
readonly total: 1;
|
|
301
445
|
readonly limit: 100;
|
|
302
446
|
readonly offset: 0;
|
|
@@ -347,6 +491,9 @@ export declare const mentionSchema: import("./core.js").CompatibleResponseSchema
|
|
|
347
491
|
readonly publishedAt: z.ZodNullable<z.ZodString>;
|
|
348
492
|
}, z.core.$strip>>;
|
|
349
493
|
export declare const mentionsDataSchema: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
|
|
494
|
+
/**
|
|
495
|
+
* Deprecated alias of `rows`. Kept for one minor version, then removed.
|
|
496
|
+
*/
|
|
350
497
|
readonly items: z.ZodArray<z.ZodObject<{
|
|
351
498
|
readonly id: z.ZodString;
|
|
352
499
|
readonly source: z.ZodString;
|
|
@@ -361,6 +508,31 @@ export declare const mentionsDataSchema: import("./core.js").CompatibleResponseS
|
|
|
361
508
|
readonly domainRank: z.ZodNullable<z.ZodNumber>;
|
|
362
509
|
readonly publishedAt: z.ZodNullable<z.ZodString>;
|
|
363
510
|
}, z.core.$strip>>;
|
|
511
|
+
readonly rows: z.ZodArray<z.ZodObject<{
|
|
512
|
+
readonly id: z.ZodString;
|
|
513
|
+
readonly source: z.ZodString;
|
|
514
|
+
readonly url: z.ZodString;
|
|
515
|
+
readonly domain: z.ZodString;
|
|
516
|
+
readonly title: z.ZodNullable<z.ZodString>;
|
|
517
|
+
readonly snippet: z.ZodNullable<z.ZodString>;
|
|
518
|
+
readonly author: z.ZodNullable<z.ZodString>;
|
|
519
|
+
readonly authorHandle: z.ZodNullable<z.ZodString>;
|
|
520
|
+
readonly engagement: z.ZodNullable<z.ZodNumber>;
|
|
521
|
+
readonly sentiment: z.ZodNullable<z.ZodString>;
|
|
522
|
+
readonly domainRank: z.ZodNullable<z.ZodNumber>;
|
|
523
|
+
readonly publishedAt: z.ZodNullable<z.ZodString>;
|
|
524
|
+
}, z.core.$strip>>;
|
|
525
|
+
readonly page: z.ZodObject<{
|
|
526
|
+
readonly total: z.ZodNumber;
|
|
527
|
+
readonly limit: z.ZodNumber;
|
|
528
|
+
readonly offset: z.ZodNumber;
|
|
529
|
+
readonly hasMore: z.ZodBoolean;
|
|
530
|
+
}, z.core.$strip>;
|
|
531
|
+
/**
|
|
532
|
+
* The whole result set, not this page. The response carried no total and no
|
|
533
|
+
* `hasMore`, so a caller could not tell a full page from the last page.
|
|
534
|
+
*/
|
|
535
|
+
readonly total: z.ZodNumber;
|
|
364
536
|
readonly limit: z.ZodNumber;
|
|
365
537
|
}, z.core.$strip>, z.ZodObject<{
|
|
366
538
|
readonly items: z.ZodArray<z.ZodObject<{
|
|
@@ -377,10 +549,34 @@ export declare const mentionsDataSchema: import("./core.js").CompatibleResponseS
|
|
|
377
549
|
readonly domainRank: z.ZodNullable<z.ZodNumber>;
|
|
378
550
|
readonly publishedAt: z.ZodNullable<z.ZodString>;
|
|
379
551
|
}, z.core.$strip>>;
|
|
552
|
+
readonly rows: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
553
|
+
readonly id: z.ZodString;
|
|
554
|
+
readonly source: z.ZodString;
|
|
555
|
+
readonly url: z.ZodString;
|
|
556
|
+
readonly domain: z.ZodString;
|
|
557
|
+
readonly title: z.ZodNullable<z.ZodString>;
|
|
558
|
+
readonly snippet: z.ZodNullable<z.ZodString>;
|
|
559
|
+
readonly author: z.ZodNullable<z.ZodString>;
|
|
560
|
+
readonly authorHandle: z.ZodNullable<z.ZodString>;
|
|
561
|
+
readonly engagement: z.ZodNullable<z.ZodNumber>;
|
|
562
|
+
readonly sentiment: z.ZodNullable<z.ZodString>;
|
|
563
|
+
readonly domainRank: z.ZodNullable<z.ZodNumber>;
|
|
564
|
+
readonly publishedAt: z.ZodNullable<z.ZodString>;
|
|
565
|
+
}, z.core.$strip>>>;
|
|
566
|
+
readonly page: z.ZodOptional<z.ZodObject<{
|
|
567
|
+
readonly total: z.ZodNumber;
|
|
568
|
+
readonly limit: z.ZodNumber;
|
|
569
|
+
readonly offset: z.ZodNumber;
|
|
570
|
+
readonly hasMore: z.ZodBoolean;
|
|
571
|
+
}, z.core.$strip>>;
|
|
572
|
+
readonly total: z.ZodOptional<z.ZodNumber>;
|
|
380
573
|
readonly limit: z.ZodNumber;
|
|
381
574
|
}, z.core.$strip>>;
|
|
382
575
|
export declare const mentionsResponseSchema: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
|
|
383
576
|
data: z.ZodObject<{
|
|
577
|
+
/**
|
|
578
|
+
* Deprecated alias of `rows`. Kept for one minor version, then removed.
|
|
579
|
+
*/
|
|
384
580
|
readonly items: z.ZodArray<z.ZodObject<{
|
|
385
581
|
readonly id: z.ZodString;
|
|
386
582
|
readonly source: z.ZodString;
|
|
@@ -395,6 +591,31 @@ export declare const mentionsResponseSchema: import("./core.js").CompatibleRespo
|
|
|
395
591
|
readonly domainRank: z.ZodNullable<z.ZodNumber>;
|
|
396
592
|
readonly publishedAt: z.ZodNullable<z.ZodString>;
|
|
397
593
|
}, z.core.$strip>>;
|
|
594
|
+
readonly rows: z.ZodArray<z.ZodObject<{
|
|
595
|
+
readonly id: z.ZodString;
|
|
596
|
+
readonly source: z.ZodString;
|
|
597
|
+
readonly url: z.ZodString;
|
|
598
|
+
readonly domain: z.ZodString;
|
|
599
|
+
readonly title: z.ZodNullable<z.ZodString>;
|
|
600
|
+
readonly snippet: z.ZodNullable<z.ZodString>;
|
|
601
|
+
readonly author: z.ZodNullable<z.ZodString>;
|
|
602
|
+
readonly authorHandle: z.ZodNullable<z.ZodString>;
|
|
603
|
+
readonly engagement: z.ZodNullable<z.ZodNumber>;
|
|
604
|
+
readonly sentiment: z.ZodNullable<z.ZodString>;
|
|
605
|
+
readonly domainRank: z.ZodNullable<z.ZodNumber>;
|
|
606
|
+
readonly publishedAt: z.ZodNullable<z.ZodString>;
|
|
607
|
+
}, z.core.$strip>>;
|
|
608
|
+
readonly page: z.ZodObject<{
|
|
609
|
+
readonly total: z.ZodNumber;
|
|
610
|
+
readonly limit: z.ZodNumber;
|
|
611
|
+
readonly offset: z.ZodNumber;
|
|
612
|
+
readonly hasMore: z.ZodBoolean;
|
|
613
|
+
}, z.core.$strip>;
|
|
614
|
+
/**
|
|
615
|
+
* The whole result set, not this page. The response carried no total and no
|
|
616
|
+
* `hasMore`, so a caller could not tell a full page from the last page.
|
|
617
|
+
*/
|
|
618
|
+
readonly total: z.ZodNumber;
|
|
398
619
|
readonly limit: z.ZodNumber;
|
|
399
620
|
}, z.core.$strip>;
|
|
400
621
|
meta: z.ZodObject<{
|
|
@@ -417,6 +638,27 @@ export declare const mentionsResponseSchema: import("./core.js").CompatibleRespo
|
|
|
417
638
|
readonly domainRank: z.ZodNullable<z.ZodNumber>;
|
|
418
639
|
readonly publishedAt: z.ZodNullable<z.ZodString>;
|
|
419
640
|
}, z.core.$strip>>;
|
|
641
|
+
readonly rows: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
642
|
+
readonly id: z.ZodString;
|
|
643
|
+
readonly source: z.ZodString;
|
|
644
|
+
readonly url: z.ZodString;
|
|
645
|
+
readonly domain: z.ZodString;
|
|
646
|
+
readonly title: z.ZodNullable<z.ZodString>;
|
|
647
|
+
readonly snippet: z.ZodNullable<z.ZodString>;
|
|
648
|
+
readonly author: z.ZodNullable<z.ZodString>;
|
|
649
|
+
readonly authorHandle: z.ZodNullable<z.ZodString>;
|
|
650
|
+
readonly engagement: z.ZodNullable<z.ZodNumber>;
|
|
651
|
+
readonly sentiment: z.ZodNullable<z.ZodString>;
|
|
652
|
+
readonly domainRank: z.ZodNullable<z.ZodNumber>;
|
|
653
|
+
readonly publishedAt: z.ZodNullable<z.ZodString>;
|
|
654
|
+
}, z.core.$strip>>>;
|
|
655
|
+
readonly page: z.ZodOptional<z.ZodObject<{
|
|
656
|
+
readonly total: z.ZodNumber;
|
|
657
|
+
readonly limit: z.ZodNumber;
|
|
658
|
+
readonly offset: z.ZodNumber;
|
|
659
|
+
readonly hasMore: z.ZodBoolean;
|
|
660
|
+
}, z.core.$strip>>;
|
|
661
|
+
readonly total: z.ZodOptional<z.ZodNumber>;
|
|
420
662
|
readonly limit: z.ZodNumber;
|
|
421
663
|
}, z.core.$strip>;
|
|
422
664
|
meta: z.ZodObject<{
|
|
@@ -425,6 +667,8 @@ export declare const mentionsResponseSchema: import("./core.js").CompatibleRespo
|
|
|
425
667
|
}, z.core.$loose>;
|
|
426
668
|
}, z.core.$strip>>;
|
|
427
669
|
export type Mentions = z.output<typeof mentionsDataSchema.producer>;
|
|
670
|
+
/** What a consumer receives. See `PageInspectData` for why it is looser. */
|
|
671
|
+
export type MentionsData = z.output<typeof mentionsDataSchema.client>;
|
|
428
672
|
export declare const mentionsListOperation: {
|
|
429
673
|
readonly id: 'mentions.list';
|
|
430
674
|
readonly method: 'GET';
|
|
@@ -461,6 +705,9 @@ export declare const mentionsListOperation: {
|
|
|
461
705
|
readonly responses: {
|
|
462
706
|
readonly 200: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
|
|
463
707
|
data: z.ZodObject<{
|
|
708
|
+
/**
|
|
709
|
+
* Deprecated alias of `rows`. Kept for one minor version, then removed.
|
|
710
|
+
*/
|
|
464
711
|
readonly items: z.ZodArray<z.ZodObject<{
|
|
465
712
|
readonly id: z.ZodString;
|
|
466
713
|
readonly source: z.ZodString;
|
|
@@ -475,6 +722,31 @@ export declare const mentionsListOperation: {
|
|
|
475
722
|
readonly domainRank: z.ZodNullable<z.ZodNumber>;
|
|
476
723
|
readonly publishedAt: z.ZodNullable<z.ZodString>;
|
|
477
724
|
}, z.core.$strip>>;
|
|
725
|
+
readonly rows: z.ZodArray<z.ZodObject<{
|
|
726
|
+
readonly id: z.ZodString;
|
|
727
|
+
readonly source: z.ZodString;
|
|
728
|
+
readonly url: z.ZodString;
|
|
729
|
+
readonly domain: z.ZodString;
|
|
730
|
+
readonly title: z.ZodNullable<z.ZodString>;
|
|
731
|
+
readonly snippet: z.ZodNullable<z.ZodString>;
|
|
732
|
+
readonly author: z.ZodNullable<z.ZodString>;
|
|
733
|
+
readonly authorHandle: z.ZodNullable<z.ZodString>;
|
|
734
|
+
readonly engagement: z.ZodNullable<z.ZodNumber>;
|
|
735
|
+
readonly sentiment: z.ZodNullable<z.ZodString>;
|
|
736
|
+
readonly domainRank: z.ZodNullable<z.ZodNumber>;
|
|
737
|
+
readonly publishedAt: z.ZodNullable<z.ZodString>;
|
|
738
|
+
}, z.core.$strip>>;
|
|
739
|
+
readonly page: z.ZodObject<{
|
|
740
|
+
readonly total: z.ZodNumber;
|
|
741
|
+
readonly limit: z.ZodNumber;
|
|
742
|
+
readonly offset: z.ZodNumber;
|
|
743
|
+
readonly hasMore: z.ZodBoolean;
|
|
744
|
+
}, z.core.$strip>;
|
|
745
|
+
/**
|
|
746
|
+
* The whole result set, not this page. The response carried no total and no
|
|
747
|
+
* `hasMore`, so a caller could not tell a full page from the last page.
|
|
748
|
+
*/
|
|
749
|
+
readonly total: z.ZodNumber;
|
|
478
750
|
readonly limit: z.ZodNumber;
|
|
479
751
|
}, z.core.$strip>;
|
|
480
752
|
meta: z.ZodObject<{
|
|
@@ -497,6 +769,27 @@ export declare const mentionsListOperation: {
|
|
|
497
769
|
readonly domainRank: z.ZodNullable<z.ZodNumber>;
|
|
498
770
|
readonly publishedAt: z.ZodNullable<z.ZodString>;
|
|
499
771
|
}, z.core.$strip>>;
|
|
772
|
+
readonly rows: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
773
|
+
readonly id: z.ZodString;
|
|
774
|
+
readonly source: z.ZodString;
|
|
775
|
+
readonly url: z.ZodString;
|
|
776
|
+
readonly domain: z.ZodString;
|
|
777
|
+
readonly title: z.ZodNullable<z.ZodString>;
|
|
778
|
+
readonly snippet: z.ZodNullable<z.ZodString>;
|
|
779
|
+
readonly author: z.ZodNullable<z.ZodString>;
|
|
780
|
+
readonly authorHandle: z.ZodNullable<z.ZodString>;
|
|
781
|
+
readonly engagement: z.ZodNullable<z.ZodNumber>;
|
|
782
|
+
readonly sentiment: z.ZodNullable<z.ZodString>;
|
|
783
|
+
readonly domainRank: z.ZodNullable<z.ZodNumber>;
|
|
784
|
+
readonly publishedAt: z.ZodNullable<z.ZodString>;
|
|
785
|
+
}, z.core.$strip>>>;
|
|
786
|
+
readonly page: z.ZodOptional<z.ZodObject<{
|
|
787
|
+
readonly total: z.ZodNumber;
|
|
788
|
+
readonly limit: z.ZodNumber;
|
|
789
|
+
readonly offset: z.ZodNumber;
|
|
790
|
+
readonly hasMore: z.ZodBoolean;
|
|
791
|
+
}, z.core.$strip>>;
|
|
792
|
+
readonly total: z.ZodOptional<z.ZodNumber>;
|
|
500
793
|
readonly limit: z.ZodNumber;
|
|
501
794
|
}, z.core.$strip>;
|
|
502
795
|
meta: z.ZodObject<{
|
|
@@ -607,6 +900,27 @@ export declare const mentionsListOperation: {
|
|
|
607
900
|
readonly domainRank: 812;
|
|
608
901
|
readonly publishedAt: '2026-08-01T09:12:00.000Z';
|
|
609
902
|
}];
|
|
903
|
+
readonly rows: readonly [{
|
|
904
|
+
readonly id: 'mn_01JXYZ';
|
|
905
|
+
readonly source: 'hackernews';
|
|
906
|
+
readonly url: 'https://news.ycombinator.com/item?id=1';
|
|
907
|
+
readonly domain: 'news.ycombinator.com';
|
|
908
|
+
readonly title: 'Show HN: a sitemap module';
|
|
909
|
+
readonly snippet: 'We moved to example.com last week';
|
|
910
|
+
readonly author: 'Ada Lovelace';
|
|
911
|
+
readonly authorHandle: 'ada';
|
|
912
|
+
readonly engagement: 142;
|
|
913
|
+
readonly sentiment: 'positive';
|
|
914
|
+
readonly domainRank: 812;
|
|
915
|
+
readonly publishedAt: '2026-08-01T09:12:00.000Z';
|
|
916
|
+
}];
|
|
917
|
+
readonly page: {
|
|
918
|
+
readonly total: 1;
|
|
919
|
+
readonly limit: 100;
|
|
920
|
+
readonly offset: 0;
|
|
921
|
+
readonly hasMore: false;
|
|
922
|
+
};
|
|
923
|
+
readonly total: 1;
|
|
610
924
|
readonly limit: 100;
|
|
611
925
|
};
|
|
612
926
|
readonly meta: {
|
|
@@ -655,6 +969,9 @@ export declare const mentionsV1Registry: import("./core.js").PublicV1Registry<{
|
|
|
655
969
|
readonly responses: {
|
|
656
970
|
readonly 200: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
|
|
657
971
|
data: z.ZodObject<{
|
|
972
|
+
/**
|
|
973
|
+
* Deprecated alias of `rows`. Kept for one minor version, then removed.
|
|
974
|
+
*/
|
|
658
975
|
readonly items: z.ZodArray<z.ZodObject<{
|
|
659
976
|
readonly id: z.ZodString;
|
|
660
977
|
readonly source: z.ZodString;
|
|
@@ -669,6 +986,31 @@ export declare const mentionsV1Registry: import("./core.js").PublicV1Registry<{
|
|
|
669
986
|
readonly domainRank: z.ZodNullable<z.ZodNumber>;
|
|
670
987
|
readonly publishedAt: z.ZodNullable<z.ZodString>;
|
|
671
988
|
}, z.core.$strip>>;
|
|
989
|
+
readonly rows: z.ZodArray<z.ZodObject<{
|
|
990
|
+
readonly id: z.ZodString;
|
|
991
|
+
readonly source: z.ZodString;
|
|
992
|
+
readonly url: z.ZodString;
|
|
993
|
+
readonly domain: z.ZodString;
|
|
994
|
+
readonly title: z.ZodNullable<z.ZodString>;
|
|
995
|
+
readonly snippet: z.ZodNullable<z.ZodString>;
|
|
996
|
+
readonly author: z.ZodNullable<z.ZodString>;
|
|
997
|
+
readonly authorHandle: z.ZodNullable<z.ZodString>;
|
|
998
|
+
readonly engagement: z.ZodNullable<z.ZodNumber>;
|
|
999
|
+
readonly sentiment: z.ZodNullable<z.ZodString>;
|
|
1000
|
+
readonly domainRank: z.ZodNullable<z.ZodNumber>;
|
|
1001
|
+
readonly publishedAt: z.ZodNullable<z.ZodString>;
|
|
1002
|
+
}, z.core.$strip>>;
|
|
1003
|
+
readonly page: z.ZodObject<{
|
|
1004
|
+
readonly total: z.ZodNumber;
|
|
1005
|
+
readonly limit: z.ZodNumber;
|
|
1006
|
+
readonly offset: z.ZodNumber;
|
|
1007
|
+
readonly hasMore: z.ZodBoolean;
|
|
1008
|
+
}, z.core.$strip>;
|
|
1009
|
+
/**
|
|
1010
|
+
* The whole result set, not this page. The response carried no total and no
|
|
1011
|
+
* `hasMore`, so a caller could not tell a full page from the last page.
|
|
1012
|
+
*/
|
|
1013
|
+
readonly total: z.ZodNumber;
|
|
672
1014
|
readonly limit: z.ZodNumber;
|
|
673
1015
|
}, z.core.$strip>;
|
|
674
1016
|
meta: z.ZodObject<{
|
|
@@ -691,6 +1033,27 @@ export declare const mentionsV1Registry: import("./core.js").PublicV1Registry<{
|
|
|
691
1033
|
readonly domainRank: z.ZodNullable<z.ZodNumber>;
|
|
692
1034
|
readonly publishedAt: z.ZodNullable<z.ZodString>;
|
|
693
1035
|
}, z.core.$strip>>;
|
|
1036
|
+
readonly rows: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
1037
|
+
readonly id: z.ZodString;
|
|
1038
|
+
readonly source: z.ZodString;
|
|
1039
|
+
readonly url: z.ZodString;
|
|
1040
|
+
readonly domain: z.ZodString;
|
|
1041
|
+
readonly title: z.ZodNullable<z.ZodString>;
|
|
1042
|
+
readonly snippet: z.ZodNullable<z.ZodString>;
|
|
1043
|
+
readonly author: z.ZodNullable<z.ZodString>;
|
|
1044
|
+
readonly authorHandle: z.ZodNullable<z.ZodString>;
|
|
1045
|
+
readonly engagement: z.ZodNullable<z.ZodNumber>;
|
|
1046
|
+
readonly sentiment: z.ZodNullable<z.ZodString>;
|
|
1047
|
+
readonly domainRank: z.ZodNullable<z.ZodNumber>;
|
|
1048
|
+
readonly publishedAt: z.ZodNullable<z.ZodString>;
|
|
1049
|
+
}, z.core.$strip>>>;
|
|
1050
|
+
readonly page: z.ZodOptional<z.ZodObject<{
|
|
1051
|
+
readonly total: z.ZodNumber;
|
|
1052
|
+
readonly limit: z.ZodNumber;
|
|
1053
|
+
readonly offset: z.ZodNumber;
|
|
1054
|
+
readonly hasMore: z.ZodBoolean;
|
|
1055
|
+
}, z.core.$strip>>;
|
|
1056
|
+
readonly total: z.ZodOptional<z.ZodNumber>;
|
|
694
1057
|
readonly limit: z.ZodNumber;
|
|
695
1058
|
}, z.core.$strip>;
|
|
696
1059
|
meta: z.ZodObject<{
|
|
@@ -801,6 +1164,27 @@ export declare const mentionsV1Registry: import("./core.js").PublicV1Registry<{
|
|
|
801
1164
|
readonly domainRank: 812;
|
|
802
1165
|
readonly publishedAt: '2026-08-01T09:12:00.000Z';
|
|
803
1166
|
}];
|
|
1167
|
+
readonly rows: readonly [{
|
|
1168
|
+
readonly id: 'mn_01JXYZ';
|
|
1169
|
+
readonly source: 'hackernews';
|
|
1170
|
+
readonly url: 'https://news.ycombinator.com/item?id=1';
|
|
1171
|
+
readonly domain: 'news.ycombinator.com';
|
|
1172
|
+
readonly title: 'Show HN: a sitemap module';
|
|
1173
|
+
readonly snippet: 'We moved to example.com last week';
|
|
1174
|
+
readonly author: 'Ada Lovelace';
|
|
1175
|
+
readonly authorHandle: 'ada';
|
|
1176
|
+
readonly engagement: 142;
|
|
1177
|
+
readonly sentiment: 'positive';
|
|
1178
|
+
readonly domainRank: 812;
|
|
1179
|
+
readonly publishedAt: '2026-08-01T09:12:00.000Z';
|
|
1180
|
+
}];
|
|
1181
|
+
readonly page: {
|
|
1182
|
+
readonly total: 1;
|
|
1183
|
+
readonly limit: 100;
|
|
1184
|
+
readonly offset: 0;
|
|
1185
|
+
readonly hasMore: false;
|
|
1186
|
+
};
|
|
1187
|
+
readonly total: 1;
|
|
804
1188
|
readonly limit: 100;
|
|
805
1189
|
};
|
|
806
1190
|
readonly meta: {
|
|
@@ -2526,6 +2910,9 @@ export declare const backlinksV1Registry: import("./core.js").PublicV1Registry<{
|
|
|
2526
2910
|
readonly responses: {
|
|
2527
2911
|
readonly 200: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
|
|
2528
2912
|
data: z.ZodObject<{
|
|
2913
|
+
/**
|
|
2914
|
+
* Deprecated alias of `rows`. Kept for one minor version, then removed.
|
|
2915
|
+
*/
|
|
2529
2916
|
readonly items: z.ZodArray<z.ZodObject<{
|
|
2530
2917
|
readonly id: z.ZodString;
|
|
2531
2918
|
readonly destinationUrl: z.ZodString;
|
|
@@ -2539,6 +2926,25 @@ export declare const backlinksV1Registry: import("./core.js").PublicV1Registry<{
|
|
|
2539
2926
|
readonly firstSeenAt: z.ZodNullable<z.ZodString>;
|
|
2540
2927
|
readonly lastSeenAt: z.ZodNullable<z.ZodString>;
|
|
2541
2928
|
}, z.core.$strip>>;
|
|
2929
|
+
readonly rows: z.ZodArray<z.ZodObject<{
|
|
2930
|
+
readonly id: z.ZodString;
|
|
2931
|
+
readonly destinationUrl: z.ZodString;
|
|
2932
|
+
readonly referringUrl: z.ZodString;
|
|
2933
|
+
readonly referringDomain: z.ZodString;
|
|
2934
|
+
readonly anchor: z.ZodNullable<z.ZodString>;
|
|
2935
|
+
readonly destinationStatus: z.ZodNullable<z.ZodNumber>;
|
|
2936
|
+
readonly domainRank: z.ZodNullable<z.ZodNumber>;
|
|
2937
|
+
readonly pageRank: z.ZodNullable<z.ZodNumber>;
|
|
2938
|
+
readonly dofollow: z.ZodNullable<z.ZodBoolean>;
|
|
2939
|
+
readonly firstSeenAt: z.ZodNullable<z.ZodString>;
|
|
2940
|
+
readonly lastSeenAt: z.ZodNullable<z.ZodString>;
|
|
2941
|
+
}, z.core.$strip>>;
|
|
2942
|
+
readonly page: z.ZodObject<{
|
|
2943
|
+
readonly total: z.ZodNumber;
|
|
2944
|
+
readonly limit: z.ZodNumber;
|
|
2945
|
+
readonly offset: z.ZodNumber;
|
|
2946
|
+
readonly hasMore: z.ZodBoolean;
|
|
2947
|
+
}, z.core.$strip>;
|
|
2542
2948
|
readonly total: z.ZodNumber;
|
|
2543
2949
|
readonly limit: z.ZodNumber;
|
|
2544
2950
|
readonly offset: z.ZodNumber;
|
|
@@ -2562,6 +2968,25 @@ export declare const backlinksV1Registry: import("./core.js").PublicV1Registry<{
|
|
|
2562
2968
|
readonly firstSeenAt: z.ZodNullable<z.ZodString>;
|
|
2563
2969
|
readonly lastSeenAt: z.ZodNullable<z.ZodString>;
|
|
2564
2970
|
}, z.core.$strip>>;
|
|
2971
|
+
readonly rows: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
2972
|
+
readonly id: z.ZodString;
|
|
2973
|
+
readonly destinationUrl: z.ZodString;
|
|
2974
|
+
readonly referringUrl: z.ZodString;
|
|
2975
|
+
readonly referringDomain: z.ZodString;
|
|
2976
|
+
readonly anchor: z.ZodNullable<z.ZodString>;
|
|
2977
|
+
readonly destinationStatus: z.ZodNullable<z.ZodNumber>;
|
|
2978
|
+
readonly domainRank: z.ZodNullable<z.ZodNumber>;
|
|
2979
|
+
readonly pageRank: z.ZodNullable<z.ZodNumber>;
|
|
2980
|
+
readonly dofollow: z.ZodNullable<z.ZodBoolean>;
|
|
2981
|
+
readonly firstSeenAt: z.ZodNullable<z.ZodString>;
|
|
2982
|
+
readonly lastSeenAt: z.ZodNullable<z.ZodString>;
|
|
2983
|
+
}, z.core.$strip>>>;
|
|
2984
|
+
readonly page: z.ZodOptional<z.ZodObject<{
|
|
2985
|
+
readonly total: z.ZodNumber;
|
|
2986
|
+
readonly limit: z.ZodNumber;
|
|
2987
|
+
readonly offset: z.ZodNumber;
|
|
2988
|
+
readonly hasMore: z.ZodBoolean;
|
|
2989
|
+
}, z.core.$strip>>;
|
|
2565
2990
|
readonly total: z.ZodNumber;
|
|
2566
2991
|
readonly limit: z.ZodNumber;
|
|
2567
2992
|
readonly offset: z.ZodNumber;
|
|
@@ -2673,6 +3098,25 @@ export declare const backlinksV1Registry: import("./core.js").PublicV1Registry<{
|
|
|
2673
3098
|
readonly firstSeenAt: '2026-02-09T20:43:50.000Z';
|
|
2674
3099
|
readonly lastSeenAt: '2026-07-17T04:40:07.000Z';
|
|
2675
3100
|
}];
|
|
3101
|
+
readonly rows: readonly [{
|
|
3102
|
+
readonly id: 'bl_01JXYZ';
|
|
3103
|
+
readonly destinationUrl: 'https://example.com/docs/utils';
|
|
3104
|
+
readonly referringUrl: 'https://news.example/posts/seo';
|
|
3105
|
+
readonly referringDomain: 'news.example';
|
|
3106
|
+
readonly anchor: 'Read the full documentation';
|
|
3107
|
+
readonly destinationStatus: 404;
|
|
3108
|
+
readonly domainRank: 529;
|
|
3109
|
+
readonly pageRank: 55;
|
|
3110
|
+
readonly dofollow: true;
|
|
3111
|
+
readonly firstSeenAt: '2026-02-09T20:43:50.000Z';
|
|
3112
|
+
readonly lastSeenAt: '2026-07-17T04:40:07.000Z';
|
|
3113
|
+
}];
|
|
3114
|
+
readonly page: {
|
|
3115
|
+
readonly total: 1;
|
|
3116
|
+
readonly limit: 100;
|
|
3117
|
+
readonly offset: 0;
|
|
3118
|
+
readonly hasMore: false;
|
|
3119
|
+
};
|
|
2676
3120
|
readonly total: 1;
|
|
2677
3121
|
readonly limit: 100;
|
|
2678
3122
|
readonly offset: 0;
|