Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions api/analytics/assistant-caller-stats.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Get assistant caller stats"
openapi: /analytics.openapi.json GET /v1/analytics/{projectId}/assistant/caller-stats

Check warning on line 3 in api/analytics/assistant-caller-stats.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/analytics/assistant-caller-stats.mdx#L3

Use 'JSON' instead of 'json'.
keywords: ["analytics", "assistant", "caller", "stats", "export"]

---
Expand All @@ -10,10 +10,14 @@
Use this endpoint to see how the system distributes assistant queries across different caller types. The response breaks down total queries into:

- **web**: Queries from the documentation site
- **api**: Queries from direct API calls

Check warning on line 13 in api/analytics/assistant-caller-stats.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/analytics/assistant-caller-stats.mdx#L13

Use 'API' instead of 'api'.
- **other**: Queries from other sources (for example, integrations, SDKs)
- **total**: Sum of all query types

## Filtering

Filter by date range using `dateFrom` and `dateTo` parameters.

## Rate limits

- 100 requests per Mintlify organization per hour
4 changes: 4 additions & 0 deletions api/analytics/assistant-conversations.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Get assistant conversations"
openapi: /analytics.openapi.json GET /v1/analytics/{projectId}/assistant

Check warning on line 3 in api/analytics/assistant-conversations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/analytics/assistant-conversations.mdx#L3

Use 'JSON' instead of 'json'.
keywords: ["analytics", "assistant", "conversations", "export", "AI"]

---
Expand All @@ -21,5 +21,9 @@
- **query**: The user's question
- **response**: The assistant's answer
- **sources**: Pages referenced in the response, with title and URL
- **resolutionStatus**: Whether the assistant successfully answered the question. Either `answered` or `unanswered`. Use this field to track and analyze documentation gaps surfaced by user questions the assistant could not resolve.

Check warning on line 24 in api/analytics/assistant-conversations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/analytics/assistant-conversations.mdx#L24

Did you really mean 'resolutionStatus'?
- **queryCategory**: Classification of the query type (if available)

Check warning on line 25 in api/analytics/assistant-conversations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/analytics/assistant-conversations.mdx#L25

Did you really mean 'queryCategory'?

## Rate limits

- 100 requests per Mintlify organization per hour
4 changes: 4 additions & 0 deletions api/analytics/feedback-by-page.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Get feedback by page"
openapi: /analytics.openapi.json GET /v1/analytics/{projectId}/feedback/by-page

Check warning on line 3 in api/analytics/feedback-by-page.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/analytics/feedback-by-page.mdx#L3

Use 'JSON' instead of 'json'.
keywords: ["analytics", "feedback", "export", "by page", "aggregated"]

---
Expand All @@ -16,3 +16,7 @@
- **Source**: Filter by `code_snippet`, `contextual`, or `agent` feedback types
- **Status**: Filter by status values like `pending`, `in_progress`, `resolved`, or `dismissed`


## Rate limits

- 100 requests per Mintlify organization per hour
4 changes: 4 additions & 0 deletions api/analytics/feedback.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Get feedback"
openapi: /analytics.openapi.json GET /v1/analytics/{projectId}/feedback

Check warning on line 3 in api/analytics/feedback.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/analytics/feedback.mdx#L3

Use 'JSON' instead of 'json'.
keywords: ["analytics", "feedback", "export", "user feedback"]

---
Expand All @@ -25,3 +25,7 @@
- **Contextual feedback**: Includes `helpful` boolean and optional `contact` email
- **Code snippet feedback**: Includes `code`, `filename`, and `lang` fields
- **Agent feedback**: Includes a `comment` with the agent's feedback text and the `path` of the page it relates to

## Rate limits

- 100 requests per Mintlify organization per hour
4 changes: 4 additions & 0 deletions api/analytics/searches.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Get search queries"
openapi: /analytics.openapi.json GET /v1/analytics/{projectId}/searches

Check warning on line 3 in api/analytics/searches.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/analytics/searches.mdx#L3

Use 'JSON' instead of 'json'.
keywords: ["analytics", "search", "export", "queries", "search terms"]

---
Expand All @@ -15,3 +15,7 @@

Filter search data by date range using `dateFrom` and `dateTo` parameters.


## Rate limits

- 100 requests per Mintlify organization per hour
4 changes: 4 additions & 0 deletions api/analytics/views.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Get page views"
openapi: /analytics.openapi.json GET /v1/analytics/{projectId}/views

Check warning on line 3 in api/analytics/views.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/analytics/views.mdx#L3

Use 'JSON' instead of 'json'.
keywords: ["analytics", "views", "page views", "traffic", "export"]

---
Expand All @@ -15,3 +15,7 @@

Filter view data by date range using `dateFrom` and `dateTo` parameters.


## Rate limits

- 100 requests per Mintlify organization per hour
4 changes: 4 additions & 0 deletions api/analytics/visitors.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Get unique visitors"
openapi: /analytics.openapi.json GET /v1/analytics/{projectId}/visitors

Check warning on line 3 in api/analytics/visitors.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/analytics/visitors.mdx#L3

Use 'JSON' instead of 'json'.
keywords: ["analytics", "visitors", "unique visitors", "traffic", "export"]

---
Expand All @@ -15,3 +15,7 @@

Filter visitor data by date range using `dateFrom` and `dateTo` parameters.


## Rate limits

- 100 requests per Mintlify organization per hour
4 changes: 4 additions & 0 deletions api/update/status.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
---
title: "Get deployment status"
openapi: "/openapi.json GET /project/update-status/{statusId}"

Check warning on line 3 in api/update/status.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/update/status.mdx#L3

Use 'JSON' instead of 'json'.
keywords: [ "update status", "deployment status", "check status" ]

---

## Rate limits

- 20 requests per Mintlify organization per 10 seconds
4 changes: 4 additions & 0 deletions api/update/trigger.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
---
title: "Trigger deployment"
openapi: "/openapi.json POST /project/update/{projectId}"

Check warning on line 3 in api/update/trigger.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/update/trigger.mdx#L3

Use 'JSON' instead of 'json'.
keywords: [ "trigger", "update", "deployment", "programmatic" ]

---

## Rate limits

- 10 requests per Mintlify organization per 10 seconds
Loading