Obtenir des retours
Renvoie des retours d’utilisateurs paginés avec des filtres facultatifs
curl --request GET \
--url https://api.mintlify.com/v1/analytics/{projectId}/feedback \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.mintlify.com/v1/analytics/{projectId}/feedback"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.mintlify.com/v1/analytics/{projectId}/feedback', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.mintlify.com/v1/analytics/{projectId}/feedback",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.mintlify.com/v1/analytics/{projectId}/feedback"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.mintlify.com/v1/analytics/{projectId}/feedback")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.mintlify.com/v1/analytics/{projectId}/feedback")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"feedback": [
{
"id": "<string>",
"path": "<string>",
"comment": "<string>",
"createdAt": "<string>",
"source": "code_snippet",
"status": "pending",
"helpful": true,
"contact": "<string>"
}
],
"nextCursor": "<string>",
"hasMore": true
}{
"error": "<string>",
"details": [
{
"message": "<string>"
}
]
}{
"error": "<string>",
"details": [
{
"message": "<string>"
}
]
}Utilisation
cursor renvoyé dans la réponse. Continuez à effectuer des requêtes tant que hasMore vaut true.
Filtrage
- Plage de dates : utilisez
dateFrometdateTopour limiter les résultats à une période donnée - Source : filtrez par type de feedback,
code_snippet,contextualouagent - Statut : filtrez par des valeurs de statut comme
pending,in_progress,resolvedoudismissed
Types de réponse
- Commentaire contextuel : inclut le booléen
helpfulet éventuellement l’adresse e-mailcontact - Commentaire sur extrait de code : inclut les champs
code,filenameetlang - Retour d’agent : inclut un
commentavec le texte du retour de l’agent et lepathde la page concernée
Autorisations
L’en-tête Authorization requiert un jeton Bearer. Utilisez une clé d’API administrateur (préfixée par mint_). Il s’agit d’une clé secrète côté serveur. Générez-en une depuis la page API keys dans votre Dashboard.
Paramètres de chemin
Paramètres de requête
Date au format ISO 8601 ou AAAA-MM-JJ
"2024-01-01"
Date au format ISO 8601 ou AAAA-MM-JJ. dateTo est une borne supérieure exclusive. Les résultats incluent les dates antérieures, mais pas la date spécifiée elle-même.
"2024-01-01"
Filtrer par source des retours utilisateurs
code_snippet, contextual, agent, thumbs_only Liste de statuts séparés par des virgules pour le filtrage
Nombre maximal de résultats par page
1 <= x <= 100Curseur de pagination
Réponse
Données de retours utilisateurs paginées
Liste des retours.
Renvoyé lorsque la source est contextual. Indique si l'utilisateur a trouvé la page utile et un e-mail de contact optionnel.
- Option 1
- Option 2
- Option 3
Show child attributes
Show child attributes
Curseur permettant de récupérer la page de résultats suivante. null s’il n’y a plus de résultats.
Indique si des résultats supplémentaires sont disponibles au-delà de cette page.
Cette page vous a-t-elle été utile ?
curl --request GET \
--url https://api.mintlify.com/v1/analytics/{projectId}/feedback \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.mintlify.com/v1/analytics/{projectId}/feedback"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.mintlify.com/v1/analytics/{projectId}/feedback', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.mintlify.com/v1/analytics/{projectId}/feedback",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.mintlify.com/v1/analytics/{projectId}/feedback"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.mintlify.com/v1/analytics/{projectId}/feedback")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.mintlify.com/v1/analytics/{projectId}/feedback")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"feedback": [
{
"id": "<string>",
"path": "<string>",
"comment": "<string>",
"createdAt": "<string>",
"source": "code_snippet",
"status": "pending",
"helpful": true,
"contact": "<string>"
}
],
"nextCursor": "<string>",
"hasMore": true
}{
"error": "<string>",
"details": [
{
"message": "<string>"
}
]
}{
"error": "<string>",
"details": [
{
"message": "<string>"
}
]
}