@nuxtseo/protocol 0.1.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/analytics-codecs/analytics-row.d.ts +265 -0
- package/dist/analytics-codecs/analytics-row.js +175 -0
- package/dist/analytics-codecs/analytics-web-vitals.d.ts +57 -0
- package/dist/analytics-codecs/analytics-web-vitals.js +76 -0
- package/dist/analytics-codecs/capabilities.d.ts +35 -0
- package/dist/analytics-codecs/capabilities.js +76 -0
- package/dist/analytics-codecs/index.d.ts +3 -0
- package/dist/analytics-codecs/index.js +3 -0
- package/dist/cli-pairing.d.ts +67 -0
- package/dist/cli-pairing.js +52 -0
- package/dist/index.d.ts +1 -0
- package/dist/index.js +1 -0
- package/dist/v1/account.d.ts +715 -0
- package/dist/v1/account.js +123 -0
- package/dist/v1/actions.d.ts +2591 -0
- package/dist/v1/actions.js +460 -0
- package/dist/v1/analytics.d.ts +6145 -0
- package/dist/v1/analytics.js +296 -0
- package/dist/v1/audit.d.ts +4053 -0
- package/dist/v1/audit.js +609 -0
- package/dist/v1/backlinks.d.ts +1002 -0
- package/dist/v1/backlinks.js +239 -0
- package/dist/v1/content.d.ts +2745 -0
- package/dist/v1/content.js +326 -0
- package/dist/v1/core.d.ts +301 -0
- package/dist/v1/core.js +333 -0
- package/dist/v1/documents.d.ts +4 -0
- package/dist/v1/documents.js +216 -0
- package/dist/v1/gsc.d.ts +5172 -0
- package/dist/v1/gsc.js +583 -0
- package/dist/v1/index.d.ts +49 -0
- package/dist/v1/index.js +52 -0
- package/dist/v1/pages.d.ts +1404 -0
- package/dist/v1/pages.js +287 -0
- package/dist/v1/performance.d.ts +1379 -0
- package/dist/v1/performance.js +198 -0
- package/dist/v1/research.d.ts +1173 -0
- package/dist/v1/research.js +174 -0
- package/dist/v1/sitemaps.d.ts +1506 -0
- package/dist/v1/sitemaps.js +199 -0
- package/dist/v1/sites.d.ts +591 -0
- package/dist/v1/sites.js +101 -0
- package/generated/openapi.v1.json +1 -0
- package/package.json +131 -0
|
@@ -0,0 +1,1002 @@
|
|
|
1
|
+
import type { z } from 'zod';
|
|
2
|
+
export declare const backlinksSiteParamsSchema: z.ZodObject<{
|
|
3
|
+
siteId: z.ZodString;
|
|
4
|
+
}, z.core.$strict>;
|
|
5
|
+
export declare const backlinksPageQuerySchema: z.ZodObject<{
|
|
6
|
+
limit: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
|
|
7
|
+
offset: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
|
|
8
|
+
}, z.core.$strict>;
|
|
9
|
+
/**
|
|
10
|
+
* One inbound link whose destination is broken. `destinationStatus` is the
|
|
11
|
+
* status the destination answered with when the provider last checked, so a
|
|
12
|
+
* consumer can separate a 404 from a 5xx without refetching.
|
|
13
|
+
*/
|
|
14
|
+
export declare const recoverableBacklinkSchema: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
|
|
15
|
+
readonly id: z.ZodString;
|
|
16
|
+
readonly destinationUrl: z.ZodString;
|
|
17
|
+
readonly referringUrl: z.ZodString;
|
|
18
|
+
readonly referringDomain: z.ZodString;
|
|
19
|
+
readonly anchor: z.ZodNullable<z.ZodString>;
|
|
20
|
+
readonly destinationStatus: z.ZodNullable<z.ZodNumber>;
|
|
21
|
+
readonly domainRank: z.ZodNullable<z.ZodNumber>;
|
|
22
|
+
readonly pageRank: z.ZodNullable<z.ZodNumber>;
|
|
23
|
+
readonly dofollow: z.ZodNullable<z.ZodBoolean>;
|
|
24
|
+
readonly firstSeenAt: z.ZodNullable<z.ZodString>;
|
|
25
|
+
readonly lastSeenAt: z.ZodNullable<z.ZodString>;
|
|
26
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
27
|
+
readonly id: z.ZodString;
|
|
28
|
+
readonly destinationUrl: z.ZodString;
|
|
29
|
+
readonly referringUrl: z.ZodString;
|
|
30
|
+
readonly referringDomain: z.ZodString;
|
|
31
|
+
readonly anchor: z.ZodNullable<z.ZodString>;
|
|
32
|
+
readonly destinationStatus: z.ZodNullable<z.ZodNumber>;
|
|
33
|
+
readonly domainRank: z.ZodNullable<z.ZodNumber>;
|
|
34
|
+
readonly pageRank: z.ZodNullable<z.ZodNumber>;
|
|
35
|
+
readonly dofollow: z.ZodNullable<z.ZodBoolean>;
|
|
36
|
+
readonly firstSeenAt: z.ZodNullable<z.ZodString>;
|
|
37
|
+
readonly lastSeenAt: z.ZodNullable<z.ZodString>;
|
|
38
|
+
}, z.core.$strip>>;
|
|
39
|
+
export declare const recoverableBacklinksDataSchema: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
|
|
40
|
+
readonly items: z.ZodArray<z.ZodObject<{
|
|
41
|
+
readonly id: z.ZodString;
|
|
42
|
+
readonly destinationUrl: z.ZodString;
|
|
43
|
+
readonly referringUrl: z.ZodString;
|
|
44
|
+
readonly referringDomain: z.ZodString;
|
|
45
|
+
readonly anchor: z.ZodNullable<z.ZodString>;
|
|
46
|
+
readonly destinationStatus: z.ZodNullable<z.ZodNumber>;
|
|
47
|
+
readonly domainRank: z.ZodNullable<z.ZodNumber>;
|
|
48
|
+
readonly pageRank: z.ZodNullable<z.ZodNumber>;
|
|
49
|
+
readonly dofollow: z.ZodNullable<z.ZodBoolean>;
|
|
50
|
+
readonly firstSeenAt: z.ZodNullable<z.ZodString>;
|
|
51
|
+
readonly lastSeenAt: z.ZodNullable<z.ZodString>;
|
|
52
|
+
}, z.core.$strip>>;
|
|
53
|
+
readonly total: z.ZodNumber;
|
|
54
|
+
readonly limit: z.ZodNumber;
|
|
55
|
+
readonly offset: z.ZodNumber;
|
|
56
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
57
|
+
readonly items: z.ZodArray<z.ZodObject<{
|
|
58
|
+
readonly id: z.ZodString;
|
|
59
|
+
readonly destinationUrl: z.ZodString;
|
|
60
|
+
readonly referringUrl: z.ZodString;
|
|
61
|
+
readonly referringDomain: z.ZodString;
|
|
62
|
+
readonly anchor: z.ZodNullable<z.ZodString>;
|
|
63
|
+
readonly destinationStatus: z.ZodNullable<z.ZodNumber>;
|
|
64
|
+
readonly domainRank: z.ZodNullable<z.ZodNumber>;
|
|
65
|
+
readonly pageRank: z.ZodNullable<z.ZodNumber>;
|
|
66
|
+
readonly dofollow: z.ZodNullable<z.ZodBoolean>;
|
|
67
|
+
readonly firstSeenAt: z.ZodNullable<z.ZodString>;
|
|
68
|
+
readonly lastSeenAt: z.ZodNullable<z.ZodString>;
|
|
69
|
+
}, z.core.$strip>>;
|
|
70
|
+
readonly total: z.ZodNumber;
|
|
71
|
+
readonly limit: z.ZodNumber;
|
|
72
|
+
readonly offset: z.ZodNumber;
|
|
73
|
+
}, z.core.$strip>>;
|
|
74
|
+
export declare const recoverableBacklinksResponseSchema: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
|
|
75
|
+
data: z.ZodObject<{
|
|
76
|
+
readonly items: z.ZodArray<z.ZodObject<{
|
|
77
|
+
readonly id: z.ZodString;
|
|
78
|
+
readonly destinationUrl: z.ZodString;
|
|
79
|
+
readonly referringUrl: z.ZodString;
|
|
80
|
+
readonly referringDomain: z.ZodString;
|
|
81
|
+
readonly anchor: z.ZodNullable<z.ZodString>;
|
|
82
|
+
readonly destinationStatus: z.ZodNullable<z.ZodNumber>;
|
|
83
|
+
readonly domainRank: z.ZodNullable<z.ZodNumber>;
|
|
84
|
+
readonly pageRank: z.ZodNullable<z.ZodNumber>;
|
|
85
|
+
readonly dofollow: z.ZodNullable<z.ZodBoolean>;
|
|
86
|
+
readonly firstSeenAt: z.ZodNullable<z.ZodString>;
|
|
87
|
+
readonly lastSeenAt: z.ZodNullable<z.ZodString>;
|
|
88
|
+
}, z.core.$strip>>;
|
|
89
|
+
readonly total: z.ZodNumber;
|
|
90
|
+
readonly limit: z.ZodNumber;
|
|
91
|
+
readonly offset: z.ZodNumber;
|
|
92
|
+
}, z.core.$strip>;
|
|
93
|
+
meta: z.ZodObject<{
|
|
94
|
+
requestId: z.ZodString;
|
|
95
|
+
version: z.ZodLiteral<"1.0">;
|
|
96
|
+
}, z.core.$strict>;
|
|
97
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
98
|
+
data: z.ZodObject<{
|
|
99
|
+
readonly items: z.ZodArray<z.ZodObject<{
|
|
100
|
+
readonly id: z.ZodString;
|
|
101
|
+
readonly destinationUrl: z.ZodString;
|
|
102
|
+
readonly referringUrl: z.ZodString;
|
|
103
|
+
readonly referringDomain: z.ZodString;
|
|
104
|
+
readonly anchor: z.ZodNullable<z.ZodString>;
|
|
105
|
+
readonly destinationStatus: z.ZodNullable<z.ZodNumber>;
|
|
106
|
+
readonly domainRank: z.ZodNullable<z.ZodNumber>;
|
|
107
|
+
readonly pageRank: z.ZodNullable<z.ZodNumber>;
|
|
108
|
+
readonly dofollow: z.ZodNullable<z.ZodBoolean>;
|
|
109
|
+
readonly firstSeenAt: z.ZodNullable<z.ZodString>;
|
|
110
|
+
readonly lastSeenAt: z.ZodNullable<z.ZodString>;
|
|
111
|
+
}, z.core.$strip>>;
|
|
112
|
+
readonly total: z.ZodNumber;
|
|
113
|
+
readonly limit: z.ZodNumber;
|
|
114
|
+
readonly offset: z.ZodNumber;
|
|
115
|
+
}, z.core.$strip>;
|
|
116
|
+
meta: z.ZodObject<{
|
|
117
|
+
requestId: z.ZodString;
|
|
118
|
+
version: z.ZodLiteral<"1.0">;
|
|
119
|
+
}, z.core.$loose>;
|
|
120
|
+
}, z.core.$strip>>;
|
|
121
|
+
export type RecoverableBacklinks = z.output<typeof recoverableBacklinksDataSchema.producer>;
|
|
122
|
+
export declare const recoverableBacklinksOperation: {
|
|
123
|
+
readonly id: 'backlinks.recoverable';
|
|
124
|
+
readonly method: 'GET';
|
|
125
|
+
readonly path: '/api/v1/sites/{siteId}/backlinks/recoverable';
|
|
126
|
+
readonly visibility: 'public';
|
|
127
|
+
readonly semantics: {
|
|
128
|
+
readonly kind: 'query';
|
|
129
|
+
readonly sideEffects: 'none';
|
|
130
|
+
readonly retry: 'idempotent';
|
|
131
|
+
readonly readConsistency: 'primary';
|
|
132
|
+
};
|
|
133
|
+
readonly auth: {
|
|
134
|
+
readonly credentials: readonly ["session", "api_token"];
|
|
135
|
+
readonly scopes: readonly ["research:read"];
|
|
136
|
+
readonly minimumRole: 'viewer';
|
|
137
|
+
readonly ownership: 'site';
|
|
138
|
+
};
|
|
139
|
+
readonly request: {
|
|
140
|
+
readonly params: z.ZodObject<{
|
|
141
|
+
siteId: z.ZodString;
|
|
142
|
+
}, z.core.$strict>;
|
|
143
|
+
readonly query: z.ZodObject<{
|
|
144
|
+
limit: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
|
|
145
|
+
offset: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
|
|
146
|
+
}, z.core.$strict>;
|
|
147
|
+
readonly headers: null;
|
|
148
|
+
readonly body: null;
|
|
149
|
+
};
|
|
150
|
+
readonly responses: {
|
|
151
|
+
readonly 200: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
|
|
152
|
+
data: z.ZodObject<{
|
|
153
|
+
readonly items: z.ZodArray<z.ZodObject<{
|
|
154
|
+
readonly id: z.ZodString;
|
|
155
|
+
readonly destinationUrl: z.ZodString;
|
|
156
|
+
readonly referringUrl: z.ZodString;
|
|
157
|
+
readonly referringDomain: z.ZodString;
|
|
158
|
+
readonly anchor: z.ZodNullable<z.ZodString>;
|
|
159
|
+
readonly destinationStatus: z.ZodNullable<z.ZodNumber>;
|
|
160
|
+
readonly domainRank: z.ZodNullable<z.ZodNumber>;
|
|
161
|
+
readonly pageRank: z.ZodNullable<z.ZodNumber>;
|
|
162
|
+
readonly dofollow: z.ZodNullable<z.ZodBoolean>;
|
|
163
|
+
readonly firstSeenAt: z.ZodNullable<z.ZodString>;
|
|
164
|
+
readonly lastSeenAt: z.ZodNullable<z.ZodString>;
|
|
165
|
+
}, z.core.$strip>>;
|
|
166
|
+
readonly total: z.ZodNumber;
|
|
167
|
+
readonly limit: z.ZodNumber;
|
|
168
|
+
readonly offset: z.ZodNumber;
|
|
169
|
+
}, z.core.$strip>;
|
|
170
|
+
meta: z.ZodObject<{
|
|
171
|
+
requestId: z.ZodString;
|
|
172
|
+
version: z.ZodLiteral<"1.0">;
|
|
173
|
+
}, z.core.$strict>;
|
|
174
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
175
|
+
data: z.ZodObject<{
|
|
176
|
+
readonly items: z.ZodArray<z.ZodObject<{
|
|
177
|
+
readonly id: z.ZodString;
|
|
178
|
+
readonly destinationUrl: z.ZodString;
|
|
179
|
+
readonly referringUrl: z.ZodString;
|
|
180
|
+
readonly referringDomain: z.ZodString;
|
|
181
|
+
readonly anchor: z.ZodNullable<z.ZodString>;
|
|
182
|
+
readonly destinationStatus: z.ZodNullable<z.ZodNumber>;
|
|
183
|
+
readonly domainRank: z.ZodNullable<z.ZodNumber>;
|
|
184
|
+
readonly pageRank: z.ZodNullable<z.ZodNumber>;
|
|
185
|
+
readonly dofollow: z.ZodNullable<z.ZodBoolean>;
|
|
186
|
+
readonly firstSeenAt: z.ZodNullable<z.ZodString>;
|
|
187
|
+
readonly lastSeenAt: z.ZodNullable<z.ZodString>;
|
|
188
|
+
}, z.core.$strip>>;
|
|
189
|
+
readonly total: z.ZodNumber;
|
|
190
|
+
readonly limit: z.ZodNumber;
|
|
191
|
+
readonly offset: z.ZodNumber;
|
|
192
|
+
}, z.core.$strip>;
|
|
193
|
+
meta: z.ZodObject<{
|
|
194
|
+
requestId: z.ZodString;
|
|
195
|
+
version: z.ZodLiteral<"1.0">;
|
|
196
|
+
}, z.core.$loose>;
|
|
197
|
+
}, z.core.$strip>>;
|
|
198
|
+
};
|
|
199
|
+
readonly errors: readonly ["invalid_request", "unauthorized", "auth_expired", "forbidden", "not_found", "rate_limited", "contract_violation", "internal_error"];
|
|
200
|
+
readonly errorResponse: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
|
|
201
|
+
readonly error: z.ZodObject<{
|
|
202
|
+
code: z.ZodEnum<{
|
|
203
|
+
auth_expired: "auth_expired";
|
|
204
|
+
conflict: "conflict";
|
|
205
|
+
contract_violation: "contract_violation";
|
|
206
|
+
entitlement_required: "entitlement_required";
|
|
207
|
+
forbidden: "forbidden";
|
|
208
|
+
internal_error: "internal_error";
|
|
209
|
+
invalid_request: "invalid_request";
|
|
210
|
+
not_found: "not_found";
|
|
211
|
+
provider_unavailable: "provider_unavailable";
|
|
212
|
+
quota_exhausted: "quota_exhausted";
|
|
213
|
+
rate_limited: "rate_limited";
|
|
214
|
+
site_ambiguous: "site_ambiguous";
|
|
215
|
+
stale_evidence: "stale_evidence";
|
|
216
|
+
unauthorized: "unauthorized";
|
|
217
|
+
}>;
|
|
218
|
+
message: z.ZodString;
|
|
219
|
+
requestId: z.ZodString;
|
|
220
|
+
retryable: z.ZodBoolean;
|
|
221
|
+
details: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
222
|
+
}, z.core.$strict>;
|
|
223
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
224
|
+
readonly error: z.ZodObject<{
|
|
225
|
+
code: z.ZodEnum<{
|
|
226
|
+
auth_expired: "auth_expired";
|
|
227
|
+
conflict: "conflict";
|
|
228
|
+
contract_violation: "contract_violation";
|
|
229
|
+
entitlement_required: "entitlement_required";
|
|
230
|
+
forbidden: "forbidden";
|
|
231
|
+
internal_error: "internal_error";
|
|
232
|
+
invalid_request: "invalid_request";
|
|
233
|
+
not_found: "not_found";
|
|
234
|
+
provider_unavailable: "provider_unavailable";
|
|
235
|
+
quota_exhausted: "quota_exhausted";
|
|
236
|
+
rate_limited: "rate_limited";
|
|
237
|
+
site_ambiguous: "site_ambiguous";
|
|
238
|
+
stale_evidence: "stale_evidence";
|
|
239
|
+
unauthorized: "unauthorized";
|
|
240
|
+
}>;
|
|
241
|
+
message: z.ZodString;
|
|
242
|
+
requestId: z.ZodString;
|
|
243
|
+
retryable: z.ZodBoolean;
|
|
244
|
+
details: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
245
|
+
}, z.core.$loose>;
|
|
246
|
+
}, z.core.$strip>>;
|
|
247
|
+
readonly resources: {
|
|
248
|
+
readonly reads: readonly [{
|
|
249
|
+
readonly type: 'site.research';
|
|
250
|
+
readonly idFrom: 'params.siteId';
|
|
251
|
+
}];
|
|
252
|
+
readonly changes: readonly [];
|
|
253
|
+
};
|
|
254
|
+
readonly policy: {
|
|
255
|
+
readonly rate: {
|
|
256
|
+
readonly name: 'public-v1-fixed-window';
|
|
257
|
+
readonly limit: 50;
|
|
258
|
+
readonly windowSeconds: 60;
|
|
259
|
+
};
|
|
260
|
+
readonly idempotency: {
|
|
261
|
+
readonly _tag: 'none';
|
|
262
|
+
};
|
|
263
|
+
readonly entitlement: null;
|
|
264
|
+
readonly meter: null;
|
|
265
|
+
};
|
|
266
|
+
readonly lifecycle: {
|
|
267
|
+
readonly introduced: '1.1.0';
|
|
268
|
+
};
|
|
269
|
+
readonly docs: {
|
|
270
|
+
readonly summary: 'List recoverable Backlinks';
|
|
271
|
+
readonly description: 'Returns retained inbound links whose destination is broken, ranked by referring domain authority. Each item carries the referring URL and the destination URL, so a redirect can be written without a crawl. It never starts provider work and does not consume metered units.';
|
|
272
|
+
readonly tags: readonly ["Research"];
|
|
273
|
+
readonly examples: readonly [{
|
|
274
|
+
readonly request: {
|
|
275
|
+
readonly params: {
|
|
276
|
+
readonly siteId: 'site_01JXYZ';
|
|
277
|
+
};
|
|
278
|
+
readonly query: {
|
|
279
|
+
readonly limit: 100;
|
|
280
|
+
readonly offset: 0;
|
|
281
|
+
};
|
|
282
|
+
};
|
|
283
|
+
readonly response: {
|
|
284
|
+
readonly status: 200;
|
|
285
|
+
readonly body: {
|
|
286
|
+
readonly data: {
|
|
287
|
+
readonly items: readonly [{
|
|
288
|
+
readonly id: 'bl_01JXYZ';
|
|
289
|
+
readonly destinationUrl: 'https://example.com/docs/utils';
|
|
290
|
+
readonly referringUrl: 'https://news.example/posts/seo';
|
|
291
|
+
readonly referringDomain: 'news.example';
|
|
292
|
+
readonly anchor: 'Read the full documentation';
|
|
293
|
+
readonly destinationStatus: 404;
|
|
294
|
+
readonly domainRank: 529;
|
|
295
|
+
readonly pageRank: 55;
|
|
296
|
+
readonly dofollow: true;
|
|
297
|
+
readonly firstSeenAt: '2026-02-09T20:43:50.000Z';
|
|
298
|
+
readonly lastSeenAt: '2026-07-17T04:40:07.000Z';
|
|
299
|
+
}];
|
|
300
|
+
readonly total: 1;
|
|
301
|
+
readonly limit: 100;
|
|
302
|
+
readonly offset: 0;
|
|
303
|
+
};
|
|
304
|
+
readonly meta: {
|
|
305
|
+
readonly requestId: 'req_01JXYZ';
|
|
306
|
+
readonly version: '1.0';
|
|
307
|
+
};
|
|
308
|
+
};
|
|
309
|
+
};
|
|
310
|
+
}];
|
|
311
|
+
};
|
|
312
|
+
};
|
|
313
|
+
export declare const backlinksV1Registry: import("./core.js").PublicV1Registry<{
|
|
314
|
+
readonly recoverable: {
|
|
315
|
+
readonly id: 'backlinks.recoverable';
|
|
316
|
+
readonly method: 'GET';
|
|
317
|
+
readonly path: '/api/v1/sites/{siteId}/backlinks/recoverable';
|
|
318
|
+
readonly visibility: 'public';
|
|
319
|
+
readonly semantics: {
|
|
320
|
+
readonly kind: 'query';
|
|
321
|
+
readonly sideEffects: 'none';
|
|
322
|
+
readonly retry: 'idempotent';
|
|
323
|
+
readonly readConsistency: 'primary';
|
|
324
|
+
};
|
|
325
|
+
readonly auth: {
|
|
326
|
+
readonly credentials: readonly ["session", "api_token"];
|
|
327
|
+
readonly scopes: readonly ["research:read"];
|
|
328
|
+
readonly minimumRole: 'viewer';
|
|
329
|
+
readonly ownership: 'site';
|
|
330
|
+
};
|
|
331
|
+
readonly request: {
|
|
332
|
+
readonly params: z.ZodObject<{
|
|
333
|
+
siteId: z.ZodString;
|
|
334
|
+
}, z.core.$strict>;
|
|
335
|
+
readonly query: z.ZodObject<{
|
|
336
|
+
limit: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
|
|
337
|
+
offset: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
|
|
338
|
+
}, z.core.$strict>;
|
|
339
|
+
readonly headers: null;
|
|
340
|
+
readonly body: null;
|
|
341
|
+
};
|
|
342
|
+
readonly responses: {
|
|
343
|
+
readonly 200: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
|
|
344
|
+
data: z.ZodObject<{
|
|
345
|
+
readonly items: z.ZodArray<z.ZodObject<{
|
|
346
|
+
readonly id: z.ZodString;
|
|
347
|
+
readonly destinationUrl: z.ZodString;
|
|
348
|
+
readonly referringUrl: z.ZodString;
|
|
349
|
+
readonly referringDomain: z.ZodString;
|
|
350
|
+
readonly anchor: z.ZodNullable<z.ZodString>;
|
|
351
|
+
readonly destinationStatus: z.ZodNullable<z.ZodNumber>;
|
|
352
|
+
readonly domainRank: z.ZodNullable<z.ZodNumber>;
|
|
353
|
+
readonly pageRank: z.ZodNullable<z.ZodNumber>;
|
|
354
|
+
readonly dofollow: z.ZodNullable<z.ZodBoolean>;
|
|
355
|
+
readonly firstSeenAt: z.ZodNullable<z.ZodString>;
|
|
356
|
+
readonly lastSeenAt: z.ZodNullable<z.ZodString>;
|
|
357
|
+
}, z.core.$strip>>;
|
|
358
|
+
readonly total: z.ZodNumber;
|
|
359
|
+
readonly limit: z.ZodNumber;
|
|
360
|
+
readonly offset: z.ZodNumber;
|
|
361
|
+
}, z.core.$strip>;
|
|
362
|
+
meta: z.ZodObject<{
|
|
363
|
+
requestId: z.ZodString;
|
|
364
|
+
version: z.ZodLiteral<"1.0">;
|
|
365
|
+
}, z.core.$strict>;
|
|
366
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
367
|
+
data: z.ZodObject<{
|
|
368
|
+
readonly items: z.ZodArray<z.ZodObject<{
|
|
369
|
+
readonly id: z.ZodString;
|
|
370
|
+
readonly destinationUrl: z.ZodString;
|
|
371
|
+
readonly referringUrl: z.ZodString;
|
|
372
|
+
readonly referringDomain: z.ZodString;
|
|
373
|
+
readonly anchor: z.ZodNullable<z.ZodString>;
|
|
374
|
+
readonly destinationStatus: z.ZodNullable<z.ZodNumber>;
|
|
375
|
+
readonly domainRank: z.ZodNullable<z.ZodNumber>;
|
|
376
|
+
readonly pageRank: z.ZodNullable<z.ZodNumber>;
|
|
377
|
+
readonly dofollow: z.ZodNullable<z.ZodBoolean>;
|
|
378
|
+
readonly firstSeenAt: z.ZodNullable<z.ZodString>;
|
|
379
|
+
readonly lastSeenAt: z.ZodNullable<z.ZodString>;
|
|
380
|
+
}, z.core.$strip>>;
|
|
381
|
+
readonly total: z.ZodNumber;
|
|
382
|
+
readonly limit: z.ZodNumber;
|
|
383
|
+
readonly offset: z.ZodNumber;
|
|
384
|
+
}, z.core.$strip>;
|
|
385
|
+
meta: z.ZodObject<{
|
|
386
|
+
requestId: z.ZodString;
|
|
387
|
+
version: z.ZodLiteral<"1.0">;
|
|
388
|
+
}, z.core.$loose>;
|
|
389
|
+
}, z.core.$strip>>;
|
|
390
|
+
};
|
|
391
|
+
readonly errors: readonly ["invalid_request", "unauthorized", "auth_expired", "forbidden", "not_found", "rate_limited", "contract_violation", "internal_error"];
|
|
392
|
+
readonly errorResponse: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
|
|
393
|
+
readonly error: z.ZodObject<{
|
|
394
|
+
code: z.ZodEnum<{
|
|
395
|
+
auth_expired: "auth_expired";
|
|
396
|
+
conflict: "conflict";
|
|
397
|
+
contract_violation: "contract_violation";
|
|
398
|
+
entitlement_required: "entitlement_required";
|
|
399
|
+
forbidden: "forbidden";
|
|
400
|
+
internal_error: "internal_error";
|
|
401
|
+
invalid_request: "invalid_request";
|
|
402
|
+
not_found: "not_found";
|
|
403
|
+
provider_unavailable: "provider_unavailable";
|
|
404
|
+
quota_exhausted: "quota_exhausted";
|
|
405
|
+
rate_limited: "rate_limited";
|
|
406
|
+
site_ambiguous: "site_ambiguous";
|
|
407
|
+
stale_evidence: "stale_evidence";
|
|
408
|
+
unauthorized: "unauthorized";
|
|
409
|
+
}>;
|
|
410
|
+
message: z.ZodString;
|
|
411
|
+
requestId: z.ZodString;
|
|
412
|
+
retryable: z.ZodBoolean;
|
|
413
|
+
details: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
414
|
+
}, z.core.$strict>;
|
|
415
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
416
|
+
readonly error: z.ZodObject<{
|
|
417
|
+
code: z.ZodEnum<{
|
|
418
|
+
auth_expired: "auth_expired";
|
|
419
|
+
conflict: "conflict";
|
|
420
|
+
contract_violation: "contract_violation";
|
|
421
|
+
entitlement_required: "entitlement_required";
|
|
422
|
+
forbidden: "forbidden";
|
|
423
|
+
internal_error: "internal_error";
|
|
424
|
+
invalid_request: "invalid_request";
|
|
425
|
+
not_found: "not_found";
|
|
426
|
+
provider_unavailable: "provider_unavailable";
|
|
427
|
+
quota_exhausted: "quota_exhausted";
|
|
428
|
+
rate_limited: "rate_limited";
|
|
429
|
+
site_ambiguous: "site_ambiguous";
|
|
430
|
+
stale_evidence: "stale_evidence";
|
|
431
|
+
unauthorized: "unauthorized";
|
|
432
|
+
}>;
|
|
433
|
+
message: z.ZodString;
|
|
434
|
+
requestId: z.ZodString;
|
|
435
|
+
retryable: z.ZodBoolean;
|
|
436
|
+
details: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
437
|
+
}, z.core.$loose>;
|
|
438
|
+
}, z.core.$strip>>;
|
|
439
|
+
readonly resources: {
|
|
440
|
+
readonly reads: readonly [{
|
|
441
|
+
readonly type: 'site.research';
|
|
442
|
+
readonly idFrom: 'params.siteId';
|
|
443
|
+
}];
|
|
444
|
+
readonly changes: readonly [];
|
|
445
|
+
};
|
|
446
|
+
readonly policy: {
|
|
447
|
+
readonly rate: {
|
|
448
|
+
readonly name: 'public-v1-fixed-window';
|
|
449
|
+
readonly limit: 50;
|
|
450
|
+
readonly windowSeconds: 60;
|
|
451
|
+
};
|
|
452
|
+
readonly idempotency: {
|
|
453
|
+
readonly _tag: 'none';
|
|
454
|
+
};
|
|
455
|
+
readonly entitlement: null;
|
|
456
|
+
readonly meter: null;
|
|
457
|
+
};
|
|
458
|
+
readonly lifecycle: {
|
|
459
|
+
readonly introduced: '1.1.0';
|
|
460
|
+
};
|
|
461
|
+
readonly docs: {
|
|
462
|
+
readonly summary: 'List recoverable Backlinks';
|
|
463
|
+
readonly description: 'Returns retained inbound links whose destination is broken, ranked by referring domain authority. Each item carries the referring URL and the destination URL, so a redirect can be written without a crawl. It never starts provider work and does not consume metered units.';
|
|
464
|
+
readonly tags: readonly ["Research"];
|
|
465
|
+
readonly examples: readonly [{
|
|
466
|
+
readonly request: {
|
|
467
|
+
readonly params: {
|
|
468
|
+
readonly siteId: 'site_01JXYZ';
|
|
469
|
+
};
|
|
470
|
+
readonly query: {
|
|
471
|
+
readonly limit: 100;
|
|
472
|
+
readonly offset: 0;
|
|
473
|
+
};
|
|
474
|
+
};
|
|
475
|
+
readonly response: {
|
|
476
|
+
readonly status: 200;
|
|
477
|
+
readonly body: {
|
|
478
|
+
readonly data: {
|
|
479
|
+
readonly items: readonly [{
|
|
480
|
+
readonly id: 'bl_01JXYZ';
|
|
481
|
+
readonly destinationUrl: 'https://example.com/docs/utils';
|
|
482
|
+
readonly referringUrl: 'https://news.example/posts/seo';
|
|
483
|
+
readonly referringDomain: 'news.example';
|
|
484
|
+
readonly anchor: 'Read the full documentation';
|
|
485
|
+
readonly destinationStatus: 404;
|
|
486
|
+
readonly domainRank: 529;
|
|
487
|
+
readonly pageRank: 55;
|
|
488
|
+
readonly dofollow: true;
|
|
489
|
+
readonly firstSeenAt: '2026-02-09T20:43:50.000Z';
|
|
490
|
+
readonly lastSeenAt: '2026-07-17T04:40:07.000Z';
|
|
491
|
+
}];
|
|
492
|
+
readonly total: 1;
|
|
493
|
+
readonly limit: 100;
|
|
494
|
+
readonly offset: 0;
|
|
495
|
+
};
|
|
496
|
+
readonly meta: {
|
|
497
|
+
readonly requestId: 'req_01JXYZ';
|
|
498
|
+
readonly version: '1.0';
|
|
499
|
+
};
|
|
500
|
+
};
|
|
501
|
+
};
|
|
502
|
+
}];
|
|
503
|
+
};
|
|
504
|
+
};
|
|
505
|
+
}>;
|
|
506
|
+
export declare const mentionsQuerySchema: z.ZodObject<{
|
|
507
|
+
limit: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
|
|
508
|
+
includeFiltered: z.ZodDefault<z.ZodEnum<{
|
|
509
|
+
0: "0";
|
|
510
|
+
1: "1";
|
|
511
|
+
}>>;
|
|
512
|
+
}, z.core.$strict>;
|
|
513
|
+
export declare const mentionSchema: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
|
|
514
|
+
readonly id: z.ZodString;
|
|
515
|
+
readonly source: z.ZodString;
|
|
516
|
+
readonly url: z.ZodString;
|
|
517
|
+
readonly domain: z.ZodString;
|
|
518
|
+
readonly title: z.ZodNullable<z.ZodString>;
|
|
519
|
+
readonly snippet: z.ZodNullable<z.ZodString>;
|
|
520
|
+
readonly author: z.ZodNullable<z.ZodString>;
|
|
521
|
+
readonly authorHandle: z.ZodNullable<z.ZodString>;
|
|
522
|
+
readonly engagement: z.ZodNullable<z.ZodNumber>;
|
|
523
|
+
readonly sentiment: z.ZodNullable<z.ZodString>;
|
|
524
|
+
readonly domainRank: z.ZodNullable<z.ZodNumber>;
|
|
525
|
+
readonly publishedAt: z.ZodNullable<z.ZodString>;
|
|
526
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
527
|
+
readonly id: z.ZodString;
|
|
528
|
+
readonly source: z.ZodString;
|
|
529
|
+
readonly url: z.ZodString;
|
|
530
|
+
readonly domain: z.ZodString;
|
|
531
|
+
readonly title: z.ZodNullable<z.ZodString>;
|
|
532
|
+
readonly snippet: z.ZodNullable<z.ZodString>;
|
|
533
|
+
readonly author: z.ZodNullable<z.ZodString>;
|
|
534
|
+
readonly authorHandle: z.ZodNullable<z.ZodString>;
|
|
535
|
+
readonly engagement: z.ZodNullable<z.ZodNumber>;
|
|
536
|
+
readonly sentiment: z.ZodNullable<z.ZodString>;
|
|
537
|
+
readonly domainRank: z.ZodNullable<z.ZodNumber>;
|
|
538
|
+
readonly publishedAt: z.ZodNullable<z.ZodString>;
|
|
539
|
+
}, z.core.$strip>>;
|
|
540
|
+
export declare const mentionsDataSchema: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
|
|
541
|
+
readonly items: z.ZodArray<z.ZodObject<{
|
|
542
|
+
readonly id: z.ZodString;
|
|
543
|
+
readonly source: z.ZodString;
|
|
544
|
+
readonly url: z.ZodString;
|
|
545
|
+
readonly domain: z.ZodString;
|
|
546
|
+
readonly title: z.ZodNullable<z.ZodString>;
|
|
547
|
+
readonly snippet: z.ZodNullable<z.ZodString>;
|
|
548
|
+
readonly author: z.ZodNullable<z.ZodString>;
|
|
549
|
+
readonly authorHandle: z.ZodNullable<z.ZodString>;
|
|
550
|
+
readonly engagement: z.ZodNullable<z.ZodNumber>;
|
|
551
|
+
readonly sentiment: z.ZodNullable<z.ZodString>;
|
|
552
|
+
readonly domainRank: z.ZodNullable<z.ZodNumber>;
|
|
553
|
+
readonly publishedAt: z.ZodNullable<z.ZodString>;
|
|
554
|
+
}, z.core.$strip>>;
|
|
555
|
+
readonly limit: z.ZodNumber;
|
|
556
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
557
|
+
readonly items: z.ZodArray<z.ZodObject<{
|
|
558
|
+
readonly id: z.ZodString;
|
|
559
|
+
readonly source: z.ZodString;
|
|
560
|
+
readonly url: z.ZodString;
|
|
561
|
+
readonly domain: z.ZodString;
|
|
562
|
+
readonly title: z.ZodNullable<z.ZodString>;
|
|
563
|
+
readonly snippet: z.ZodNullable<z.ZodString>;
|
|
564
|
+
readonly author: z.ZodNullable<z.ZodString>;
|
|
565
|
+
readonly authorHandle: z.ZodNullable<z.ZodString>;
|
|
566
|
+
readonly engagement: z.ZodNullable<z.ZodNumber>;
|
|
567
|
+
readonly sentiment: z.ZodNullable<z.ZodString>;
|
|
568
|
+
readonly domainRank: z.ZodNullable<z.ZodNumber>;
|
|
569
|
+
readonly publishedAt: z.ZodNullable<z.ZodString>;
|
|
570
|
+
}, z.core.$strip>>;
|
|
571
|
+
readonly limit: z.ZodNumber;
|
|
572
|
+
}, z.core.$strip>>;
|
|
573
|
+
export declare const mentionsResponseSchema: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
|
|
574
|
+
data: z.ZodObject<{
|
|
575
|
+
readonly items: z.ZodArray<z.ZodObject<{
|
|
576
|
+
readonly id: z.ZodString;
|
|
577
|
+
readonly source: z.ZodString;
|
|
578
|
+
readonly url: z.ZodString;
|
|
579
|
+
readonly domain: z.ZodString;
|
|
580
|
+
readonly title: z.ZodNullable<z.ZodString>;
|
|
581
|
+
readonly snippet: z.ZodNullable<z.ZodString>;
|
|
582
|
+
readonly author: z.ZodNullable<z.ZodString>;
|
|
583
|
+
readonly authorHandle: z.ZodNullable<z.ZodString>;
|
|
584
|
+
readonly engagement: z.ZodNullable<z.ZodNumber>;
|
|
585
|
+
readonly sentiment: z.ZodNullable<z.ZodString>;
|
|
586
|
+
readonly domainRank: z.ZodNullable<z.ZodNumber>;
|
|
587
|
+
readonly publishedAt: z.ZodNullable<z.ZodString>;
|
|
588
|
+
}, z.core.$strip>>;
|
|
589
|
+
readonly limit: z.ZodNumber;
|
|
590
|
+
}, z.core.$strip>;
|
|
591
|
+
meta: z.ZodObject<{
|
|
592
|
+
requestId: z.ZodString;
|
|
593
|
+
version: z.ZodLiteral<"1.0">;
|
|
594
|
+
}, z.core.$strict>;
|
|
595
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
596
|
+
data: z.ZodObject<{
|
|
597
|
+
readonly items: z.ZodArray<z.ZodObject<{
|
|
598
|
+
readonly id: z.ZodString;
|
|
599
|
+
readonly source: z.ZodString;
|
|
600
|
+
readonly url: z.ZodString;
|
|
601
|
+
readonly domain: z.ZodString;
|
|
602
|
+
readonly title: z.ZodNullable<z.ZodString>;
|
|
603
|
+
readonly snippet: z.ZodNullable<z.ZodString>;
|
|
604
|
+
readonly author: z.ZodNullable<z.ZodString>;
|
|
605
|
+
readonly authorHandle: z.ZodNullable<z.ZodString>;
|
|
606
|
+
readonly engagement: z.ZodNullable<z.ZodNumber>;
|
|
607
|
+
readonly sentiment: z.ZodNullable<z.ZodString>;
|
|
608
|
+
readonly domainRank: z.ZodNullable<z.ZodNumber>;
|
|
609
|
+
readonly publishedAt: z.ZodNullable<z.ZodString>;
|
|
610
|
+
}, z.core.$strip>>;
|
|
611
|
+
readonly limit: z.ZodNumber;
|
|
612
|
+
}, z.core.$strip>;
|
|
613
|
+
meta: z.ZodObject<{
|
|
614
|
+
requestId: z.ZodString;
|
|
615
|
+
version: z.ZodLiteral<"1.0">;
|
|
616
|
+
}, z.core.$loose>;
|
|
617
|
+
}, z.core.$strip>>;
|
|
618
|
+
export type Mentions = z.output<typeof mentionsDataSchema.producer>;
|
|
619
|
+
export declare const mentionsListOperation: {
|
|
620
|
+
readonly id: 'mentions.list';
|
|
621
|
+
readonly method: 'GET';
|
|
622
|
+
readonly path: '/api/v1/sites/{siteId}/mentions';
|
|
623
|
+
readonly visibility: 'public';
|
|
624
|
+
readonly semantics: {
|
|
625
|
+
readonly kind: 'query';
|
|
626
|
+
readonly sideEffects: 'none';
|
|
627
|
+
readonly retry: 'idempotent';
|
|
628
|
+
readonly readConsistency: 'primary';
|
|
629
|
+
};
|
|
630
|
+
readonly auth: {
|
|
631
|
+
readonly credentials: readonly ["session", "api_token"];
|
|
632
|
+
readonly scopes: readonly ["research:read"];
|
|
633
|
+
readonly minimumRole: 'viewer';
|
|
634
|
+
readonly ownership: 'site';
|
|
635
|
+
};
|
|
636
|
+
readonly request: {
|
|
637
|
+
readonly params: z.ZodObject<{
|
|
638
|
+
siteId: z.ZodString;
|
|
639
|
+
}, z.core.$strict>;
|
|
640
|
+
readonly query: z.ZodObject<{
|
|
641
|
+
limit: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
|
|
642
|
+
includeFiltered: z.ZodDefault<z.ZodEnum<{
|
|
643
|
+
0: "0";
|
|
644
|
+
1: "1";
|
|
645
|
+
}>>;
|
|
646
|
+
}, z.core.$strict>;
|
|
647
|
+
readonly headers: null;
|
|
648
|
+
readonly body: null;
|
|
649
|
+
};
|
|
650
|
+
readonly responses: {
|
|
651
|
+
readonly 200: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
|
|
652
|
+
data: z.ZodObject<{
|
|
653
|
+
readonly items: z.ZodArray<z.ZodObject<{
|
|
654
|
+
readonly id: z.ZodString;
|
|
655
|
+
readonly source: z.ZodString;
|
|
656
|
+
readonly url: z.ZodString;
|
|
657
|
+
readonly domain: z.ZodString;
|
|
658
|
+
readonly title: z.ZodNullable<z.ZodString>;
|
|
659
|
+
readonly snippet: z.ZodNullable<z.ZodString>;
|
|
660
|
+
readonly author: z.ZodNullable<z.ZodString>;
|
|
661
|
+
readonly authorHandle: z.ZodNullable<z.ZodString>;
|
|
662
|
+
readonly engagement: z.ZodNullable<z.ZodNumber>;
|
|
663
|
+
readonly sentiment: z.ZodNullable<z.ZodString>;
|
|
664
|
+
readonly domainRank: z.ZodNullable<z.ZodNumber>;
|
|
665
|
+
readonly publishedAt: z.ZodNullable<z.ZodString>;
|
|
666
|
+
}, z.core.$strip>>;
|
|
667
|
+
readonly limit: z.ZodNumber;
|
|
668
|
+
}, z.core.$strip>;
|
|
669
|
+
meta: z.ZodObject<{
|
|
670
|
+
requestId: z.ZodString;
|
|
671
|
+
version: z.ZodLiteral<"1.0">;
|
|
672
|
+
}, z.core.$strict>;
|
|
673
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
674
|
+
data: z.ZodObject<{
|
|
675
|
+
readonly items: z.ZodArray<z.ZodObject<{
|
|
676
|
+
readonly id: z.ZodString;
|
|
677
|
+
readonly source: z.ZodString;
|
|
678
|
+
readonly url: z.ZodString;
|
|
679
|
+
readonly domain: z.ZodString;
|
|
680
|
+
readonly title: z.ZodNullable<z.ZodString>;
|
|
681
|
+
readonly snippet: z.ZodNullable<z.ZodString>;
|
|
682
|
+
readonly author: z.ZodNullable<z.ZodString>;
|
|
683
|
+
readonly authorHandle: z.ZodNullable<z.ZodString>;
|
|
684
|
+
readonly engagement: z.ZodNullable<z.ZodNumber>;
|
|
685
|
+
readonly sentiment: z.ZodNullable<z.ZodString>;
|
|
686
|
+
readonly domainRank: z.ZodNullable<z.ZodNumber>;
|
|
687
|
+
readonly publishedAt: z.ZodNullable<z.ZodString>;
|
|
688
|
+
}, z.core.$strip>>;
|
|
689
|
+
readonly limit: z.ZodNumber;
|
|
690
|
+
}, z.core.$strip>;
|
|
691
|
+
meta: z.ZodObject<{
|
|
692
|
+
requestId: z.ZodString;
|
|
693
|
+
version: z.ZodLiteral<"1.0">;
|
|
694
|
+
}, z.core.$loose>;
|
|
695
|
+
}, z.core.$strip>>;
|
|
696
|
+
};
|
|
697
|
+
readonly errors: readonly ["invalid_request", "unauthorized", "auth_expired", "forbidden", "not_found", "rate_limited", "contract_violation", "internal_error"];
|
|
698
|
+
readonly errorResponse: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
|
|
699
|
+
readonly error: z.ZodObject<{
|
|
700
|
+
code: z.ZodEnum<{
|
|
701
|
+
auth_expired: "auth_expired";
|
|
702
|
+
conflict: "conflict";
|
|
703
|
+
contract_violation: "contract_violation";
|
|
704
|
+
entitlement_required: "entitlement_required";
|
|
705
|
+
forbidden: "forbidden";
|
|
706
|
+
internal_error: "internal_error";
|
|
707
|
+
invalid_request: "invalid_request";
|
|
708
|
+
not_found: "not_found";
|
|
709
|
+
provider_unavailable: "provider_unavailable";
|
|
710
|
+
quota_exhausted: "quota_exhausted";
|
|
711
|
+
rate_limited: "rate_limited";
|
|
712
|
+
site_ambiguous: "site_ambiguous";
|
|
713
|
+
stale_evidence: "stale_evidence";
|
|
714
|
+
unauthorized: "unauthorized";
|
|
715
|
+
}>;
|
|
716
|
+
message: z.ZodString;
|
|
717
|
+
requestId: z.ZodString;
|
|
718
|
+
retryable: z.ZodBoolean;
|
|
719
|
+
details: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
720
|
+
}, z.core.$strict>;
|
|
721
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
722
|
+
readonly error: z.ZodObject<{
|
|
723
|
+
code: z.ZodEnum<{
|
|
724
|
+
auth_expired: "auth_expired";
|
|
725
|
+
conflict: "conflict";
|
|
726
|
+
contract_violation: "contract_violation";
|
|
727
|
+
entitlement_required: "entitlement_required";
|
|
728
|
+
forbidden: "forbidden";
|
|
729
|
+
internal_error: "internal_error";
|
|
730
|
+
invalid_request: "invalid_request";
|
|
731
|
+
not_found: "not_found";
|
|
732
|
+
provider_unavailable: "provider_unavailable";
|
|
733
|
+
quota_exhausted: "quota_exhausted";
|
|
734
|
+
rate_limited: "rate_limited";
|
|
735
|
+
site_ambiguous: "site_ambiguous";
|
|
736
|
+
stale_evidence: "stale_evidence";
|
|
737
|
+
unauthorized: "unauthorized";
|
|
738
|
+
}>;
|
|
739
|
+
message: z.ZodString;
|
|
740
|
+
requestId: z.ZodString;
|
|
741
|
+
retryable: z.ZodBoolean;
|
|
742
|
+
details: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
743
|
+
}, z.core.$loose>;
|
|
744
|
+
}, z.core.$strip>>;
|
|
745
|
+
readonly resources: {
|
|
746
|
+
readonly reads: readonly [{
|
|
747
|
+
readonly type: 'site.research';
|
|
748
|
+
readonly idFrom: 'params.siteId';
|
|
749
|
+
}];
|
|
750
|
+
readonly changes: readonly [];
|
|
751
|
+
};
|
|
752
|
+
readonly policy: {
|
|
753
|
+
readonly rate: {
|
|
754
|
+
readonly name: 'public-v1-fixed-window';
|
|
755
|
+
readonly limit: 50;
|
|
756
|
+
readonly windowSeconds: 60;
|
|
757
|
+
};
|
|
758
|
+
readonly idempotency: {
|
|
759
|
+
readonly _tag: 'none';
|
|
760
|
+
};
|
|
761
|
+
readonly entitlement: null;
|
|
762
|
+
readonly meter: null;
|
|
763
|
+
};
|
|
764
|
+
readonly lifecycle: {
|
|
765
|
+
readonly introduced: '1.1.0';
|
|
766
|
+
};
|
|
767
|
+
readonly docs: {
|
|
768
|
+
readonly summary: 'List Mentions';
|
|
769
|
+
readonly description: 'Returns retained pages and posts that name the Site without linking to it, newest first. Dismissed and lost Mentions are excluded. Pass includeFiltered=1 to keep the ones AI triage marked a false positive. It never starts provider work and does not consume metered units.';
|
|
770
|
+
readonly tags: readonly ["Research"];
|
|
771
|
+
readonly examples: readonly [{
|
|
772
|
+
readonly request: {
|
|
773
|
+
readonly params: {
|
|
774
|
+
readonly siteId: 'site_01JXYZ';
|
|
775
|
+
};
|
|
776
|
+
readonly query: {
|
|
777
|
+
readonly limit: 100;
|
|
778
|
+
readonly includeFiltered: '0';
|
|
779
|
+
};
|
|
780
|
+
};
|
|
781
|
+
readonly response: {
|
|
782
|
+
readonly status: 200;
|
|
783
|
+
readonly body: {
|
|
784
|
+
readonly data: {
|
|
785
|
+
readonly items: readonly [{
|
|
786
|
+
readonly id: 'mn_01JXYZ';
|
|
787
|
+
readonly source: 'hackernews';
|
|
788
|
+
readonly url: 'https://news.ycombinator.com/item?id=1';
|
|
789
|
+
readonly domain: 'news.ycombinator.com';
|
|
790
|
+
readonly title: 'Show HN: a sitemap module';
|
|
791
|
+
readonly snippet: 'We moved to example.com last week';
|
|
792
|
+
readonly author: 'Ada Lovelace';
|
|
793
|
+
readonly authorHandle: 'ada';
|
|
794
|
+
readonly engagement: 142;
|
|
795
|
+
readonly sentiment: 'positive';
|
|
796
|
+
readonly domainRank: 812;
|
|
797
|
+
readonly publishedAt: '2026-08-01T09:12:00.000Z';
|
|
798
|
+
}];
|
|
799
|
+
readonly limit: 100;
|
|
800
|
+
};
|
|
801
|
+
readonly meta: {
|
|
802
|
+
readonly requestId: 'req_01JXYZ';
|
|
803
|
+
readonly version: '1.0';
|
|
804
|
+
};
|
|
805
|
+
};
|
|
806
|
+
};
|
|
807
|
+
}];
|
|
808
|
+
};
|
|
809
|
+
};
|
|
810
|
+
export declare const mentionsV1Registry: import("./core.js").PublicV1Registry<{
|
|
811
|
+
readonly list: {
|
|
812
|
+
readonly id: 'mentions.list';
|
|
813
|
+
readonly method: 'GET';
|
|
814
|
+
readonly path: '/api/v1/sites/{siteId}/mentions';
|
|
815
|
+
readonly visibility: 'public';
|
|
816
|
+
readonly semantics: {
|
|
817
|
+
readonly kind: 'query';
|
|
818
|
+
readonly sideEffects: 'none';
|
|
819
|
+
readonly retry: 'idempotent';
|
|
820
|
+
readonly readConsistency: 'primary';
|
|
821
|
+
};
|
|
822
|
+
readonly auth: {
|
|
823
|
+
readonly credentials: readonly ["session", "api_token"];
|
|
824
|
+
readonly scopes: readonly ["research:read"];
|
|
825
|
+
readonly minimumRole: 'viewer';
|
|
826
|
+
readonly ownership: 'site';
|
|
827
|
+
};
|
|
828
|
+
readonly request: {
|
|
829
|
+
readonly params: z.ZodObject<{
|
|
830
|
+
siteId: z.ZodString;
|
|
831
|
+
}, z.core.$strict>;
|
|
832
|
+
readonly query: z.ZodObject<{
|
|
833
|
+
limit: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
|
|
834
|
+
includeFiltered: z.ZodDefault<z.ZodEnum<{
|
|
835
|
+
0: "0";
|
|
836
|
+
1: "1";
|
|
837
|
+
}>>;
|
|
838
|
+
}, z.core.$strict>;
|
|
839
|
+
readonly headers: null;
|
|
840
|
+
readonly body: null;
|
|
841
|
+
};
|
|
842
|
+
readonly responses: {
|
|
843
|
+
readonly 200: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
|
|
844
|
+
data: z.ZodObject<{
|
|
845
|
+
readonly items: z.ZodArray<z.ZodObject<{
|
|
846
|
+
readonly id: z.ZodString;
|
|
847
|
+
readonly source: z.ZodString;
|
|
848
|
+
readonly url: z.ZodString;
|
|
849
|
+
readonly domain: z.ZodString;
|
|
850
|
+
readonly title: z.ZodNullable<z.ZodString>;
|
|
851
|
+
readonly snippet: z.ZodNullable<z.ZodString>;
|
|
852
|
+
readonly author: z.ZodNullable<z.ZodString>;
|
|
853
|
+
readonly authorHandle: z.ZodNullable<z.ZodString>;
|
|
854
|
+
readonly engagement: z.ZodNullable<z.ZodNumber>;
|
|
855
|
+
readonly sentiment: z.ZodNullable<z.ZodString>;
|
|
856
|
+
readonly domainRank: z.ZodNullable<z.ZodNumber>;
|
|
857
|
+
readonly publishedAt: z.ZodNullable<z.ZodString>;
|
|
858
|
+
}, z.core.$strip>>;
|
|
859
|
+
readonly limit: z.ZodNumber;
|
|
860
|
+
}, z.core.$strip>;
|
|
861
|
+
meta: z.ZodObject<{
|
|
862
|
+
requestId: z.ZodString;
|
|
863
|
+
version: z.ZodLiteral<"1.0">;
|
|
864
|
+
}, z.core.$strict>;
|
|
865
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
866
|
+
data: z.ZodObject<{
|
|
867
|
+
readonly items: z.ZodArray<z.ZodObject<{
|
|
868
|
+
readonly id: z.ZodString;
|
|
869
|
+
readonly source: z.ZodString;
|
|
870
|
+
readonly url: z.ZodString;
|
|
871
|
+
readonly domain: z.ZodString;
|
|
872
|
+
readonly title: z.ZodNullable<z.ZodString>;
|
|
873
|
+
readonly snippet: z.ZodNullable<z.ZodString>;
|
|
874
|
+
readonly author: z.ZodNullable<z.ZodString>;
|
|
875
|
+
readonly authorHandle: z.ZodNullable<z.ZodString>;
|
|
876
|
+
readonly engagement: z.ZodNullable<z.ZodNumber>;
|
|
877
|
+
readonly sentiment: z.ZodNullable<z.ZodString>;
|
|
878
|
+
readonly domainRank: z.ZodNullable<z.ZodNumber>;
|
|
879
|
+
readonly publishedAt: z.ZodNullable<z.ZodString>;
|
|
880
|
+
}, z.core.$strip>>;
|
|
881
|
+
readonly limit: z.ZodNumber;
|
|
882
|
+
}, z.core.$strip>;
|
|
883
|
+
meta: z.ZodObject<{
|
|
884
|
+
requestId: z.ZodString;
|
|
885
|
+
version: z.ZodLiteral<"1.0">;
|
|
886
|
+
}, z.core.$loose>;
|
|
887
|
+
}, z.core.$strip>>;
|
|
888
|
+
};
|
|
889
|
+
readonly errors: readonly ["invalid_request", "unauthorized", "auth_expired", "forbidden", "not_found", "rate_limited", "contract_violation", "internal_error"];
|
|
890
|
+
readonly errorResponse: import("./core.js").CompatibleResponseSchema<z.ZodObject<{
|
|
891
|
+
readonly error: z.ZodObject<{
|
|
892
|
+
code: z.ZodEnum<{
|
|
893
|
+
auth_expired: "auth_expired";
|
|
894
|
+
conflict: "conflict";
|
|
895
|
+
contract_violation: "contract_violation";
|
|
896
|
+
entitlement_required: "entitlement_required";
|
|
897
|
+
forbidden: "forbidden";
|
|
898
|
+
internal_error: "internal_error";
|
|
899
|
+
invalid_request: "invalid_request";
|
|
900
|
+
not_found: "not_found";
|
|
901
|
+
provider_unavailable: "provider_unavailable";
|
|
902
|
+
quota_exhausted: "quota_exhausted";
|
|
903
|
+
rate_limited: "rate_limited";
|
|
904
|
+
site_ambiguous: "site_ambiguous";
|
|
905
|
+
stale_evidence: "stale_evidence";
|
|
906
|
+
unauthorized: "unauthorized";
|
|
907
|
+
}>;
|
|
908
|
+
message: z.ZodString;
|
|
909
|
+
requestId: z.ZodString;
|
|
910
|
+
retryable: z.ZodBoolean;
|
|
911
|
+
details: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
912
|
+
}, z.core.$strict>;
|
|
913
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
914
|
+
readonly error: z.ZodObject<{
|
|
915
|
+
code: z.ZodEnum<{
|
|
916
|
+
auth_expired: "auth_expired";
|
|
917
|
+
conflict: "conflict";
|
|
918
|
+
contract_violation: "contract_violation";
|
|
919
|
+
entitlement_required: "entitlement_required";
|
|
920
|
+
forbidden: "forbidden";
|
|
921
|
+
internal_error: "internal_error";
|
|
922
|
+
invalid_request: "invalid_request";
|
|
923
|
+
not_found: "not_found";
|
|
924
|
+
provider_unavailable: "provider_unavailable";
|
|
925
|
+
quota_exhausted: "quota_exhausted";
|
|
926
|
+
rate_limited: "rate_limited";
|
|
927
|
+
site_ambiguous: "site_ambiguous";
|
|
928
|
+
stale_evidence: "stale_evidence";
|
|
929
|
+
unauthorized: "unauthorized";
|
|
930
|
+
}>;
|
|
931
|
+
message: z.ZodString;
|
|
932
|
+
requestId: z.ZodString;
|
|
933
|
+
retryable: z.ZodBoolean;
|
|
934
|
+
details: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
935
|
+
}, z.core.$loose>;
|
|
936
|
+
}, z.core.$strip>>;
|
|
937
|
+
readonly resources: {
|
|
938
|
+
readonly reads: readonly [{
|
|
939
|
+
readonly type: 'site.research';
|
|
940
|
+
readonly idFrom: 'params.siteId';
|
|
941
|
+
}];
|
|
942
|
+
readonly changes: readonly [];
|
|
943
|
+
};
|
|
944
|
+
readonly policy: {
|
|
945
|
+
readonly rate: {
|
|
946
|
+
readonly name: 'public-v1-fixed-window';
|
|
947
|
+
readonly limit: 50;
|
|
948
|
+
readonly windowSeconds: 60;
|
|
949
|
+
};
|
|
950
|
+
readonly idempotency: {
|
|
951
|
+
readonly _tag: 'none';
|
|
952
|
+
};
|
|
953
|
+
readonly entitlement: null;
|
|
954
|
+
readonly meter: null;
|
|
955
|
+
};
|
|
956
|
+
readonly lifecycle: {
|
|
957
|
+
readonly introduced: '1.1.0';
|
|
958
|
+
};
|
|
959
|
+
readonly docs: {
|
|
960
|
+
readonly summary: 'List Mentions';
|
|
961
|
+
readonly description: 'Returns retained pages and posts that name the Site without linking to it, newest first. Dismissed and lost Mentions are excluded. Pass includeFiltered=1 to keep the ones AI triage marked a false positive. It never starts provider work and does not consume metered units.';
|
|
962
|
+
readonly tags: readonly ["Research"];
|
|
963
|
+
readonly examples: readonly [{
|
|
964
|
+
readonly request: {
|
|
965
|
+
readonly params: {
|
|
966
|
+
readonly siteId: 'site_01JXYZ';
|
|
967
|
+
};
|
|
968
|
+
readonly query: {
|
|
969
|
+
readonly limit: 100;
|
|
970
|
+
readonly includeFiltered: '0';
|
|
971
|
+
};
|
|
972
|
+
};
|
|
973
|
+
readonly response: {
|
|
974
|
+
readonly status: 200;
|
|
975
|
+
readonly body: {
|
|
976
|
+
readonly data: {
|
|
977
|
+
readonly items: readonly [{
|
|
978
|
+
readonly id: 'mn_01JXYZ';
|
|
979
|
+
readonly source: 'hackernews';
|
|
980
|
+
readonly url: 'https://news.ycombinator.com/item?id=1';
|
|
981
|
+
readonly domain: 'news.ycombinator.com';
|
|
982
|
+
readonly title: 'Show HN: a sitemap module';
|
|
983
|
+
readonly snippet: 'We moved to example.com last week';
|
|
984
|
+
readonly author: 'Ada Lovelace';
|
|
985
|
+
readonly authorHandle: 'ada';
|
|
986
|
+
readonly engagement: 142;
|
|
987
|
+
readonly sentiment: 'positive';
|
|
988
|
+
readonly domainRank: 812;
|
|
989
|
+
readonly publishedAt: '2026-08-01T09:12:00.000Z';
|
|
990
|
+
}];
|
|
991
|
+
readonly limit: 100;
|
|
992
|
+
};
|
|
993
|
+
readonly meta: {
|
|
994
|
+
readonly requestId: 'req_01JXYZ';
|
|
995
|
+
readonly version: '1.0';
|
|
996
|
+
};
|
|
997
|
+
};
|
|
998
|
+
};
|
|
999
|
+
}];
|
|
1000
|
+
};
|
|
1001
|
+
};
|
|
1002
|
+
}>;
|