> ## Documentation Index > Fetch the complete documentation index at: https://docs.athenahq.ai/llms.txt > Use this file to discover all available pages before exploring further. # Obtener consultas > Devuelve todas las consultas de un sitio web concreto. Puedes filtrar por estado (activas o pausadas). Incluye metadatos como el volumen mensual de búsquedas y el valor total. ## OpenAPI ````yaml es/api-reference/openapi.json get /api/v1/prompts openapi: 3.1.0 info: title: API de AthenaHQ description: >- La API de AthenaHQ ofrece acceso programático para gestionar tus sitios web y consultas para optimizar el contenido con IA. version: 1.0.0 contact: email: support@athenahq.ai servers: - url: https://api.athenahq.ai description: Servidor de producción security: - apiKey: [] tags: - name: Basics description: Operaciones principales de la API para gestionar sitios web y consultas - name: Metrics description: Endpoints de métricas y análisis para monitorizar la visibilidad en IA - name: Billing description: Endpoints de facturación y créditos para gestionar el uso - name: Team Management description: Endpoints para gestionar miembros del equipo e invitaciones - name: Groups description: Endpoints para gestionar grupos de sitios web - name: Content description: >- Endpoints para acceder a los datos del centro de contenidos: pestañas, URL monitorizadas y desglose de consultas por URL. - name: Pitch Workspace description: >- Endpoints para acceder a los informes del espacio de propuestas: ejecuciones de propuestas con alcance de organización, con competidores, consultas, atributos y métricas agregadas. - name: Knowledge Base description: >- Endpoints para leer la base de conocimientos de la marca: datos aprobados sobre la marca y los pilares que los organizan. paths: /api/v1/prompts: get: tags: - Basics summary: Obtener consultas description: >- Devuelve todas las consultas de un sitio web concreto. Puedes filtrar por estado (activas o pausadas). Incluye metadatos como el volumen mensual de búsquedas y el valor total. operationId: getPrompts parameters: - name: website_id in: query description: ID del sitio web del que se consultarán las consultas required: true schema: type: string format: uuid - name: status in: query description: >- Filtra las consultas por estado. Si se omite, devuelve tanto las activas como las pausadas. required: false schema: type: string enum: - active - paused - name: prompt_tags in: query description: >- Filtra consultas por etiqueta. Pasa uno o varios ID de etiqueta (UUID). Si se omite, no filtra por etiqueta. Combínalo con `prompt_tags_operator` para decidir cómo coinciden varias etiquetas. Todos los ID deben pertenecer al mismo sitio que `website_id`; de lo contrario, se rechaza con `403`. required: false schema: type: array items: type: string format: uuid - name: prompt_tags_operator in: query description: >- Cómo combinar el filtro `prompt_tags`. `is_any_of` (predeterminado) devuelve consultas con al menos una etiqueta indicada; `has_all_of`, solo las que tienen todas. Se ignora si se omite `prompt_tags`. required: false schema: type: string enum: - is_any_of - has_all_of responses: '200': description: Respuesta correcta con la lista de consultas content: application/json: schema: type: object properties: prompts: type: array items: $ref: '#/components/schemas/Prompt' required: - prompts '400': description: 'Solicitud incorrecta: parámetros no válidos' content: application/json: schema: $ref: '#/components/schemas/Error' examples: missing_website_id: value: error: website_id is required invalid_status: value: error: status must be 'active' or 'paused' '401': description: 'Sin autorización: falta la clave de API o no es válida' content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: 'Acceso denegado: no tienes acceso a este sitio web' content: application/json: schema: $ref: '#/components/schemas/Error' example: error: Unauthorized access to this website '429': description: >- Demasiadas solicitudes: se ha superado el límite. Vuelve a intentarlo tras una breve pausa. content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: Error interno del servidor content: application/json: schema: $ref: '#/components/schemas/Error' security: - apiKey: [] components: schemas: Prompt: type: object description: Recurso de instrucciones para generar contenido con IA required: - id - prompt - status - country - countries - tags - prompt_type properties: id: type: string format: uuid description: Identificador único de la consulta example: 123e4567-e89b-12d3-a456-426614174000 prompt: type: string description: Instrucciones utilizadas para generar el contenido example: How to optimize website performance topic_name: type: string nullable: true description: Nombre de la categoría temática a la que pertenece esta consulta example: Web Development current_monthly_searches: type: integer description: >- Volumen mensual estimado de búsquedas de esta consulta. El proveedor solo mide volúmenes por encima de unas 100 búsquedas al mes; para consultas inferiores devuelve 100. example: 5400 current_total_value: type: number nullable: true description: Valor mensual total estimado de esta consulta example: 1250.5 status: type: string enum: - active - paused description: Estado actual de la consulta example: active country: type: string deprecated: true description: >- Obsoleto. Usa `countries`. Devuelve el país marcado como principal o, si no lo hay, el primero alfabéticamente. Utiliza `"United States"` como alternativa si la consulta no tiene países. example: United States countries: type: array description: >- Todos los países de destino de la consulta. El principal, si lo hay, aparece primero; los demás siguen en orden alfabético. Vacío si la consulta no tiene países asignados. items: type: object required: - country - is_primary properties: country: type: string description: Nombre del país example: United States is_primary: type: boolean description: >- Indica si este es el país principal de la consulta. Solo puede haber un país principal por consulta. example: true example: - country: United States is_primary: true - country: Canada is_primary: false tags: type: array description: >- Etiquetas de la consulta, ordenadas por nombre sin distinguir mayúsculas de minúsculas. Vacío si no tiene etiquetas. Sus ID se pueden pasar a `prompt_tags` en este endpoint o a `tag_ids` en POST /api/v1/prompts. Obtén el catálogo completo con GET /api/v1/prompt-tags. items: $ref: '#/components/schemas/PromptTag' example: - id: 223e4567-e89b-12d3-a456-426614174111 name: Caption Phones prompt_type: type: string enum: - branded - non_branded nullable: true description: >- Indica si Athena muestra la consulta como Con marca o Sin marca. Se devuelve por separado de `tags`, que solo lista etiquetas personalizadas. Usa los valores de `prompt_type` de los endpoints de métricas. `null` si no tiene tipo. Para definirlo, envía `type` en POST /api/v1/prompts o PATCH /api/v1/prompts/{prompt_id}: `high_intent` es Con marca y `discovery`, Sin marca. example: non_branded Error: type: object description: Objeto de respuesta de error required: - error properties: error: type: string description: Mensaje de error que describe qué ha fallado example: Unauthorized PromptTag: type: object description: Una referencia a una etiqueta de consulta required: - id - name properties: id: type: string format: uuid description: Identificador único de la etiqueta example: 223e4567-e89b-12d3-a456-426614174111 name: type: string description: Nombre de la etiqueta example: Caption Phones securitySchemes: apiKey: type: apiKey in: header name: x-api-key description: >- Clave de API para autenticarse. Puedes crear una [aquí](https://app.athenahq.ai/organization?tab=api). ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.