Repository navigation
Expand file tree
/
Copy pathanalytics.openapi.json
More file actions
1607 lines (1607 loc) · 55.8 KB
/
Copy pathanalytics.openapi.json
File metadata and controls
1607 lines (1607 loc) · 55.8 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"openapi": "3.1.0",
"info": {
"title": "Mintlify Analytics Export API",
"version": "1.0.0",
"description": "API for exporting documentation analytics data"
},
"servers": [
{
"url": "https://api.mintlify.com",
"description": "Production"
}
],
"components": {
"securitySchemes": {
"bearerAuth": {
"type": "http",
"scheme": "bearer",
"description": "The Authorization header expects a Bearer token. Use an admin API key. This is a server-side secret key. Generate one on the [API keys page](https://app.mintlify.com/settings/organization/api-keys) in your dashboard."
}
},
"schemas": {
"projectId": {
"type": "string",
"description": "Your project ID. Can be copied from the [API keys](https://app.mintlify.com/settings/organization/api-keys) page in your dashboard."
},
"FeedbackResponse": {
"type": "object",
"properties": {
"feedback": {
"type": "array",
"description": "List of feedback entries.",
"items": {
"anyOf": [
{
"description": "Returned when source is `contextual`. Includes whether the user found the page helpful and an optional contact email.",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique feedback identifier."
},
"path": {
"type": "string",
"description": "The path or URL to the source document."
},
"comment": {
"type": [
"string",
"null"
],
"description": "Text of the user's feedback comment."
},
"createdAt": {
"type": [
"string",
"null"
],
"description": "Timestamp when the feedback was submitted."
},
"source": {
"type": "string",
"enum": [
"code_snippet",
"contextual",
"agent",
"thumbs_only"
],
"description": "Where the feedback originated. `code_snippet` is feedback on a code block, `contextual` is page-level feedback, `agent` is feedback submitted by a third-party AI agent, `thumbs_only` is a thumbs up/down vote."
},
"status": {
"type": "string",
"enum": [
"pending",
"in_progress",
"resolved",
"dismissed"
],
"description": "Current review status of the feedback."
},
"helpful": {
"type": "boolean",
"description": "Whether the user found the content helpful."
},
"contact": {
"type": [
"string",
"null"
],
"description": "Email address the user provided for follow-up."
}
},
"required": [
"id",
"path",
"comment",
"createdAt",
"source",
"status",
"helpful",
"contact"
]
},
{
"description": "Returned when source is `code_snippet`. Includes the code, filename, and language of the snippet the feedback relates to.",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique feedback identifier."
},
"path": {
"type": "string",
"description": "The path or URL to the source document."
},
"comment": {
"type": [
"string",
"null"
],
"description": "Text of the user's feedback comment."
},
"createdAt": {
"type": [
"string",
"null"
],
"description": "Timestamp when the feedback was submitted."
},
"source": {
"type": "string",
"enum": [
"code_snippet",
"contextual",
"agent",
"thumbs_only"
],
"description": "Where the feedback originated. `code_snippet` is feedback on a code block, `contextual` is page-level feedback, `agent` is feedback submitted by a third-party AI agent, `thumbs_only` is a thumbs up/down vote."
},
"status": {
"type": "string",
"enum": [
"pending",
"in_progress",
"resolved",
"dismissed"
],
"description": "Current review status of the feedback."
},
"code": {
"type": "string",
"description": "The code snippet the feedback relates to."
},
"filename": {
"type": [
"string",
"null"
],
"description": "Filename associated with the code snippet."
},
"lang": {
"type": [
"string",
"null"
],
"description": "Programming language of the code snippet."
}
},
"required": [
"id",
"path",
"comment",
"createdAt",
"source",
"status",
"code",
"filename",
"lang"
]
},
{
"description": "Returned when source is `thumbs_only`. A thumbs up or thumbs down vote on a page without a written comment. Includes whether the user found the page helpful.",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique feedback identifier."
},
"path": {
"type": "string",
"description": "The path or URL to the source document."
},
"comment": {
"type": [
"string",
"null"
],
"description": "Text of the user's feedback comment."
},
"createdAt": {
"type": [
"string",
"null"
],
"description": "Timestamp when the feedback was submitted."
},
"source": {
"type": "string",
"enum": [
"code_snippet",
"contextual",
"agent",
"thumbs_only"
],
"description": "Where the feedback originated. `code_snippet` is feedback on a code block, `contextual` is page-level feedback, `agent` is feedback submitted by a third-party AI agent, `thumbs_only` is a thumbs up/down vote."
},
"status": {
"type": "string",
"enum": [
"pending",
"in_progress",
"resolved",
"dismissed"
],
"description": "Current review status of the feedback."
},
"helpful": {
"type": "boolean",
"description": "Whether the user found the content helpful."
}
},
"required": [
"id",
"path",
"comment",
"createdAt",
"source",
"status",
"helpful"
]
},
{
"description": "Returned when source is `agent`. Contains base feedback fields only.",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique feedback identifier."
},
"path": {
"type": "string",
"description": "The path or URL to the source document."
},
"comment": {
"type": [
"string",
"null"
],
"description": "Text of the user's feedback comment."
},
"createdAt": {
"type": [
"string",
"null"
],
"description": "Timestamp when the feedback was submitted."
},
"source": {
"type": "string",
"enum": [
"code_snippet",
"contextual",
"agent",
"thumbs_only"
],
"description": "Where the feedback originated. `code_snippet` is feedback on a code block, `contextual` is page-level feedback, `agent` is feedback submitted by a third-party AI agent, `thumbs_only` is a thumbs up/down vote."
},
"status": {
"type": "string",
"enum": [
"pending",
"in_progress",
"resolved",
"dismissed"
],
"description": "Current review status of the feedback."
}
},
"required": [
"id",
"path",
"comment",
"createdAt",
"source",
"status"
]
}
]
}
},
"nextCursor": {
"type": [
"string",
"null"
],
"description": "Cursor to retrieve the next page of results. Null if no more results."
},
"hasMore": {
"type": "boolean",
"description": "Whether additional results are available beyond this page."
}
},
"required": [
"feedback",
"nextCursor",
"hasMore"
]
},
"AnalyticsErrorResponse": {
"type": "object",
"properties": {
"error": {
"type": "string",
"description": "Error message describing what went wrong."
},
"details": {
"type": "array",
"description": "Additional details about the error.",
"items": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "Description of a specific validation or processing error."
}
},
"required": [
"message"
]
}
}
},
"required": [
"error"
]
},
"AssistantConversationsResponse": {
"type": "object",
"properties": {
"conversations": {
"type": "array",
"description": "List of assistant conversations.",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique identifier for this turn. Each row in a multi-turn conversation has a different `id`."
},
"conversationId": {
"type": "string",
"description": "Identifier of the conversation this turn belongs to. Rows from the same conversation share the same `conversationId`. Use it as the `threadId` for the Get assistant conversation thread endpoint."
},
"timestamp": {
"type": "string",
"description": "Timestamp of the user message that started this turn."
},
"query": {
"type": "string",
"description": "The user's question to the assistant."
},
"response": {
"type": "string",
"description": "The assistant's response. For clarifying-question turns, this is the question the assistant asked the user."
},
"responseType": {
"type": "string",
"enum": [
"answer",
"clarifying_question"
],
"description": "Type of response returned to the user. `answer` is a final answer. `clarifying_question` means the assistant asked the user a follow-up question instead of answering. Defaults to `answer` when not present."
},
"sources": {
"type": "array",
"description": "Documentation pages referenced in the response.",
"items": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "Title of the referenced documentation page."
},
"url": {
"type": "string",
"description": "URL of the referenced documentation page."
}
},
"required": [
"title",
"url"
]
}
},
"resolutionStatus": {
"type": "string",
"enum": [
"answered",
"unanswered"
],
"description": "Whether the assistant successfully answered this turn. Computed per row: `unanswered` when the assistant marked the question as not covered by the available documentation. If the conversation is recorded as unanswered, for example because a response failed, and no turn was marked as not covered, every turn in the conversation is `unanswered`. Otherwise `answered`."
},
"queryCategory": {
"type": [
"string",
"null"
],
"description": "Auto-assigned category grouping for the conversation, if applicable."
},
"feedback": {
"type": [
"string",
"null"
],
"enum": [
"positive",
"negative",
null
],
"description": "The user's thumbs rating on the assistant's response. `positive` for thumbs up, `negative` for thumbs down, or `null` if the user did not rate the response."
},
"pageUrl": {
"type": [
"string",
"null"
],
"description": "Full URL of the documentation page where the conversation started. Null if no page path was captured."
}
},
"required": [
"id",
"conversationId",
"timestamp",
"query",
"response",
"sources",
"resolutionStatus",
"queryCategory",
"feedback",
"pageUrl"
]
}
},
"nextCursor": {
"type": [
"string",
"null"
],
"description": "Cursor to retrieve the next page of results. Null if no more results."
},
"hasMore": {
"type": "boolean",
"description": "Whether additional results are available beyond this page."
}
},
"required": [
"conversations",
"nextCursor",
"hasMore"
]
},
"FeedbackGroupedByPageResponse": {
"type": "object",
"properties": {
"feedback": {
"type": "array",
"description": "Feedback counts aggregated by documentation page path.",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string",
"description": "The documentation page path."
},
"thumbsUp": {
"type": "number",
"description": "Number of positive (thumbs up) contextual feedback entries."
},
"thumbsDown": {
"type": "number",
"description": "Number of negative (thumbs down) contextual feedback entries."
},
"code": {
"type": "number",
"description": "Number of code snippet feedback entries."
},
"total": {
"type": "number",
"description": "Total feedback entries for this page."
}
},
"required": [
"path",
"thumbsUp",
"thumbsDown",
"code",
"total"
]
}
},
"hasMore": {
"type": "boolean",
"description": "Whether additional results are available beyond this page."
}
},
"required": [
"feedback",
"hasMore"
]
},
"SearchesResponse": {
"type": "object",
"properties": {
"searches": {
"type": "array",
"description": "Search terms ordered by hit count descending.",
"items": {
"type": "object",
"properties": {
"searchQuery": {
"type": "string",
"description": "The search term entered by users."
},
"hits": {
"type": "number",
"description": "Number of times this term was searched."
},
"ctr": {
"type": "number",
"description": "Percentage of searches for this term that resulted in a click on a specific search result (clicks ÷ hits × 100). A click includes selecting a result with the pointer or pressing Enter when a result is highlighted. Submitting a query by itself does not count as a click. Clicking the AI assistant in the search bar, or pressing Enter to use it, counts as a search with no click and is not tracked separately in this field."
},
"topClickedPage": {
"type": [
"string",
"null"
],
"description": "The most-clicked result path for this query, if any."
},
"lastSearchedAt": {
"type": "string",
"description": "Timestamp of the last time this term was searched."
}
},
"required": [
"searchQuery",
"hits",
"ctr",
"topClickedPage",
"lastSearchedAt"
]
}
},
"totalSearches": {
"type": "integer",
"minimum": 0,
"description": "Total count of search events in the requested date range (sum of all hits, not distinct queries)."
},
"nextCursor": {
"type": [
"string",
"null"
],
"description": "Opaque pagination cursor for the next page. Null if no more results."
}
},
"required": [
"searches",
"totalSearches",
"nextCursor"
]
},
"ViewsTrafficTotals": {
"type": "object",
"properties": {
"human": {
"type": "number",
"description": "Site-wide content view events from human traffic."
},
"ai": {
"type": "number",
"description": "Site-wide content view events from AI bot traffic."
},
"total": {
"type": "number",
"description": "Site-wide content view events."
}
},
"required": ["human", "ai", "total"]
},
"ViewsByPageResponse": {
"type": "object",
"properties": {
"totals": {
"$ref": "#/components/schemas/ViewsTrafficTotals",
"description": "Site-wide view totals for the date range."
},
"views": {
"type": "array",
"description": "Per-page view counts.",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string",
"description": "The documentation page path."
},
"human": {
"type": "number",
"description": "Content view events on this path from human traffic."
},
"ai": {
"type": "number",
"description": "Content view events on this path from AI bot traffic."
},
"total": {
"type": "number",
"description": "Total content view events on this path."
}
},
"required": ["path", "human", "ai", "total"]
}
},
"hasMore": {
"type": "boolean",
"description": "Whether additional results are available beyond this page."
}
},
"required": ["totals", "views", "hasMore"]
},
"AssistantThreadResponse": {
"type": "object",
"properties": {
"threadId": {
"type": "string",
"description": "Assistant conversation thread identifier (ULID)."
},
"createdAt": {
"type": "string",
"description": "Timestamp when the thread was created."
},
"messages": {
"type": "array",
"description": "Ordered list of messages exchanged in the thread.",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique message identifier."
},
"role": {
"type": "string",
"enum": ["user", "assistant"],
"description": "Whether the message was sent by the user or the assistant."
},
"content": {
"type": "string",
"description": "The text content of the message."
},
"createdAt": {
"type": "string",
"description": "Timestamp when the message was sent."
}
},
"required": ["id", "role", "content", "createdAt"]
}
}
},
"required": ["threadId", "createdAt", "messages"]
},
"AssistantCallerStatsResponse": {
"type": "object",
"properties": {
"web": {
"type": "number",
"description": "Number of assistant conversations started from the web (documentation site)."
},
"api": {
"type": "number",
"description": "Number of assistant conversations started from API calls."
},
"other": {
"type": "number",
"description": "Number of assistant conversations started from other sources (e.g., integrations, SDKs)."
},
"total": {
"type": "number",
"description": "Total assistant conversations across all caller types."
}
},
"required": ["web", "api", "other", "total"]
},
"VisitorsTrafficTotals": {
"type": "object",
"properties": {
"human": {
"type": "number",
"description": "Site-wide unique visitors from human traffic."
},
"ai": {
"type": "number",
"description": "Site-wide unique visitors from AI bot traffic."
},
"total": {
"type": "number",
"description": "Site-wide approximate distinct visitors with any qualifying view (deduplicated across human and AI)."
}
},
"required": ["human", "ai", "total"]
},
"VisitorsByPageResponse": {
"type": "object",
"properties": {
"totals": {
"$ref": "#/components/schemas/VisitorsTrafficTotals",
"description": "Site-wide unique visitor totals for the date range."
},
"visitors": {
"type": "array",
"description": "Per-page visitor counts.",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string",
"description": "The documentation page path."
},
"human": {
"type": "number",
"description": "Unique visitors from human traffic."
},
"ai": {
"type": "number",
"description": "Unique visitors from AI bot traffic."
},
"total": {
"type": "number",
"description": "Approximate distinct visitors with any qualifying view on this path (deduplicated across human and AI)."
}
},
"required": ["path", "human", "ai", "total"]
}
},
"hasMore": {
"type": "boolean",
"description": "Whether additional results are available beyond this page."
}
},
"required": ["totals", "visitors", "hasMore"]
}
},
"parameters": {
"projectId": {
"schema": {
"$ref": "#/components/schemas/projectId"
},
"required": true,
"name": "projectId",
"in": "path"
}
}
},
"paths": {
"/v1/analytics/{projectId}/feedback": {
"get": {
"summary": "List feedback",
"description": "Lists user feedback, with optional filtering and pagination.\n\nAuthenticate with an admin API key.",
"tags": [
"Analytics"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/projectId"
},
{
"schema": {
"type": "string",
"description": "Date in ISO 8601 or YYYY-MM-DD format",
"example": "2024-01-01"
},
"required": false,
"name": "dateFrom",
"in": "query"
},
{
"schema": {
"type": "string",
"description": "Date in ISO 8601 or YYYY-MM-DD format. `dateTo` is an exclusive upper limit. Results include dates before, but not on, the specified date.",
"example": "2024-01-01"
},
"required": false,
"name": "dateTo",
"in": "query"
},
{
"schema": {
"type": "string",
"enum": [
"code_snippet",
"contextual",
"agent",
"thumbs_only"
],
"description": "Filter by feedback source"
},
"required": false,
"name": "source",
"in": "query"
},
{
"schema": {
"type": "string",
"description": "Comma-separated list of statuses to filter by"
},
"required": false,
"name": "status",
"in": "query"
},
{
"schema": {
"type": "number",
"minimum": 1,
"maximum": 100,
"default": 50,
"description": "Max results per page"
},
"required": false,
"name": "limit",
"in": "query"
},
{
"schema": {
"type": "string",
"description": "Pagination cursor"
},
"required": false,
"name": "cursor",
"in": "query"
}
],
"responses": {
"200": {
"description": "Feedback data with pagination",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FeedbackResponse"
}
}
}
},
"400": {
"description": "A query parameter is invalid, such as a malformed date or a `limit` outside the allowed range, or the project ID is malformed. The response body describes the error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AnalyticsErrorResponse"
}
}
}
},
"401": {
"description": "The API key is missing or invalid, or your plan doesn't include API access."
},
"403": {
"description": "Your request came from an IP address that isn't on your API key's allowlist."
},
"404": {
"description": "The project doesn't exist or doesn't belong to your organization."
},
"429": {
"description": "You exceeded the rate limit for the analytics endpoints."
},
"500": {
"description": "An unexpected server error occurred. Retry the request. If the error continues, contact support.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AnalyticsErrorResponse"
}
}
}
}
}
}
},
"/v1/analytics/{projectId}/feedback/by-page": {
"get": {
"summary": "Get feedback by page",
"description": "Retrieves feedback counts aggregated by documentation page path, including thumbs up and down votes for contextual feedback, code snippet feedback count, and total per page.\n\nAuthenticate with an admin API key.",
"tags": [
"Analytics"
],
"security": [
{
"bearerAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/projectId"
},
{
"schema": {
"type": "string",
"description": "Date in ISO 8601 or YYYY-MM-DD format",
"example": "2024-01-01"
},
"required": false,
"name": "dateFrom",
"in": "query"
},
{
"schema": {
"type": "string",
"description": "Date in ISO 8601 or YYYY-MM-DD format. `dateTo` is an exclusive upper limit. Results include dates before, but not on, the specified date.",
"example": "2024-01-01"
},
"required": false,
"name": "dateTo",
"in": "query"
},
{
"schema": {
"type": "number",
"minimum": 1,
"maximum": 100,
"default": 10,
"description": "Max results per page"
},
"required": false,
"name": "limit",
"in": "query"
},
{
"schema": {
"type": "string",
"enum": [
"code_snippet",
"contextual",
"agent",
"thumbs_only"
],
"description": "Filter by feedback source"
},
"required": false,
"name": "source",
"in": "query"
},
{
"schema": {
"type": "string",
"description": "Comma-separated list of statuses to filter by"
},
"required": false,
"name": "status",
"in": "query"
}
],
"responses": {
"200": {
"description": "Per-page feedback aggregates with pagination flag",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FeedbackGroupedByPageResponse"
}
}
}
},
"400": {
"description": "A query parameter is invalid, such as a malformed date or a `limit` outside the allowed range, or the project ID is malformed. The response body describes the error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AnalyticsErrorResponse"
}
}
}
},
"401": {
"description": "The API key is missing or invalid, or your plan doesn't include API access."
},
"403": {
"description": "Your request came from an IP address that isn't on your API key's allowlist."