Skip to content

feedback.mdx

Latest commit

 

History

History
27 lines (18 loc) · 1.12 KB

feedback.mdx

File metadata and controls

27 lines (18 loc) · 1.12 KB
Raw
title Get feedback
openapi /analytics.openapi.json GET /v1/analytics/{projectId}/feedback
keywords
analytics
feedback
export
user feedback

Usage

Use this endpoint to export user feedback collected from your documentation. Feedback includes contextual feedback from page ratings, code snippet feedback, and agent feedback.

Paginate through results using the cursor parameter returned in the response. Continue fetching while hasMore is true.

Filtering

Filter feedback by:

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

Response types

The response contains different feedback types based on the source:

  • 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