Skip to content

Add agent as a feedback source type #5203

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mintlify wants to merge 1 commit into
base: main
Choose a base branch
from
+13 −6
Open

Add agent as a feedback source type #5203

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
13 changes: 9 additions & 4 deletions analytics.openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,9 +62,10 @@
"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, `thumbs_only` is a thumbs up/down vote."
"description": "Where the feedback originated. `code_snippet` is feedback on a code block, `contextual` is page-level feedback, `agent` is feedback submitted by a Mintlify agent, `thumbs_only` is a thumbs up/down vote."
},
"status": {
"type": "string",
Expand Down Expand Up @@ -116,9 +117,10 @@
"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, `thumbs_only` is a thumbs up/down vote."
"description": "Where the feedback originated. `code_snippet` is feedback on a code block, `contextual` is page-level feedback, `agent` is feedback submitted by a Mintlify agent, `thumbs_only` is a thumbs up/down vote."
},
"status": {
"type": "string",
Expand Down Expand Up @@ -183,9 +185,10 @@
"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, `thumbs_only` is a thumbs up/down vote."
"description": "Where the feedback originated. `code_snippet` is feedback on a code block, `contextual` is page-level feedback, `agent` is feedback submitted by a Mintlify agent, `thumbs_only` is a thumbs up/down vote."
},
"status": {
"type": "string",
Expand Down Expand Up @@ -662,6 +665,7 @@
"enum": [
"code_snippet",
"contextual",
"agent",
"thumbs_only"
],
"description": "Filter by feedback source"
Expand Down Expand Up @@ -788,7 +792,8 @@
"type": "string",
"enum": [
"code_snippet",
"contextual"
"contextual",
"agent"
],
"description": "Filter by feedback source"
},
Expand Down
2 changes: 1 addition & 1 deletion api/analytics/feedback-by-page.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Get feedback by page"
description: "Retrieve user feedback counts aggregated by documentation page, including thumbs up/down ratings and code snippet feedback."
openapi: /analytics.openapi.json GET /v1/analytics/{projectId}/feedback/by-page

Check warning on line 4 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#L4 

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

Expand All @@ -13,6 +13,6 @@

Filter feedback by:
- **Date range**: Use `dateFrom` and `dateTo` to limit results to a specific time period
- **Source**: Filter by `code_snippet` or `contextual` feedback types
- **Source**: Filter by `code_snippet`, `contextual`, or `agent` feedback types
- **Status**: Filter by status values like `pending`, `in_progress`, `resolved`, or `dismissed`

3 changes: 2 additions & 1 deletion api/analytics/feedback.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Get feedback"
description: "Retrieve user feedback from your documentation, including page ratings and code snippet feedback."
openapi: /analytics.openapi.json GET /v1/analytics/{projectId}/feedback

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/analytics/feedback.mdx#L4 

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

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

Filter feedback by:
- **Date range**: Use `dateFrom` and `dateTo` to limit results to a specific time period
- **Source**: Filter by `code_snippet` or `contextual` feedback types
- **Source**: Filter by `code_snippet`, `contextual`, or `agent` feedback types
- **Status**: Filter by status values like `pending`, `in_progress`, `resolved`, or `dismissed`

## Response types
Expand All @@ -24,3 +24,4 @@

- **Contextual feedback**: Includes `helpful` boolean and optional `contact` email
- **Code snippet feedback**: Includes `code`, `filename`, and `lang` fields
- **Agent feedback**: Feedback submitted by a Mintlify agent
1 change: 1 addition & 0 deletions optimize/feedback.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@
- **Raise issues**: Allow users to create GitHub issues directly from your documentation. Only available for public GitHub repositories.
- **Contextual feedback**: Free form feedback about the content of a page.
- **Code snippet feedback**: Feedback specifically on code snippets.
- **Agent feedback**: Feedback submitted by a Mintlify agent on behalf of users.

## Collect email addresses

Expand Down Expand Up @@ -80,7 +81,7 @@

- **Pending**: Feedback is awaiting review.
- **In Progress**: Work is in progress to address the feedback.
- **Resolved**: Feedback has been resolved.

Check warning on line 84 in optimize/feedback.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

optimize/feedback.mdx#L84 

In general, use active voice instead of passive voice ('been resolved').
- **Dismissed**: Feedback is irrelevant or inaccurate.

### Filter by status
Expand Down
Loading