Lister les sites web

Paramètres

Cet endpoint ne prend aucun paramètre de chemin ou de requête.

Corps de la requête

Cet endpoint ne nécessite aucun corps JSON.

Réponse

Renvoie un objet avec un tableau websites.

• websites (Website[]): Sites surveillés visibles pour le compte du token.

Objet Website

• id (string): UUID du site web.
• accountGroupId (string): Groupe de compte résolu depuis le token.
• domain (string): Domaine normalisé du site web.
• url (string): URL du site web.
• name (string | null): Nom affiché.
• description (string | null): Contexte utilisé pour le score de pertinence.
• createdAt, updatedAt (ISO string | null): Horodatages de création et de mise à jour au format ISO 8601, ou null.
• keywords (Keyword[]): Objets Keyword de ce site web.

Objet Keyword

• id (string): UUID du mot-clé.
• websiteId (string): UUID du site web parent.
• value (string): Texte du mot-clé, jusqu’à 255 caractères.
• status (string): PENDING, ACTIVE, DISABLED ou SUSPENDED.
• createdAt, updatedAt (ISO string | null): Horodatages de création et de mise à jour au format ISO 8601, ou null.

Notes

Utilisez-le d’abord pour découvrir les valeurs websiteId et keywordId des appels suivants.

Erreurs

• 400 Bad Request: Entrée, URL, UUID, enum, paramètre de requête ou corps non valide.
• 401 Unauthorized: Bearer token manquant ou non valide, ou code: "token_issuer_lost_access" quand la personne qui a créé la clé API a été désactivée ou a quitté l'espace de travail.
• 403 Forbidden: code: "subscription_required" quand l'abonnement de l'espace de travail n'inclut pas l'accès à l'API, code: "workspace_access_denied" quand X-Workspace-Id désigne un espace de travail que ces identifiants ne peuvent pas atteindre, ou code: "permission_denied" quand votre rôle dans l'espace de travail n'a pas la permission redreplier.write (Admin et Editor l'ont).
• 404 Not Found: La ressource n’existe pas pour le compte du token.
• 429 Too Many Requests: Limite de débit dépassée. Attendez le nombre de secondes indiqué dans Retry-After.
• 500 Internal Server Error: Erreur serveur inattendue.