misarseo 1.0.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.
Files changed (49) hide show
  1. checksums.yaml +7 -0
  2. data/CHANGELOG.md +25 -0
  3. data/LICENSE +21 -0
  4. data/README.md +257 -0
  5. data/lib/misarseo/client.rb +29 -0
  6. data/lib/misarseo/errors.rb +100 -0
  7. data/lib/misarseo/generated/account.rb +30 -0
  8. data/lib/misarseo/generated/activity.rb +22 -0
  9. data/lib/misarseo/generated/ahrefs.rb +35 -0
  10. data/lib/misarseo/generated/ai_search.rb +87 -0
  11. data/lib/misarseo/generated/backlinks.rb +34 -0
  12. data/lib/misarseo/generated/baidu.rb +35 -0
  13. data/lib/misarseo/generated/bing.rb +95 -0
  14. data/lib/misarseo/generated/brave_search.rb +20 -0
  15. data/lib/misarseo/generated/competitor_monitor.rb +37 -0
  16. data/lib/misarseo/generated/competitors.rb +20 -0
  17. data/lib/misarseo/generated/content.rb +25 -0
  18. data/lib/misarseo/generated/crawl.rb +140 -0
  19. data/lib/misarseo/generated/dashboard.rb +20 -0
  20. data/lib/misarseo/generated/direct_vendor_ai.rb +20 -0
  21. data/lib/misarseo/generated/disavow.rb +35 -0
  22. data/lib/misarseo/generated/domain.rb +37 -0
  23. data/lib/misarseo/generated/ga4.rb +50 -0
  24. data/lib/misarseo/generated/google_business_profile.rb +77 -0
  25. data/lib/misarseo/generated/gsc.rb +70 -0
  26. data/lib/misarseo/generated/index_now.rb +20 -0
  27. data/lib/misarseo/generated/keywords.rb +71 -0
  28. data/lib/misarseo/generated/link_building.rb +60 -0
  29. data/lib/misarseo/generated/local.rb +30 -0
  30. data/lib/misarseo/generated/local_pack_rank.rb +40 -0
  31. data/lib/misarseo/generated/local_rank_grid.rb +40 -0
  32. data/lib/misarseo/generated/log_analyzer.rb +42 -0
  33. data/lib/misarseo/generated/mentions.rb +25 -0
  34. data/lib/misarseo/generated/patches.rb +55 -0
  35. data/lib/misarseo/generated/portfolios.rb +50 -0
  36. data/lib/misarseo/generated/projects.rb +40 -0
  37. data/lib/misarseo/generated/rank_tracking.rb +144 -0
  38. data/lib/misarseo/generated/report_builder.rb +67 -0
  39. data/lib/misarseo/generated/resources.rb +85 -0
  40. data/lib/misarseo/generated/team.rb +20 -0
  41. data/lib/misarseo/generated/usage.rb +20 -0
  42. data/lib/misarseo/generated/web_analytics.rb +35 -0
  43. data/lib/misarseo/generated/yandex.rb +45 -0
  44. data/lib/misarseo/pagination.rb +38 -0
  45. data/lib/misarseo/transport.rb +192 -0
  46. data/lib/misarseo/version.rb +5 -0
  47. data/lib/misarseo.rb +13 -0
  48. data/manifest.json +2850 -0
  49. metadata +114 -0
data/manifest.json ADDED
@@ -0,0 +1,2850 @@
1
+ {
2
+ "$comment": "GENERATED by scripts/sync-sdk-manifest.mjs from src/server/openapi/registry.ts — do not hand-edit. Single source of truth for all MisarSEO SDKs: scripts/generate-sdks.mjs emits each language's resource layer from it and scripts/check-sdk-coverage.mjs fails CI when a language drifts. To change the surface, change the route and its registry entry, then run `pnpm sdk:sync`.",
3
+ "version": "1.1.0",
4
+ "baseUrl": "https://api.misar.io/seo",
5
+ "auth": {
6
+ "scheme": "bearer",
7
+ "header": "Authorization",
8
+ "keyPrefix": "mseo_",
9
+ "planGatedServerSide": true,
10
+ "planDeniedStatuses": [
11
+ 401,
12
+ 402,
13
+ 403,
14
+ 429
15
+ ]
16
+ },
17
+ "resources": {
18
+ "account": {
19
+ "methods": [
20
+ {
21
+ "name": "delete",
22
+ "verb": "DELETE",
23
+ "path": "/account/delete",
24
+ "pathParams": [],
25
+ "requiredQuery": [],
26
+ "queryParams": [],
27
+ "hasBody": true,
28
+ "auth": "api_key"
29
+ },
30
+ {
31
+ "name": "deleteViaPost",
32
+ "verb": "POST",
33
+ "path": "/account/delete",
34
+ "pathParams": [],
35
+ "requiredQuery": [],
36
+ "queryParams": [],
37
+ "hasBody": true,
38
+ "auth": "api_key"
39
+ },
40
+ {
41
+ "name": "export",
42
+ "verb": "GET",
43
+ "path": "/account/export",
44
+ "pathParams": [],
45
+ "requiredQuery": [],
46
+ "queryParams": [],
47
+ "hasBody": false,
48
+ "auth": "api_key"
49
+ }
50
+ ]
51
+ },
52
+ "activity": {
53
+ "methods": [
54
+ {
55
+ "name": "list",
56
+ "verb": "GET",
57
+ "path": "/activity",
58
+ "pathParams": [],
59
+ "requiredQuery": [],
60
+ "queryParams": [
61
+ "before",
62
+ "pageSize",
63
+ "projectId"
64
+ ],
65
+ "hasBody": false,
66
+ "auth": "api_key"
67
+ }
68
+ ]
69
+ },
70
+ "ahrefs": {
71
+ "methods": [
72
+ {
73
+ "name": "connect",
74
+ "verb": "GET",
75
+ "path": "/ahrefs/connection",
76
+ "pathParams": [],
77
+ "requiredQuery": [
78
+ "projectId"
79
+ ],
80
+ "queryParams": [
81
+ "projectId"
82
+ ],
83
+ "hasBody": false,
84
+ "auth": "api_key"
85
+ },
86
+ {
87
+ "name": "disconnect",
88
+ "verb": "DELETE",
89
+ "path": "/ahrefs/connection",
90
+ "pathParams": [],
91
+ "requiredQuery": [],
92
+ "queryParams": [],
93
+ "hasBody": true,
94
+ "auth": "api_key"
95
+ },
96
+ {
97
+ "name": "listProjects",
98
+ "verb": "GET",
99
+ "path": "/ahrefs/projects",
100
+ "pathParams": [],
101
+ "requiredQuery": [
102
+ "projectId"
103
+ ],
104
+ "queryParams": [
105
+ "projectId"
106
+ ],
107
+ "hasBody": false,
108
+ "auth": "api_key"
109
+ },
110
+ {
111
+ "name": "setProject",
112
+ "verb": "POST",
113
+ "path": "/ahrefs/connection",
114
+ "pathParams": [],
115
+ "requiredQuery": [],
116
+ "queryParams": [],
117
+ "hasBody": true,
118
+ "auth": "api_key"
119
+ }
120
+ ]
121
+ },
122
+ "aiSearch": {
123
+ "methods": [
124
+ {
125
+ "name": "brandLookup",
126
+ "verb": "POST",
127
+ "path": "/ai/brand-lookup",
128
+ "pathParams": [],
129
+ "requiredQuery": [],
130
+ "queryParams": [],
131
+ "hasBody": true,
132
+ "auth": "api_key"
133
+ },
134
+ {
135
+ "name": "brandLookupStatus",
136
+ "verb": "GET",
137
+ "path": "/ai/brand-lookup/:jobId/status",
138
+ "pathParams": [
139
+ "jobId"
140
+ ],
141
+ "requiredQuery": [
142
+ "projectId"
143
+ ],
144
+ "queryParams": [
145
+ "projectId"
146
+ ],
147
+ "hasBody": false,
148
+ "auth": "api_key"
149
+ },
150
+ {
151
+ "name": "brandScanTrend",
152
+ "verb": "GET",
153
+ "path": "/ai/brand-scan-trend",
154
+ "pathParams": [],
155
+ "requiredQuery": [
156
+ "projectId",
157
+ "target"
158
+ ],
159
+ "queryParams": [
160
+ "projectId",
161
+ "since",
162
+ "target"
163
+ ],
164
+ "hasBody": false,
165
+ "auth": "api_key"
166
+ },
167
+ {
168
+ "name": "citations",
169
+ "verb": "POST",
170
+ "path": "/citations",
171
+ "pathParams": [],
172
+ "requiredQuery": [],
173
+ "queryParams": [],
174
+ "hasBody": true,
175
+ "auth": "api_key"
176
+ },
177
+ {
178
+ "name": "competitorPositioning",
179
+ "verb": "POST",
180
+ "path": "/ai/competitor-positioning",
181
+ "pathParams": [],
182
+ "requiredQuery": [],
183
+ "queryParams": [],
184
+ "hasBody": true,
185
+ "auth": "api_key"
186
+ },
187
+ {
188
+ "name": "deleteBrandMonitor",
189
+ "verb": "DELETE",
190
+ "path": "/ai/brand-monitors/:monitorId",
191
+ "pathParams": [
192
+ "monitorId"
193
+ ],
194
+ "requiredQuery": [
195
+ "projectId"
196
+ ],
197
+ "queryParams": [
198
+ "projectId"
199
+ ],
200
+ "hasBody": false,
201
+ "auth": "api_key"
202
+ },
203
+ {
204
+ "name": "deleteTrackedPrompt",
205
+ "verb": "DELETE",
206
+ "path": "/ai/prompt-tracking/:trackedPromptId",
207
+ "pathParams": [
208
+ "trackedPromptId"
209
+ ],
210
+ "requiredQuery": [
211
+ "projectId"
212
+ ],
213
+ "queryParams": [
214
+ "projectId"
215
+ ],
216
+ "hasBody": false,
217
+ "auth": "api_key"
218
+ },
219
+ {
220
+ "name": "listBrandMonitors",
221
+ "verb": "GET",
222
+ "path": "/ai/brand-monitors",
223
+ "pathParams": [],
224
+ "requiredQuery": [
225
+ "projectId"
226
+ ],
227
+ "queryParams": [
228
+ "projectId"
229
+ ],
230
+ "hasBody": false,
231
+ "auth": "api_key"
232
+ },
233
+ {
234
+ "name": "listTrackedPrompts",
235
+ "verb": "GET",
236
+ "path": "/ai/prompt-tracking",
237
+ "pathParams": [],
238
+ "requiredQuery": [
239
+ "projectId"
240
+ ],
241
+ "queryParams": [
242
+ "projectId"
243
+ ],
244
+ "hasBody": false,
245
+ "auth": "api_key"
246
+ },
247
+ {
248
+ "name": "promptExplorer",
249
+ "verb": "POST",
250
+ "path": "/ai/prompt-explorer",
251
+ "pathParams": [],
252
+ "requiredQuery": [],
253
+ "queryParams": [],
254
+ "hasBody": true,
255
+ "auth": "api_key"
256
+ },
257
+ {
258
+ "name": "promptResearch",
259
+ "verb": "POST",
260
+ "path": "/ai/prompt-research",
261
+ "pathParams": [],
262
+ "requiredQuery": [],
263
+ "queryParams": [],
264
+ "hasBody": true,
265
+ "auth": "api_key"
266
+ },
267
+ {
268
+ "name": "trackedPromptTrend",
269
+ "verb": "GET",
270
+ "path": "/ai/prompt-tracking/:trackedPromptId/trend",
271
+ "pathParams": [
272
+ "trackedPromptId"
273
+ ],
274
+ "requiredQuery": [
275
+ "projectId"
276
+ ],
277
+ "queryParams": [
278
+ "projectId"
279
+ ],
280
+ "hasBody": false,
281
+ "auth": "api_key"
282
+ },
283
+ {
284
+ "name": "upsertBrandMonitor",
285
+ "verb": "POST",
286
+ "path": "/ai/brand-monitors",
287
+ "pathParams": [],
288
+ "requiredQuery": [],
289
+ "queryParams": [],
290
+ "hasBody": true,
291
+ "auth": "api_key"
292
+ },
293
+ {
294
+ "name": "upsertTrackedPrompt",
295
+ "verb": "POST",
296
+ "path": "/ai/prompt-tracking",
297
+ "pathParams": [],
298
+ "requiredQuery": [],
299
+ "queryParams": [],
300
+ "hasBody": true,
301
+ "auth": "api_key"
302
+ }
303
+ ]
304
+ },
305
+ "backlinks": {
306
+ "methods": [
307
+ {
308
+ "name": "anchors",
309
+ "verb": "GET",
310
+ "path": "/backlinks/anchors",
311
+ "pathParams": [],
312
+ "requiredQuery": [
313
+ "projectId",
314
+ "target"
315
+ ],
316
+ "queryParams": [
317
+ "page",
318
+ "pageSize",
319
+ "projectId",
320
+ "scope",
321
+ "sortField",
322
+ "sortOrder",
323
+ "target"
324
+ ],
325
+ "hasBody": false,
326
+ "auth": "api_key"
327
+ },
328
+ {
329
+ "name": "intersect",
330
+ "verb": "POST",
331
+ "path": "/backlinks/intersect",
332
+ "pathParams": [],
333
+ "requiredQuery": [],
334
+ "queryParams": [],
335
+ "hasBody": true,
336
+ "auth": "api_key"
337
+ },
338
+ {
339
+ "name": "overview",
340
+ "verb": "GET",
341
+ "path": "/backlinks",
342
+ "pathParams": [],
343
+ "requiredQuery": [
344
+ "projectId",
345
+ "target"
346
+ ],
347
+ "queryParams": [
348
+ "projectId",
349
+ "scope",
350
+ "target"
351
+ ],
352
+ "hasBody": false,
353
+ "auth": "api_key"
354
+ }
355
+ ]
356
+ },
357
+ "baidu": {
358
+ "methods": [
359
+ {
360
+ "name": "connection",
361
+ "verb": "GET",
362
+ "path": "/baidu/connection",
363
+ "pathParams": [],
364
+ "requiredQuery": [
365
+ "projectId"
366
+ ],
367
+ "queryParams": [
368
+ "projectId"
369
+ ],
370
+ "hasBody": false,
371
+ "auth": "api_key"
372
+ },
373
+ {
374
+ "name": "disconnect",
375
+ "verb": "DELETE",
376
+ "path": "/baidu/connection",
377
+ "pathParams": [],
378
+ "requiredQuery": [],
379
+ "queryParams": [],
380
+ "hasBody": true,
381
+ "auth": "api_key"
382
+ },
383
+ {
384
+ "name": "setConnection",
385
+ "verb": "POST",
386
+ "path": "/baidu/connection",
387
+ "pathParams": [],
388
+ "requiredQuery": [],
389
+ "queryParams": [],
390
+ "hasBody": true,
391
+ "auth": "api_key"
392
+ },
393
+ {
394
+ "name": "submitUrls",
395
+ "verb": "POST",
396
+ "path": "/baidu/submit",
397
+ "pathParams": [],
398
+ "requiredQuery": [],
399
+ "queryParams": [],
400
+ "hasBody": true,
401
+ "auth": "api_key"
402
+ }
403
+ ]
404
+ },
405
+ "bing": {
406
+ "methods": [
407
+ {
408
+ "name": "backlinks",
409
+ "verb": "POST",
410
+ "path": "/bing/backlinks",
411
+ "pathParams": [],
412
+ "requiredQuery": [],
413
+ "queryParams": [],
414
+ "hasBody": true,
415
+ "auth": "api_key"
416
+ },
417
+ {
418
+ "name": "connect",
419
+ "verb": "GET",
420
+ "path": "/bing/connection",
421
+ "pathParams": [],
422
+ "requiredQuery": [
423
+ "projectId"
424
+ ],
425
+ "queryParams": [
426
+ "projectId"
427
+ ],
428
+ "hasBody": false,
429
+ "auth": "api_key"
430
+ },
431
+ {
432
+ "name": "detailStats",
433
+ "verb": "POST",
434
+ "path": "/bing/detail-stats",
435
+ "pathParams": [],
436
+ "requiredQuery": [],
437
+ "queryParams": [],
438
+ "hasBody": true,
439
+ "auth": "api_key"
440
+ },
441
+ {
442
+ "name": "disconnect",
443
+ "verb": "DELETE",
444
+ "path": "/bing/connection",
445
+ "pathParams": [],
446
+ "requiredQuery": [],
447
+ "queryParams": [],
448
+ "hasBody": true,
449
+ "auth": "api_key"
450
+ },
451
+ {
452
+ "name": "getFeedDetails",
453
+ "verb": "POST",
454
+ "path": "/bing/feed-details",
455
+ "pathParams": [],
456
+ "requiredQuery": [],
457
+ "queryParams": [],
458
+ "hasBody": true,
459
+ "auth": "api_key"
460
+ },
461
+ {
462
+ "name": "keywordResearch",
463
+ "verb": "POST",
464
+ "path": "/bing/keyword-research",
465
+ "pathParams": [],
466
+ "requiredQuery": [],
467
+ "queryParams": [],
468
+ "hasBody": true,
469
+ "auth": "api_key"
470
+ },
471
+ {
472
+ "name": "listSites",
473
+ "verb": "GET",
474
+ "path": "/bing/sites",
475
+ "pathParams": [],
476
+ "requiredQuery": [
477
+ "projectId"
478
+ ],
479
+ "queryParams": [
480
+ "projectId"
481
+ ],
482
+ "hasBody": false,
483
+ "auth": "api_key"
484
+ },
485
+ {
486
+ "name": "saveCrawlSettings",
487
+ "verb": "POST",
488
+ "path": "/bing/crawl-settings",
489
+ "pathParams": [],
490
+ "requiredQuery": [],
491
+ "queryParams": [],
492
+ "hasBody": true,
493
+ "auth": "api_key"
494
+ },
495
+ {
496
+ "name": "setSite",
497
+ "verb": "POST",
498
+ "path": "/bing/connection",
499
+ "pathParams": [],
500
+ "requiredQuery": [],
501
+ "queryParams": [],
502
+ "hasBody": true,
503
+ "auth": "api_key"
504
+ },
505
+ {
506
+ "name": "siteOverview",
507
+ "verb": "POST",
508
+ "path": "/bing/site-overview",
509
+ "pathParams": [],
510
+ "requiredQuery": [],
511
+ "queryParams": [],
512
+ "hasBody": true,
513
+ "auth": "api_key"
514
+ },
515
+ {
516
+ "name": "submitContent",
517
+ "verb": "POST",
518
+ "path": "/bing/submit-content",
519
+ "pathParams": [],
520
+ "requiredQuery": [],
521
+ "queryParams": [],
522
+ "hasBody": true,
523
+ "auth": "api_key"
524
+ },
525
+ {
526
+ "name": "submitFeed",
527
+ "verb": "POST",
528
+ "path": "/bing/submit-feed",
529
+ "pathParams": [],
530
+ "requiredQuery": [],
531
+ "queryParams": [],
532
+ "hasBody": true,
533
+ "auth": "api_key"
534
+ },
535
+ {
536
+ "name": "updateBlockedUrl",
537
+ "verb": "POST",
538
+ "path": "/bing/blocked-urls",
539
+ "pathParams": [],
540
+ "requiredQuery": [],
541
+ "queryParams": [],
542
+ "hasBody": true,
543
+ "auth": "api_key"
544
+ },
545
+ {
546
+ "name": "updateQueryParameter",
547
+ "verb": "POST",
548
+ "path": "/bing/query-parameters",
549
+ "pathParams": [],
550
+ "requiredQuery": [],
551
+ "queryParams": [],
552
+ "hasBody": true,
553
+ "auth": "api_key"
554
+ },
555
+ {
556
+ "name": "urlInfo",
557
+ "verb": "POST",
558
+ "path": "/bing/url-info",
559
+ "pathParams": [],
560
+ "requiredQuery": [],
561
+ "queryParams": [],
562
+ "hasBody": true,
563
+ "auth": "api_key"
564
+ },
565
+ {
566
+ "name": "urlLinks",
567
+ "verb": "POST",
568
+ "path": "/bing/url-links",
569
+ "pathParams": [],
570
+ "requiredQuery": [],
571
+ "queryParams": [],
572
+ "hasBody": true,
573
+ "auth": "api_key"
574
+ }
575
+ ]
576
+ },
577
+ "braveSearch": {
578
+ "methods": [
579
+ {
580
+ "name": "rankCheck",
581
+ "verb": "POST",
582
+ "path": "/brave-search/rank-check",
583
+ "pathParams": [],
584
+ "requiredQuery": [],
585
+ "queryParams": [],
586
+ "hasBody": true,
587
+ "auth": "api_key"
588
+ }
589
+ ]
590
+ },
591
+ "competitorMonitor": {
592
+ "methods": [
593
+ {
594
+ "name": "addTarget",
595
+ "verb": "POST",
596
+ "path": "/competitor-monitor/targets",
597
+ "pathParams": [],
598
+ "requiredQuery": [],
599
+ "queryParams": [],
600
+ "hasBody": true,
601
+ "auth": "api_key"
602
+ },
603
+ {
604
+ "name": "listChanges",
605
+ "verb": "GET",
606
+ "path": "/competitor-monitor/changes",
607
+ "pathParams": [],
608
+ "requiredQuery": [
609
+ "projectId",
610
+ "targetId"
611
+ ],
612
+ "queryParams": [
613
+ "limit",
614
+ "projectId",
615
+ "targetId"
616
+ ],
617
+ "hasBody": false,
618
+ "auth": "api_key"
619
+ },
620
+ {
621
+ "name": "listTargets",
622
+ "verb": "GET",
623
+ "path": "/competitor-monitor/targets",
624
+ "pathParams": [],
625
+ "requiredQuery": [
626
+ "projectId"
627
+ ],
628
+ "queryParams": [
629
+ "projectId"
630
+ ],
631
+ "hasBody": false,
632
+ "auth": "api_key"
633
+ },
634
+ {
635
+ "name": "removeTarget",
636
+ "verb": "DELETE",
637
+ "path": "/competitor-monitor/targets",
638
+ "pathParams": [],
639
+ "requiredQuery": [],
640
+ "queryParams": [],
641
+ "hasBody": true,
642
+ "auth": "api_key"
643
+ }
644
+ ]
645
+ },
646
+ "competitors": {
647
+ "methods": [
648
+ {
649
+ "name": "find",
650
+ "verb": "POST",
651
+ "path": "/competitors",
652
+ "pathParams": [],
653
+ "requiredQuery": [],
654
+ "queryParams": [],
655
+ "hasBody": true,
656
+ "auth": "api_key"
657
+ }
658
+ ]
659
+ },
660
+ "content": {
661
+ "methods": [
662
+ {
663
+ "name": "optimizer",
664
+ "verb": "POST",
665
+ "path": "/content/optimizer",
666
+ "pathParams": [],
667
+ "requiredQuery": [],
668
+ "queryParams": [],
669
+ "hasBody": true,
670
+ "auth": "api_key"
671
+ },
672
+ {
673
+ "name": "pageMetrics",
674
+ "verb": "POST",
675
+ "path": "/content/page-metrics",
676
+ "pathParams": [],
677
+ "requiredQuery": [],
678
+ "queryParams": [],
679
+ "hasBody": true,
680
+ "auth": "api_key"
681
+ }
682
+ ]
683
+ },
684
+ "crawl": {
685
+ "methods": [
686
+ {
687
+ "name": "clearIssueStatus",
688
+ "verb": "DELETE",
689
+ "path": "/crawl/issue-status",
690
+ "pathParams": [],
691
+ "requiredQuery": [],
692
+ "queryParams": [],
693
+ "hasBody": true,
694
+ "auth": "api_key"
695
+ },
696
+ {
697
+ "name": "comparison",
698
+ "verb": "GET",
699
+ "path": "/crawl/:jobId/comparison",
700
+ "pathParams": [
701
+ "jobId"
702
+ ],
703
+ "requiredQuery": [
704
+ "projectId"
705
+ ],
706
+ "queryParams": [
707
+ "baselineAuditId",
708
+ "projectId"
709
+ ],
710
+ "hasBody": false,
711
+ "auth": "api_key"
712
+ },
713
+ {
714
+ "name": "coreWebVitals",
715
+ "verb": "GET",
716
+ "path": "/crawl/:jobId/core-web-vitals",
717
+ "pathParams": [
718
+ "jobId"
719
+ ],
720
+ "requiredQuery": [
721
+ "projectId"
722
+ ],
723
+ "queryParams": [
724
+ "projectId"
725
+ ],
726
+ "hasBody": false,
727
+ "auth": "api_key"
728
+ },
729
+ {
730
+ "name": "createAuditSegment",
731
+ "verb": "POST",
732
+ "path": "/crawl/audit-segments",
733
+ "pathParams": [],
734
+ "requiredQuery": [],
735
+ "queryParams": [],
736
+ "hasBody": true,
737
+ "auth": "api_key"
738
+ },
739
+ {
740
+ "name": "createCustomIssueRule",
741
+ "verb": "POST",
742
+ "path": "/crawl/custom-issue-rules",
743
+ "pathParams": [],
744
+ "requiredQuery": [],
745
+ "queryParams": [],
746
+ "hasBody": true,
747
+ "auth": "api_key"
748
+ },
749
+ {
750
+ "name": "createIssueMuteRule",
751
+ "verb": "POST",
752
+ "path": "/crawl/issue-mute-rules",
753
+ "pathParams": [],
754
+ "requiredQuery": [],
755
+ "queryParams": [],
756
+ "hasBody": true,
757
+ "auth": "api_key"
758
+ },
759
+ {
760
+ "name": "createIssueSeverityOverride",
761
+ "verb": "POST",
762
+ "path": "/crawl/issue-severity-overrides",
763
+ "pathParams": [],
764
+ "requiredQuery": [],
765
+ "queryParams": [],
766
+ "hasBody": true,
767
+ "auth": "api_key"
768
+ },
769
+ {
770
+ "name": "deleteAuditSegment",
771
+ "verb": "DELETE",
772
+ "path": "/crawl/audit-segments",
773
+ "pathParams": [],
774
+ "requiredQuery": [],
775
+ "queryParams": [],
776
+ "hasBody": true,
777
+ "auth": "api_key"
778
+ },
779
+ {
780
+ "name": "deleteCustomIssueRule",
781
+ "verb": "DELETE",
782
+ "path": "/crawl/custom-issue-rules",
783
+ "pathParams": [],
784
+ "requiredQuery": [],
785
+ "queryParams": [],
786
+ "hasBody": true,
787
+ "auth": "api_key"
788
+ },
789
+ {
790
+ "name": "deleteIssueMuteRule",
791
+ "verb": "DELETE",
792
+ "path": "/crawl/issue-mute-rules",
793
+ "pathParams": [],
794
+ "requiredQuery": [],
795
+ "queryParams": [],
796
+ "hasBody": true,
797
+ "auth": "api_key"
798
+ },
799
+ {
800
+ "name": "deleteIssueSeverityOverride",
801
+ "verb": "DELETE",
802
+ "path": "/crawl/issue-severity-overrides",
803
+ "pathParams": [],
804
+ "requiredQuery": [],
805
+ "queryParams": [],
806
+ "hasBody": true,
807
+ "auth": "api_key"
808
+ },
809
+ {
810
+ "name": "httpsReport",
811
+ "verb": "POST",
812
+ "path": "/crawl/https-report",
813
+ "pathParams": [],
814
+ "requiredQuery": [],
815
+ "queryParams": [],
816
+ "hasBody": true,
817
+ "auth": "api_key"
818
+ },
819
+ {
820
+ "name": "internalLinks",
821
+ "verb": "POST",
822
+ "path": "/crawl/internal-links",
823
+ "pathParams": [],
824
+ "requiredQuery": [],
825
+ "queryParams": [],
826
+ "hasBody": true,
827
+ "auth": "api_key"
828
+ },
829
+ {
830
+ "name": "listAuditSegments",
831
+ "verb": "GET",
832
+ "path": "/crawl/audit-segments",
833
+ "pathParams": [],
834
+ "requiredQuery": [
835
+ "projectId"
836
+ ],
837
+ "queryParams": [
838
+ "projectId"
839
+ ],
840
+ "hasBody": false,
841
+ "auth": "api_key"
842
+ },
843
+ {
844
+ "name": "listCustomIssueRules",
845
+ "verb": "GET",
846
+ "path": "/crawl/custom-issue-rules",
847
+ "pathParams": [],
848
+ "requiredQuery": [
849
+ "projectId"
850
+ ],
851
+ "queryParams": [
852
+ "projectId"
853
+ ],
854
+ "hasBody": false,
855
+ "auth": "api_key"
856
+ },
857
+ {
858
+ "name": "listIssueMuteRules",
859
+ "verb": "GET",
860
+ "path": "/crawl/issue-mute-rules",
861
+ "pathParams": [],
862
+ "requiredQuery": [
863
+ "projectId"
864
+ ],
865
+ "queryParams": [
866
+ "projectId"
867
+ ],
868
+ "hasBody": false,
869
+ "auth": "api_key"
870
+ },
871
+ {
872
+ "name": "listIssueSeverityOverrides",
873
+ "verb": "GET",
874
+ "path": "/crawl/issue-severity-overrides",
875
+ "pathParams": [],
876
+ "requiredQuery": [
877
+ "projectId"
878
+ ],
879
+ "queryParams": [
880
+ "projectId"
881
+ ],
882
+ "hasBody": false,
883
+ "auth": "api_key"
884
+ },
885
+ {
886
+ "name": "listIssueStatuses",
887
+ "verb": "GET",
888
+ "path": "/crawl/issue-status",
889
+ "pathParams": [],
890
+ "requiredQuery": [
891
+ "projectId"
892
+ ],
893
+ "queryParams": [
894
+ "projectId"
895
+ ],
896
+ "hasBody": false,
897
+ "auth": "api_key"
898
+ },
899
+ {
900
+ "name": "segment",
901
+ "verb": "GET",
902
+ "path": "/crawl/:jobId/segment",
903
+ "pathParams": [
904
+ "jobId"
905
+ ],
906
+ "requiredQuery": [
907
+ "projectId",
908
+ "segmentId"
909
+ ],
910
+ "queryParams": [
911
+ "projectId",
912
+ "segmentId"
913
+ ],
914
+ "hasBody": false,
915
+ "auth": "api_key"
916
+ },
917
+ {
918
+ "name": "setIssueStatus",
919
+ "verb": "POST",
920
+ "path": "/crawl/issue-status",
921
+ "pathParams": [],
922
+ "requiredQuery": [],
923
+ "queryParams": [],
924
+ "hasBody": true,
925
+ "auth": "api_key"
926
+ },
927
+ {
928
+ "name": "start",
929
+ "verb": "POST",
930
+ "path": "/crawl/start",
931
+ "pathParams": [],
932
+ "requiredQuery": [],
933
+ "queryParams": [],
934
+ "hasBody": true,
935
+ "auth": "api_key"
936
+ },
937
+ {
938
+ "name": "status",
939
+ "verb": "GET",
940
+ "path": "/crawl/:jobId/status",
941
+ "pathParams": [
942
+ "jobId"
943
+ ],
944
+ "requiredQuery": [
945
+ "projectId"
946
+ ],
947
+ "queryParams": [
948
+ "projectId"
949
+ ],
950
+ "hasBody": false,
951
+ "auth": "api_key"
952
+ },
953
+ {
954
+ "name": "structuredDataReport",
955
+ "verb": "POST",
956
+ "path": "/crawl/structured-data-report",
957
+ "pathParams": [],
958
+ "requiredQuery": [],
959
+ "queryParams": [],
960
+ "hasBody": true,
961
+ "auth": "api_key"
962
+ }
963
+ ]
964
+ },
965
+ "dashboard": {
966
+ "methods": [
967
+ {
968
+ "name": "get",
969
+ "verb": "GET",
970
+ "path": "/dashboard",
971
+ "pathParams": [],
972
+ "requiredQuery": [],
973
+ "queryParams": [],
974
+ "hasBody": false,
975
+ "auth": "api_key"
976
+ }
977
+ ]
978
+ },
979
+ "directVendorAi": {
980
+ "methods": [
981
+ {
982
+ "name": "answer",
983
+ "verb": "POST",
984
+ "path": "/ai/direct-vendor-answers",
985
+ "pathParams": [],
986
+ "requiredQuery": [],
987
+ "queryParams": [],
988
+ "hasBody": true,
989
+ "auth": "api_key"
990
+ }
991
+ ]
992
+ },
993
+ "disavow": {
994
+ "methods": [
995
+ {
996
+ "name": "add",
997
+ "verb": "POST",
998
+ "path": "/disavow/entries",
999
+ "pathParams": [],
1000
+ "requiredQuery": [],
1001
+ "queryParams": [],
1002
+ "hasBody": true,
1003
+ "auth": "api_key"
1004
+ },
1005
+ {
1006
+ "name": "export",
1007
+ "verb": "GET",
1008
+ "path": "/disavow/export",
1009
+ "pathParams": [],
1010
+ "requiredQuery": [
1011
+ "projectId"
1012
+ ],
1013
+ "queryParams": [
1014
+ "projectId"
1015
+ ],
1016
+ "hasBody": false,
1017
+ "auth": "api_key"
1018
+ },
1019
+ {
1020
+ "name": "list",
1021
+ "verb": "GET",
1022
+ "path": "/disavow/entries",
1023
+ "pathParams": [],
1024
+ "requiredQuery": [
1025
+ "projectId"
1026
+ ],
1027
+ "queryParams": [
1028
+ "projectId"
1029
+ ],
1030
+ "hasBody": false,
1031
+ "auth": "api_key"
1032
+ },
1033
+ {
1034
+ "name": "remove",
1035
+ "verb": "DELETE",
1036
+ "path": "/disavow/entries",
1037
+ "pathParams": [],
1038
+ "requiredQuery": [],
1039
+ "queryParams": [],
1040
+ "hasBody": true,
1041
+ "auth": "api_key"
1042
+ }
1043
+ ]
1044
+ },
1045
+ "domain": {
1046
+ "methods": [
1047
+ {
1048
+ "name": "authorityHistory",
1049
+ "verb": "GET",
1050
+ "path": "/domain/authority-history",
1051
+ "pathParams": [],
1052
+ "requiredQuery": [
1053
+ "domain",
1054
+ "projectId"
1055
+ ],
1056
+ "queryParams": [
1057
+ "domain",
1058
+ "projectId"
1059
+ ],
1060
+ "hasBody": false,
1061
+ "auth": "api_key"
1062
+ },
1063
+ {
1064
+ "name": "batchOverview",
1065
+ "verb": "POST",
1066
+ "path": "/domain/batch",
1067
+ "pathParams": [],
1068
+ "requiredQuery": [],
1069
+ "queryParams": [],
1070
+ "hasBody": true,
1071
+ "auth": "api_key"
1072
+ },
1073
+ {
1074
+ "name": "captureAuthoritySnapshot",
1075
+ "verb": "POST",
1076
+ "path": "/domain/authority-history",
1077
+ "pathParams": [],
1078
+ "requiredQuery": [],
1079
+ "queryParams": [],
1080
+ "hasBody": true,
1081
+ "auth": "api_key"
1082
+ },
1083
+ {
1084
+ "name": "overview",
1085
+ "verb": "GET",
1086
+ "path": "/domain/overview",
1087
+ "pathParams": [],
1088
+ "requiredQuery": [
1089
+ "domain",
1090
+ "projectId"
1091
+ ],
1092
+ "queryParams": [
1093
+ "domain",
1094
+ "includeSubdomains",
1095
+ "languageCode",
1096
+ "locationCode",
1097
+ "projectId"
1098
+ ],
1099
+ "hasBody": false,
1100
+ "auth": "api_key"
1101
+ }
1102
+ ]
1103
+ },
1104
+ "ga4": {
1105
+ "methods": [
1106
+ {
1107
+ "name": "channels",
1108
+ "verb": "POST",
1109
+ "path": "/ga4/channels",
1110
+ "pathParams": [],
1111
+ "requiredQuery": [],
1112
+ "queryParams": [],
1113
+ "hasBody": true,
1114
+ "auth": "api_key"
1115
+ },
1116
+ {
1117
+ "name": "connect",
1118
+ "verb": "GET",
1119
+ "path": "/ga4/connection",
1120
+ "pathParams": [],
1121
+ "requiredQuery": [
1122
+ "projectId"
1123
+ ],
1124
+ "queryParams": [
1125
+ "projectId"
1126
+ ],
1127
+ "hasBody": false,
1128
+ "auth": "api_key"
1129
+ },
1130
+ {
1131
+ "name": "daily",
1132
+ "verb": "POST",
1133
+ "path": "/ga4/daily",
1134
+ "pathParams": [],
1135
+ "requiredQuery": [],
1136
+ "queryParams": [],
1137
+ "hasBody": true,
1138
+ "auth": "api_key"
1139
+ },
1140
+ {
1141
+ "name": "disconnect",
1142
+ "verb": "DELETE",
1143
+ "path": "/ga4/connection",
1144
+ "pathParams": [],
1145
+ "requiredQuery": [],
1146
+ "queryParams": [],
1147
+ "hasBody": true,
1148
+ "auth": "api_key"
1149
+ },
1150
+ {
1151
+ "name": "landingPages",
1152
+ "verb": "POST",
1153
+ "path": "/ga4/landing-pages",
1154
+ "pathParams": [],
1155
+ "requiredQuery": [],
1156
+ "queryParams": [],
1157
+ "hasBody": true,
1158
+ "auth": "api_key"
1159
+ },
1160
+ {
1161
+ "name": "listProperties",
1162
+ "verb": "GET",
1163
+ "path": "/ga4/properties",
1164
+ "pathParams": [],
1165
+ "requiredQuery": [
1166
+ "projectId"
1167
+ ],
1168
+ "queryParams": [
1169
+ "projectId"
1170
+ ],
1171
+ "hasBody": false,
1172
+ "auth": "api_key"
1173
+ },
1174
+ {
1175
+ "name": "setProperty",
1176
+ "verb": "POST",
1177
+ "path": "/ga4/connection",
1178
+ "pathParams": [],
1179
+ "requiredQuery": [],
1180
+ "queryParams": [],
1181
+ "hasBody": true,
1182
+ "auth": "api_key"
1183
+ }
1184
+ ]
1185
+ },
1186
+ "googleBusinessProfile": {
1187
+ "methods": [
1188
+ {
1189
+ "name": "availableLocations",
1190
+ "verb": "GET",
1191
+ "path": "/gbp/accounts",
1192
+ "pathParams": [],
1193
+ "requiredQuery": [
1194
+ "projectId"
1195
+ ],
1196
+ "queryParams": [
1197
+ "projectId"
1198
+ ],
1199
+ "hasBody": false,
1200
+ "auth": "api_key"
1201
+ },
1202
+ {
1203
+ "name": "createPost",
1204
+ "verb": "POST",
1205
+ "path": "/gbp/posts",
1206
+ "pathParams": [],
1207
+ "requiredQuery": [],
1208
+ "queryParams": [],
1209
+ "hasBody": true,
1210
+ "auth": "api_key"
1211
+ },
1212
+ {
1213
+ "name": "deleteReviewReply",
1214
+ "verb": "DELETE",
1215
+ "path": "/gbp/review-reply",
1216
+ "pathParams": [],
1217
+ "requiredQuery": [],
1218
+ "queryParams": [],
1219
+ "hasBody": true,
1220
+ "auth": "api_key"
1221
+ },
1222
+ {
1223
+ "name": "getConnection",
1224
+ "verb": "GET",
1225
+ "path": "/gbp/connection",
1226
+ "pathParams": [],
1227
+ "requiredQuery": [
1228
+ "projectId"
1229
+ ],
1230
+ "queryParams": [
1231
+ "projectId"
1232
+ ],
1233
+ "hasBody": false,
1234
+ "auth": "api_key"
1235
+ },
1236
+ {
1237
+ "name": "getOptimization",
1238
+ "verb": "POST",
1239
+ "path": "/gbp/optimization",
1240
+ "pathParams": [],
1241
+ "requiredQuery": [],
1242
+ "queryParams": [],
1243
+ "hasBody": true,
1244
+ "auth": "api_key"
1245
+ },
1246
+ {
1247
+ "name": "getPerformance",
1248
+ "verb": "GET",
1249
+ "path": "/gbp/performance",
1250
+ "pathParams": [],
1251
+ "requiredQuery": [
1252
+ "endDate",
1253
+ "metrics",
1254
+ "projectId",
1255
+ "startDate"
1256
+ ],
1257
+ "queryParams": [
1258
+ "endDate",
1259
+ "metrics",
1260
+ "projectId",
1261
+ "startDate"
1262
+ ],
1263
+ "hasBody": false,
1264
+ "auth": "api_key"
1265
+ },
1266
+ {
1267
+ "name": "getProfile",
1268
+ "verb": "GET",
1269
+ "path": "/gbp/profile",
1270
+ "pathParams": [],
1271
+ "requiredQuery": [
1272
+ "projectId"
1273
+ ],
1274
+ "queryParams": [
1275
+ "projectId"
1276
+ ],
1277
+ "hasBody": false,
1278
+ "auth": "api_key"
1279
+ },
1280
+ {
1281
+ "name": "link",
1282
+ "verb": "POST",
1283
+ "path": "/gbp/connection",
1284
+ "pathParams": [],
1285
+ "requiredQuery": [],
1286
+ "queryParams": [],
1287
+ "hasBody": true,
1288
+ "auth": "api_key"
1289
+ },
1290
+ {
1291
+ "name": "listPosts",
1292
+ "verb": "GET",
1293
+ "path": "/gbp/posts",
1294
+ "pathParams": [],
1295
+ "requiredQuery": [
1296
+ "projectId"
1297
+ ],
1298
+ "queryParams": [
1299
+ "projectId"
1300
+ ],
1301
+ "hasBody": false,
1302
+ "auth": "api_key"
1303
+ },
1304
+ {
1305
+ "name": "listReviews",
1306
+ "verb": "GET",
1307
+ "path": "/gbp/reviews",
1308
+ "pathParams": [],
1309
+ "requiredQuery": [
1310
+ "projectId"
1311
+ ],
1312
+ "queryParams": [
1313
+ "pageToken",
1314
+ "projectId"
1315
+ ],
1316
+ "hasBody": false,
1317
+ "auth": "api_key"
1318
+ },
1319
+ {
1320
+ "name": "replyToReview",
1321
+ "verb": "POST",
1322
+ "path": "/gbp/review-reply",
1323
+ "pathParams": [],
1324
+ "requiredQuery": [],
1325
+ "queryParams": [],
1326
+ "hasBody": true,
1327
+ "auth": "api_key"
1328
+ },
1329
+ {
1330
+ "name": "unlink",
1331
+ "verb": "DELETE",
1332
+ "path": "/gbp/connection",
1333
+ "pathParams": [],
1334
+ "requiredQuery": [],
1335
+ "queryParams": [],
1336
+ "hasBody": true,
1337
+ "auth": "api_key"
1338
+ }
1339
+ ]
1340
+ },
1341
+ "gsc": {
1342
+ "methods": [
1343
+ {
1344
+ "name": "anonymousQueries",
1345
+ "verb": "POST",
1346
+ "path": "/gsc/anonymous-queries",
1347
+ "pathParams": [],
1348
+ "requiredQuery": [],
1349
+ "queryParams": [],
1350
+ "hasBody": true,
1351
+ "auth": "api_key"
1352
+ },
1353
+ {
1354
+ "name": "archive",
1355
+ "verb": "POST",
1356
+ "path": "/gsc/archive",
1357
+ "pathParams": [],
1358
+ "requiredQuery": [],
1359
+ "queryParams": [],
1360
+ "hasBody": true,
1361
+ "auth": "api_key"
1362
+ },
1363
+ {
1364
+ "name": "cannibalisation",
1365
+ "verb": "POST",
1366
+ "path": "/gsc/cannibalisation",
1367
+ "pathParams": [],
1368
+ "requiredQuery": [],
1369
+ "queryParams": [],
1370
+ "hasBody": true,
1371
+ "auth": "api_key"
1372
+ },
1373
+ {
1374
+ "name": "connect",
1375
+ "verb": "GET",
1376
+ "path": "/gsc/connect",
1377
+ "pathParams": [],
1378
+ "requiredQuery": [
1379
+ "projectId"
1380
+ ],
1381
+ "queryParams": [
1382
+ "projectId"
1383
+ ],
1384
+ "hasBody": false,
1385
+ "auth": "api_key"
1386
+ },
1387
+ {
1388
+ "name": "contentDecay",
1389
+ "verb": "POST",
1390
+ "path": "/gsc/content-decay",
1391
+ "pathParams": [],
1392
+ "requiredQuery": [],
1393
+ "queryParams": [],
1394
+ "hasBody": true,
1395
+ "auth": "api_key"
1396
+ },
1397
+ {
1398
+ "name": "coverage",
1399
+ "verb": "POST",
1400
+ "path": "/gsc/coverage",
1401
+ "pathParams": [],
1402
+ "requiredQuery": [],
1403
+ "queryParams": [],
1404
+ "hasBody": true,
1405
+ "auth": "api_key"
1406
+ },
1407
+ {
1408
+ "name": "ctrByPosition",
1409
+ "verb": "POST",
1410
+ "path": "/gsc/ctr-by-position",
1411
+ "pathParams": [],
1412
+ "requiredQuery": [],
1413
+ "queryParams": [],
1414
+ "hasBody": true,
1415
+ "auth": "api_key"
1416
+ },
1417
+ {
1418
+ "name": "hourly",
1419
+ "verb": "POST",
1420
+ "path": "/gsc/hourly",
1421
+ "pathParams": [],
1422
+ "requiredQuery": [],
1423
+ "queryParams": [],
1424
+ "hasBody": true,
1425
+ "auth": "api_key"
1426
+ },
1427
+ {
1428
+ "name": "inspectUrls",
1429
+ "verb": "POST",
1430
+ "path": "/gsc/inspect-urls",
1431
+ "pathParams": [],
1432
+ "requiredQuery": [],
1433
+ "queryParams": [],
1434
+ "hasBody": true,
1435
+ "auth": "api_key"
1436
+ },
1437
+ {
1438
+ "name": "performance",
1439
+ "verb": "POST",
1440
+ "path": "/gsc/performance",
1441
+ "pathParams": [],
1442
+ "requiredQuery": [],
1443
+ "queryParams": [],
1444
+ "hasBody": true,
1445
+ "auth": "api_key"
1446
+ },
1447
+ {
1448
+ "name": "sitemaps",
1449
+ "verb": "POST",
1450
+ "path": "/gsc/sitemaps",
1451
+ "pathParams": [],
1452
+ "requiredQuery": [],
1453
+ "queryParams": [],
1454
+ "hasBody": true,
1455
+ "auth": "api_key"
1456
+ }
1457
+ ]
1458
+ },
1459
+ "indexNow": {
1460
+ "methods": [
1461
+ {
1462
+ "name": "submit",
1463
+ "verb": "POST",
1464
+ "path": "/indexnow/submit",
1465
+ "pathParams": [],
1466
+ "requiredQuery": [],
1467
+ "queryParams": [],
1468
+ "hasBody": true,
1469
+ "auth": "api_key"
1470
+ }
1471
+ ]
1472
+ },
1473
+ "keywords": {
1474
+ "methods": [
1475
+ {
1476
+ "name": "classifyIntent",
1477
+ "verb": "POST",
1478
+ "path": "/keywords/classify-intent",
1479
+ "pathParams": [],
1480
+ "requiredQuery": [],
1481
+ "queryParams": [],
1482
+ "hasBody": true,
1483
+ "auth": "api_key"
1484
+ },
1485
+ {
1486
+ "name": "gap",
1487
+ "verb": "POST",
1488
+ "path": "/keywords/gap",
1489
+ "pathParams": [],
1490
+ "requiredQuery": [],
1491
+ "queryParams": [],
1492
+ "hasBody": true,
1493
+ "auth": "api_key"
1494
+ },
1495
+ {
1496
+ "name": "listSaved",
1497
+ "verb": "GET",
1498
+ "path": "/keywords/saved",
1499
+ "pathParams": [],
1500
+ "requiredQuery": [
1501
+ "projectId"
1502
+ ],
1503
+ "queryParams": [
1504
+ "order",
1505
+ "page",
1506
+ "pageSize",
1507
+ "projectId",
1508
+ "search",
1509
+ "sort"
1510
+ ],
1511
+ "hasBody": false,
1512
+ "auth": "api_key"
1513
+ },
1514
+ {
1515
+ "name": "listShareOfVoice",
1516
+ "verb": "POST",
1517
+ "path": "/keywords/list-share-of-voice",
1518
+ "pathParams": [],
1519
+ "requiredQuery": [],
1520
+ "queryParams": [],
1521
+ "hasBody": true,
1522
+ "auth": "api_key"
1523
+ },
1524
+ {
1525
+ "name": "potential",
1526
+ "verb": "GET",
1527
+ "path": "/keywords/potential",
1528
+ "pathParams": [],
1529
+ "requiredQuery": [
1530
+ "keyword",
1531
+ "projectId"
1532
+ ],
1533
+ "queryParams": [
1534
+ "keyword",
1535
+ "languageCode",
1536
+ "locationCode",
1537
+ "projectId"
1538
+ ],
1539
+ "hasBody": false,
1540
+ "auth": "api_key"
1541
+ },
1542
+ {
1543
+ "name": "research",
1544
+ "verb": "POST",
1545
+ "path": "/keywords/research",
1546
+ "pathParams": [],
1547
+ "requiredQuery": [],
1548
+ "queryParams": [],
1549
+ "hasBody": true,
1550
+ "auth": "api_key"
1551
+ },
1552
+ {
1553
+ "name": "save",
1554
+ "verb": "POST",
1555
+ "path": "/keywords/saved",
1556
+ "pathParams": [],
1557
+ "requiredQuery": [],
1558
+ "queryParams": [],
1559
+ "hasBody": true,
1560
+ "auth": "api_key"
1561
+ },
1562
+ {
1563
+ "name": "serpOverview",
1564
+ "verb": "GET",
1565
+ "path": "/keywords/serp-overview",
1566
+ "pathParams": [],
1567
+ "requiredQuery": [
1568
+ "keyword",
1569
+ "projectId"
1570
+ ],
1571
+ "queryParams": [
1572
+ "keyword",
1573
+ "languageCode",
1574
+ "locationCode",
1575
+ "projectId",
1576
+ "sinceDays"
1577
+ ],
1578
+ "hasBody": false,
1579
+ "auth": "api_key"
1580
+ },
1581
+ {
1582
+ "name": "strategy",
1583
+ "verb": "POST",
1584
+ "path": "/keywords/strategy",
1585
+ "pathParams": [],
1586
+ "requiredQuery": [],
1587
+ "queryParams": [],
1588
+ "hasBody": true,
1589
+ "auth": "api_key"
1590
+ },
1591
+ {
1592
+ "name": "topicResearch",
1593
+ "verb": "POST",
1594
+ "path": "/keywords/topic-research",
1595
+ "pathParams": [],
1596
+ "requiredQuery": [],
1597
+ "queryParams": [],
1598
+ "hasBody": true,
1599
+ "auth": "api_key"
1600
+ }
1601
+ ]
1602
+ },
1603
+ "linkBuilding": {
1604
+ "methods": [
1605
+ {
1606
+ "name": "add",
1607
+ "verb": "POST",
1608
+ "path": "/link-building/prospects",
1609
+ "pathParams": [],
1610
+ "requiredQuery": [],
1611
+ "queryParams": [],
1612
+ "hasBody": true,
1613
+ "auth": "api_key"
1614
+ },
1615
+ {
1616
+ "name": "addNote",
1617
+ "verb": "POST",
1618
+ "path": "/link-building/activity",
1619
+ "pathParams": [],
1620
+ "requiredQuery": [],
1621
+ "queryParams": [],
1622
+ "hasBody": true,
1623
+ "auth": "api_key"
1624
+ },
1625
+ {
1626
+ "name": "exportCsv",
1627
+ "verb": "GET",
1628
+ "path": "/link-building/csv",
1629
+ "pathParams": [],
1630
+ "requiredQuery": [
1631
+ "projectId"
1632
+ ],
1633
+ "queryParams": [
1634
+ "projectId"
1635
+ ],
1636
+ "hasBody": false,
1637
+ "auth": "api_key"
1638
+ },
1639
+ {
1640
+ "name": "importCsv",
1641
+ "verb": "POST",
1642
+ "path": "/link-building/csv",
1643
+ "pathParams": [],
1644
+ "requiredQuery": [],
1645
+ "queryParams": [],
1646
+ "hasBody": true,
1647
+ "auth": "api_key"
1648
+ },
1649
+ {
1650
+ "name": "list",
1651
+ "verb": "GET",
1652
+ "path": "/link-building/prospects",
1653
+ "pathParams": [],
1654
+ "requiredQuery": [
1655
+ "projectId"
1656
+ ],
1657
+ "queryParams": [
1658
+ "projectId"
1659
+ ],
1660
+ "hasBody": false,
1661
+ "auth": "api_key"
1662
+ },
1663
+ {
1664
+ "name": "listActivity",
1665
+ "verb": "GET",
1666
+ "path": "/link-building/activity",
1667
+ "pathParams": [],
1668
+ "requiredQuery": [
1669
+ "projectId",
1670
+ "prospectId"
1671
+ ],
1672
+ "queryParams": [
1673
+ "projectId",
1674
+ "prospectId"
1675
+ ],
1676
+ "hasBody": false,
1677
+ "auth": "api_key"
1678
+ },
1679
+ {
1680
+ "name": "remove",
1681
+ "verb": "DELETE",
1682
+ "path": "/link-building/prospects",
1683
+ "pathParams": [],
1684
+ "requiredQuery": [],
1685
+ "queryParams": [],
1686
+ "hasBody": true,
1687
+ "auth": "api_key"
1688
+ },
1689
+ {
1690
+ "name": "update",
1691
+ "verb": "PATCH",
1692
+ "path": "/link-building/prospects",
1693
+ "pathParams": [],
1694
+ "requiredQuery": [],
1695
+ "queryParams": [],
1696
+ "hasBody": true,
1697
+ "auth": "api_key"
1698
+ },
1699
+ {
1700
+ "name": "updateStatus",
1701
+ "verb": "POST",
1702
+ "path": "/link-building/status",
1703
+ "pathParams": [],
1704
+ "requiredQuery": [],
1705
+ "queryParams": [],
1706
+ "hasBody": true,
1707
+ "auth": "api_key"
1708
+ }
1709
+ ]
1710
+ },
1711
+ "local": {
1712
+ "methods": [
1713
+ {
1714
+ "name": "businessListings",
1715
+ "verb": "POST",
1716
+ "path": "/local/business-listings",
1717
+ "pathParams": [],
1718
+ "requiredQuery": [],
1719
+ "queryParams": [],
1720
+ "hasBody": true,
1721
+ "auth": "api_key"
1722
+ },
1723
+ {
1724
+ "name": "napAudit",
1725
+ "verb": "POST",
1726
+ "path": "/local/nap-audit",
1727
+ "pathParams": [],
1728
+ "requiredQuery": [],
1729
+ "queryParams": [],
1730
+ "hasBody": true,
1731
+ "auth": "api_key"
1732
+ },
1733
+ {
1734
+ "name": "questionsAnswers",
1735
+ "verb": "POST",
1736
+ "path": "/local/questions-answers",
1737
+ "pathParams": [],
1738
+ "requiredQuery": [],
1739
+ "queryParams": [],
1740
+ "hasBody": true,
1741
+ "auth": "api_key"
1742
+ }
1743
+ ]
1744
+ },
1745
+ "localPackRank": {
1746
+ "methods": [
1747
+ {
1748
+ "name": "createConfig",
1749
+ "verb": "POST",
1750
+ "path": "/local/local-pack-rank/configs",
1751
+ "pathParams": [],
1752
+ "requiredQuery": [],
1753
+ "queryParams": [],
1754
+ "hasBody": true,
1755
+ "auth": "api_key"
1756
+ },
1757
+ {
1758
+ "name": "deleteConfig",
1759
+ "verb": "DELETE",
1760
+ "path": "/local/local-pack-rank/configs",
1761
+ "pathParams": [],
1762
+ "requiredQuery": [],
1763
+ "queryParams": [],
1764
+ "hasBody": true,
1765
+ "auth": "api_key"
1766
+ },
1767
+ {
1768
+ "name": "getLatestCheck",
1769
+ "verb": "GET",
1770
+ "path": "/local/local-pack-rank/checks",
1771
+ "pathParams": [],
1772
+ "requiredQuery": [
1773
+ "configId",
1774
+ "projectId"
1775
+ ],
1776
+ "queryParams": [
1777
+ "configId",
1778
+ "projectId"
1779
+ ],
1780
+ "hasBody": false,
1781
+ "auth": "api_key"
1782
+ },
1783
+ {
1784
+ "name": "listConfigs",
1785
+ "verb": "GET",
1786
+ "path": "/local/local-pack-rank/configs",
1787
+ "pathParams": [],
1788
+ "requiredQuery": [
1789
+ "projectId"
1790
+ ],
1791
+ "queryParams": [
1792
+ "projectId"
1793
+ ],
1794
+ "hasBody": false,
1795
+ "auth": "api_key"
1796
+ },
1797
+ {
1798
+ "name": "runCheck",
1799
+ "verb": "POST",
1800
+ "path": "/local/local-pack-rank/checks",
1801
+ "pathParams": [],
1802
+ "requiredQuery": [],
1803
+ "queryParams": [],
1804
+ "hasBody": true,
1805
+ "auth": "api_key"
1806
+ }
1807
+ ]
1808
+ },
1809
+ "localRankGrid": {
1810
+ "methods": [
1811
+ {
1812
+ "name": "createConfig",
1813
+ "verb": "POST",
1814
+ "path": "/local/rank-grid/configs",
1815
+ "pathParams": [],
1816
+ "requiredQuery": [],
1817
+ "queryParams": [],
1818
+ "hasBody": true,
1819
+ "auth": "api_key"
1820
+ },
1821
+ {
1822
+ "name": "deleteConfig",
1823
+ "verb": "DELETE",
1824
+ "path": "/local/rank-grid/configs",
1825
+ "pathParams": [],
1826
+ "requiredQuery": [],
1827
+ "queryParams": [],
1828
+ "hasBody": true,
1829
+ "auth": "api_key"
1830
+ },
1831
+ {
1832
+ "name": "getLatestRun",
1833
+ "verb": "GET",
1834
+ "path": "/local/rank-grid/runs",
1835
+ "pathParams": [],
1836
+ "requiredQuery": [
1837
+ "configId",
1838
+ "projectId"
1839
+ ],
1840
+ "queryParams": [
1841
+ "configId",
1842
+ "projectId"
1843
+ ],
1844
+ "hasBody": false,
1845
+ "auth": "api_key"
1846
+ },
1847
+ {
1848
+ "name": "listConfigs",
1849
+ "verb": "GET",
1850
+ "path": "/local/rank-grid/configs",
1851
+ "pathParams": [],
1852
+ "requiredQuery": [
1853
+ "projectId"
1854
+ ],
1855
+ "queryParams": [
1856
+ "projectId"
1857
+ ],
1858
+ "hasBody": false,
1859
+ "auth": "api_key"
1860
+ },
1861
+ {
1862
+ "name": "runCheck",
1863
+ "verb": "POST",
1864
+ "path": "/local/rank-grid/runs",
1865
+ "pathParams": [],
1866
+ "requiredQuery": [],
1867
+ "queryParams": [],
1868
+ "hasBody": true,
1869
+ "auth": "api_key"
1870
+ }
1871
+ ]
1872
+ },
1873
+ "logAnalyzer": {
1874
+ "methods": [
1875
+ {
1876
+ "name": "dailySummary",
1877
+ "verb": "GET",
1878
+ "path": "/log-analyzer/daily-summary",
1879
+ "pathParams": [],
1880
+ "requiredQuery": [
1881
+ "projectId",
1882
+ "sinceDay",
1883
+ "untilDay"
1884
+ ],
1885
+ "queryParams": [
1886
+ "projectId",
1887
+ "sinceDay",
1888
+ "untilDay"
1889
+ ],
1890
+ "hasBody": false,
1891
+ "auth": "api_key"
1892
+ },
1893
+ {
1894
+ "name": "getUpload",
1895
+ "verb": "GET",
1896
+ "path": "/log-analyzer/uploads/:uploadId",
1897
+ "pathParams": [
1898
+ "uploadId"
1899
+ ],
1900
+ "requiredQuery": [
1901
+ "projectId"
1902
+ ],
1903
+ "queryParams": [
1904
+ "projectId"
1905
+ ],
1906
+ "hasBody": false,
1907
+ "auth": "api_key"
1908
+ },
1909
+ {
1910
+ "name": "listUploads",
1911
+ "verb": "GET",
1912
+ "path": "/log-analyzer/uploads",
1913
+ "pathParams": [],
1914
+ "requiredQuery": [
1915
+ "projectId"
1916
+ ],
1917
+ "queryParams": [
1918
+ "projectId"
1919
+ ],
1920
+ "hasBody": false,
1921
+ "auth": "api_key"
1922
+ },
1923
+ {
1924
+ "name": "topPaths",
1925
+ "verb": "GET",
1926
+ "path": "/log-analyzer/top-paths",
1927
+ "pathParams": [],
1928
+ "requiredQuery": [
1929
+ "projectId"
1930
+ ],
1931
+ "queryParams": [
1932
+ "botCategory",
1933
+ "projectId"
1934
+ ],
1935
+ "hasBody": false,
1936
+ "auth": "api_key"
1937
+ },
1938
+ {
1939
+ "name": "upload",
1940
+ "verb": "POST",
1941
+ "path": "/log-analyzer/uploads",
1942
+ "pathParams": [],
1943
+ "requiredQuery": [],
1944
+ "queryParams": [],
1945
+ "hasBody": true,
1946
+ "auth": "api_key"
1947
+ }
1948
+ ]
1949
+ },
1950
+ "mentions": {
1951
+ "methods": [
1952
+ {
1953
+ "name": "mediaMonitoring",
1954
+ "verb": "POST",
1955
+ "path": "/mentions/media-monitoring",
1956
+ "pathParams": [],
1957
+ "requiredQuery": [],
1958
+ "queryParams": [],
1959
+ "hasBody": true,
1960
+ "auth": "api_key"
1961
+ },
1962
+ {
1963
+ "name": "unlinkedMentions",
1964
+ "verb": "POST",
1965
+ "path": "/mentions/unlinked",
1966
+ "pathParams": [],
1967
+ "requiredQuery": [],
1968
+ "queryParams": [],
1969
+ "hasBody": true,
1970
+ "auth": "api_key"
1971
+ }
1972
+ ]
1973
+ },
1974
+ "patches": {
1975
+ "methods": [
1976
+ {
1977
+ "name": "batchDraft",
1978
+ "verb": "POST",
1979
+ "path": "/patches/batch-draft",
1980
+ "pathParams": [],
1981
+ "requiredQuery": [],
1982
+ "queryParams": [],
1983
+ "hasBody": true,
1984
+ "auth": "api_key"
1985
+ },
1986
+ {
1987
+ "name": "disableAutoPublish",
1988
+ "verb": "DELETE",
1989
+ "path": "/patches/auto-publish-rules",
1990
+ "pathParams": [],
1991
+ "requiredQuery": [],
1992
+ "queryParams": [],
1993
+ "hasBody": true,
1994
+ "auth": "api_key"
1995
+ },
1996
+ {
1997
+ "name": "draft",
1998
+ "verb": "POST",
1999
+ "path": "/patches",
2000
+ "pathParams": [],
2001
+ "requiredQuery": [],
2002
+ "queryParams": [],
2003
+ "hasBody": true,
2004
+ "auth": "api_key"
2005
+ },
2006
+ {
2007
+ "name": "enableAutoPublish",
2008
+ "verb": "POST",
2009
+ "path": "/patches/auto-publish-rules",
2010
+ "pathParams": [],
2011
+ "requiredQuery": [],
2012
+ "queryParams": [],
2013
+ "hasBody": true,
2014
+ "auth": "api_key"
2015
+ },
2016
+ {
2017
+ "name": "list",
2018
+ "verb": "GET",
2019
+ "path": "/patches",
2020
+ "pathParams": [],
2021
+ "requiredQuery": [
2022
+ "projectId"
2023
+ ],
2024
+ "queryParams": [
2025
+ "projectId"
2026
+ ],
2027
+ "hasBody": false,
2028
+ "auth": "api_key"
2029
+ },
2030
+ {
2031
+ "name": "listAutoPublishRules",
2032
+ "verb": "GET",
2033
+ "path": "/patches/auto-publish-rules",
2034
+ "pathParams": [],
2035
+ "requiredQuery": [
2036
+ "projectId"
2037
+ ],
2038
+ "queryParams": [
2039
+ "projectId"
2040
+ ],
2041
+ "hasBody": false,
2042
+ "auth": "api_key"
2043
+ },
2044
+ {
2045
+ "name": "publish",
2046
+ "verb": "POST",
2047
+ "path": "/patches/:patchId/publish",
2048
+ "pathParams": [
2049
+ "patchId"
2050
+ ],
2051
+ "requiredQuery": [],
2052
+ "queryParams": [],
2053
+ "hasBody": true,
2054
+ "auth": "api_key"
2055
+ },
2056
+ {
2057
+ "name": "revert",
2058
+ "verb": "POST",
2059
+ "path": "/patches/:patchId/revert",
2060
+ "pathParams": [
2061
+ "patchId"
2062
+ ],
2063
+ "requiredQuery": [],
2064
+ "queryParams": [],
2065
+ "hasBody": true,
2066
+ "auth": "api_key"
2067
+ }
2068
+ ]
2069
+ },
2070
+ "portfolios": {
2071
+ "methods": [
2072
+ {
2073
+ "name": "addProjects",
2074
+ "verb": "POST",
2075
+ "path": "/portfolios/:portfolioId/projects",
2076
+ "pathParams": [
2077
+ "portfolioId"
2078
+ ],
2079
+ "requiredQuery": [],
2080
+ "queryParams": [],
2081
+ "hasBody": true,
2082
+ "auth": "api_key"
2083
+ },
2084
+ {
2085
+ "name": "create",
2086
+ "verb": "POST",
2087
+ "path": "/portfolios",
2088
+ "pathParams": [],
2089
+ "requiredQuery": [],
2090
+ "queryParams": [],
2091
+ "hasBody": true,
2092
+ "auth": "api_key"
2093
+ },
2094
+ {
2095
+ "name": "delete",
2096
+ "verb": "DELETE",
2097
+ "path": "/portfolios/:portfolioId",
2098
+ "pathParams": [
2099
+ "portfolioId"
2100
+ ],
2101
+ "requiredQuery": [],
2102
+ "queryParams": [],
2103
+ "hasBody": false,
2104
+ "auth": "api_key"
2105
+ },
2106
+ {
2107
+ "name": "get",
2108
+ "verb": "GET",
2109
+ "path": "/portfolios/:portfolioId",
2110
+ "pathParams": [
2111
+ "portfolioId"
2112
+ ],
2113
+ "requiredQuery": [],
2114
+ "queryParams": [],
2115
+ "hasBody": false,
2116
+ "auth": "api_key"
2117
+ },
2118
+ {
2119
+ "name": "list",
2120
+ "verb": "GET",
2121
+ "path": "/portfolios",
2122
+ "pathParams": [],
2123
+ "requiredQuery": [],
2124
+ "queryParams": [],
2125
+ "hasBody": false,
2126
+ "auth": "api_key"
2127
+ },
2128
+ {
2129
+ "name": "removeProjects",
2130
+ "verb": "DELETE",
2131
+ "path": "/portfolios/:portfolioId/projects",
2132
+ "pathParams": [
2133
+ "portfolioId"
2134
+ ],
2135
+ "requiredQuery": [],
2136
+ "queryParams": [],
2137
+ "hasBody": true,
2138
+ "auth": "api_key"
2139
+ },
2140
+ {
2141
+ "name": "rename",
2142
+ "verb": "PATCH",
2143
+ "path": "/portfolios/:portfolioId",
2144
+ "pathParams": [
2145
+ "portfolioId"
2146
+ ],
2147
+ "requiredQuery": [],
2148
+ "queryParams": [],
2149
+ "hasBody": true,
2150
+ "auth": "api_key"
2151
+ }
2152
+ ]
2153
+ },
2154
+ "projects": {
2155
+ "methods": [
2156
+ {
2157
+ "name": "create",
2158
+ "verb": "POST",
2159
+ "path": "/projects",
2160
+ "pathParams": [],
2161
+ "requiredQuery": [],
2162
+ "queryParams": [],
2163
+ "hasBody": true,
2164
+ "auth": "api_key"
2165
+ },
2166
+ {
2167
+ "name": "delete",
2168
+ "verb": "DELETE",
2169
+ "path": "/projects/:projectId",
2170
+ "pathParams": [
2171
+ "projectId"
2172
+ ],
2173
+ "requiredQuery": [],
2174
+ "queryParams": [],
2175
+ "hasBody": false,
2176
+ "auth": "api_key"
2177
+ },
2178
+ {
2179
+ "name": "get",
2180
+ "verb": "GET",
2181
+ "path": "/projects/:projectId",
2182
+ "pathParams": [
2183
+ "projectId"
2184
+ ],
2185
+ "requiredQuery": [],
2186
+ "queryParams": [],
2187
+ "hasBody": false,
2188
+ "auth": "api_key"
2189
+ },
2190
+ {
2191
+ "name": "list",
2192
+ "verb": "GET",
2193
+ "path": "/projects",
2194
+ "pathParams": [],
2195
+ "requiredQuery": [],
2196
+ "queryParams": [],
2197
+ "hasBody": false,
2198
+ "auth": "api_key"
2199
+ },
2200
+ {
2201
+ "name": "update",
2202
+ "verb": "PATCH",
2203
+ "path": "/projects/:projectId",
2204
+ "pathParams": [
2205
+ "projectId"
2206
+ ],
2207
+ "requiredQuery": [],
2208
+ "queryParams": [],
2209
+ "hasBody": true,
2210
+ "auth": "api_key"
2211
+ }
2212
+ ]
2213
+ },
2214
+ "rankTracking": {
2215
+ "methods": [
2216
+ {
2217
+ "name": "addAnnotation",
2218
+ "verb": "POST",
2219
+ "path": "/rank-tracking/annotations",
2220
+ "pathParams": [],
2221
+ "requiredQuery": [],
2222
+ "queryParams": [],
2223
+ "hasBody": true,
2224
+ "auth": "api_key"
2225
+ },
2226
+ {
2227
+ "name": "addCompetitor",
2228
+ "verb": "POST",
2229
+ "path": "/rank-tracking/competitors",
2230
+ "pathParams": [],
2231
+ "requiredQuery": [],
2232
+ "queryParams": [],
2233
+ "hasBody": true,
2234
+ "auth": "api_key"
2235
+ },
2236
+ {
2237
+ "name": "addKeywords",
2238
+ "verb": "POST",
2239
+ "path": "/rank-tracking/keywords",
2240
+ "pathParams": [],
2241
+ "requiredQuery": [],
2242
+ "queryParams": [],
2243
+ "hasBody": true,
2244
+ "auth": "api_key"
2245
+ },
2246
+ {
2247
+ "name": "create",
2248
+ "verb": "POST",
2249
+ "path": "/rank-tracking/configs",
2250
+ "pathParams": [],
2251
+ "requiredQuery": [],
2252
+ "queryParams": [],
2253
+ "hasBody": true,
2254
+ "auth": "api_key"
2255
+ },
2256
+ {
2257
+ "name": "delete",
2258
+ "verb": "DELETE",
2259
+ "path": "/rank-tracking/configs",
2260
+ "pathParams": [],
2261
+ "requiredQuery": [],
2262
+ "queryParams": [],
2263
+ "hasBody": true,
2264
+ "auth": "api_key"
2265
+ },
2266
+ {
2267
+ "name": "get",
2268
+ "verb": "GET",
2269
+ "path": "/rank-tracking/keywords",
2270
+ "pathParams": [],
2271
+ "requiredQuery": [
2272
+ "configId",
2273
+ "projectId"
2274
+ ],
2275
+ "queryParams": [
2276
+ "configId",
2277
+ "page",
2278
+ "pageSize",
2279
+ "projectId"
2280
+ ],
2281
+ "hasBody": false,
2282
+ "auth": "api_key"
2283
+ },
2284
+ {
2285
+ "name": "getAiOverviewTrend",
2286
+ "verb": "GET",
2287
+ "path": "/rank-tracking/ai-overview-trend",
2288
+ "pathParams": [],
2289
+ "requiredQuery": [
2290
+ "configId",
2291
+ "projectId"
2292
+ ],
2293
+ "queryParams": [
2294
+ "configId",
2295
+ "device",
2296
+ "projectId",
2297
+ "sinceDays"
2298
+ ],
2299
+ "hasBody": false,
2300
+ "auth": "api_key"
2301
+ },
2302
+ {
2303
+ "name": "getConfigTrend",
2304
+ "verb": "GET",
2305
+ "path": "/rank-tracking/trend",
2306
+ "pathParams": [],
2307
+ "requiredQuery": [
2308
+ "configId",
2309
+ "projectId"
2310
+ ],
2311
+ "queryParams": [
2312
+ "configId",
2313
+ "device",
2314
+ "projectId",
2315
+ "sinceDays"
2316
+ ],
2317
+ "hasBody": false,
2318
+ "auth": "api_key"
2319
+ },
2320
+ {
2321
+ "name": "getKeywordHistory",
2322
+ "verb": "GET",
2323
+ "path": "/rank-tracking/keyword-history",
2324
+ "pathParams": [],
2325
+ "requiredQuery": [
2326
+ "configId",
2327
+ "projectId",
2328
+ "trackingKeywordId"
2329
+ ],
2330
+ "queryParams": [
2331
+ "configId",
2332
+ "projectId",
2333
+ "sinceDays",
2334
+ "trackingKeywordId"
2335
+ ],
2336
+ "hasBody": false,
2337
+ "auth": "api_key"
2338
+ },
2339
+ {
2340
+ "name": "getLatestRun",
2341
+ "verb": "GET",
2342
+ "path": "/rank-tracking/runs",
2343
+ "pathParams": [],
2344
+ "requiredQuery": [
2345
+ "configId",
2346
+ "projectId"
2347
+ ],
2348
+ "queryParams": [
2349
+ "configId",
2350
+ "projectId"
2351
+ ],
2352
+ "hasBody": false,
2353
+ "auth": "api_key"
2354
+ },
2355
+ {
2356
+ "name": "getRankMovers",
2357
+ "verb": "GET",
2358
+ "path": "/rank-tracking/movers",
2359
+ "pathParams": [],
2360
+ "requiredQuery": [
2361
+ "configId",
2362
+ "projectId"
2363
+ ],
2364
+ "queryParams": [
2365
+ "configId",
2366
+ "minGain",
2367
+ "projectId",
2368
+ "sinceDays"
2369
+ ],
2370
+ "hasBody": false,
2371
+ "auth": "api_key"
2372
+ },
2373
+ {
2374
+ "name": "getVolatilityIndex",
2375
+ "verb": "GET",
2376
+ "path": "/rank-tracking/volatility",
2377
+ "pathParams": [],
2378
+ "requiredQuery": [
2379
+ "configId",
2380
+ "projectId"
2381
+ ],
2382
+ "queryParams": [
2383
+ "configId",
2384
+ "device",
2385
+ "projectId",
2386
+ "runLimit"
2387
+ ],
2388
+ "hasBody": false,
2389
+ "auth": "api_key"
2390
+ },
2391
+ {
2392
+ "name": "listAnnotations",
2393
+ "verb": "GET",
2394
+ "path": "/rank-tracking/annotations",
2395
+ "pathParams": [],
2396
+ "requiredQuery": [
2397
+ "configId",
2398
+ "projectId"
2399
+ ],
2400
+ "queryParams": [
2401
+ "configId",
2402
+ "projectId"
2403
+ ],
2404
+ "hasBody": false,
2405
+ "auth": "api_key"
2406
+ },
2407
+ {
2408
+ "name": "listCannibalisation",
2409
+ "verb": "GET",
2410
+ "path": "/rank-tracking/cannibalisation",
2411
+ "pathParams": [],
2412
+ "requiredQuery": [
2413
+ "configId",
2414
+ "projectId"
2415
+ ],
2416
+ "queryParams": [
2417
+ "configId",
2418
+ "projectId"
2419
+ ],
2420
+ "hasBody": false,
2421
+ "auth": "api_key"
2422
+ },
2423
+ {
2424
+ "name": "listCompetitors",
2425
+ "verb": "GET",
2426
+ "path": "/rank-tracking/competitors",
2427
+ "pathParams": [],
2428
+ "requiredQuery": [
2429
+ "configId",
2430
+ "projectId"
2431
+ ],
2432
+ "queryParams": [
2433
+ "configId",
2434
+ "device",
2435
+ "projectId"
2436
+ ],
2437
+ "hasBody": false,
2438
+ "auth": "api_key"
2439
+ },
2440
+ {
2441
+ "name": "listConfigs",
2442
+ "verb": "GET",
2443
+ "path": "/rank-tracking/configs",
2444
+ "pathParams": [],
2445
+ "requiredQuery": [
2446
+ "projectId"
2447
+ ],
2448
+ "queryParams": [
2449
+ "projectId"
2450
+ ],
2451
+ "hasBody": false,
2452
+ "auth": "api_key"
2453
+ },
2454
+ {
2455
+ "name": "listKeywordTags",
2456
+ "verb": "GET",
2457
+ "path": "/rank-tracking/keyword-tags",
2458
+ "pathParams": [],
2459
+ "requiredQuery": [
2460
+ "configId",
2461
+ "projectId"
2462
+ ],
2463
+ "queryParams": [
2464
+ "configId",
2465
+ "projectId"
2466
+ ],
2467
+ "hasBody": false,
2468
+ "auth": "api_key"
2469
+ },
2470
+ {
2471
+ "name": "removeAnnotation",
2472
+ "verb": "DELETE",
2473
+ "path": "/rank-tracking/annotations",
2474
+ "pathParams": [],
2475
+ "requiredQuery": [],
2476
+ "queryParams": [],
2477
+ "hasBody": true,
2478
+ "auth": "api_key"
2479
+ },
2480
+ {
2481
+ "name": "removeCompetitor",
2482
+ "verb": "DELETE",
2483
+ "path": "/rank-tracking/competitors",
2484
+ "pathParams": [],
2485
+ "requiredQuery": [],
2486
+ "queryParams": [],
2487
+ "hasBody": true,
2488
+ "auth": "api_key"
2489
+ },
2490
+ {
2491
+ "name": "removeKeywords",
2492
+ "verb": "DELETE",
2493
+ "path": "/rank-tracking/keywords",
2494
+ "pathParams": [],
2495
+ "requiredQuery": [],
2496
+ "queryParams": [],
2497
+ "hasBody": true,
2498
+ "auth": "api_key"
2499
+ },
2500
+ {
2501
+ "name": "setKeywordTargetUrl",
2502
+ "verb": "POST",
2503
+ "path": "/rank-tracking/keyword-target-url",
2504
+ "pathParams": [],
2505
+ "requiredQuery": [],
2506
+ "queryParams": [],
2507
+ "hasBody": true,
2508
+ "auth": "api_key"
2509
+ },
2510
+ {
2511
+ "name": "update",
2512
+ "verb": "PATCH",
2513
+ "path": "/rank-tracking/configs",
2514
+ "pathParams": [],
2515
+ "requiredQuery": [],
2516
+ "queryParams": [],
2517
+ "hasBody": true,
2518
+ "auth": "api_key"
2519
+ },
2520
+ {
2521
+ "name": "updateKeywordTag",
2522
+ "verb": "POST",
2523
+ "path": "/rank-tracking/keyword-tags",
2524
+ "pathParams": [],
2525
+ "requiredQuery": [],
2526
+ "queryParams": [],
2527
+ "hasBody": true,
2528
+ "auth": "api_key"
2529
+ }
2530
+ ]
2531
+ },
2532
+ "reportBuilder": {
2533
+ "methods": [
2534
+ {
2535
+ "name": "createDefinition",
2536
+ "verb": "POST",
2537
+ "path": "/reports/definitions",
2538
+ "pathParams": [],
2539
+ "requiredQuery": [],
2540
+ "queryParams": [],
2541
+ "hasBody": true,
2542
+ "auth": "api_key"
2543
+ },
2544
+ {
2545
+ "name": "deleteDefinition",
2546
+ "verb": "DELETE",
2547
+ "path": "/reports/definitions/:reportDefinitionId",
2548
+ "pathParams": [
2549
+ "reportDefinitionId"
2550
+ ],
2551
+ "requiredQuery": [
2552
+ "projectId"
2553
+ ],
2554
+ "queryParams": [
2555
+ "projectId"
2556
+ ],
2557
+ "hasBody": false,
2558
+ "auth": "api_key"
2559
+ },
2560
+ {
2561
+ "name": "deleteSchedule",
2562
+ "verb": "DELETE",
2563
+ "path": "/reports/definitions/:reportDefinitionId/schedule",
2564
+ "pathParams": [
2565
+ "reportDefinitionId"
2566
+ ],
2567
+ "requiredQuery": [
2568
+ "projectId"
2569
+ ],
2570
+ "queryParams": [
2571
+ "projectId"
2572
+ ],
2573
+ "hasBody": false,
2574
+ "auth": "api_key"
2575
+ },
2576
+ {
2577
+ "name": "getDefinition",
2578
+ "verb": "GET",
2579
+ "path": "/reports/definitions/:reportDefinitionId",
2580
+ "pathParams": [
2581
+ "reportDefinitionId"
2582
+ ],
2583
+ "requiredQuery": [
2584
+ "projectId"
2585
+ ],
2586
+ "queryParams": [
2587
+ "projectId"
2588
+ ],
2589
+ "hasBody": false,
2590
+ "auth": "api_key"
2591
+ },
2592
+ {
2593
+ "name": "getSchedule",
2594
+ "verb": "GET",
2595
+ "path": "/reports/definitions/:reportDefinitionId/schedule",
2596
+ "pathParams": [
2597
+ "reportDefinitionId"
2598
+ ],
2599
+ "requiredQuery": [
2600
+ "projectId"
2601
+ ],
2602
+ "queryParams": [
2603
+ "projectId"
2604
+ ],
2605
+ "hasBody": false,
2606
+ "auth": "api_key"
2607
+ },
2608
+ {
2609
+ "name": "listDefinitions",
2610
+ "verb": "GET",
2611
+ "path": "/reports/definitions",
2612
+ "pathParams": [],
2613
+ "requiredQuery": [
2614
+ "projectId"
2615
+ ],
2616
+ "queryParams": [
2617
+ "projectId"
2618
+ ],
2619
+ "hasBody": false,
2620
+ "auth": "api_key"
2621
+ },
2622
+ {
2623
+ "name": "renameDefinition",
2624
+ "verb": "PATCH",
2625
+ "path": "/reports/definitions/:reportDefinitionId",
2626
+ "pathParams": [
2627
+ "reportDefinitionId"
2628
+ ],
2629
+ "requiredQuery": [],
2630
+ "queryParams": [],
2631
+ "hasBody": true,
2632
+ "auth": "api_key"
2633
+ },
2634
+ {
2635
+ "name": "renderDefinition",
2636
+ "verb": "GET",
2637
+ "path": "/reports/definitions/:reportDefinitionId/render",
2638
+ "pathParams": [
2639
+ "reportDefinitionId"
2640
+ ],
2641
+ "requiredQuery": [
2642
+ "projectId"
2643
+ ],
2644
+ "queryParams": [
2645
+ "periodDays",
2646
+ "projectId"
2647
+ ],
2648
+ "hasBody": false,
2649
+ "auth": "api_key"
2650
+ },
2651
+ {
2652
+ "name": "setWidgets",
2653
+ "verb": "POST",
2654
+ "path": "/reports/definitions/:reportDefinitionId/widgets",
2655
+ "pathParams": [
2656
+ "reportDefinitionId"
2657
+ ],
2658
+ "requiredQuery": [],
2659
+ "queryParams": [],
2660
+ "hasBody": true,
2661
+ "auth": "api_key"
2662
+ },
2663
+ {
2664
+ "name": "upsertSchedule",
2665
+ "verb": "POST",
2666
+ "path": "/reports/definitions/:reportDefinitionId/schedule",
2667
+ "pathParams": [
2668
+ "reportDefinitionId"
2669
+ ],
2670
+ "requiredQuery": [],
2671
+ "queryParams": [],
2672
+ "hasBody": true,
2673
+ "auth": "api_key"
2674
+ }
2675
+ ]
2676
+ },
2677
+ "team": {
2678
+ "methods": [
2679
+ {
2680
+ "name": "listMembers",
2681
+ "verb": "GET",
2682
+ "path": "/team/members",
2683
+ "pathParams": [],
2684
+ "requiredQuery": [],
2685
+ "queryParams": [],
2686
+ "hasBody": false,
2687
+ "auth": "api_key"
2688
+ }
2689
+ ]
2690
+ },
2691
+ "usage": {
2692
+ "methods": [
2693
+ {
2694
+ "name": "get",
2695
+ "verb": "GET",
2696
+ "path": "/usage",
2697
+ "pathParams": [],
2698
+ "requiredQuery": [],
2699
+ "queryParams": [],
2700
+ "hasBody": false,
2701
+ "auth": "api_key"
2702
+ }
2703
+ ]
2704
+ },
2705
+ "webAnalytics": {
2706
+ "methods": [
2707
+ {
2708
+ "name": "devices",
2709
+ "verb": "POST",
2710
+ "path": "/web-analytics/devices",
2711
+ "pathParams": [],
2712
+ "requiredQuery": [],
2713
+ "queryParams": [],
2714
+ "hasBody": true,
2715
+ "auth": "api_key"
2716
+ },
2717
+ {
2718
+ "name": "sources",
2719
+ "verb": "POST",
2720
+ "path": "/web-analytics/sources",
2721
+ "pathParams": [],
2722
+ "requiredQuery": [],
2723
+ "queryParams": [],
2724
+ "hasBody": true,
2725
+ "auth": "api_key"
2726
+ },
2727
+ {
2728
+ "name": "summary",
2729
+ "verb": "POST",
2730
+ "path": "/web-analytics/summary",
2731
+ "pathParams": [],
2732
+ "requiredQuery": [],
2733
+ "queryParams": [],
2734
+ "hasBody": true,
2735
+ "auth": "api_key"
2736
+ },
2737
+ {
2738
+ "name": "topPages",
2739
+ "verb": "POST",
2740
+ "path": "/web-analytics/top-pages",
2741
+ "pathParams": [],
2742
+ "requiredQuery": [],
2743
+ "queryParams": [],
2744
+ "hasBody": true,
2745
+ "auth": "api_key"
2746
+ }
2747
+ ]
2748
+ },
2749
+ "yandex": {
2750
+ "methods": [
2751
+ {
2752
+ "name": "connect",
2753
+ "verb": "GET",
2754
+ "path": "/yandex/connection",
2755
+ "pathParams": [],
2756
+ "requiredQuery": [
2757
+ "projectId"
2758
+ ],
2759
+ "queryParams": [
2760
+ "projectId"
2761
+ ],
2762
+ "hasBody": false,
2763
+ "auth": "api_key"
2764
+ },
2765
+ {
2766
+ "name": "disconnect",
2767
+ "verb": "DELETE",
2768
+ "path": "/yandex/connection",
2769
+ "pathParams": [],
2770
+ "requiredQuery": [],
2771
+ "queryParams": [],
2772
+ "hasBody": true,
2773
+ "auth": "api_key"
2774
+ },
2775
+ {
2776
+ "name": "listHosts",
2777
+ "verb": "GET",
2778
+ "path": "/yandex/hosts",
2779
+ "pathParams": [],
2780
+ "requiredQuery": [
2781
+ "projectId"
2782
+ ],
2783
+ "queryParams": [
2784
+ "projectId"
2785
+ ],
2786
+ "hasBody": false,
2787
+ "auth": "api_key"
2788
+ },
2789
+ {
2790
+ "name": "reindexUrl",
2791
+ "verb": "POST",
2792
+ "path": "/yandex/reindex-url",
2793
+ "pathParams": [],
2794
+ "requiredQuery": [],
2795
+ "queryParams": [],
2796
+ "hasBody": true,
2797
+ "auth": "api_key"
2798
+ },
2799
+ {
2800
+ "name": "setHost",
2801
+ "verb": "POST",
2802
+ "path": "/yandex/connection",
2803
+ "pathParams": [],
2804
+ "requiredQuery": [],
2805
+ "queryParams": [],
2806
+ "hasBody": true,
2807
+ "auth": "api_key"
2808
+ },
2809
+ {
2810
+ "name": "siteOverview",
2811
+ "verb": "POST",
2812
+ "path": "/yandex/site-overview",
2813
+ "pathParams": [],
2814
+ "requiredQuery": [],
2815
+ "queryParams": [],
2816
+ "hasBody": true,
2817
+ "auth": "api_key"
2818
+ }
2819
+ ]
2820
+ }
2821
+ },
2822
+ "streams": {
2823
+ "sse": [
2824
+ {
2825
+ "name": "streamEvents",
2826
+ "resource": "crawl",
2827
+ "verb": "GET",
2828
+ "path": "/crawl/:jobId/stream",
2829
+ "pathParams": [
2830
+ "jobId"
2831
+ ],
2832
+ "requiredQuery": [
2833
+ "projectId"
2834
+ ],
2835
+ "queryParams": [
2836
+ "projectId"
2837
+ ],
2838
+ "terminalEvents": [
2839
+ "complete",
2840
+ "error"
2841
+ ],
2842
+ "auth": "api_key"
2843
+ }
2844
+ ]
2845
+ },
2846
+ "mcp": {
2847
+ "path": "/mcp",
2848
+ "protocolVersion": "2025-06-18"
2849
+ }
2850
+ }