frontmost 0.0.0-stage → 0.6.2

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/openapi.json ADDED
@@ -0,0 +1,4676 @@
1
+ {
2
+ "openapi": "3.1.0",
3
+ "info": {
4
+ "title": "Frontmost AI API",
5
+ "version": "1",
6
+ "description": "Read how AI apps answer your buyers' questions, and change the questions Frontmost AI asks."
7
+ },
8
+ "servers": [
9
+ {
10
+ "url": "https://app.frontmost.ai/api/v1"
11
+ }
12
+ ],
13
+ "components": {
14
+ "schemas": {
15
+ "CreditStatus": {
16
+ "type": "string",
17
+ "enum": [
18
+ "ok",
19
+ "low",
20
+ "out"
21
+ ]
22
+ },
23
+ "Credits": {
24
+ "type": "object",
25
+ "properties": {
26
+ "step": {
27
+ "type": "object",
28
+ "properties": {
29
+ "code": {
30
+ "type": "string"
31
+ },
32
+ "credits": {
33
+ "type": "integer",
34
+ "minimum": -9007199254740991,
35
+ "maximum": 9007199254740991
36
+ },
37
+ "monthly_usd": {
38
+ "type": "string"
39
+ },
40
+ "annual_usd": {
41
+ "type": [
42
+ "string",
43
+ "null"
44
+ ]
45
+ }
46
+ },
47
+ "required": [
48
+ "code",
49
+ "credits",
50
+ "monthly_usd",
51
+ "annual_usd"
52
+ ],
53
+ "additionalProperties": false
54
+ },
55
+ "remaining": {
56
+ "type": "integer",
57
+ "minimum": -9007199254740991,
58
+ "maximum": 9007199254740991,
59
+ "description": "Credits left now: the monthly credits and top-ups, less what running work holds"
60
+ },
61
+ "monthly_remaining": {
62
+ "type": "integer",
63
+ "minimum": -9007199254740991,
64
+ "maximum": 9007199254740991,
65
+ "description": "The part of `remaining` that ends at `cycle_resets_at`"
66
+ },
67
+ "topup_remaining": {
68
+ "type": "integer",
69
+ "minimum": -9007199254740991,
70
+ "maximum": 9007199254740991,
71
+ "description": "The part of `remaining` from top-ups, which last 12 months"
72
+ },
73
+ "cycle_resets_at": {
74
+ "type": [
75
+ "string",
76
+ "null"
77
+ ]
78
+ },
79
+ "projected_monthly_use": {
80
+ "type": "integer",
81
+ "minimum": -9007199254740991,
82
+ "maximum": 9007199254740991,
83
+ "description": "Credits used this cycle plus what the project schedules use before the reset"
84
+ },
85
+ "ask_last_30_days": {
86
+ "type": "integer",
87
+ "minimum": -9007199254740991,
88
+ "maximum": 9007199254740991,
89
+ "description": "Credits Ask used in the last 30 days. Not in `projected_monthly_use`"
90
+ },
91
+ "status": {
92
+ "description": "low: 80% of this cycle's credits are used. out: fewer than 10 left, so no scan can start",
93
+ "$ref": "#/components/schemas/CreditStatus"
94
+ },
95
+ "auto_topup": {
96
+ "type": "object",
97
+ "properties": {
98
+ "enabled": {
99
+ "type": "boolean"
100
+ },
101
+ "monthly_limit_usd": {
102
+ "type": "string"
103
+ },
104
+ "spent_this_cycle_usd": {
105
+ "type": "string"
106
+ }
107
+ },
108
+ "required": [
109
+ "enabled",
110
+ "monthly_limit_usd",
111
+ "spent_this_cycle_usd"
112
+ ],
113
+ "additionalProperties": false,
114
+ "description": "Change it on the Billing page"
115
+ }
116
+ },
117
+ "required": [
118
+ "step",
119
+ "remaining",
120
+ "monthly_remaining",
121
+ "topup_remaining",
122
+ "cycle_resets_at",
123
+ "projected_monthly_use",
124
+ "ask_last_30_days",
125
+ "status",
126
+ "auto_topup"
127
+ ],
128
+ "additionalProperties": false,
129
+ "description": "The workspace's credits"
130
+ },
131
+ "KeyKind": {
132
+ "type": "string",
133
+ "enum": [
134
+ "read",
135
+ "full"
136
+ ]
137
+ },
138
+ "ScanCadence": {
139
+ "type": "string",
140
+ "enum": [
141
+ "daily",
142
+ "weekly",
143
+ "mwf"
144
+ ]
145
+ },
146
+ "Workspace": {
147
+ "type": "object",
148
+ "properties": {
149
+ "object": {
150
+ "type": "string",
151
+ "const": "workspace"
152
+ },
153
+ "id": {
154
+ "type": "string"
155
+ },
156
+ "name": {
157
+ "type": "string"
158
+ },
159
+ "plan": {
160
+ "type": "string"
161
+ },
162
+ "key_kind": {
163
+ "$ref": "#/components/schemas/KeyKind"
164
+ },
165
+ "questions": {
166
+ "type": "object",
167
+ "properties": {
168
+ "used": {
169
+ "type": "integer",
170
+ "minimum": -9007199254740991,
171
+ "maximum": 9007199254740991
172
+ }
173
+ },
174
+ "required": [
175
+ "used"
176
+ ],
177
+ "additionalProperties": false
178
+ },
179
+ "projects": {
180
+ "type": "object",
181
+ "properties": {
182
+ "used": {
183
+ "type": "integer",
184
+ "minimum": -9007199254740991,
185
+ "maximum": 9007199254740991
186
+ },
187
+ "max": {
188
+ "type": "integer",
189
+ "minimum": -9007199254740991,
190
+ "maximum": 9007199254740991
191
+ }
192
+ },
193
+ "required": [
194
+ "used",
195
+ "max"
196
+ ],
197
+ "additionalProperties": false
198
+ },
199
+ "profiles": {
200
+ "type": "object",
201
+ "properties": {
202
+ "max_per_project": {
203
+ "type": "integer",
204
+ "minimum": -9007199254740991,
205
+ "maximum": 9007199254740991
206
+ }
207
+ },
208
+ "required": [
209
+ "max_per_project"
210
+ ],
211
+ "additionalProperties": false
212
+ },
213
+ "apps": {
214
+ "type": "array",
215
+ "items": {
216
+ "type": "string"
217
+ }
218
+ },
219
+ "scanning": {
220
+ "type": "boolean"
221
+ },
222
+ "scan_cadence": {
223
+ "$ref": "#/components/schemas/ScanCadence"
224
+ },
225
+ "credits": {
226
+ "anyOf": [
227
+ {
228
+ "$ref": "#/components/schemas/Credits"
229
+ },
230
+ {
231
+ "type": "null"
232
+ }
233
+ ],
234
+ "description": "Null for a person who sees only some of the workspace's projects"
235
+ }
236
+ },
237
+ "required": [
238
+ "object",
239
+ "id",
240
+ "name",
241
+ "plan",
242
+ "key_kind",
243
+ "questions",
244
+ "projects",
245
+ "profiles",
246
+ "apps",
247
+ "scanning",
248
+ "scan_cadence",
249
+ "credits"
250
+ ],
251
+ "additionalProperties": false
252
+ },
253
+ "ProjectCadence": {
254
+ "type": "string",
255
+ "enum": [
256
+ "daily",
257
+ "mwf",
258
+ "weekly",
259
+ "off"
260
+ ]
261
+ },
262
+ "RunConfigChange": {
263
+ "type": "object",
264
+ "properties": {
265
+ "apps": {
266
+ "description": "The AI apps each scan asks, such as chatgpt and gemini",
267
+ "minItems": 1,
268
+ "maxItems": 12,
269
+ "type": "array",
270
+ "items": {
271
+ "type": "string"
272
+ }
273
+ },
274
+ "cadence": {
275
+ "description": "How often the scans run. mwf is Monday, Wednesday, and Friday. weekly is Monday",
276
+ "$ref": "#/components/schemas/ProjectCadence"
277
+ },
278
+ "weekly_brief": {
279
+ "description": "Write a brief after each Monday scan",
280
+ "type": "boolean"
281
+ }
282
+ },
283
+ "additionalProperties": false,
284
+ "description": "The fields to set. A field left out keeps its value. On a new project, it takes the default: the workspace's `apps`, the workspace's `scan_cadence`, and `weekly_brief` true"
285
+ },
286
+ "RunCost": {
287
+ "type": "object",
288
+ "properties": {
289
+ "rates": {
290
+ "type": "array",
291
+ "items": {
292
+ "type": "object",
293
+ "properties": {
294
+ "app": {
295
+ "type": "string"
296
+ },
297
+ "credits_per_answer": {
298
+ "type": "integer",
299
+ "minimum": -9007199254740991,
300
+ "maximum": 9007199254740991
301
+ }
302
+ },
303
+ "required": [
304
+ "app",
305
+ "credits_per_answer"
306
+ ],
307
+ "additionalProperties": false
308
+ },
309
+ "description": "The credits one answer uses in each AI app, at today's rate"
310
+ },
311
+ "minimum_per_scan": {
312
+ "type": "integer",
313
+ "minimum": -9007199254740991,
314
+ "maximum": 9007199254740991,
315
+ "description": "The fewest credits a scan uses"
316
+ },
317
+ "per_scan": {
318
+ "type": "integer",
319
+ "minimum": -9007199254740991,
320
+ "maximum": 9007199254740991,
321
+ "description": "max(active_questions × the sum of the rates, minimum_per_scan)"
322
+ },
323
+ "scans_per_month": {
324
+ "type": "integer",
325
+ "minimum": -9007199254740991,
326
+ "maximum": 9007199254740991,
327
+ "description": "Scans in the longest month: daily 31, mwf 14, weekly 5, off 0"
328
+ },
329
+ "per_brief": {
330
+ "type": "integer",
331
+ "minimum": -9007199254740991,
332
+ "maximum": 9007199254740991,
333
+ "description": "Credits for one weekly brief"
334
+ },
335
+ "briefs_per_month": {
336
+ "type": "integer",
337
+ "minimum": -9007199254740991,
338
+ "maximum": 9007199254740991,
339
+ "description": "Briefs in the longest month: 5 Mondays when weekly_brief is on and the scans run, else 0"
340
+ },
341
+ "monthly_max": {
342
+ "type": "integer",
343
+ "minimum": -9007199254740991,
344
+ "maximum": 9007199254740991,
345
+ "description": "per_scan × scans_per_month + per_brief × briefs_per_month. The most credits a calendar month uses. Ask is billed per message and is not in it"
346
+ }
347
+ },
348
+ "required": [
349
+ "rates",
350
+ "minimum_per_scan",
351
+ "per_scan",
352
+ "scans_per_month",
353
+ "per_brief",
354
+ "briefs_per_month",
355
+ "monthly_max"
356
+ ],
357
+ "additionalProperties": false,
358
+ "description": "The credits the run config uses. Every number in monthly_max is here"
359
+ },
360
+ "RunConfig": {
361
+ "type": "object",
362
+ "properties": {
363
+ "apps": {
364
+ "type": "array",
365
+ "items": {
366
+ "type": "string"
367
+ },
368
+ "description": "The AI apps each scan asks"
369
+ },
370
+ "cadence": {
371
+ "description": "How often the scans run. mwf is Monday, Wednesday, and Friday. weekly is Monday",
372
+ "$ref": "#/components/schemas/ProjectCadence"
373
+ },
374
+ "weekly_brief": {
375
+ "type": "boolean",
376
+ "description": "Whether a brief is written after each Monday scan"
377
+ },
378
+ "active_questions": {
379
+ "type": "integer",
380
+ "minimum": -9007199254740991,
381
+ "maximum": 9007199254740991,
382
+ "description": "Questions each scan asks. Change them with the questions routes"
383
+ },
384
+ "cost": {
385
+ "$ref": "#/components/schemas/RunCost"
386
+ }
387
+ },
388
+ "required": [
389
+ "apps",
390
+ "cadence",
391
+ "weekly_brief",
392
+ "active_questions",
393
+ "cost"
394
+ ],
395
+ "additionalProperties": false,
396
+ "description": "What the project's scans ask, how often they run, and the credits that uses. Change it with PATCH /projects/{id}"
397
+ },
398
+ "Project": {
399
+ "type": "object",
400
+ "properties": {
401
+ "object": {
402
+ "type": "string",
403
+ "const": "project"
404
+ },
405
+ "id": {
406
+ "type": "string"
407
+ },
408
+ "name": {
409
+ "type": "string"
410
+ },
411
+ "domain": {
412
+ "type": [
413
+ "string",
414
+ "null"
415
+ ]
416
+ },
417
+ "run_config": {
418
+ "$ref": "#/components/schemas/RunConfig"
419
+ },
420
+ "apps": {
421
+ "type": "array",
422
+ "items": {
423
+ "type": "string"
424
+ },
425
+ "description": "Older field. The same as run_config.apps",
426
+ "deprecated": true
427
+ },
428
+ "scanning": {
429
+ "type": "boolean",
430
+ "description": "Older field. True when run_config.cadence is not off",
431
+ "deprecated": true
432
+ },
433
+ "cadence": {
434
+ "type": "string",
435
+ "enum": [
436
+ "daily",
437
+ "mwf",
438
+ "weekly",
439
+ "off"
440
+ ],
441
+ "description": "Older field. The same as run_config.cadence",
442
+ "deprecated": true,
443
+ "$ref": "#/components/schemas/ProjectCadence"
444
+ },
445
+ "weekly_brief": {
446
+ "type": "boolean",
447
+ "description": "Older field. The same as run_config.weekly_brief",
448
+ "deprecated": true
449
+ },
450
+ "created_at": {
451
+ "type": [
452
+ "string",
453
+ "null"
454
+ ]
455
+ },
456
+ "url": {
457
+ "type": "string"
458
+ }
459
+ },
460
+ "required": [
461
+ "object",
462
+ "id",
463
+ "name",
464
+ "domain",
465
+ "run_config",
466
+ "apps",
467
+ "scanning",
468
+ "cadence",
469
+ "weekly_brief",
470
+ "created_at",
471
+ "url"
472
+ ],
473
+ "additionalProperties": false
474
+ },
475
+ "Question": {
476
+ "type": "object",
477
+ "properties": {
478
+ "object": {
479
+ "type": "string",
480
+ "const": "question"
481
+ },
482
+ "id": {
483
+ "type": "string"
484
+ },
485
+ "text": {
486
+ "type": "string"
487
+ },
488
+ "topic": {
489
+ "type": [
490
+ "string",
491
+ "null"
492
+ ]
493
+ },
494
+ "active": {
495
+ "type": "boolean"
496
+ },
497
+ "is_branded": {
498
+ "description": "Null while Frontmost AI has not decided whether the question names the brand",
499
+ "type": [
500
+ "boolean",
501
+ "null"
502
+ ]
503
+ },
504
+ "profile_id": {
505
+ "type": [
506
+ "string",
507
+ "null"
508
+ ]
509
+ }
510
+ },
511
+ "required": [
512
+ "object",
513
+ "id",
514
+ "text",
515
+ "topic",
516
+ "active",
517
+ "is_branded",
518
+ "profile_id"
519
+ ],
520
+ "additionalProperties": false
521
+ },
522
+ "ProjectList": {
523
+ "type": "object",
524
+ "properties": {
525
+ "object": {
526
+ "type": "string",
527
+ "const": "list"
528
+ },
529
+ "data": {
530
+ "type": "array",
531
+ "items": {
532
+ "$ref": "#/components/schemas/Project"
533
+ }
534
+ },
535
+ "has_more": {
536
+ "type": "boolean"
537
+ },
538
+ "next_cursor": {
539
+ "type": [
540
+ "string",
541
+ "null"
542
+ ]
543
+ }
544
+ },
545
+ "required": [
546
+ "object",
547
+ "data",
548
+ "has_more",
549
+ "next_cursor"
550
+ ],
551
+ "additionalProperties": false
552
+ },
553
+ "QuestionList": {
554
+ "type": "object",
555
+ "properties": {
556
+ "object": {
557
+ "type": "string",
558
+ "const": "list"
559
+ },
560
+ "data": {
561
+ "type": "array",
562
+ "items": {
563
+ "$ref": "#/components/schemas/Question"
564
+ }
565
+ },
566
+ "has_more": {
567
+ "type": "boolean"
568
+ },
569
+ "next_cursor": {
570
+ "type": [
571
+ "string",
572
+ "null"
573
+ ]
574
+ }
575
+ },
576
+ "required": [
577
+ "object",
578
+ "data",
579
+ "has_more",
580
+ "next_cursor"
581
+ ],
582
+ "additionalProperties": false
583
+ },
584
+ "ScanStatus": {
585
+ "type": "string",
586
+ "enum": [
587
+ "done",
588
+ "partial"
589
+ ]
590
+ },
591
+ "Scan": {
592
+ "type": "object",
593
+ "properties": {
594
+ "object": {
595
+ "type": "string",
596
+ "const": "scan"
597
+ },
598
+ "id": {
599
+ "type": "string"
600
+ },
601
+ "status": {
602
+ "description": "partial: some answers failed, and the scan counts the answers it has",
603
+ "$ref": "#/components/schemas/ScanStatus"
604
+ },
605
+ "delivered_at": {
606
+ "type": [
607
+ "string",
608
+ "null"
609
+ ]
610
+ },
611
+ "url": {
612
+ "type": "string"
613
+ }
614
+ },
615
+ "required": [
616
+ "object",
617
+ "id",
618
+ "status",
619
+ "delivered_at",
620
+ "url"
621
+ ],
622
+ "additionalProperties": false
623
+ },
624
+ "ProjectSetup": {
625
+ "type": "object",
626
+ "properties": {
627
+ "object": {
628
+ "type": "string",
629
+ "const": "project_setup"
630
+ },
631
+ "id": {
632
+ "type": "string"
633
+ },
634
+ "status": {
635
+ "type": "string",
636
+ "const": "drafting"
637
+ },
638
+ "domain": {
639
+ "type": [
640
+ "string",
641
+ "null"
642
+ ]
643
+ },
644
+ "retry_after": {
645
+ "type": "integer",
646
+ "minimum": -9007199254740991,
647
+ "maximum": 9007199254740991,
648
+ "description": "Seconds to wait before sending `next`"
649
+ },
650
+ "next": {
651
+ "type": "object",
652
+ "properties": {
653
+ "method": {
654
+ "type": "string",
655
+ "const": "POST"
656
+ },
657
+ "path": {
658
+ "type": "string"
659
+ },
660
+ "body": {
661
+ "type": "object",
662
+ "properties": {
663
+ "setup_id": {
664
+ "type": "string"
665
+ },
666
+ "run_config": {
667
+ "description": "The run_config you sent. Nothing keeps it between calls",
668
+ "$ref": "#/components/schemas/RunConfigChange"
669
+ }
670
+ },
671
+ "required": [
672
+ "setup_id"
673
+ ],
674
+ "additionalProperties": false
675
+ }
676
+ },
677
+ "required": [
678
+ "method",
679
+ "path",
680
+ "body"
681
+ ],
682
+ "additionalProperties": false
683
+ }
684
+ },
685
+ "required": [
686
+ "object",
687
+ "id",
688
+ "status",
689
+ "domain",
690
+ "retry_after",
691
+ "next"
692
+ ],
693
+ "additionalProperties": false,
694
+ "description": "The site read is still running. Send `next` after `retry_after` seconds."
695
+ },
696
+ "Rate": {
697
+ "type": "object",
698
+ "properties": {
699
+ "value": {
700
+ "description": "numerator / denominator, from 0 to 1. Null with no answers",
701
+ "type": [
702
+ "number",
703
+ "null"
704
+ ]
705
+ },
706
+ "numerator": {
707
+ "type": "integer",
708
+ "minimum": -9007199254740991,
709
+ "maximum": 9007199254740991
710
+ },
711
+ "denominator": {
712
+ "type": "integer",
713
+ "minimum": -9007199254740991,
714
+ "maximum": 9007199254740991
715
+ },
716
+ "previous": {
717
+ "description": "The same rate in the comparison period. Null with no comparison",
718
+ "type": [
719
+ "number",
720
+ "null"
721
+ ]
722
+ }
723
+ },
724
+ "required": [
725
+ "value",
726
+ "numerator",
727
+ "denominator",
728
+ "previous"
729
+ ],
730
+ "additionalProperties": false,
731
+ "description": "A rate with its counts, such as 8 of 36 answers"
732
+ },
733
+ "Position": {
734
+ "type": "object",
735
+ "properties": {
736
+ "value": {
737
+ "type": [
738
+ "number",
739
+ "null"
740
+ ]
741
+ },
742
+ "answers": {
743
+ "type": "integer",
744
+ "minimum": -9007199254740991,
745
+ "maximum": 9007199254740991
746
+ },
747
+ "previous": {
748
+ "type": [
749
+ "number",
750
+ "null"
751
+ ]
752
+ }
753
+ },
754
+ "required": [
755
+ "value",
756
+ "answers",
757
+ "previous"
758
+ ],
759
+ "additionalProperties": false,
760
+ "description": "The average first-mention place over `answers` answers with a known place. 1 is first"
761
+ },
762
+ "Figures": {
763
+ "type": "object",
764
+ "properties": {
765
+ "visibility": {
766
+ "$ref": "#/components/schemas/Rate"
767
+ },
768
+ "win_rate": {
769
+ "$ref": "#/components/schemas/Rate"
770
+ },
771
+ "position": {
772
+ "$ref": "#/components/schemas/Position"
773
+ },
774
+ "sentiment": {
775
+ "anyOf": [
776
+ {
777
+ "$ref": "#/components/schemas/Rate"
778
+ },
779
+ {
780
+ "type": "null"
781
+ }
782
+ ],
783
+ "description": "Positive statements over classified statements. Null before Sentiment existed"
784
+ }
785
+ },
786
+ "required": [
787
+ "visibility",
788
+ "win_rate",
789
+ "position",
790
+ "sentiment"
791
+ ],
792
+ "additionalProperties": false
793
+ },
794
+ "Period": {
795
+ "type": "string",
796
+ "enum": [
797
+ "scan",
798
+ "week",
799
+ "month"
800
+ ]
801
+ },
802
+ "QuestionSet": {
803
+ "type": "string",
804
+ "enum": [
805
+ "all",
806
+ "branded",
807
+ "unbranded"
808
+ ]
809
+ },
810
+ "Scope": {
811
+ "type": "object",
812
+ "properties": {
813
+ "scan_id": {
814
+ "type": "string"
815
+ },
816
+ "period": {
817
+ "type": "object",
818
+ "properties": {
819
+ "name": {
820
+ "$ref": "#/components/schemas/Period"
821
+ },
822
+ "start": {
823
+ "type": "string"
824
+ },
825
+ "end": {
826
+ "type": "string"
827
+ }
828
+ },
829
+ "required": [
830
+ "name",
831
+ "start",
832
+ "end"
833
+ ],
834
+ "additionalProperties": false
835
+ },
836
+ "scans_counted": {
837
+ "type": "integer",
838
+ "minimum": -9007199254740991,
839
+ "maximum": 9007199254740991
840
+ },
841
+ "apps": {
842
+ "type": "array",
843
+ "items": {
844
+ "type": "string"
845
+ }
846
+ },
847
+ "questions": {
848
+ "$ref": "#/components/schemas/QuestionSet"
849
+ },
850
+ "compare_to": {
851
+ "anyOf": [
852
+ {
853
+ "type": "object",
854
+ "properties": {
855
+ "kind": {
856
+ "type": "string",
857
+ "const": "previous"
858
+ },
859
+ "start": {
860
+ "type": "string"
861
+ },
862
+ "end": {
863
+ "type": "string"
864
+ }
865
+ },
866
+ "required": [
867
+ "kind",
868
+ "start",
869
+ "end"
870
+ ],
871
+ "additionalProperties": false
872
+ },
873
+ {
874
+ "type": "null"
875
+ }
876
+ ]
877
+ },
878
+ "definitions_version": {
879
+ "type": "string",
880
+ "description": "Changes when a counting rule changes"
881
+ }
882
+ },
883
+ "required": [
884
+ "scan_id",
885
+ "period",
886
+ "scans_counted",
887
+ "apps",
888
+ "questions",
889
+ "compare_to",
890
+ "definitions_version"
891
+ ],
892
+ "additionalProperties": false,
893
+ "description": "What the numbers count"
894
+ },
895
+ "MetricsGroup": {
896
+ "type": "object",
897
+ "properties": {
898
+ "app": {
899
+ "description": "With group_by=app",
900
+ "type": "string"
901
+ },
902
+ "scan_id": {
903
+ "description": "With group_by=scan",
904
+ "type": "string"
905
+ },
906
+ "delivered_at": {
907
+ "description": "With group_by=scan",
908
+ "type": [
909
+ "string",
910
+ "null"
911
+ ]
912
+ },
913
+ "visibility": {
914
+ "$ref": "#/components/schemas/Rate"
915
+ },
916
+ "win_rate": {
917
+ "$ref": "#/components/schemas/Rate"
918
+ },
919
+ "position": {
920
+ "$ref": "#/components/schemas/Position"
921
+ },
922
+ "sentiment": {
923
+ "anyOf": [
924
+ {
925
+ "$ref": "#/components/schemas/Rate"
926
+ },
927
+ {
928
+ "type": "null"
929
+ }
930
+ ],
931
+ "description": "Positive statements over classified statements. Null before Sentiment existed"
932
+ }
933
+ },
934
+ "required": [
935
+ "visibility",
936
+ "win_rate",
937
+ "position",
938
+ "sentiment"
939
+ ],
940
+ "additionalProperties": false
941
+ },
942
+ "Metrics": {
943
+ "type": "object",
944
+ "properties": {
945
+ "object": {
946
+ "type": "string",
947
+ "const": "metrics"
948
+ },
949
+ "scope": {
950
+ "anyOf": [
951
+ {
952
+ "$ref": "#/components/schemas/Scope"
953
+ },
954
+ {
955
+ "type": "null"
956
+ }
957
+ ]
958
+ },
959
+ "totals": {
960
+ "anyOf": [
961
+ {
962
+ "$ref": "#/components/schemas/Figures"
963
+ },
964
+ {
965
+ "type": "null"
966
+ }
967
+ ]
968
+ },
969
+ "groups": {
970
+ "description": "With group_by",
971
+ "type": "array",
972
+ "items": {
973
+ "$ref": "#/components/schemas/MetricsGroup"
974
+ }
975
+ },
976
+ "message": {
977
+ "description": "Why scope and totals are null",
978
+ "type": "string"
979
+ }
980
+ },
981
+ "required": [
982
+ "object",
983
+ "scope",
984
+ "totals"
985
+ ],
986
+ "additionalProperties": false
987
+ },
988
+ "Rival": {
989
+ "type": "object",
990
+ "properties": {
991
+ "object": {
992
+ "type": "string",
993
+ "const": "rival"
994
+ },
995
+ "id": {
996
+ "type": "string"
997
+ },
998
+ "name": {
999
+ "type": "string"
1000
+ },
1001
+ "domain": {
1002
+ "type": [
1003
+ "string",
1004
+ "null"
1005
+ ]
1006
+ },
1007
+ "visibility": {
1008
+ "$ref": "#/components/schemas/Rate"
1009
+ },
1010
+ "win_rate": {
1011
+ "$ref": "#/components/schemas/Rate"
1012
+ },
1013
+ "named_instead_of_you": {
1014
+ "type": "integer",
1015
+ "minimum": -9007199254740991,
1016
+ "maximum": 9007199254740991,
1017
+ "description": "Answers that named this rival and not you"
1018
+ },
1019
+ "average_position": {
1020
+ "type": [
1021
+ "number",
1022
+ "null"
1023
+ ]
1024
+ },
1025
+ "share_of_voice": {
1026
+ "$ref": "#/components/schemas/Rate"
1027
+ }
1028
+ },
1029
+ "required": [
1030
+ "object",
1031
+ "id",
1032
+ "name",
1033
+ "domain",
1034
+ "visibility",
1035
+ "win_rate",
1036
+ "named_instead_of_you",
1037
+ "average_position",
1038
+ "share_of_voice"
1039
+ ],
1040
+ "additionalProperties": false
1041
+ },
1042
+ "Channel": {
1043
+ "type": "string",
1044
+ "enum": [
1045
+ "own_website",
1046
+ "competitor_sites",
1047
+ "editorial",
1048
+ "review_sites",
1049
+ "reddit",
1050
+ "youtube",
1051
+ "linkedin",
1052
+ "forums",
1053
+ "directories",
1054
+ "reference",
1055
+ "company_sites",
1056
+ "other"
1057
+ ]
1058
+ },
1059
+ "Source": {
1060
+ "type": "object",
1061
+ "properties": {
1062
+ "object": {
1063
+ "type": "string",
1064
+ "const": "source"
1065
+ },
1066
+ "domain": {
1067
+ "type": "string"
1068
+ },
1069
+ "citations": {
1070
+ "type": "integer",
1071
+ "minimum": -9007199254740991,
1072
+ "maximum": 9007199254740991
1073
+ },
1074
+ "answers": {
1075
+ "$ref": "#/components/schemas/Rate"
1076
+ },
1077
+ "own_site": {
1078
+ "type": "boolean"
1079
+ },
1080
+ "channel": {
1081
+ "anyOf": [
1082
+ {
1083
+ "$ref": "#/components/schemas/Channel"
1084
+ },
1085
+ {
1086
+ "type": "null"
1087
+ }
1088
+ ]
1089
+ },
1090
+ "named_you": {
1091
+ "type": "integer",
1092
+ "minimum": -9007199254740991,
1093
+ "maximum": 9007199254740991,
1094
+ "description": "Answers that cited this site and named you"
1095
+ }
1096
+ },
1097
+ "required": [
1098
+ "object",
1099
+ "domain",
1100
+ "citations",
1101
+ "answers",
1102
+ "own_site",
1103
+ "channel",
1104
+ "named_you"
1105
+ ],
1106
+ "additionalProperties": false
1107
+ },
1108
+ "AnswerStatus": {
1109
+ "type": "string",
1110
+ "enum": [
1111
+ "queued",
1112
+ "running",
1113
+ "ok",
1114
+ "no_answer",
1115
+ "failed"
1116
+ ]
1117
+ },
1118
+ "Sentiment": {
1119
+ "type": "string",
1120
+ "enum": [
1121
+ "positive",
1122
+ "neutral",
1123
+ "mixed",
1124
+ "negative"
1125
+ ]
1126
+ },
1127
+ "AnswerSummary": {
1128
+ "type": "object",
1129
+ "properties": {
1130
+ "object": {
1131
+ "type": "string",
1132
+ "const": "answer"
1133
+ },
1134
+ "id": {
1135
+ "type": "string"
1136
+ },
1137
+ "scan_id": {
1138
+ "type": "string"
1139
+ },
1140
+ "app": {
1141
+ "type": "string"
1142
+ },
1143
+ "status": {
1144
+ "$ref": "#/components/schemas/AnswerStatus"
1145
+ },
1146
+ "question": {
1147
+ "type": "object",
1148
+ "properties": {
1149
+ "id": {
1150
+ "type": "string"
1151
+ },
1152
+ "text": {
1153
+ "type": "string"
1154
+ }
1155
+ },
1156
+ "required": [
1157
+ "id",
1158
+ "text"
1159
+ ],
1160
+ "additionalProperties": false
1161
+ },
1162
+ "named": {
1163
+ "description": "Whether the answer named you. Null unless status is ok",
1164
+ "type": [
1165
+ "boolean",
1166
+ "null"
1167
+ ]
1168
+ },
1169
+ "position": {
1170
+ "type": [
1171
+ "number",
1172
+ "null"
1173
+ ]
1174
+ },
1175
+ "sentiment": {
1176
+ "anyOf": [
1177
+ {
1178
+ "$ref": "#/components/schemas/Sentiment"
1179
+ },
1180
+ {
1181
+ "type": "null"
1182
+ }
1183
+ ]
1184
+ },
1185
+ "asked_at": {
1186
+ "type": [
1187
+ "string",
1188
+ "null"
1189
+ ]
1190
+ },
1191
+ "url": {
1192
+ "type": "string"
1193
+ }
1194
+ },
1195
+ "required": [
1196
+ "object",
1197
+ "id",
1198
+ "scan_id",
1199
+ "app",
1200
+ "status",
1201
+ "question",
1202
+ "named",
1203
+ "position",
1204
+ "sentiment",
1205
+ "asked_at",
1206
+ "url"
1207
+ ],
1208
+ "additionalProperties": false,
1209
+ "description": "One answer without its text. Get the answer to read it"
1210
+ },
1211
+ "Answer": {
1212
+ "type": "object",
1213
+ "properties": {
1214
+ "object": {
1215
+ "type": "string",
1216
+ "const": "answer"
1217
+ },
1218
+ "id": {
1219
+ "type": "string"
1220
+ },
1221
+ "project_id": {
1222
+ "type": "string"
1223
+ },
1224
+ "scan_id": {
1225
+ "type": "string"
1226
+ },
1227
+ "app": {
1228
+ "type": "string"
1229
+ },
1230
+ "status": {
1231
+ "$ref": "#/components/schemas/AnswerStatus"
1232
+ },
1233
+ "question": {
1234
+ "type": "object",
1235
+ "properties": {
1236
+ "id": {
1237
+ "type": [
1238
+ "string",
1239
+ "null"
1240
+ ]
1241
+ },
1242
+ "text": {
1243
+ "type": "string"
1244
+ }
1245
+ },
1246
+ "required": [
1247
+ "id",
1248
+ "text"
1249
+ ],
1250
+ "additionalProperties": false
1251
+ },
1252
+ "named": {
1253
+ "type": [
1254
+ "boolean",
1255
+ "null"
1256
+ ]
1257
+ },
1258
+ "position": {
1259
+ "type": [
1260
+ "number",
1261
+ "null"
1262
+ ]
1263
+ },
1264
+ "sentiment": {
1265
+ "anyOf": [
1266
+ {
1267
+ "$ref": "#/components/schemas/Sentiment"
1268
+ },
1269
+ {
1270
+ "type": "null"
1271
+ }
1272
+ ]
1273
+ },
1274
+ "asked_at": {
1275
+ "type": [
1276
+ "string",
1277
+ "null"
1278
+ ]
1279
+ },
1280
+ "text": {
1281
+ "type": [
1282
+ "string",
1283
+ "null"
1284
+ ]
1285
+ },
1286
+ "mentions": {
1287
+ "type": "array",
1288
+ "items": {
1289
+ "type": "object",
1290
+ "properties": {
1291
+ "name": {
1292
+ "type": "string"
1293
+ },
1294
+ "rival_id": {
1295
+ "type": [
1296
+ "string",
1297
+ "null"
1298
+ ]
1299
+ },
1300
+ "you": {
1301
+ "type": "boolean"
1302
+ },
1303
+ "position": {
1304
+ "type": "integer",
1305
+ "minimum": -9007199254740991,
1306
+ "maximum": 9007199254740991
1307
+ }
1308
+ },
1309
+ "required": [
1310
+ "name",
1311
+ "rival_id",
1312
+ "you",
1313
+ "position"
1314
+ ],
1315
+ "additionalProperties": false
1316
+ },
1317
+ "description": "Each business once, in order of first mention"
1318
+ },
1319
+ "citations": {
1320
+ "type": "array",
1321
+ "items": {
1322
+ "type": "object",
1323
+ "properties": {
1324
+ "url": {
1325
+ "type": "string"
1326
+ },
1327
+ "domain": {
1328
+ "type": "string"
1329
+ },
1330
+ "own_site": {
1331
+ "type": "boolean"
1332
+ }
1333
+ },
1334
+ "required": [
1335
+ "url",
1336
+ "domain",
1337
+ "own_site"
1338
+ ],
1339
+ "additionalProperties": false
1340
+ }
1341
+ },
1342
+ "url": {
1343
+ "type": "string"
1344
+ }
1345
+ },
1346
+ "required": [
1347
+ "object",
1348
+ "id",
1349
+ "project_id",
1350
+ "scan_id",
1351
+ "app",
1352
+ "status",
1353
+ "question",
1354
+ "named",
1355
+ "position",
1356
+ "sentiment",
1357
+ "asked_at",
1358
+ "text",
1359
+ "mentions",
1360
+ "citations",
1361
+ "url"
1362
+ ],
1363
+ "additionalProperties": false
1364
+ },
1365
+ "RecommendationStatus": {
1366
+ "type": "string",
1367
+ "enum": [
1368
+ "open",
1369
+ "done",
1370
+ "dismissed"
1371
+ ]
1372
+ },
1373
+ "Recommendation": {
1374
+ "type": "object",
1375
+ "properties": {
1376
+ "object": {
1377
+ "type": "string",
1378
+ "const": "recommendation"
1379
+ },
1380
+ "id": {
1381
+ "type": "string"
1382
+ },
1383
+ "title": {
1384
+ "type": "string"
1385
+ },
1386
+ "action": {
1387
+ "type": "string"
1388
+ },
1389
+ "why": {
1390
+ "type": "string"
1391
+ },
1392
+ "evidence": {
1393
+ "type": "string"
1394
+ },
1395
+ "evidence_url": {
1396
+ "type": [
1397
+ "string",
1398
+ "null"
1399
+ ]
1400
+ },
1401
+ "start_url": {
1402
+ "type": [
1403
+ "string",
1404
+ "null"
1405
+ ]
1406
+ },
1407
+ "status": {
1408
+ "$ref": "#/components/schemas/RecommendationStatus"
1409
+ },
1410
+ "result": {
1411
+ "description": "After it is marked done: whether the site names you now",
1412
+ "type": [
1413
+ "string",
1414
+ "null"
1415
+ ]
1416
+ },
1417
+ "url": {
1418
+ "type": "string"
1419
+ }
1420
+ },
1421
+ "required": [
1422
+ "object",
1423
+ "id",
1424
+ "title",
1425
+ "action",
1426
+ "why",
1427
+ "evidence",
1428
+ "evidence_url",
1429
+ "start_url",
1430
+ "status",
1431
+ "result",
1432
+ "url"
1433
+ ],
1434
+ "additionalProperties": false
1435
+ },
1436
+ "Profile": {
1437
+ "type": "object",
1438
+ "properties": {
1439
+ "object": {
1440
+ "type": "string",
1441
+ "const": "profile"
1442
+ },
1443
+ "id": {
1444
+ "type": "string"
1445
+ },
1446
+ "project_id": {
1447
+ "type": "string"
1448
+ },
1449
+ "name": {
1450
+ "type": "string"
1451
+ },
1452
+ "who": {
1453
+ "type": "string"
1454
+ }
1455
+ },
1456
+ "required": [
1457
+ "object",
1458
+ "id",
1459
+ "project_id",
1460
+ "name",
1461
+ "who"
1462
+ ],
1463
+ "additionalProperties": false
1464
+ },
1465
+ "AddedQuestion": {
1466
+ "type": "object",
1467
+ "properties": {
1468
+ "object": {
1469
+ "type": "string",
1470
+ "const": "question"
1471
+ },
1472
+ "id": {
1473
+ "type": "string"
1474
+ },
1475
+ "text": {
1476
+ "type": "string"
1477
+ },
1478
+ "topic": {
1479
+ "type": [
1480
+ "string",
1481
+ "null"
1482
+ ]
1483
+ },
1484
+ "active": {
1485
+ "type": "boolean"
1486
+ },
1487
+ "is_branded": {
1488
+ "description": "Null while Frontmost AI has not decided whether the question names the brand",
1489
+ "type": [
1490
+ "boolean",
1491
+ "null"
1492
+ ]
1493
+ },
1494
+ "profile_id": {
1495
+ "type": [
1496
+ "string",
1497
+ "null"
1498
+ ]
1499
+ },
1500
+ "created": {
1501
+ "type": "boolean",
1502
+ "description": "False when the project already had this question"
1503
+ }
1504
+ },
1505
+ "required": [
1506
+ "object",
1507
+ "id",
1508
+ "text",
1509
+ "topic",
1510
+ "active",
1511
+ "is_branded",
1512
+ "profile_id",
1513
+ "created"
1514
+ ],
1515
+ "additionalProperties": false
1516
+ },
1517
+ "ScanList": {
1518
+ "type": "object",
1519
+ "properties": {
1520
+ "object": {
1521
+ "type": "string",
1522
+ "const": "list"
1523
+ },
1524
+ "data": {
1525
+ "type": "array",
1526
+ "items": {
1527
+ "$ref": "#/components/schemas/Scan"
1528
+ }
1529
+ },
1530
+ "has_more": {
1531
+ "type": "boolean"
1532
+ },
1533
+ "next_cursor": {
1534
+ "type": [
1535
+ "string",
1536
+ "null"
1537
+ ]
1538
+ }
1539
+ },
1540
+ "required": [
1541
+ "object",
1542
+ "data",
1543
+ "has_more",
1544
+ "next_cursor"
1545
+ ],
1546
+ "additionalProperties": false
1547
+ },
1548
+ "RivalList": {
1549
+ "type": "object",
1550
+ "properties": {
1551
+ "object": {
1552
+ "type": "string",
1553
+ "const": "list"
1554
+ },
1555
+ "data": {
1556
+ "type": "array",
1557
+ "items": {
1558
+ "$ref": "#/components/schemas/Rival"
1559
+ }
1560
+ },
1561
+ "has_more": {
1562
+ "type": "boolean"
1563
+ },
1564
+ "next_cursor": {
1565
+ "type": [
1566
+ "string",
1567
+ "null"
1568
+ ]
1569
+ },
1570
+ "scope": {
1571
+ "anyOf": [
1572
+ {
1573
+ "$ref": "#/components/schemas/Scope"
1574
+ },
1575
+ {
1576
+ "type": "null"
1577
+ }
1578
+ ]
1579
+ },
1580
+ "message": {
1581
+ "description": "Why the list is empty",
1582
+ "type": "string"
1583
+ }
1584
+ },
1585
+ "required": [
1586
+ "object",
1587
+ "data",
1588
+ "has_more",
1589
+ "next_cursor",
1590
+ "scope"
1591
+ ],
1592
+ "additionalProperties": false
1593
+ },
1594
+ "SourceList": {
1595
+ "type": "object",
1596
+ "properties": {
1597
+ "object": {
1598
+ "type": "string",
1599
+ "const": "list"
1600
+ },
1601
+ "data": {
1602
+ "type": "array",
1603
+ "items": {
1604
+ "$ref": "#/components/schemas/Source"
1605
+ }
1606
+ },
1607
+ "has_more": {
1608
+ "type": "boolean"
1609
+ },
1610
+ "next_cursor": {
1611
+ "type": [
1612
+ "string",
1613
+ "null"
1614
+ ]
1615
+ },
1616
+ "scope": {
1617
+ "anyOf": [
1618
+ {
1619
+ "$ref": "#/components/schemas/Scope"
1620
+ },
1621
+ {
1622
+ "type": "null"
1623
+ }
1624
+ ]
1625
+ },
1626
+ "message": {
1627
+ "description": "Why the list is empty",
1628
+ "type": "string"
1629
+ }
1630
+ },
1631
+ "required": [
1632
+ "object",
1633
+ "data",
1634
+ "has_more",
1635
+ "next_cursor",
1636
+ "scope"
1637
+ ],
1638
+ "additionalProperties": false
1639
+ },
1640
+ "AnswerList": {
1641
+ "type": "object",
1642
+ "properties": {
1643
+ "object": {
1644
+ "type": "string",
1645
+ "const": "list"
1646
+ },
1647
+ "data": {
1648
+ "type": "array",
1649
+ "items": {
1650
+ "$ref": "#/components/schemas/AnswerSummary"
1651
+ }
1652
+ },
1653
+ "has_more": {
1654
+ "type": "boolean"
1655
+ },
1656
+ "next_cursor": {
1657
+ "type": [
1658
+ "string",
1659
+ "null"
1660
+ ]
1661
+ },
1662
+ "scope": {
1663
+ "anyOf": [
1664
+ {
1665
+ "$ref": "#/components/schemas/Scope"
1666
+ },
1667
+ {
1668
+ "type": "null"
1669
+ }
1670
+ ]
1671
+ },
1672
+ "message": {
1673
+ "description": "Why the list is empty",
1674
+ "type": "string"
1675
+ }
1676
+ },
1677
+ "required": [
1678
+ "object",
1679
+ "data",
1680
+ "has_more",
1681
+ "next_cursor",
1682
+ "scope"
1683
+ ],
1684
+ "additionalProperties": false
1685
+ },
1686
+ "RecommendationList": {
1687
+ "type": "object",
1688
+ "properties": {
1689
+ "object": {
1690
+ "type": "string",
1691
+ "const": "list"
1692
+ },
1693
+ "data": {
1694
+ "type": "array",
1695
+ "items": {
1696
+ "$ref": "#/components/schemas/Recommendation"
1697
+ }
1698
+ },
1699
+ "has_more": {
1700
+ "type": "boolean"
1701
+ },
1702
+ "next_cursor": {
1703
+ "type": [
1704
+ "string",
1705
+ "null"
1706
+ ]
1707
+ }
1708
+ },
1709
+ "required": [
1710
+ "object",
1711
+ "data",
1712
+ "has_more",
1713
+ "next_cursor"
1714
+ ],
1715
+ "additionalProperties": false
1716
+ },
1717
+ "ProfileList": {
1718
+ "type": "object",
1719
+ "properties": {
1720
+ "object": {
1721
+ "type": "string",
1722
+ "const": "list"
1723
+ },
1724
+ "data": {
1725
+ "type": "array",
1726
+ "items": {
1727
+ "$ref": "#/components/schemas/Profile"
1728
+ }
1729
+ },
1730
+ "has_more": {
1731
+ "type": "boolean"
1732
+ },
1733
+ "next_cursor": {
1734
+ "type": [
1735
+ "string",
1736
+ "null"
1737
+ ]
1738
+ }
1739
+ },
1740
+ "required": [
1741
+ "object",
1742
+ "data",
1743
+ "has_more",
1744
+ "next_cursor"
1745
+ ],
1746
+ "additionalProperties": false
1747
+ },
1748
+ "AddedQuestionList": {
1749
+ "type": "object",
1750
+ "properties": {
1751
+ "object": {
1752
+ "type": "string",
1753
+ "const": "list"
1754
+ },
1755
+ "data": {
1756
+ "type": "array",
1757
+ "items": {
1758
+ "$ref": "#/components/schemas/AddedQuestion"
1759
+ }
1760
+ },
1761
+ "has_more": {
1762
+ "type": "boolean"
1763
+ },
1764
+ "next_cursor": {
1765
+ "type": [
1766
+ "string",
1767
+ "null"
1768
+ ]
1769
+ }
1770
+ },
1771
+ "required": [
1772
+ "object",
1773
+ "data",
1774
+ "has_more",
1775
+ "next_cursor"
1776
+ ],
1777
+ "additionalProperties": false
1778
+ }
1779
+ },
1780
+ "securitySchemes": {
1781
+ "bearer": {
1782
+ "type": "http",
1783
+ "scheme": "bearer",
1784
+ "description": "A workspace API key (fmk_…) from the Team page, or an OAuth access token for this API."
1785
+ }
1786
+ }
1787
+ },
1788
+ "paths": {
1789
+ "/workspace": {
1790
+ "get": {
1791
+ "summary": "The workspace's plan, limits, and use",
1792
+ "operationId": "workspace.get",
1793
+ "tags": [
1794
+ "workspace"
1795
+ ],
1796
+ "security": [
1797
+ {
1798
+ "bearer": []
1799
+ }
1800
+ ],
1801
+ "parameters": [],
1802
+ "responses": {
1803
+ "200": {
1804
+ "description": "OK",
1805
+ "content": {
1806
+ "application/json": {
1807
+ "schema": {
1808
+ "$ref": "#/components/schemas/Workspace"
1809
+ }
1810
+ }
1811
+ }
1812
+ },
1813
+ "default": {
1814
+ "description": "Error",
1815
+ "content": {
1816
+ "application/json": {
1817
+ "schema": {
1818
+ "type": "object",
1819
+ "required": [
1820
+ "error"
1821
+ ],
1822
+ "properties": {
1823
+ "error": {
1824
+ "type": "object",
1825
+ "required": [
1826
+ "code",
1827
+ "message",
1828
+ "param",
1829
+ "request_id"
1830
+ ],
1831
+ "properties": {
1832
+ "code": {
1833
+ "type": "string",
1834
+ "enum": [
1835
+ "invalid_key",
1836
+ "key_revoked",
1837
+ "plan_no_api",
1838
+ "needs_plan",
1839
+ "key_read_only",
1840
+ "not_found",
1841
+ "idempotency_conflict",
1842
+ "request_in_progress",
1843
+ "invalid_param",
1844
+ "invalid_cursor",
1845
+ "no_credits",
1846
+ "project_limit",
1847
+ "profile_limit",
1848
+ "site_unreadable",
1849
+ "rate_limited",
1850
+ "internal_error"
1851
+ ]
1852
+ },
1853
+ "message": {
1854
+ "type": "string"
1855
+ },
1856
+ "param": {
1857
+ "type": [
1858
+ "string",
1859
+ "null"
1860
+ ]
1861
+ },
1862
+ "request_id": {
1863
+ "type": "string"
1864
+ },
1865
+ "details": {
1866
+ "type": "object"
1867
+ }
1868
+ }
1869
+ }
1870
+ }
1871
+ }
1872
+ }
1873
+ }
1874
+ }
1875
+ }
1876
+ }
1877
+ },
1878
+ "/projects": {
1879
+ "get": {
1880
+ "summary": "List projects",
1881
+ "operationId": "projects.list",
1882
+ "tags": [
1883
+ "projects"
1884
+ ],
1885
+ "security": [
1886
+ {
1887
+ "bearer": []
1888
+ }
1889
+ ],
1890
+ "parameters": [
1891
+ {
1892
+ "name": "q",
1893
+ "in": "query",
1894
+ "required": false,
1895
+ "description": "Find projects by name or domain",
1896
+ "schema": {
1897
+ "type": "string",
1898
+ "minLength": 1
1899
+ }
1900
+ },
1901
+ {
1902
+ "name": "limit",
1903
+ "in": "query",
1904
+ "required": false,
1905
+ "description": "Rows in one page, 1 to 100",
1906
+ "schema": {
1907
+ "default": 25,
1908
+ "type": "integer",
1909
+ "minimum": 1,
1910
+ "maximum": 100
1911
+ }
1912
+ },
1913
+ {
1914
+ "name": "cursor",
1915
+ "in": "query",
1916
+ "required": false,
1917
+ "description": "The next_cursor of the page before",
1918
+ "schema": {
1919
+ "type": "string",
1920
+ "minLength": 1
1921
+ }
1922
+ }
1923
+ ],
1924
+ "responses": {
1925
+ "200": {
1926
+ "description": "OK",
1927
+ "content": {
1928
+ "application/json": {
1929
+ "schema": {
1930
+ "$ref": "#/components/schemas/ProjectList"
1931
+ }
1932
+ }
1933
+ }
1934
+ },
1935
+ "default": {
1936
+ "description": "Error",
1937
+ "content": {
1938
+ "application/json": {
1939
+ "schema": {
1940
+ "type": "object",
1941
+ "required": [
1942
+ "error"
1943
+ ],
1944
+ "properties": {
1945
+ "error": {
1946
+ "type": "object",
1947
+ "required": [
1948
+ "code",
1949
+ "message",
1950
+ "param",
1951
+ "request_id"
1952
+ ],
1953
+ "properties": {
1954
+ "code": {
1955
+ "type": "string",
1956
+ "enum": [
1957
+ "invalid_key",
1958
+ "key_revoked",
1959
+ "plan_no_api",
1960
+ "needs_plan",
1961
+ "key_read_only",
1962
+ "not_found",
1963
+ "idempotency_conflict",
1964
+ "request_in_progress",
1965
+ "invalid_param",
1966
+ "invalid_cursor",
1967
+ "no_credits",
1968
+ "project_limit",
1969
+ "profile_limit",
1970
+ "site_unreadable",
1971
+ "rate_limited",
1972
+ "internal_error"
1973
+ ]
1974
+ },
1975
+ "message": {
1976
+ "type": "string"
1977
+ },
1978
+ "param": {
1979
+ "type": [
1980
+ "string",
1981
+ "null"
1982
+ ]
1983
+ },
1984
+ "request_id": {
1985
+ "type": "string"
1986
+ },
1987
+ "details": {
1988
+ "type": "object"
1989
+ }
1990
+ }
1991
+ }
1992
+ }
1993
+ }
1994
+ }
1995
+ }
1996
+ }
1997
+ }
1998
+ },
1999
+ "post": {
2000
+ "summary": "Create a project from a website, or continue a setup",
2001
+ "operationId": "projects.create",
2002
+ "tags": [
2003
+ "projects"
2004
+ ],
2005
+ "security": [
2006
+ {
2007
+ "bearer": []
2008
+ }
2009
+ ],
2010
+ "parameters": [
2011
+ {
2012
+ "name": "Idempotency-Key",
2013
+ "in": "header",
2014
+ "required": false,
2015
+ "description": "Required when the body has no setup_id. A new random string for each new request, the same string for a retry. A retry gets the first reply.",
2016
+ "schema": {
2017
+ "type": "string",
2018
+ "maxLength": 255
2019
+ }
2020
+ }
2021
+ ],
2022
+ "requestBody": {
2023
+ "required": true,
2024
+ "content": {
2025
+ "application/json": {
2026
+ "schema": {
2027
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
2028
+ "type": "object",
2029
+ "properties": {
2030
+ "domain": {
2031
+ "description": "The website to track, such as example.com",
2032
+ "type": "string",
2033
+ "minLength": 3,
2034
+ "maxLength": 253
2035
+ },
2036
+ "setup_id": {
2037
+ "description": "The setup to continue, from the reply that said to wait",
2038
+ "type": "string",
2039
+ "pattern": "^\\d+$"
2040
+ },
2041
+ "country": {
2042
+ "description": "Country of your buyers, as two letters, such as US",
2043
+ "type": "string",
2044
+ "minLength": 2,
2045
+ "maxLength": 2
2046
+ },
2047
+ "language": {
2048
+ "description": "Language of the questions, such as en",
2049
+ "type": "string",
2050
+ "minLength": 2,
2051
+ "maxLength": 8
2052
+ },
2053
+ "questions": {
2054
+ "description": "Your own first questions, in place of the ones Frontmost AI writes",
2055
+ "minItems": 1,
2056
+ "maxItems": 100,
2057
+ "type": "array",
2058
+ "items": {
2059
+ "type": "object",
2060
+ "properties": {
2061
+ "text": {
2062
+ "type": "string",
2063
+ "minLength": 8,
2064
+ "maxLength": 500,
2065
+ "description": "The question, 8 to 500 characters"
2066
+ },
2067
+ "topic": {
2068
+ "type": "string",
2069
+ "maxLength": 80,
2070
+ "description": "The topic that groups the question"
2071
+ }
2072
+ },
2073
+ "required": [
2074
+ "text"
2075
+ ],
2076
+ "additionalProperties": false
2077
+ }
2078
+ },
2079
+ "run_config": {
2080
+ "type": "object",
2081
+ "properties": {
2082
+ "apps": {
2083
+ "description": "The AI apps each scan asks, such as chatgpt and gemini",
2084
+ "minItems": 1,
2085
+ "maxItems": 12,
2086
+ "type": "array",
2087
+ "items": {
2088
+ "type": "string"
2089
+ }
2090
+ },
2091
+ "cadence": {
2092
+ "type": "string",
2093
+ "enum": [
2094
+ "daily",
2095
+ "mwf",
2096
+ "weekly",
2097
+ "off"
2098
+ ],
2099
+ "description": "How often the scans run. mwf is Monday, Wednesday, and Friday. weekly is Monday"
2100
+ },
2101
+ "weekly_brief": {
2102
+ "description": "Write a brief after each Monday scan",
2103
+ "type": "boolean"
2104
+ }
2105
+ },
2106
+ "additionalProperties": false,
2107
+ "description": "The fields to set. A field left out keeps its value. On a new project, it takes the default: the workspace's `apps`, the workspace's `scan_cadence`, and `weekly_brief` true"
2108
+ }
2109
+ },
2110
+ "additionalProperties": false
2111
+ }
2112
+ }
2113
+ }
2114
+ },
2115
+ "responses": {
2116
+ "201": {
2117
+ "description": "OK",
2118
+ "content": {
2119
+ "application/json": {
2120
+ "schema": {
2121
+ "$ref": "#/components/schemas/Project"
2122
+ }
2123
+ }
2124
+ }
2125
+ },
2126
+ "202": {
2127
+ "description": "Still working. Send body.next after Retry-After seconds.",
2128
+ "content": {
2129
+ "application/json": {
2130
+ "schema": {
2131
+ "$ref": "#/components/schemas/ProjectSetup"
2132
+ }
2133
+ }
2134
+ }
2135
+ },
2136
+ "default": {
2137
+ "description": "Error",
2138
+ "content": {
2139
+ "application/json": {
2140
+ "schema": {
2141
+ "type": "object",
2142
+ "required": [
2143
+ "error"
2144
+ ],
2145
+ "properties": {
2146
+ "error": {
2147
+ "type": "object",
2148
+ "required": [
2149
+ "code",
2150
+ "message",
2151
+ "param",
2152
+ "request_id"
2153
+ ],
2154
+ "properties": {
2155
+ "code": {
2156
+ "type": "string",
2157
+ "enum": [
2158
+ "invalid_key",
2159
+ "key_revoked",
2160
+ "plan_no_api",
2161
+ "needs_plan",
2162
+ "key_read_only",
2163
+ "not_found",
2164
+ "idempotency_conflict",
2165
+ "request_in_progress",
2166
+ "invalid_param",
2167
+ "invalid_cursor",
2168
+ "no_credits",
2169
+ "project_limit",
2170
+ "profile_limit",
2171
+ "site_unreadable",
2172
+ "rate_limited",
2173
+ "internal_error"
2174
+ ]
2175
+ },
2176
+ "message": {
2177
+ "type": "string"
2178
+ },
2179
+ "param": {
2180
+ "type": [
2181
+ "string",
2182
+ "null"
2183
+ ]
2184
+ },
2185
+ "request_id": {
2186
+ "type": "string"
2187
+ },
2188
+ "details": {
2189
+ "type": "object"
2190
+ }
2191
+ }
2192
+ }
2193
+ }
2194
+ }
2195
+ }
2196
+ }
2197
+ }
2198
+ }
2199
+ }
2200
+ },
2201
+ "/projects/{id}": {
2202
+ "get": {
2203
+ "summary": "One project",
2204
+ "operationId": "projects.get",
2205
+ "tags": [
2206
+ "projects"
2207
+ ],
2208
+ "security": [
2209
+ {
2210
+ "bearer": []
2211
+ }
2212
+ ],
2213
+ "parameters": [
2214
+ {
2215
+ "name": "id",
2216
+ "in": "path",
2217
+ "required": true,
2218
+ "schema": {
2219
+ "type": "string"
2220
+ }
2221
+ }
2222
+ ],
2223
+ "responses": {
2224
+ "200": {
2225
+ "description": "OK",
2226
+ "content": {
2227
+ "application/json": {
2228
+ "schema": {
2229
+ "$ref": "#/components/schemas/Project"
2230
+ }
2231
+ }
2232
+ }
2233
+ },
2234
+ "default": {
2235
+ "description": "Error",
2236
+ "content": {
2237
+ "application/json": {
2238
+ "schema": {
2239
+ "type": "object",
2240
+ "required": [
2241
+ "error"
2242
+ ],
2243
+ "properties": {
2244
+ "error": {
2245
+ "type": "object",
2246
+ "required": [
2247
+ "code",
2248
+ "message",
2249
+ "param",
2250
+ "request_id"
2251
+ ],
2252
+ "properties": {
2253
+ "code": {
2254
+ "type": "string",
2255
+ "enum": [
2256
+ "invalid_key",
2257
+ "key_revoked",
2258
+ "plan_no_api",
2259
+ "needs_plan",
2260
+ "key_read_only",
2261
+ "not_found",
2262
+ "idempotency_conflict",
2263
+ "request_in_progress",
2264
+ "invalid_param",
2265
+ "invalid_cursor",
2266
+ "no_credits",
2267
+ "project_limit",
2268
+ "profile_limit",
2269
+ "site_unreadable",
2270
+ "rate_limited",
2271
+ "internal_error"
2272
+ ]
2273
+ },
2274
+ "message": {
2275
+ "type": "string"
2276
+ },
2277
+ "param": {
2278
+ "type": [
2279
+ "string",
2280
+ "null"
2281
+ ]
2282
+ },
2283
+ "request_id": {
2284
+ "type": "string"
2285
+ },
2286
+ "details": {
2287
+ "type": "object"
2288
+ }
2289
+ }
2290
+ }
2291
+ }
2292
+ }
2293
+ }
2294
+ }
2295
+ }
2296
+ }
2297
+ },
2298
+ "patch": {
2299
+ "summary": "Rename a project, or change its run config",
2300
+ "operationId": "projects.update",
2301
+ "tags": [
2302
+ "projects"
2303
+ ],
2304
+ "security": [
2305
+ {
2306
+ "bearer": []
2307
+ }
2308
+ ],
2309
+ "parameters": [
2310
+ {
2311
+ "name": "id",
2312
+ "in": "path",
2313
+ "required": true,
2314
+ "schema": {
2315
+ "type": "string"
2316
+ }
2317
+ }
2318
+ ],
2319
+ "requestBody": {
2320
+ "required": true,
2321
+ "content": {
2322
+ "application/json": {
2323
+ "schema": {
2324
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
2325
+ "type": "object",
2326
+ "properties": {
2327
+ "name": {
2328
+ "description": "A new name for the project",
2329
+ "type": "string",
2330
+ "minLength": 1,
2331
+ "maxLength": 120
2332
+ },
2333
+ "run_config": {
2334
+ "type": "object",
2335
+ "properties": {
2336
+ "apps": {
2337
+ "description": "The AI apps each scan asks, such as chatgpt and gemini",
2338
+ "minItems": 1,
2339
+ "maxItems": 12,
2340
+ "type": "array",
2341
+ "items": {
2342
+ "type": "string"
2343
+ }
2344
+ },
2345
+ "cadence": {
2346
+ "type": "string",
2347
+ "enum": [
2348
+ "daily",
2349
+ "mwf",
2350
+ "weekly",
2351
+ "off"
2352
+ ],
2353
+ "description": "How often the scans run. mwf is Monday, Wednesday, and Friday. weekly is Monday"
2354
+ },
2355
+ "weekly_brief": {
2356
+ "description": "Write a brief after each Monday scan",
2357
+ "type": "boolean"
2358
+ }
2359
+ },
2360
+ "additionalProperties": false,
2361
+ "description": "The fields to set. A field left out keeps its value. On a new project, it takes the default: the workspace's `apps`, the workspace's `scan_cadence`, and `weekly_brief` true"
2362
+ },
2363
+ "scanning": {
2364
+ "description": "Older field. Use run_config.cadence. true is daily, false is off",
2365
+ "deprecated": true,
2366
+ "type": "boolean"
2367
+ },
2368
+ "apps": {
2369
+ "description": "Older field. Use run_config.apps",
2370
+ "deprecated": true,
2371
+ "minItems": 1,
2372
+ "maxItems": 12,
2373
+ "type": "array",
2374
+ "items": {
2375
+ "type": "string"
2376
+ }
2377
+ },
2378
+ "cadence": {
2379
+ "description": "Older field. Use run_config.cadence. It wins over scanning",
2380
+ "deprecated": true,
2381
+ "type": "string",
2382
+ "enum": [
2383
+ "daily",
2384
+ "mwf",
2385
+ "weekly",
2386
+ "off"
2387
+ ]
2388
+ },
2389
+ "weekly_brief": {
2390
+ "description": "Older field. Use run_config.weekly_brief",
2391
+ "deprecated": true,
2392
+ "type": "boolean"
2393
+ }
2394
+ },
2395
+ "additionalProperties": false
2396
+ }
2397
+ }
2398
+ }
2399
+ },
2400
+ "responses": {
2401
+ "200": {
2402
+ "description": "OK",
2403
+ "content": {
2404
+ "application/json": {
2405
+ "schema": {
2406
+ "$ref": "#/components/schemas/Project"
2407
+ }
2408
+ }
2409
+ }
2410
+ },
2411
+ "default": {
2412
+ "description": "Error",
2413
+ "content": {
2414
+ "application/json": {
2415
+ "schema": {
2416
+ "type": "object",
2417
+ "required": [
2418
+ "error"
2419
+ ],
2420
+ "properties": {
2421
+ "error": {
2422
+ "type": "object",
2423
+ "required": [
2424
+ "code",
2425
+ "message",
2426
+ "param",
2427
+ "request_id"
2428
+ ],
2429
+ "properties": {
2430
+ "code": {
2431
+ "type": "string",
2432
+ "enum": [
2433
+ "invalid_key",
2434
+ "key_revoked",
2435
+ "plan_no_api",
2436
+ "needs_plan",
2437
+ "key_read_only",
2438
+ "not_found",
2439
+ "idempotency_conflict",
2440
+ "request_in_progress",
2441
+ "invalid_param",
2442
+ "invalid_cursor",
2443
+ "no_credits",
2444
+ "project_limit",
2445
+ "profile_limit",
2446
+ "site_unreadable",
2447
+ "rate_limited",
2448
+ "internal_error"
2449
+ ]
2450
+ },
2451
+ "message": {
2452
+ "type": "string"
2453
+ },
2454
+ "param": {
2455
+ "type": [
2456
+ "string",
2457
+ "null"
2458
+ ]
2459
+ },
2460
+ "request_id": {
2461
+ "type": "string"
2462
+ },
2463
+ "details": {
2464
+ "type": "object"
2465
+ }
2466
+ }
2467
+ }
2468
+ }
2469
+ }
2470
+ }
2471
+ }
2472
+ }
2473
+ }
2474
+ }
2475
+ },
2476
+ "/projects/{id}/scans": {
2477
+ "get": {
2478
+ "summary": "Delivered scans, newest first",
2479
+ "operationId": "scans.list",
2480
+ "tags": [
2481
+ "scans"
2482
+ ],
2483
+ "security": [
2484
+ {
2485
+ "bearer": []
2486
+ }
2487
+ ],
2488
+ "parameters": [
2489
+ {
2490
+ "name": "id",
2491
+ "in": "path",
2492
+ "required": true,
2493
+ "schema": {
2494
+ "type": "string"
2495
+ }
2496
+ },
2497
+ {
2498
+ "name": "delivered_after",
2499
+ "in": "query",
2500
+ "required": false,
2501
+ "description": "Only scans delivered after this date, such as 2026-11-01",
2502
+ "schema": {
2503
+ "type": "string"
2504
+ }
2505
+ },
2506
+ {
2507
+ "name": "limit",
2508
+ "in": "query",
2509
+ "required": false,
2510
+ "description": "Rows in one page, 1 to 100",
2511
+ "schema": {
2512
+ "default": 25,
2513
+ "type": "integer",
2514
+ "minimum": 1,
2515
+ "maximum": 100
2516
+ }
2517
+ },
2518
+ {
2519
+ "name": "cursor",
2520
+ "in": "query",
2521
+ "required": false,
2522
+ "description": "The next_cursor of the page before",
2523
+ "schema": {
2524
+ "type": "string",
2525
+ "minLength": 1
2526
+ }
2527
+ }
2528
+ ],
2529
+ "responses": {
2530
+ "200": {
2531
+ "description": "OK",
2532
+ "content": {
2533
+ "application/json": {
2534
+ "schema": {
2535
+ "$ref": "#/components/schemas/ScanList"
2536
+ }
2537
+ }
2538
+ }
2539
+ },
2540
+ "default": {
2541
+ "description": "Error",
2542
+ "content": {
2543
+ "application/json": {
2544
+ "schema": {
2545
+ "type": "object",
2546
+ "required": [
2547
+ "error"
2548
+ ],
2549
+ "properties": {
2550
+ "error": {
2551
+ "type": "object",
2552
+ "required": [
2553
+ "code",
2554
+ "message",
2555
+ "param",
2556
+ "request_id"
2557
+ ],
2558
+ "properties": {
2559
+ "code": {
2560
+ "type": "string",
2561
+ "enum": [
2562
+ "invalid_key",
2563
+ "key_revoked",
2564
+ "plan_no_api",
2565
+ "needs_plan",
2566
+ "key_read_only",
2567
+ "not_found",
2568
+ "idempotency_conflict",
2569
+ "request_in_progress",
2570
+ "invalid_param",
2571
+ "invalid_cursor",
2572
+ "no_credits",
2573
+ "project_limit",
2574
+ "profile_limit",
2575
+ "site_unreadable",
2576
+ "rate_limited",
2577
+ "internal_error"
2578
+ ]
2579
+ },
2580
+ "message": {
2581
+ "type": "string"
2582
+ },
2583
+ "param": {
2584
+ "type": [
2585
+ "string",
2586
+ "null"
2587
+ ]
2588
+ },
2589
+ "request_id": {
2590
+ "type": "string"
2591
+ },
2592
+ "details": {
2593
+ "type": "object"
2594
+ }
2595
+ }
2596
+ }
2597
+ }
2598
+ }
2599
+ }
2600
+ }
2601
+ }
2602
+ }
2603
+ }
2604
+ },
2605
+ "/projects/{id}/metrics": {
2606
+ "get": {
2607
+ "summary": "Visibility, Win Rate, Position, and Sentiment",
2608
+ "operationId": "metrics.get",
2609
+ "tags": [
2610
+ "metrics"
2611
+ ],
2612
+ "security": [
2613
+ {
2614
+ "bearer": []
2615
+ }
2616
+ ],
2617
+ "parameters": [
2618
+ {
2619
+ "name": "id",
2620
+ "in": "path",
2621
+ "required": true,
2622
+ "schema": {
2623
+ "type": "string"
2624
+ }
2625
+ },
2626
+ {
2627
+ "name": "scan_id",
2628
+ "in": "query",
2629
+ "required": false,
2630
+ "description": "A delivered scan of the project. Default: the newest scan",
2631
+ "schema": {
2632
+ "type": "string",
2633
+ "pattern": "^\\d+$"
2634
+ }
2635
+ },
2636
+ {
2637
+ "name": "period",
2638
+ "in": "query",
2639
+ "required": false,
2640
+ "description": "Count one scan, or the calendar week or month that holds it",
2641
+ "schema": {
2642
+ "default": "scan",
2643
+ "type": "string",
2644
+ "enum": [
2645
+ "scan",
2646
+ "week",
2647
+ "month"
2648
+ ]
2649
+ }
2650
+ },
2651
+ {
2652
+ "name": "app",
2653
+ "in": "query",
2654
+ "required": false,
2655
+ "description": "Only one AI app, such as chatgpt. Default: every app of the project",
2656
+ "schema": {
2657
+ "type": "string",
2658
+ "minLength": 1
2659
+ }
2660
+ },
2661
+ {
2662
+ "name": "questions",
2663
+ "in": "query",
2664
+ "required": false,
2665
+ "description": "Which questions to count. Branded questions name your business",
2666
+ "schema": {
2667
+ "default": "all",
2668
+ "type": "string",
2669
+ "enum": [
2670
+ "all",
2671
+ "branded",
2672
+ "unbranded"
2673
+ ]
2674
+ }
2675
+ },
2676
+ {
2677
+ "name": "compare_to",
2678
+ "in": "query",
2679
+ "required": false,
2680
+ "description": "Compare with the period before, or with nothing",
2681
+ "schema": {
2682
+ "default": "previous",
2683
+ "type": "string",
2684
+ "enum": [
2685
+ "previous",
2686
+ "none"
2687
+ ]
2688
+ }
2689
+ },
2690
+ {
2691
+ "name": "group_by",
2692
+ "in": "query",
2693
+ "required": false,
2694
+ "description": "Split the numbers by AI app or by scan",
2695
+ "schema": {
2696
+ "type": "string",
2697
+ "enum": [
2698
+ "app",
2699
+ "scan"
2700
+ ]
2701
+ }
2702
+ }
2703
+ ],
2704
+ "responses": {
2705
+ "200": {
2706
+ "description": "OK",
2707
+ "content": {
2708
+ "application/json": {
2709
+ "schema": {
2710
+ "$ref": "#/components/schemas/Metrics"
2711
+ }
2712
+ }
2713
+ }
2714
+ },
2715
+ "default": {
2716
+ "description": "Error",
2717
+ "content": {
2718
+ "application/json": {
2719
+ "schema": {
2720
+ "type": "object",
2721
+ "required": [
2722
+ "error"
2723
+ ],
2724
+ "properties": {
2725
+ "error": {
2726
+ "type": "object",
2727
+ "required": [
2728
+ "code",
2729
+ "message",
2730
+ "param",
2731
+ "request_id"
2732
+ ],
2733
+ "properties": {
2734
+ "code": {
2735
+ "type": "string",
2736
+ "enum": [
2737
+ "invalid_key",
2738
+ "key_revoked",
2739
+ "plan_no_api",
2740
+ "needs_plan",
2741
+ "key_read_only",
2742
+ "not_found",
2743
+ "idempotency_conflict",
2744
+ "request_in_progress",
2745
+ "invalid_param",
2746
+ "invalid_cursor",
2747
+ "no_credits",
2748
+ "project_limit",
2749
+ "profile_limit",
2750
+ "site_unreadable",
2751
+ "rate_limited",
2752
+ "internal_error"
2753
+ ]
2754
+ },
2755
+ "message": {
2756
+ "type": "string"
2757
+ },
2758
+ "param": {
2759
+ "type": [
2760
+ "string",
2761
+ "null"
2762
+ ]
2763
+ },
2764
+ "request_id": {
2765
+ "type": "string"
2766
+ },
2767
+ "details": {
2768
+ "type": "object"
2769
+ }
2770
+ }
2771
+ }
2772
+ }
2773
+ }
2774
+ }
2775
+ }
2776
+ }
2777
+ }
2778
+ }
2779
+ },
2780
+ "/projects/{id}/rivals": {
2781
+ "get": {
2782
+ "summary": "Rivals the answers named, most named first",
2783
+ "operationId": "rivals.list",
2784
+ "tags": [
2785
+ "rivals"
2786
+ ],
2787
+ "security": [
2788
+ {
2789
+ "bearer": []
2790
+ }
2791
+ ],
2792
+ "parameters": [
2793
+ {
2794
+ "name": "id",
2795
+ "in": "path",
2796
+ "required": true,
2797
+ "schema": {
2798
+ "type": "string"
2799
+ }
2800
+ },
2801
+ {
2802
+ "name": "scan_id",
2803
+ "in": "query",
2804
+ "required": false,
2805
+ "description": "A delivered scan of the project. Default: the newest scan",
2806
+ "schema": {
2807
+ "type": "string",
2808
+ "pattern": "^\\d+$"
2809
+ }
2810
+ },
2811
+ {
2812
+ "name": "period",
2813
+ "in": "query",
2814
+ "required": false,
2815
+ "description": "Count one scan, or the calendar week or month that holds it",
2816
+ "schema": {
2817
+ "default": "scan",
2818
+ "type": "string",
2819
+ "enum": [
2820
+ "scan",
2821
+ "week",
2822
+ "month"
2823
+ ]
2824
+ }
2825
+ },
2826
+ {
2827
+ "name": "app",
2828
+ "in": "query",
2829
+ "required": false,
2830
+ "description": "Only one AI app, such as chatgpt. Default: every app of the project",
2831
+ "schema": {
2832
+ "type": "string",
2833
+ "minLength": 1
2834
+ }
2835
+ },
2836
+ {
2837
+ "name": "questions",
2838
+ "in": "query",
2839
+ "required": false,
2840
+ "description": "Which questions to count. Branded questions name your business",
2841
+ "schema": {
2842
+ "default": "all",
2843
+ "type": "string",
2844
+ "enum": [
2845
+ "all",
2846
+ "branded",
2847
+ "unbranded"
2848
+ ]
2849
+ }
2850
+ },
2851
+ {
2852
+ "name": "compare_to",
2853
+ "in": "query",
2854
+ "required": false,
2855
+ "description": "Compare with the period before, or with nothing",
2856
+ "schema": {
2857
+ "default": "previous",
2858
+ "type": "string",
2859
+ "enum": [
2860
+ "previous",
2861
+ "none"
2862
+ ]
2863
+ }
2864
+ },
2865
+ {
2866
+ "name": "limit",
2867
+ "in": "query",
2868
+ "required": false,
2869
+ "description": "Rows in one page, 1 to 100",
2870
+ "schema": {
2871
+ "default": 25,
2872
+ "type": "integer",
2873
+ "minimum": 1,
2874
+ "maximum": 100
2875
+ }
2876
+ },
2877
+ {
2878
+ "name": "cursor",
2879
+ "in": "query",
2880
+ "required": false,
2881
+ "description": "The next_cursor of the page before",
2882
+ "schema": {
2883
+ "type": "string",
2884
+ "minLength": 1
2885
+ }
2886
+ }
2887
+ ],
2888
+ "responses": {
2889
+ "200": {
2890
+ "description": "OK",
2891
+ "content": {
2892
+ "application/json": {
2893
+ "schema": {
2894
+ "$ref": "#/components/schemas/RivalList"
2895
+ }
2896
+ }
2897
+ }
2898
+ },
2899
+ "default": {
2900
+ "description": "Error",
2901
+ "content": {
2902
+ "application/json": {
2903
+ "schema": {
2904
+ "type": "object",
2905
+ "required": [
2906
+ "error"
2907
+ ],
2908
+ "properties": {
2909
+ "error": {
2910
+ "type": "object",
2911
+ "required": [
2912
+ "code",
2913
+ "message",
2914
+ "param",
2915
+ "request_id"
2916
+ ],
2917
+ "properties": {
2918
+ "code": {
2919
+ "type": "string",
2920
+ "enum": [
2921
+ "invalid_key",
2922
+ "key_revoked",
2923
+ "plan_no_api",
2924
+ "needs_plan",
2925
+ "key_read_only",
2926
+ "not_found",
2927
+ "idempotency_conflict",
2928
+ "request_in_progress",
2929
+ "invalid_param",
2930
+ "invalid_cursor",
2931
+ "no_credits",
2932
+ "project_limit",
2933
+ "profile_limit",
2934
+ "site_unreadable",
2935
+ "rate_limited",
2936
+ "internal_error"
2937
+ ]
2938
+ },
2939
+ "message": {
2940
+ "type": "string"
2941
+ },
2942
+ "param": {
2943
+ "type": [
2944
+ "string",
2945
+ "null"
2946
+ ]
2947
+ },
2948
+ "request_id": {
2949
+ "type": "string"
2950
+ },
2951
+ "details": {
2952
+ "type": "object"
2953
+ }
2954
+ }
2955
+ }
2956
+ }
2957
+ }
2958
+ }
2959
+ }
2960
+ }
2961
+ }
2962
+ }
2963
+ },
2964
+ "/projects/{id}/answers": {
2965
+ "get": {
2966
+ "summary": "List answers. Get one answer to read its text",
2967
+ "operationId": "answers.list",
2968
+ "tags": [
2969
+ "answers"
2970
+ ],
2971
+ "security": [
2972
+ {
2973
+ "bearer": []
2974
+ }
2975
+ ],
2976
+ "parameters": [
2977
+ {
2978
+ "name": "id",
2979
+ "in": "path",
2980
+ "required": true,
2981
+ "schema": {
2982
+ "type": "string"
2983
+ }
2984
+ },
2985
+ {
2986
+ "name": "scan_id",
2987
+ "in": "query",
2988
+ "required": false,
2989
+ "description": "A delivered scan of the project. Default: the newest scan",
2990
+ "schema": {
2991
+ "type": "string",
2992
+ "pattern": "^\\d+$"
2993
+ }
2994
+ },
2995
+ {
2996
+ "name": "period",
2997
+ "in": "query",
2998
+ "required": false,
2999
+ "description": "Count one scan, or the calendar week or month that holds it",
3000
+ "schema": {
3001
+ "default": "scan",
3002
+ "type": "string",
3003
+ "enum": [
3004
+ "scan",
3005
+ "week",
3006
+ "month"
3007
+ ]
3008
+ }
3009
+ },
3010
+ {
3011
+ "name": "app",
3012
+ "in": "query",
3013
+ "required": false,
3014
+ "description": "Only one AI app, such as chatgpt. Default: every app of the project",
3015
+ "schema": {
3016
+ "type": "string",
3017
+ "minLength": 1
3018
+ }
3019
+ },
3020
+ {
3021
+ "name": "questions",
3022
+ "in": "query",
3023
+ "required": false,
3024
+ "description": "Which questions to count. Branded questions name your business",
3025
+ "schema": {
3026
+ "default": "all",
3027
+ "type": "string",
3028
+ "enum": [
3029
+ "all",
3030
+ "branded",
3031
+ "unbranded"
3032
+ ]
3033
+ }
3034
+ },
3035
+ {
3036
+ "name": "compare_to",
3037
+ "in": "query",
3038
+ "required": false,
3039
+ "description": "Compare with the period before, or with nothing",
3040
+ "schema": {
3041
+ "default": "previous",
3042
+ "type": "string",
3043
+ "enum": [
3044
+ "previous",
3045
+ "none"
3046
+ ]
3047
+ }
3048
+ },
3049
+ {
3050
+ "name": "limit",
3051
+ "in": "query",
3052
+ "required": false,
3053
+ "description": "Rows in one page, 1 to 100",
3054
+ "schema": {
3055
+ "default": 25,
3056
+ "type": "integer",
3057
+ "minimum": 1,
3058
+ "maximum": 100
3059
+ }
3060
+ },
3061
+ {
3062
+ "name": "cursor",
3063
+ "in": "query",
3064
+ "required": false,
3065
+ "description": "The next_cursor of the page before",
3066
+ "schema": {
3067
+ "type": "string",
3068
+ "minLength": 1
3069
+ }
3070
+ },
3071
+ {
3072
+ "name": "question_id",
3073
+ "in": "query",
3074
+ "required": false,
3075
+ "description": "Only answers to this question",
3076
+ "schema": {
3077
+ "type": "string",
3078
+ "pattern": "^\\d+$"
3079
+ }
3080
+ },
3081
+ {
3082
+ "name": "rival_id",
3083
+ "in": "query",
3084
+ "required": false,
3085
+ "description": "Only answers that named this rival",
3086
+ "schema": {
3087
+ "type": "string",
3088
+ "minLength": 1
3089
+ }
3090
+ },
3091
+ {
3092
+ "name": "named",
3093
+ "in": "query",
3094
+ "required": false,
3095
+ "description": "Only answers that named you, or only answers that did not",
3096
+ "schema": {
3097
+ "type": "string",
3098
+ "enum": [
3099
+ "true",
3100
+ "false"
3101
+ ]
3102
+ }
3103
+ },
3104
+ {
3105
+ "name": "cited_domain",
3106
+ "in": "query",
3107
+ "required": false,
3108
+ "description": "Only answers that cited this site, such as reddit.com",
3109
+ "schema": {
3110
+ "type": "string",
3111
+ "minLength": 1
3112
+ }
3113
+ }
3114
+ ],
3115
+ "responses": {
3116
+ "200": {
3117
+ "description": "OK",
3118
+ "content": {
3119
+ "application/json": {
3120
+ "schema": {
3121
+ "$ref": "#/components/schemas/AnswerList"
3122
+ }
3123
+ }
3124
+ }
3125
+ },
3126
+ "default": {
3127
+ "description": "Error",
3128
+ "content": {
3129
+ "application/json": {
3130
+ "schema": {
3131
+ "type": "object",
3132
+ "required": [
3133
+ "error"
3134
+ ],
3135
+ "properties": {
3136
+ "error": {
3137
+ "type": "object",
3138
+ "required": [
3139
+ "code",
3140
+ "message",
3141
+ "param",
3142
+ "request_id"
3143
+ ],
3144
+ "properties": {
3145
+ "code": {
3146
+ "type": "string",
3147
+ "enum": [
3148
+ "invalid_key",
3149
+ "key_revoked",
3150
+ "plan_no_api",
3151
+ "needs_plan",
3152
+ "key_read_only",
3153
+ "not_found",
3154
+ "idempotency_conflict",
3155
+ "request_in_progress",
3156
+ "invalid_param",
3157
+ "invalid_cursor",
3158
+ "no_credits",
3159
+ "project_limit",
3160
+ "profile_limit",
3161
+ "site_unreadable",
3162
+ "rate_limited",
3163
+ "internal_error"
3164
+ ]
3165
+ },
3166
+ "message": {
3167
+ "type": "string"
3168
+ },
3169
+ "param": {
3170
+ "type": [
3171
+ "string",
3172
+ "null"
3173
+ ]
3174
+ },
3175
+ "request_id": {
3176
+ "type": "string"
3177
+ },
3178
+ "details": {
3179
+ "type": "object"
3180
+ }
3181
+ }
3182
+ }
3183
+ }
3184
+ }
3185
+ }
3186
+ }
3187
+ }
3188
+ }
3189
+ }
3190
+ },
3191
+ "/answers/{id}": {
3192
+ "get": {
3193
+ "summary": "One answer with its text and citations",
3194
+ "operationId": "answers.get",
3195
+ "tags": [
3196
+ "answers"
3197
+ ],
3198
+ "security": [
3199
+ {
3200
+ "bearer": []
3201
+ }
3202
+ ],
3203
+ "parameters": [
3204
+ {
3205
+ "name": "id",
3206
+ "in": "path",
3207
+ "required": true,
3208
+ "schema": {
3209
+ "type": "string"
3210
+ }
3211
+ }
3212
+ ],
3213
+ "responses": {
3214
+ "200": {
3215
+ "description": "OK",
3216
+ "content": {
3217
+ "application/json": {
3218
+ "schema": {
3219
+ "$ref": "#/components/schemas/Answer"
3220
+ }
3221
+ }
3222
+ }
3223
+ },
3224
+ "default": {
3225
+ "description": "Error",
3226
+ "content": {
3227
+ "application/json": {
3228
+ "schema": {
3229
+ "type": "object",
3230
+ "required": [
3231
+ "error"
3232
+ ],
3233
+ "properties": {
3234
+ "error": {
3235
+ "type": "object",
3236
+ "required": [
3237
+ "code",
3238
+ "message",
3239
+ "param",
3240
+ "request_id"
3241
+ ],
3242
+ "properties": {
3243
+ "code": {
3244
+ "type": "string",
3245
+ "enum": [
3246
+ "invalid_key",
3247
+ "key_revoked",
3248
+ "plan_no_api",
3249
+ "needs_plan",
3250
+ "key_read_only",
3251
+ "not_found",
3252
+ "idempotency_conflict",
3253
+ "request_in_progress",
3254
+ "invalid_param",
3255
+ "invalid_cursor",
3256
+ "no_credits",
3257
+ "project_limit",
3258
+ "profile_limit",
3259
+ "site_unreadable",
3260
+ "rate_limited",
3261
+ "internal_error"
3262
+ ]
3263
+ },
3264
+ "message": {
3265
+ "type": "string"
3266
+ },
3267
+ "param": {
3268
+ "type": [
3269
+ "string",
3270
+ "null"
3271
+ ]
3272
+ },
3273
+ "request_id": {
3274
+ "type": "string"
3275
+ },
3276
+ "details": {
3277
+ "type": "object"
3278
+ }
3279
+ }
3280
+ }
3281
+ }
3282
+ }
3283
+ }
3284
+ }
3285
+ }
3286
+ }
3287
+ }
3288
+ },
3289
+ "/projects/{id}/sources": {
3290
+ "get": {
3291
+ "summary": "Sites the answers cited, most cited first",
3292
+ "operationId": "sources.list",
3293
+ "tags": [
3294
+ "sources"
3295
+ ],
3296
+ "security": [
3297
+ {
3298
+ "bearer": []
3299
+ }
3300
+ ],
3301
+ "parameters": [
3302
+ {
3303
+ "name": "id",
3304
+ "in": "path",
3305
+ "required": true,
3306
+ "schema": {
3307
+ "type": "string"
3308
+ }
3309
+ },
3310
+ {
3311
+ "name": "scan_id",
3312
+ "in": "query",
3313
+ "required": false,
3314
+ "description": "A delivered scan of the project. Default: the newest scan",
3315
+ "schema": {
3316
+ "type": "string",
3317
+ "pattern": "^\\d+$"
3318
+ }
3319
+ },
3320
+ {
3321
+ "name": "period",
3322
+ "in": "query",
3323
+ "required": false,
3324
+ "description": "Count one scan, or the calendar week or month that holds it",
3325
+ "schema": {
3326
+ "default": "scan",
3327
+ "type": "string",
3328
+ "enum": [
3329
+ "scan",
3330
+ "week",
3331
+ "month"
3332
+ ]
3333
+ }
3334
+ },
3335
+ {
3336
+ "name": "app",
3337
+ "in": "query",
3338
+ "required": false,
3339
+ "description": "Only one AI app, such as chatgpt. Default: every app of the project",
3340
+ "schema": {
3341
+ "type": "string",
3342
+ "minLength": 1
3343
+ }
3344
+ },
3345
+ {
3346
+ "name": "questions",
3347
+ "in": "query",
3348
+ "required": false,
3349
+ "description": "Which questions to count. Branded questions name your business",
3350
+ "schema": {
3351
+ "default": "all",
3352
+ "type": "string",
3353
+ "enum": [
3354
+ "all",
3355
+ "branded",
3356
+ "unbranded"
3357
+ ]
3358
+ }
3359
+ },
3360
+ {
3361
+ "name": "compare_to",
3362
+ "in": "query",
3363
+ "required": false,
3364
+ "description": "Compare with the period before, or with nothing",
3365
+ "schema": {
3366
+ "default": "previous",
3367
+ "type": "string",
3368
+ "enum": [
3369
+ "previous",
3370
+ "none"
3371
+ ]
3372
+ }
3373
+ },
3374
+ {
3375
+ "name": "limit",
3376
+ "in": "query",
3377
+ "required": false,
3378
+ "description": "Rows in one page, 1 to 100",
3379
+ "schema": {
3380
+ "default": 25,
3381
+ "type": "integer",
3382
+ "minimum": 1,
3383
+ "maximum": 100
3384
+ }
3385
+ },
3386
+ {
3387
+ "name": "cursor",
3388
+ "in": "query",
3389
+ "required": false,
3390
+ "description": "The next_cursor of the page before",
3391
+ "schema": {
3392
+ "type": "string",
3393
+ "minLength": 1
3394
+ }
3395
+ },
3396
+ {
3397
+ "name": "domain",
3398
+ "in": "query",
3399
+ "required": false,
3400
+ "description": "Only this site, such as reddit.com",
3401
+ "schema": {
3402
+ "type": "string",
3403
+ "minLength": 1
3404
+ }
3405
+ },
3406
+ {
3407
+ "name": "channel",
3408
+ "in": "query",
3409
+ "required": false,
3410
+ "description": "Only sites in this channel, such as editorial or own_website",
3411
+ "schema": {
3412
+ "type": "string",
3413
+ "enum": [
3414
+ "own_website",
3415
+ "competitor_sites",
3416
+ "editorial",
3417
+ "review_sites",
3418
+ "reddit",
3419
+ "youtube",
3420
+ "linkedin",
3421
+ "forums",
3422
+ "directories",
3423
+ "reference",
3424
+ "company_sites",
3425
+ "other"
3426
+ ]
3427
+ }
3428
+ }
3429
+ ],
3430
+ "responses": {
3431
+ "200": {
3432
+ "description": "OK",
3433
+ "content": {
3434
+ "application/json": {
3435
+ "schema": {
3436
+ "$ref": "#/components/schemas/SourceList"
3437
+ }
3438
+ }
3439
+ }
3440
+ },
3441
+ "default": {
3442
+ "description": "Error",
3443
+ "content": {
3444
+ "application/json": {
3445
+ "schema": {
3446
+ "type": "object",
3447
+ "required": [
3448
+ "error"
3449
+ ],
3450
+ "properties": {
3451
+ "error": {
3452
+ "type": "object",
3453
+ "required": [
3454
+ "code",
3455
+ "message",
3456
+ "param",
3457
+ "request_id"
3458
+ ],
3459
+ "properties": {
3460
+ "code": {
3461
+ "type": "string",
3462
+ "enum": [
3463
+ "invalid_key",
3464
+ "key_revoked",
3465
+ "plan_no_api",
3466
+ "needs_plan",
3467
+ "key_read_only",
3468
+ "not_found",
3469
+ "idempotency_conflict",
3470
+ "request_in_progress",
3471
+ "invalid_param",
3472
+ "invalid_cursor",
3473
+ "no_credits",
3474
+ "project_limit",
3475
+ "profile_limit",
3476
+ "site_unreadable",
3477
+ "rate_limited",
3478
+ "internal_error"
3479
+ ]
3480
+ },
3481
+ "message": {
3482
+ "type": "string"
3483
+ },
3484
+ "param": {
3485
+ "type": [
3486
+ "string",
3487
+ "null"
3488
+ ]
3489
+ },
3490
+ "request_id": {
3491
+ "type": "string"
3492
+ },
3493
+ "details": {
3494
+ "type": "object"
3495
+ }
3496
+ }
3497
+ }
3498
+ }
3499
+ }
3500
+ }
3501
+ }
3502
+ }
3503
+ }
3504
+ }
3505
+ },
3506
+ "/projects/{id}/questions": {
3507
+ "get": {
3508
+ "summary": "The project's questions",
3509
+ "operationId": "questions.list",
3510
+ "tags": [
3511
+ "questions"
3512
+ ],
3513
+ "security": [
3514
+ {
3515
+ "bearer": []
3516
+ }
3517
+ ],
3518
+ "parameters": [
3519
+ {
3520
+ "name": "id",
3521
+ "in": "path",
3522
+ "required": true,
3523
+ "schema": {
3524
+ "type": "string"
3525
+ }
3526
+ },
3527
+ {
3528
+ "name": "active",
3529
+ "in": "query",
3530
+ "required": false,
3531
+ "description": "Only active questions, or only paused questions",
3532
+ "schema": {
3533
+ "type": "string",
3534
+ "enum": [
3535
+ "true",
3536
+ "false"
3537
+ ]
3538
+ }
3539
+ },
3540
+ {
3541
+ "name": "limit",
3542
+ "in": "query",
3543
+ "required": false,
3544
+ "description": "Rows in one page, 1 to 100",
3545
+ "schema": {
3546
+ "default": 25,
3547
+ "type": "integer",
3548
+ "minimum": 1,
3549
+ "maximum": 100
3550
+ }
3551
+ },
3552
+ {
3553
+ "name": "cursor",
3554
+ "in": "query",
3555
+ "required": false,
3556
+ "description": "The next_cursor of the page before",
3557
+ "schema": {
3558
+ "type": "string",
3559
+ "minLength": 1
3560
+ }
3561
+ }
3562
+ ],
3563
+ "responses": {
3564
+ "200": {
3565
+ "description": "OK",
3566
+ "content": {
3567
+ "application/json": {
3568
+ "schema": {
3569
+ "$ref": "#/components/schemas/QuestionList"
3570
+ }
3571
+ }
3572
+ }
3573
+ },
3574
+ "default": {
3575
+ "description": "Error",
3576
+ "content": {
3577
+ "application/json": {
3578
+ "schema": {
3579
+ "type": "object",
3580
+ "required": [
3581
+ "error"
3582
+ ],
3583
+ "properties": {
3584
+ "error": {
3585
+ "type": "object",
3586
+ "required": [
3587
+ "code",
3588
+ "message",
3589
+ "param",
3590
+ "request_id"
3591
+ ],
3592
+ "properties": {
3593
+ "code": {
3594
+ "type": "string",
3595
+ "enum": [
3596
+ "invalid_key",
3597
+ "key_revoked",
3598
+ "plan_no_api",
3599
+ "needs_plan",
3600
+ "key_read_only",
3601
+ "not_found",
3602
+ "idempotency_conflict",
3603
+ "request_in_progress",
3604
+ "invalid_param",
3605
+ "invalid_cursor",
3606
+ "no_credits",
3607
+ "project_limit",
3608
+ "profile_limit",
3609
+ "site_unreadable",
3610
+ "rate_limited",
3611
+ "internal_error"
3612
+ ]
3613
+ },
3614
+ "message": {
3615
+ "type": "string"
3616
+ },
3617
+ "param": {
3618
+ "type": [
3619
+ "string",
3620
+ "null"
3621
+ ]
3622
+ },
3623
+ "request_id": {
3624
+ "type": "string"
3625
+ },
3626
+ "details": {
3627
+ "type": "object"
3628
+ }
3629
+ }
3630
+ }
3631
+ }
3632
+ }
3633
+ }
3634
+ }
3635
+ }
3636
+ }
3637
+ },
3638
+ "post": {
3639
+ "summary": "Add questions",
3640
+ "operationId": "questions.create",
3641
+ "tags": [
3642
+ "questions"
3643
+ ],
3644
+ "security": [
3645
+ {
3646
+ "bearer": []
3647
+ }
3648
+ ],
3649
+ "parameters": [
3650
+ {
3651
+ "name": "id",
3652
+ "in": "path",
3653
+ "required": true,
3654
+ "schema": {
3655
+ "type": "string"
3656
+ }
3657
+ },
3658
+ {
3659
+ "name": "Idempotency-Key",
3660
+ "in": "header",
3661
+ "required": false,
3662
+ "description": "A new random string for each new request, the same string for a retry. A retry gets the first reply.",
3663
+ "schema": {
3664
+ "type": "string",
3665
+ "maxLength": 255
3666
+ }
3667
+ }
3668
+ ],
3669
+ "requestBody": {
3670
+ "required": true,
3671
+ "content": {
3672
+ "application/json": {
3673
+ "schema": {
3674
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
3675
+ "type": "object",
3676
+ "properties": {
3677
+ "questions": {
3678
+ "minItems": 1,
3679
+ "maxItems": 25,
3680
+ "type": "array",
3681
+ "items": {
3682
+ "type": "object",
3683
+ "properties": {
3684
+ "text": {
3685
+ "type": "string",
3686
+ "minLength": 8,
3687
+ "maxLength": 500,
3688
+ "description": "The question, 8 to 500 characters"
3689
+ },
3690
+ "topic": {
3691
+ "description": "The topic that groups the question",
3692
+ "anyOf": [
3693
+ {
3694
+ "type": "string",
3695
+ "maxLength": 80,
3696
+ "description": "The topic that groups the question"
3697
+ },
3698
+ {
3699
+ "type": "null"
3700
+ }
3701
+ ]
3702
+ },
3703
+ "profile_id": {
3704
+ "description": "The buyer profile that asks the question",
3705
+ "anyOf": [
3706
+ {
3707
+ "type": "string",
3708
+ "pattern": "^\\d+$"
3709
+ },
3710
+ {
3711
+ "type": "null"
3712
+ }
3713
+ ]
3714
+ }
3715
+ },
3716
+ "required": [
3717
+ "text"
3718
+ ],
3719
+ "additionalProperties": false
3720
+ },
3721
+ "description": "1 to 25 questions"
3722
+ }
3723
+ },
3724
+ "required": [
3725
+ "questions"
3726
+ ],
3727
+ "additionalProperties": false
3728
+ }
3729
+ }
3730
+ }
3731
+ },
3732
+ "responses": {
3733
+ "201": {
3734
+ "description": "OK",
3735
+ "content": {
3736
+ "application/json": {
3737
+ "schema": {
3738
+ "$ref": "#/components/schemas/AddedQuestionList"
3739
+ }
3740
+ }
3741
+ }
3742
+ },
3743
+ "default": {
3744
+ "description": "Error",
3745
+ "content": {
3746
+ "application/json": {
3747
+ "schema": {
3748
+ "type": "object",
3749
+ "required": [
3750
+ "error"
3751
+ ],
3752
+ "properties": {
3753
+ "error": {
3754
+ "type": "object",
3755
+ "required": [
3756
+ "code",
3757
+ "message",
3758
+ "param",
3759
+ "request_id"
3760
+ ],
3761
+ "properties": {
3762
+ "code": {
3763
+ "type": "string",
3764
+ "enum": [
3765
+ "invalid_key",
3766
+ "key_revoked",
3767
+ "plan_no_api",
3768
+ "needs_plan",
3769
+ "key_read_only",
3770
+ "not_found",
3771
+ "idempotency_conflict",
3772
+ "request_in_progress",
3773
+ "invalid_param",
3774
+ "invalid_cursor",
3775
+ "no_credits",
3776
+ "project_limit",
3777
+ "profile_limit",
3778
+ "site_unreadable",
3779
+ "rate_limited",
3780
+ "internal_error"
3781
+ ]
3782
+ },
3783
+ "message": {
3784
+ "type": "string"
3785
+ },
3786
+ "param": {
3787
+ "type": [
3788
+ "string",
3789
+ "null"
3790
+ ]
3791
+ },
3792
+ "request_id": {
3793
+ "type": "string"
3794
+ },
3795
+ "details": {
3796
+ "type": "object"
3797
+ }
3798
+ }
3799
+ }
3800
+ }
3801
+ }
3802
+ }
3803
+ }
3804
+ }
3805
+ }
3806
+ }
3807
+ },
3808
+ "/projects/{id}/recommendations": {
3809
+ "get": {
3810
+ "summary": "The project's recommendations, open first",
3811
+ "operationId": "recommendations.list",
3812
+ "tags": [
3813
+ "recommendations"
3814
+ ],
3815
+ "security": [
3816
+ {
3817
+ "bearer": []
3818
+ }
3819
+ ],
3820
+ "parameters": [
3821
+ {
3822
+ "name": "id",
3823
+ "in": "path",
3824
+ "required": true,
3825
+ "schema": {
3826
+ "type": "string"
3827
+ }
3828
+ },
3829
+ {
3830
+ "name": "status",
3831
+ "in": "query",
3832
+ "required": false,
3833
+ "description": "Only recommendations with this status",
3834
+ "schema": {
3835
+ "type": "string",
3836
+ "enum": [
3837
+ "open",
3838
+ "done",
3839
+ "dismissed"
3840
+ ]
3841
+ }
3842
+ },
3843
+ {
3844
+ "name": "limit",
3845
+ "in": "query",
3846
+ "required": false,
3847
+ "description": "Rows in one page, 1 to 100",
3848
+ "schema": {
3849
+ "default": 25,
3850
+ "type": "integer",
3851
+ "minimum": 1,
3852
+ "maximum": 100
3853
+ }
3854
+ },
3855
+ {
3856
+ "name": "cursor",
3857
+ "in": "query",
3858
+ "required": false,
3859
+ "description": "The next_cursor of the page before",
3860
+ "schema": {
3861
+ "type": "string",
3862
+ "minLength": 1
3863
+ }
3864
+ }
3865
+ ],
3866
+ "responses": {
3867
+ "200": {
3868
+ "description": "OK",
3869
+ "content": {
3870
+ "application/json": {
3871
+ "schema": {
3872
+ "$ref": "#/components/schemas/RecommendationList"
3873
+ }
3874
+ }
3875
+ }
3876
+ },
3877
+ "default": {
3878
+ "description": "Error",
3879
+ "content": {
3880
+ "application/json": {
3881
+ "schema": {
3882
+ "type": "object",
3883
+ "required": [
3884
+ "error"
3885
+ ],
3886
+ "properties": {
3887
+ "error": {
3888
+ "type": "object",
3889
+ "required": [
3890
+ "code",
3891
+ "message",
3892
+ "param",
3893
+ "request_id"
3894
+ ],
3895
+ "properties": {
3896
+ "code": {
3897
+ "type": "string",
3898
+ "enum": [
3899
+ "invalid_key",
3900
+ "key_revoked",
3901
+ "plan_no_api",
3902
+ "needs_plan",
3903
+ "key_read_only",
3904
+ "not_found",
3905
+ "idempotency_conflict",
3906
+ "request_in_progress",
3907
+ "invalid_param",
3908
+ "invalid_cursor",
3909
+ "no_credits",
3910
+ "project_limit",
3911
+ "profile_limit",
3912
+ "site_unreadable",
3913
+ "rate_limited",
3914
+ "internal_error"
3915
+ ]
3916
+ },
3917
+ "message": {
3918
+ "type": "string"
3919
+ },
3920
+ "param": {
3921
+ "type": [
3922
+ "string",
3923
+ "null"
3924
+ ]
3925
+ },
3926
+ "request_id": {
3927
+ "type": "string"
3928
+ },
3929
+ "details": {
3930
+ "type": "object"
3931
+ }
3932
+ }
3933
+ }
3934
+ }
3935
+ }
3936
+ }
3937
+ }
3938
+ }
3939
+ }
3940
+ }
3941
+ },
3942
+ "/projects/{id}/profiles": {
3943
+ "get": {
3944
+ "summary": "The project's buyer profiles",
3945
+ "operationId": "profiles.list",
3946
+ "tags": [
3947
+ "profiles"
3948
+ ],
3949
+ "security": [
3950
+ {
3951
+ "bearer": []
3952
+ }
3953
+ ],
3954
+ "parameters": [
3955
+ {
3956
+ "name": "id",
3957
+ "in": "path",
3958
+ "required": true,
3959
+ "schema": {
3960
+ "type": "string"
3961
+ }
3962
+ },
3963
+ {
3964
+ "name": "limit",
3965
+ "in": "query",
3966
+ "required": false,
3967
+ "description": "Rows in one page, 1 to 100",
3968
+ "schema": {
3969
+ "default": 25,
3970
+ "type": "integer",
3971
+ "minimum": 1,
3972
+ "maximum": 100
3973
+ }
3974
+ },
3975
+ {
3976
+ "name": "cursor",
3977
+ "in": "query",
3978
+ "required": false,
3979
+ "description": "The next_cursor of the page before",
3980
+ "schema": {
3981
+ "type": "string",
3982
+ "minLength": 1
3983
+ }
3984
+ }
3985
+ ],
3986
+ "responses": {
3987
+ "200": {
3988
+ "description": "OK",
3989
+ "content": {
3990
+ "application/json": {
3991
+ "schema": {
3992
+ "$ref": "#/components/schemas/ProfileList"
3993
+ }
3994
+ }
3995
+ }
3996
+ },
3997
+ "default": {
3998
+ "description": "Error",
3999
+ "content": {
4000
+ "application/json": {
4001
+ "schema": {
4002
+ "type": "object",
4003
+ "required": [
4004
+ "error"
4005
+ ],
4006
+ "properties": {
4007
+ "error": {
4008
+ "type": "object",
4009
+ "required": [
4010
+ "code",
4011
+ "message",
4012
+ "param",
4013
+ "request_id"
4014
+ ],
4015
+ "properties": {
4016
+ "code": {
4017
+ "type": "string",
4018
+ "enum": [
4019
+ "invalid_key",
4020
+ "key_revoked",
4021
+ "plan_no_api",
4022
+ "needs_plan",
4023
+ "key_read_only",
4024
+ "not_found",
4025
+ "idempotency_conflict",
4026
+ "request_in_progress",
4027
+ "invalid_param",
4028
+ "invalid_cursor",
4029
+ "no_credits",
4030
+ "project_limit",
4031
+ "profile_limit",
4032
+ "site_unreadable",
4033
+ "rate_limited",
4034
+ "internal_error"
4035
+ ]
4036
+ },
4037
+ "message": {
4038
+ "type": "string"
4039
+ },
4040
+ "param": {
4041
+ "type": [
4042
+ "string",
4043
+ "null"
4044
+ ]
4045
+ },
4046
+ "request_id": {
4047
+ "type": "string"
4048
+ },
4049
+ "details": {
4050
+ "type": "object"
4051
+ }
4052
+ }
4053
+ }
4054
+ }
4055
+ }
4056
+ }
4057
+ }
4058
+ }
4059
+ }
4060
+ },
4061
+ "post": {
4062
+ "summary": "Add a buyer profile",
4063
+ "operationId": "profiles.create",
4064
+ "tags": [
4065
+ "profiles"
4066
+ ],
4067
+ "security": [
4068
+ {
4069
+ "bearer": []
4070
+ }
4071
+ ],
4072
+ "parameters": [
4073
+ {
4074
+ "name": "id",
4075
+ "in": "path",
4076
+ "required": true,
4077
+ "schema": {
4078
+ "type": "string"
4079
+ }
4080
+ },
4081
+ {
4082
+ "name": "Idempotency-Key",
4083
+ "in": "header",
4084
+ "required": false,
4085
+ "description": "A new random string for each new request, the same string for a retry. A retry gets the first reply.",
4086
+ "schema": {
4087
+ "type": "string",
4088
+ "maxLength": 255
4089
+ }
4090
+ }
4091
+ ],
4092
+ "requestBody": {
4093
+ "required": true,
4094
+ "content": {
4095
+ "application/json": {
4096
+ "schema": {
4097
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
4098
+ "type": "object",
4099
+ "properties": {
4100
+ "name": {
4101
+ "type": "string",
4102
+ "minLength": 1,
4103
+ "maxLength": 60,
4104
+ "description": "A short name, such as Agency owner"
4105
+ },
4106
+ "who": {
4107
+ "description": "Who this buyer is, in one or two sentences",
4108
+ "type": "string",
4109
+ "maxLength": 500
4110
+ }
4111
+ },
4112
+ "required": [
4113
+ "name"
4114
+ ],
4115
+ "additionalProperties": false
4116
+ }
4117
+ }
4118
+ }
4119
+ },
4120
+ "responses": {
4121
+ "201": {
4122
+ "description": "OK",
4123
+ "content": {
4124
+ "application/json": {
4125
+ "schema": {
4126
+ "$ref": "#/components/schemas/Profile"
4127
+ }
4128
+ }
4129
+ }
4130
+ },
4131
+ "default": {
4132
+ "description": "Error",
4133
+ "content": {
4134
+ "application/json": {
4135
+ "schema": {
4136
+ "type": "object",
4137
+ "required": [
4138
+ "error"
4139
+ ],
4140
+ "properties": {
4141
+ "error": {
4142
+ "type": "object",
4143
+ "required": [
4144
+ "code",
4145
+ "message",
4146
+ "param",
4147
+ "request_id"
4148
+ ],
4149
+ "properties": {
4150
+ "code": {
4151
+ "type": "string",
4152
+ "enum": [
4153
+ "invalid_key",
4154
+ "key_revoked",
4155
+ "plan_no_api",
4156
+ "needs_plan",
4157
+ "key_read_only",
4158
+ "not_found",
4159
+ "idempotency_conflict",
4160
+ "request_in_progress",
4161
+ "invalid_param",
4162
+ "invalid_cursor",
4163
+ "no_credits",
4164
+ "project_limit",
4165
+ "profile_limit",
4166
+ "site_unreadable",
4167
+ "rate_limited",
4168
+ "internal_error"
4169
+ ]
4170
+ },
4171
+ "message": {
4172
+ "type": "string"
4173
+ },
4174
+ "param": {
4175
+ "type": [
4176
+ "string",
4177
+ "null"
4178
+ ]
4179
+ },
4180
+ "request_id": {
4181
+ "type": "string"
4182
+ },
4183
+ "details": {
4184
+ "type": "object"
4185
+ }
4186
+ }
4187
+ }
4188
+ }
4189
+ }
4190
+ }
4191
+ }
4192
+ }
4193
+ }
4194
+ }
4195
+ },
4196
+ "/projects/{id}/questions/{question_id}": {
4197
+ "patch": {
4198
+ "summary": "Reword, move, pause, or resume a question",
4199
+ "operationId": "questions.update",
4200
+ "tags": [
4201
+ "questions"
4202
+ ],
4203
+ "security": [
4204
+ {
4205
+ "bearer": []
4206
+ }
4207
+ ],
4208
+ "parameters": [
4209
+ {
4210
+ "name": "id",
4211
+ "in": "path",
4212
+ "required": true,
4213
+ "schema": {
4214
+ "type": "string"
4215
+ }
4216
+ },
4217
+ {
4218
+ "name": "question_id",
4219
+ "in": "path",
4220
+ "required": true,
4221
+ "schema": {
4222
+ "type": "string"
4223
+ }
4224
+ }
4225
+ ],
4226
+ "requestBody": {
4227
+ "required": true,
4228
+ "content": {
4229
+ "application/json": {
4230
+ "schema": {
4231
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
4232
+ "type": "object",
4233
+ "properties": {
4234
+ "text": {
4235
+ "type": "string",
4236
+ "minLength": 8,
4237
+ "maxLength": 500,
4238
+ "description": "The question, 8 to 500 characters"
4239
+ },
4240
+ "topic": {
4241
+ "description": "The topic that groups the question",
4242
+ "anyOf": [
4243
+ {
4244
+ "type": "string",
4245
+ "maxLength": 80,
4246
+ "description": "The topic that groups the question"
4247
+ },
4248
+ {
4249
+ "type": "null"
4250
+ }
4251
+ ]
4252
+ },
4253
+ "active": {
4254
+ "description": "Resume or pause the question",
4255
+ "type": "boolean"
4256
+ }
4257
+ },
4258
+ "additionalProperties": false
4259
+ }
4260
+ }
4261
+ }
4262
+ },
4263
+ "responses": {
4264
+ "200": {
4265
+ "description": "OK",
4266
+ "content": {
4267
+ "application/json": {
4268
+ "schema": {
4269
+ "$ref": "#/components/schemas/Question"
4270
+ }
4271
+ }
4272
+ }
4273
+ },
4274
+ "default": {
4275
+ "description": "Error",
4276
+ "content": {
4277
+ "application/json": {
4278
+ "schema": {
4279
+ "type": "object",
4280
+ "required": [
4281
+ "error"
4282
+ ],
4283
+ "properties": {
4284
+ "error": {
4285
+ "type": "object",
4286
+ "required": [
4287
+ "code",
4288
+ "message",
4289
+ "param",
4290
+ "request_id"
4291
+ ],
4292
+ "properties": {
4293
+ "code": {
4294
+ "type": "string",
4295
+ "enum": [
4296
+ "invalid_key",
4297
+ "key_revoked",
4298
+ "plan_no_api",
4299
+ "needs_plan",
4300
+ "key_read_only",
4301
+ "not_found",
4302
+ "idempotency_conflict",
4303
+ "request_in_progress",
4304
+ "invalid_param",
4305
+ "invalid_cursor",
4306
+ "no_credits",
4307
+ "project_limit",
4308
+ "profile_limit",
4309
+ "site_unreadable",
4310
+ "rate_limited",
4311
+ "internal_error"
4312
+ ]
4313
+ },
4314
+ "message": {
4315
+ "type": "string"
4316
+ },
4317
+ "param": {
4318
+ "type": [
4319
+ "string",
4320
+ "null"
4321
+ ]
4322
+ },
4323
+ "request_id": {
4324
+ "type": "string"
4325
+ },
4326
+ "details": {
4327
+ "type": "object"
4328
+ }
4329
+ }
4330
+ }
4331
+ }
4332
+ }
4333
+ }
4334
+ }
4335
+ }
4336
+ }
4337
+ }
4338
+ },
4339
+ "/profiles/{id}": {
4340
+ "patch": {
4341
+ "summary": "Rename or describe a buyer profile",
4342
+ "operationId": "profiles.update",
4343
+ "tags": [
4344
+ "profiles"
4345
+ ],
4346
+ "security": [
4347
+ {
4348
+ "bearer": []
4349
+ }
4350
+ ],
4351
+ "parameters": [
4352
+ {
4353
+ "name": "id",
4354
+ "in": "path",
4355
+ "required": true,
4356
+ "schema": {
4357
+ "type": "string"
4358
+ }
4359
+ }
4360
+ ],
4361
+ "requestBody": {
4362
+ "required": true,
4363
+ "content": {
4364
+ "application/json": {
4365
+ "schema": {
4366
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
4367
+ "type": "object",
4368
+ "properties": {
4369
+ "name": {
4370
+ "description": "A new name",
4371
+ "type": "string",
4372
+ "minLength": 1,
4373
+ "maxLength": 60
4374
+ },
4375
+ "who": {
4376
+ "description": "Who this buyer is, in one or two sentences",
4377
+ "type": "string",
4378
+ "maxLength": 500
4379
+ }
4380
+ },
4381
+ "additionalProperties": false
4382
+ }
4383
+ }
4384
+ }
4385
+ },
4386
+ "responses": {
4387
+ "200": {
4388
+ "description": "OK",
4389
+ "content": {
4390
+ "application/json": {
4391
+ "schema": {
4392
+ "$ref": "#/components/schemas/Profile"
4393
+ }
4394
+ }
4395
+ }
4396
+ },
4397
+ "default": {
4398
+ "description": "Error",
4399
+ "content": {
4400
+ "application/json": {
4401
+ "schema": {
4402
+ "type": "object",
4403
+ "required": [
4404
+ "error"
4405
+ ],
4406
+ "properties": {
4407
+ "error": {
4408
+ "type": "object",
4409
+ "required": [
4410
+ "code",
4411
+ "message",
4412
+ "param",
4413
+ "request_id"
4414
+ ],
4415
+ "properties": {
4416
+ "code": {
4417
+ "type": "string",
4418
+ "enum": [
4419
+ "invalid_key",
4420
+ "key_revoked",
4421
+ "plan_no_api",
4422
+ "needs_plan",
4423
+ "key_read_only",
4424
+ "not_found",
4425
+ "idempotency_conflict",
4426
+ "request_in_progress",
4427
+ "invalid_param",
4428
+ "invalid_cursor",
4429
+ "no_credits",
4430
+ "project_limit",
4431
+ "profile_limit",
4432
+ "site_unreadable",
4433
+ "rate_limited",
4434
+ "internal_error"
4435
+ ]
4436
+ },
4437
+ "message": {
4438
+ "type": "string"
4439
+ },
4440
+ "param": {
4441
+ "type": [
4442
+ "string",
4443
+ "null"
4444
+ ]
4445
+ },
4446
+ "request_id": {
4447
+ "type": "string"
4448
+ },
4449
+ "details": {
4450
+ "type": "object"
4451
+ }
4452
+ }
4453
+ }
4454
+ }
4455
+ }
4456
+ }
4457
+ }
4458
+ }
4459
+ }
4460
+ },
4461
+ "delete": {
4462
+ "summary": "Remove a buyer profile; its questions stay",
4463
+ "operationId": "profiles.delete",
4464
+ "tags": [
4465
+ "profiles"
4466
+ ],
4467
+ "security": [
4468
+ {
4469
+ "bearer": []
4470
+ }
4471
+ ],
4472
+ "parameters": [
4473
+ {
4474
+ "name": "id",
4475
+ "in": "path",
4476
+ "required": true,
4477
+ "schema": {
4478
+ "type": "string"
4479
+ }
4480
+ }
4481
+ ],
4482
+ "responses": {
4483
+ "204": {
4484
+ "description": "Removed"
4485
+ },
4486
+ "default": {
4487
+ "description": "Error",
4488
+ "content": {
4489
+ "application/json": {
4490
+ "schema": {
4491
+ "type": "object",
4492
+ "required": [
4493
+ "error"
4494
+ ],
4495
+ "properties": {
4496
+ "error": {
4497
+ "type": "object",
4498
+ "required": [
4499
+ "code",
4500
+ "message",
4501
+ "param",
4502
+ "request_id"
4503
+ ],
4504
+ "properties": {
4505
+ "code": {
4506
+ "type": "string",
4507
+ "enum": [
4508
+ "invalid_key",
4509
+ "key_revoked",
4510
+ "plan_no_api",
4511
+ "needs_plan",
4512
+ "key_read_only",
4513
+ "not_found",
4514
+ "idempotency_conflict",
4515
+ "request_in_progress",
4516
+ "invalid_param",
4517
+ "invalid_cursor",
4518
+ "no_credits",
4519
+ "project_limit",
4520
+ "profile_limit",
4521
+ "site_unreadable",
4522
+ "rate_limited",
4523
+ "internal_error"
4524
+ ]
4525
+ },
4526
+ "message": {
4527
+ "type": "string"
4528
+ },
4529
+ "param": {
4530
+ "type": [
4531
+ "string",
4532
+ "null"
4533
+ ]
4534
+ },
4535
+ "request_id": {
4536
+ "type": "string"
4537
+ },
4538
+ "details": {
4539
+ "type": "object"
4540
+ }
4541
+ }
4542
+ }
4543
+ }
4544
+ }
4545
+ }
4546
+ }
4547
+ }
4548
+ }
4549
+ }
4550
+ },
4551
+ "/recommendations/{id}": {
4552
+ "patch": {
4553
+ "summary": "Mark a recommendation done or dismissed, or open it again",
4554
+ "operationId": "recommendations.update",
4555
+ "tags": [
4556
+ "recommendations"
4557
+ ],
4558
+ "security": [
4559
+ {
4560
+ "bearer": []
4561
+ }
4562
+ ],
4563
+ "parameters": [
4564
+ {
4565
+ "name": "id",
4566
+ "in": "path",
4567
+ "required": true,
4568
+ "schema": {
4569
+ "type": "string"
4570
+ }
4571
+ }
4572
+ ],
4573
+ "requestBody": {
4574
+ "required": true,
4575
+ "content": {
4576
+ "application/json": {
4577
+ "schema": {
4578
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
4579
+ "type": "object",
4580
+ "properties": {
4581
+ "status": {
4582
+ "type": "string",
4583
+ "enum": [
4584
+ "open",
4585
+ "done",
4586
+ "dismissed"
4587
+ ],
4588
+ "description": "The new status"
4589
+ }
4590
+ },
4591
+ "required": [
4592
+ "status"
4593
+ ],
4594
+ "additionalProperties": false
4595
+ }
4596
+ }
4597
+ }
4598
+ },
4599
+ "responses": {
4600
+ "200": {
4601
+ "description": "OK",
4602
+ "content": {
4603
+ "application/json": {
4604
+ "schema": {
4605
+ "$ref": "#/components/schemas/Recommendation"
4606
+ }
4607
+ }
4608
+ }
4609
+ },
4610
+ "default": {
4611
+ "description": "Error",
4612
+ "content": {
4613
+ "application/json": {
4614
+ "schema": {
4615
+ "type": "object",
4616
+ "required": [
4617
+ "error"
4618
+ ],
4619
+ "properties": {
4620
+ "error": {
4621
+ "type": "object",
4622
+ "required": [
4623
+ "code",
4624
+ "message",
4625
+ "param",
4626
+ "request_id"
4627
+ ],
4628
+ "properties": {
4629
+ "code": {
4630
+ "type": "string",
4631
+ "enum": [
4632
+ "invalid_key",
4633
+ "key_revoked",
4634
+ "plan_no_api",
4635
+ "needs_plan",
4636
+ "key_read_only",
4637
+ "not_found",
4638
+ "idempotency_conflict",
4639
+ "request_in_progress",
4640
+ "invalid_param",
4641
+ "invalid_cursor",
4642
+ "no_credits",
4643
+ "project_limit",
4644
+ "profile_limit",
4645
+ "site_unreadable",
4646
+ "rate_limited",
4647
+ "internal_error"
4648
+ ]
4649
+ },
4650
+ "message": {
4651
+ "type": "string"
4652
+ },
4653
+ "param": {
4654
+ "type": [
4655
+ "string",
4656
+ "null"
4657
+ ]
4658
+ },
4659
+ "request_id": {
4660
+ "type": "string"
4661
+ },
4662
+ "details": {
4663
+ "type": "object"
4664
+ }
4665
+ }
4666
+ }
4667
+ }
4668
+ }
4669
+ }
4670
+ }
4671
+ }
4672
+ }
4673
+ }
4674
+ }
4675
+ }
4676
+ }