API refresh

analytics.openapi.json

@@ -11,6 +11,11 @@
       "description": "Production"
     }
   ],
+  "security": [
+    {
+      "bearerAuth": []
+    }
+  ],
   "components": {
     "securitySchemes": {
       "bearerAuth": {
@@ -638,7 +643,7 @@
     "/v1/analytics/{projectId}/feedback": {
       "get": {
         "summary": "Get user feedback",
-        "description": "Returns paginated user feedback with optional filtering",
+        "description": "Returns paginated user feedback with optional filtering. Paginate using the `cursor` from each response while `hasMore` is `true`.",
         "tags": [
           "Analytics"
         ],
@@ -647,6 +652,13 @@
             "bearerAuth": []
           }
         ],
+        "x-codeSamples": [
+          {
+            "lang": "bash",
+            "label": "cURL",
+            "source": "curl \"https://api.mintlify.com/v1/analytics/my-project-id/feedback?dateFrom=2024-01-01&dateTo=2024-02-01&limit=50\" \\\n  -H \"Authorization: Bearer mint_xxxxx\""
+          }
+        ],
         "parameters": [
           {
             "$ref": "#/components/parameters/projectId"
@@ -754,7 +766,7 @@
     "/v1/analytics/{projectId}/feedback/by-page": {
       "get": {
         "summary": "Get feedback by page",
-        "description": "Returns feedback counts aggregated by documentation page path (thumbs up/down for contextual feedback, code snippet count, and total per page)",
+        "description": "Returns feedback counts aggregated by documentation page path — thumbs up/down for contextual feedback, code snippet feedback count, and total per page.",
         "tags": [
           "Analytics"
         ],
@@ -763,6 +775,13 @@
             "bearerAuth": []
           }
         ],
+        "x-codeSamples": [
+          {
+            "lang": "bash",
+            "label": "cURL",
+            "source": "curl \"https://api.mintlify.com/v1/analytics/my-project-id/feedback/by-page?dateFrom=2024-01-01&dateTo=2024-02-01\" \\\n  -H \"Authorization: Bearer mint_xxxxx\""
+          }
+        ],
         "parameters": [
           {
             "$ref": "#/components/parameters/projectId"
@@ -861,7 +880,7 @@
     "/v1/analytics/{projectId}/assistant": {
       "get": {
         "summary": "Get assistant conversations",
-        "description": "Returns paginated AI assistant conversation history",
+        "description": "Returns paginated AI assistant conversation history, including the user query, assistant response, sources cited, resolution status, and query category. Paginate using the `cursor` from each response while `hasMore` is `true`.",
         "tags": [
           "Analytics"
         ],
@@ -870,6 +889,13 @@
             "bearerAuth": []
           }
         ],
+        "x-codeSamples": [
+          {
+            "lang": "bash",
+            "label": "cURL",
+            "source": "curl \"https://api.mintlify.com/v1/analytics/my-project-id/assistant?dateFrom=2024-01-01&dateTo=2024-02-01&limit=100\" \\\n  -H \"Authorization: Bearer mint_xxxxx\""
+          }
+        ],
         "parameters": [
           {
             "$ref": "#/components/parameters/projectId"
@@ -954,7 +980,7 @@
     "/v1/analytics/{projectId}/assistant/caller-stats": {
       "get": {
         "summary": "Get assistant caller stats",
-        "description": "Returns a breakdown of assistant query counts by caller type (web, API, and other) for the specified date range.",
+        "description": "Returns a breakdown of assistant query counts by caller type (web, API, and other) for the specified date range. Use this to understand whether queries come from your documentation site or from direct API integrations.",
         "tags": [
           "Analytics"
         ],
@@ -963,6 +989,13 @@
             "bearerAuth": []
           }
         ],
+        "x-codeSamples": [
+          {
+            "lang": "bash",
+            "label": "cURL",
+            "source": "curl \"https://api.mintlify.com/v1/analytics/my-project-id/assistant/caller-stats?dateFrom=2024-01-01&dateTo=2024-02-01\" \\\n  -H \"Authorization: Bearer mint_xxxxx\""
+          }
+        ],
         "parameters": [
           {
             "$ref": "#/components/parameters/projectId"
@@ -1025,7 +1058,7 @@
     "/v1/analytics/{projectId}/searches": {
       "get": {
         "summary": "Get search queries",
-        "description": "Returns paginated documentation search terms for the date range, ordered by hit count descending. Each row includes click-through rate, the most-clicked result path for that query (if any), and the last time the term was searched. `totalSearches` is the total number of search query events in the same date range (sum of all hits, not distinct queries).",
+        "description": "Returns paginated documentation search terms ordered by hit count descending. Each row includes click-through rate, the most-clicked result path, and the last time the term was searched. `totalSearches` is the total search event count (sum of all hits, not distinct queries). Paginate using `nextCursor` while it is not null.",
         "tags": [
           "Analytics"
         ],
@@ -1034,6 +1067,13 @@
             "bearerAuth": []
           }
         ],
+        "x-codeSamples": [
+          {
+            "lang": "bash",
+            "label": "cURL",
+            "source": "curl \"https://api.mintlify.com/v1/analytics/my-project-id/searches?dateFrom=2024-01-01&dateTo=2024-02-01&limit=50\" \\\n  -H \"Authorization: Bearer mint_xxxxx\""
+          }
+        ],
         "parameters": [
           {
             "$ref": "#/components/parameters/projectId"
@@ -1117,7 +1157,7 @@
     "/v1/analytics/{projectId}/views": {
       "get": {
         "summary": "Get page views",
-        "description": "Returns per-path and site-wide content view event counts, split by human and AI traffic.",
+        "description": "Returns per-path and site-wide content view event counts, split by human and AI traffic. Paginate using offset-based pagination: increment `offset` by `limit` while `hasMore` is `true`.",
         "tags": [
           "Analytics"
         ],
@@ -1126,6 +1166,13 @@
             "bearerAuth": []
           }
         ],
+        "x-codeSamples": [
+          {
+            "lang": "bash",
+            "label": "cURL",
+            "source": "curl \"https://api.mintlify.com/v1/analytics/my-project-id/views?dateFrom=2024-01-01&dateTo=2024-02-01&limit=50&offset=0\" \\\n  -H \"Authorization: Bearer mint_xxxxx\""
+          }
+        ],
         "parameters": [
           {
             "$ref": "#/components/parameters/projectId"
@@ -1211,7 +1258,7 @@
     "/v1/analytics/{projectId}/visitors": {
       "get": {
         "summary": "Get unique visitors",
-        "description": "Returns per-path and site-wide approximate distinct visitors by traffic type. The `total` field is deduplicated across human and AI (union of distinct visitor IDs with any qualifying content view).",
+        "description": "Returns per-path and site-wide approximate distinct visitors split by human and AI traffic. The `total` field is deduplicated across human and AI (union of distinct visitor IDs). Paginate using offset-based pagination: increment `offset` by `limit` while `hasMore` is `true`.",
         "tags": [
           "Analytics"
         ],
@@ -1220,6 +1267,13 @@
             "bearerAuth": []
           }
         ],
+        "x-codeSamples": [
+          {
+            "lang": "bash",
+            "label": "cURL",
+            "source": "curl \"https://api.mintlify.com/v1/analytics/my-project-id/visitors?dateFrom=2024-01-01&dateTo=2024-02-01&limit=50&offset=0\" \\\n  -H \"Authorization: Bearer mint_xxxxx\""
+          }
+        ],
         "parameters": [
           {
             "$ref": "#/components/parameters/projectId"