> For the complete documentation index, see [llms.txt](https://help.impact.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.impact.com/brand/es/what-would-you-like-to-learn-about/advocate-program/getting-started-with-advocate/import-your-referral-program-data.md).

# Importa los datos de tu programa de referidos

Cuando cambias de otra plataforma de referidos a Advocate, no solo importas datos: también mejoras el potencial de tu programa con un seguimiento potente, experiencias personalizables y soporte experto. Este artículo te guía a través de:

* Por qué importa la migración
* Cómo se ve un plan de migración estratégico
* Qué datos se pueden importar
* Cómo preparar tus archivos
* Errores de validación comunes y cómo evitarlos

#### ¿Por qué planificar una migración estratégica?

Migrar tu programa de referidos no es solo una tarea técnica: es una oportunidad para mejorar la forma en que interactúas con tus clientes y los recompensas. Una migración bien planificada ayuda a:

* Minimizar las interrupciones en tu experiencia de referidos
* Conservar los datos históricos y garantizar la continuidad de las recompensas ![](https://3147719151-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwMLlMoFBtKJa8ptd3zaw%2Fuploads%2Fgit-blob-c11b6248bd7b0ef1b687330c8c79fba510517058%2Ff18ad34bbbcaa64fb7feb774bf5d7e154b2a259f3a75f2c3b60ec0ed3ed2371d.svg?alt=media)
* Permitir una transición limpia desde los sistemas heredados
* Reintroducir tu programa de referidos con entusiasmo y claridad

![](https://3147719151-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwMLlMoFBtKJa8ptd3zaw%2Fuploads%2Fgit-blob-c11b6248bd7b0ef1b687330c8c79fba510517058%2Ff18ad34bbbcaa64fb7feb774bf5d7e154b2a259f3a75f2c3b60ec0ed3ed2371d.svg?alt=media) La migración de referidos y recompensas depende de tu capacidad para exportar datos de tu sistema actual. Tu equipo de Advocate puede decirte qué es posible según los datos de exportación que proporciones.

Tu equipo de Advocate trabajará contigo para revisar tus archivos de exportación, identificar lo que es viable y crear un plan que se ajuste a las necesidades y objetivos de tu programa.

#### Lo que necesitarás hacer

* Exporta los *datos de usuarios*, *datos de referidos*, y *datos de recompensas*. Ponte en contacto con tu CSM en tu antigua plataforma de referidos para obtener ayuda, o usa una herramienta de exportación dentro de la plataforma si se proporciona una.
* Descarga cada uno de los 3 informes de datos en un archivo CSV aparte, por ejemplo, `user_data.CSV`, `referral_data.CSV`, y `reward_data.CSV`.
  * Consulta los ejemplos a continuación para ver cómo podría verse el contenido de cada archivo .csv, o consulta la referencia completa del campo de destino.

Esto incluye correos electrónicos, códigos de referidos, enlaces para compartir ![](https://3147719151-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwMLlMoFBtKJa8ptd3zaw%2Fuploads%2Fgit-blob-c11b6248bd7b0ef1b687330c8c79fba510517058%2Ff18ad34bbbcaa64fb7feb774bf5d7e154b2a259f3a75f2c3b60ec0ed3ed2371d.svg?alt=media), y campos personalizados. Los afiliados deben filtrarse para evitar recompensas duplicadas.

![](https://3147719151-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwMLlMoFBtKJa8ptd3zaw%2Fuploads%2Fgit-blob-c11b6248bd7b0ef1b687330c8c79fba510517058%2Ff18ad34bbbcaa64fb7feb774bf5d7e154b2a259f3a75f2c3b60ec0ed3ed2371d.svg?alt=media) Depende del formato del enlace compartido y del uso de un subdominio personalizado.

El archivo de datos de usuario contendrá información detallada sobre cada participante de tu programa. Exporta una lista de todos los participantes para mantener tu programa actualizado con sus enlaces para compartir y códigos de referido.

Los siguientes campos son **obligatorios**:

* ID de usuario
* ID de cuenta

Usa el correo electrónico del usuario como su *ID de usuario* y *ID de cuenta*. Las fechas deben tener el formato [milisegundos desde la época Unix](https://currentmillis.com/). Descarga un [ejemplo de los campos requeridos](https://res.cloudinary.com/product-enablement/raw/upload/v1750169976/CSVs/Migration_User_Import_examples_-_User_Data.csv) o usa el ejemplo a continuación en `.csv` .

```programlisting
id,accountId,email,firstName,lastName,dateCreated,locale,countryCode,segments
User1@example.com,User1@example.com,User1@example.com,First,Last,1741051242000,en_US,US,
User2@example.com,User2@example.com,User2@example.com,First,Last,,,,"vip,newuser"
User3@example.com,User3@example.com,User3@example.com,First,Last,,en_CA,,
User4@example.com,User4@example.com,User4@example.com,First,Last,,,,newuser
```

Esto incluye las fechas de inicio y de conversión, y las relaciones entre quien refiere y quien es referido. Permite asignar el rendimiento histórico de los referidos.

El archivo de datos de referidos proporciona un registro del estado de cada conexión de referido realizada en tu programa de referidos.

Los siguientes campos son **obligatorios**:

* ID de usuario de Advocate
* ID de cuenta de Advocate
* ID de usuario del referido
* ID de cuenta del referido

Usa el correo electrónico del usuario como su *ID de usuario* y *ID de cuenta*. Las fechas deben tener el formato [milisegundos desde la época Unix](https://currentmillis.com/). Descarga un [ejemplo de los campos requeridos](https://res.cloudinary.com/product-enablement/raw/upload/v1750249453/CSVs/Migration_User_Import_examples_-_Referral_Data_-_Referral_Data.csv) o usa el ejemplo a continuación en `.csv` .

```programlisting
referrerUser,referrerAccount,referredUser,referredAccount,dateReferralStarted,dateConverted,programId
User2@example.com,User2@example.com,User12@example.com,User12@example.com,1740824979000,1740824979000,33435
User1@example.com,User1@example.com,User13@example.com,User13@example.com,1741051242000,1741051242000,33435
User1@example.com,User1@example.com,User17@example.com,User17@example.com,,,33435
User1@example.com,User1@example.com,User18@example.com,User18@example.com,,,33435
```

Esto incluye valores, fechas otorgadas/canjeadas, tipos de recompensa y estados. Permite preservar la credibilidad y la equidad con los usuarios.

El archivo de datos de recompensas proporciona un registro del historial de recompensas de los participantes, incluido su valor y el importe canjeado generado a través de tu programa de referidos.

Los siguientes campos son **obligatorios**:

* ID de usuario de Advocate
* ID de cuenta de Advocate
* Nombre de la recompensa
* Unidad de la recompensa
* Valor de la recompensa
* Fecha de creación
* Fecha de otorgamiento
* Fecha de canje
* Importe canjeado

Usa el correo electrónico del usuario como su *ID de usuario* y *ID de cuenta*. Las fechas deben tener el formato [milisegundos desde la época Unix](https://currentmillis.com/).

El valor de la recompensa es el valor numérico de la recompensa en su unidad de medida más pequeña (por ejemplo, para una recompensa en efectivo de $1.00, el valor sería 100 centavos). Si la unidad de la recompensa es efectivo, debe incluir el código de moneda en el siguiente formato `<nombreUnidad>/<Moneda>` (p. ej., Cash/USD).

{% hint style="warning" %}
**Importante**: Si los *Fecha de canje* y *Importe canjeado* campos no se configuran correctamente — es decir, si se dejan en blanco o contienen valores incorrectos (por ejemplo, una fecha futura o un importe canjeado inexacto) — la recompensa podría volver a estar disponible para que el usuario la canjee de nuevo.
{% endhint %}

Descarga un [ejemplo de los campos requeridos](https://res.cloudinary.com/product-enablement/raw/upload/v1750249453/CSVs/Migration_User_Import_examples_-_Reward_Data_-_Reward_Data.csv) o usa el ejemplo a continuación en `.csv` .

```programlisting
User ID,Acccount ID,Referred User ID,Referred Account ID,Reward Name,Reward Unit,Reward Value,Redeemed Amount,Date Created,Date Given,Date Redeemed
User1@example.com,User1@example.com,User2@example.com,User2@example.com,Dólares,CASH/USD,1000,1000,1709712158000,1709712158000,1709712158000
User1@example.com,User1@example.com,User3@example.com,User3@example.com,Puntos,POINT,100,100,1726164909682,1726164909682,1726164909682
User1@example.com,User1@example.com,User4@example.com,User4@example.com,Puntos,POINT,100,100,1726164887075,1726164887075,1726164887075
User1@example.com,User1@example.com,User5@example.com,User5@example.com,Puntos,POINT,100,100,1726164875888,1726164875888,1726164875888
User1@example.com,User1@example.com,User6@example.com,User6@example.com,Puntos,POINT,10,10,1726164828986,1726164828986,1726164828986
User1@example.com,User1@example.com,User7@example.com,User7@example.com,Crédito de cuenta,USD,8000,8000,1726164289997,1726164289997,1726164289997
User1@example.com,User1@example.com,,,Tarjeta regalo,USD,10000,10000,1726163864871,1726163864871,1726163864871
User1@example.com,User1@example.com,,,Puntos,POINT,800,800,1726095906392,1726095906392,1726095906392
User1@example.com,User1@example.com,,,Tarjeta regalo,USD,30000,30000,1726163769157,1726163769157,1726163769157
User1@example.com,User1@example.com,,,20 % de descuento,%,20,20,1726180309034,1726180309034,1726180309034
```

{% hint style="warning" %}
**Importante:** Los 3 archivos de exportación deben contener datos de un solo programa. Si los archivos tienen datos de varios programas, la importación los consolidará en un solo programa.
{% endhint %}

<details>

<summary>Un plan de migración de ejemplo</summary>

Cada migración es única, pero las exitosas siguen una estructura similar que equilibra la preparación, la comunicación y la ejecución. A continuación se muestra un plan de migración que garantiza la continuidad y una experiencia fluida tanto para tu equipo como para tus defensores. Los plazos y las fases pueden variar según la configuración de tu programa.

**Fase 1: planificación y preparación (1–2 semanas)**

Esta es tu etapa de preparación de bases, sentando los cimientos para una transición fluida.

|           |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Objetivos | <p>• Alinea a las partes interesadas.</p><p>• Configuración técnica.</p><p>• Confirma el alcance de la migración.</p><p>• Planifica la comunicación con los usuarios.</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| Tareas    | <p>• Asegura un conjunto de muestra de tus datos históricos (usuarios, referidos, recompensas) y compártelo con el equipo de Advocate para su revisión y asignación de campos <img src="https://3147719151-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwMLlMoFBtKJa8ptd3zaw%2Fuploads%2Fgit-blob-c11b6248bd7b0ef1b687330c8c79fba510517058%2Ff18ad34bbbcaa64fb7feb774bf5d7e154b2a259f3a75f2c3b60ec0ed3ed2371d.svg?alt=media" alt="">.</p><p>• Exporta conjuntos completos de datos una vez que la muestra haya sido validada. Es muy probable que los datos de exportación deban manipularse (por ejemplo, ajustando encabezados, nombres de campos o la estructura del archivo) para que coincidan con los requisitos de importación.</p><p>• Establece una fecha de puesta en producción y una ventana de reversión.</p><p>• Añade widgets de Advocate en modo oculto (entorno de pruebas o páginas sin vincular).</p><p>• Configura las integraciones necesarias (por ejemplo, Shopify, HubSpot, Segment).</p><p>• Completa la configuración del programa en Advocate (por ejemplo, configuración de recompensas, reglas del programa, plantillas de correo electrónico, segmentación).</p><p>• Prueba la funcionalidad del programa de extremo a extremo: confirma que los compartidos, conversiones y recompensas se registren correctamente en un entorno de pruebas antes de ponerlo en producción.</p><p>• Redacta los mensajes para comunicar la transición a los defensores.</p><p><img src="https://3147719151-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwMLlMoFBtKJa8ptd3zaw%2Fuploads%2Fgit-blob-c11b6248bd7b0ef1b687330c8c79fba510517058%2Ff18ad34bbbcaa64fb7feb774bf5d7e154b2a259f3a75f2c3b60ec0ed3ed2371d.svg?alt=media" alt=""> La migración de referidos y recompensas depende de tu capacidad para exportar datos de tu sistema actual. Tu equipo de Advocate puede decirte qué es posible según los datos de exportación que proporciones.</p> |
| Consejos  | <p>• Si estás superponiendo plataformas, asegúrate de que solo una esté emitiendo recompensas.</p><p>• Identifica a los usuarios avanzados que puedan necesitar un tratamiento especial (VIP, influencers).</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |

**Fase 2: transición y puesta en producción (1–2 días)**

Este es tu momento de transición. Planifica una breve pausa en el seguimiento entre sistemas y programa durante las horas de menor tráfico si es posible.

|           |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Objetivos | <p>• Cambia sin problemas de tu plataforma heredada a Advocate.</p><p>• Asegúrate de que los usuarios puedan acceder a la nueva experiencia de inmediato.</p><p>• Evita la pérdida de datos de referidos o recompensas.</p>                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| Tareas    | <p>• Elimina de tu sitio los scripts/widgets de la plataforma antigua.</p><p>• Publica los widgets de Advocate.</p><p>• Importa los datos finales de usuarios, referidos y recompensas.</p><p>• Haz seguimiento manual/marca cualquier conversión entre el cierre del sistema y el lanzamiento.</p><p>• Supervisa el panel de control de Advocate en busca de actividad.</p><p>• Envía la comunicación de lanzamiento a tus defensores. Hazles saber a los usuarios que sus enlaces de referido se han actualizado e, idealmente, incluye los nuevos enlaces directamente en el correo electrónico para que les resulte fácil comenzar a compartir de inmediato.</p> |
| Consejos  | <p>• Incluye un breve margen de bloqueo de recompensas si es necesario (por ejemplo, “Los referidos realizados el 15 de mayo se revisarán y se agregarán después del lanzamiento”).</p><p>• Usa una comunicación dirigida a los defensores para generar entusiasmo (por ejemplo, “¡Hemos mejorado tu experiencia de referidos!”).</p>                                                                                                                                                                                                                                                                                                                                |

**Fase 3: posmigración y limpieza (1–2 días)**

Ahora que estás en producción, asegúrate de que tu programa funcione como se espera y resuelve cualquier asunto pendiente.

|           |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Objetivos | <p>• Verifica la integridad de los datos y el seguimiento de recompensas.</p><p>• Captura cualquier conversión omitida.</p><p>• Da soporte y educa a los usuarios.</p>                                                                                                                                                                                                                                                                                                                                        |
| Tareas    | <p>• Valida que las relaciones entre quien refiere y quien es referido funcionen en modo en vivo.</p><p>• Importa cualquier conversión omitida que haya ocurrido entre la transición.</p><p>• Realiza una prueba de QA (recomiéndate a ti mismo, confirma el seguimiento y la lógica de recompensas).</p><p>• Proporciona preguntas frecuentes internas y externas o documentos de ayuda.</p><p>• Supervisa la bandeja de entrada de soporte para detectar problemas relacionados con usuarios heredados.</p> |
| Consejos  | <p>• Si vas a retirar una cuenta heredada de financiación de recompensas, dale a los usuarios un período de gracia para canjear.</p><p>• Usa recordatorios por correo electrónico o dentro de la aplicación para impulsar la actividad temprana de referidos en el nuevo programa.</p>                                                                                                                                                                                                                        |

</details>

#### Importa los datos de tu programa

1. En el menú de navegación izquierdo, seleccione ![](https://3147719151-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwMLlMoFBtKJa8ptd3zaw%2Fuploads%2Fgit-blob-230534471fef5f40808e921e41ee44e4a06ded03%2Fe6cb9548999afdc1ed3ce4942e4cb5b45b5cecbd323267aac2a7cd1915fccc09.svg?alt=media) **\[Engage] → Informes → Importaciones y exportaciones**.
2. En la esquina superior derecha, selecciona ![](https://3147719151-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwMLlMoFBtKJa8ptd3zaw%2Fuploads%2Fgit-blob-ec3276f07285180fbb2167a40e148d3e43e8681c%2F05aa88f72076df5a744d4620574f19cc187b7154fe1f3bb73ad7a892b7d23002.svg?alt=media) **Importar**.
3. Seleccione el *Tipo de importación* de entre las opciones disponibles:

   | Tipo de importación                         | Descripción                                                                                                                                                                                                                                                               |
   | ------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
   | Usuarios                                    | Selecciona esta opción para cargar nuevos usuarios o datos de usuarios existentes. También puedes elegir importar estos datos desde una cuenta o plataforma diferente.                                                                                                    |
   | Actualizar saldos de recompensas de usuario | Selecciona esta opción para actualizar y canjear los saldos de recompensas de los usuarios.                                                                                                                                                                               |
   | Eventos de usuario                          | Selecciona esta opción para cargar datos de eventos de usuario.                                                                                                                                                                                                           |
   | Eliminar usuarios                           | <p>Selecciona esta opción si deseas eliminar masivamente a los usuarios existentes de tu programa.</p><p>También puedes eliminar el manejo de usuarios y optar por:</p><p>• Conservar las cuentas vacías</p><p>• Evitar que los usuarios eliminados se creen de nuevo</p> |
   | Historial de recompensas                    | Selecciona esta opción para cargar un registro de toda la información de recompensas. También puedes elegir importar estos datos desde una cuenta o plataforma diferente.                                                                                                 |
   | Historial de referidos                      | Selecciona esta opción para cargar un registro de todas las conexiones de referido. También puedes elegir importar estos datos desde una cuenta o plataforma diferente.                                                                                                   |
4. Seleccione **Elegir archivo** o arrastra y suelta el archivo que deseas importar.
5. Seleccione **Importar** para cargar tus datos.
   * Si vas a eliminar masivamente usuarios existentes, selecciona **Eliminación masiva**.

#### Referencia de errores de validación

Puedes obtener 3 tipos de errores de validación:

1. **Mensaje de error en línea:** estos aparecen en la tabla de validación previa y hacen que las filas con error se resalten en rojo:

   * `INVALID_FIELD` — p. ej., el *Fecha de creación* campo no estaba formateado en [milisegundos desde la época Unix](https://currentmillis.com/) .
   * `MISSING_FIELD` — p. ej., falta un campo obligatorio como *ID de usuario* o *ID de cuenta* no está presente.

   <div data-with-frame="true"><figure><img src="https://3147719151-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwMLlMoFBtKJa8ptd3zaw%2Fuploads%2Fgit-blob-eb521fbbc452c243d6b3763ebcb90053b4e9e4dc%2Ff969fa535707c24f4913282d07287a546b348f2448bdb4ca2eef0a30c871fbb6.png?alt=media" alt="" width="375"><figcaption></figcaption></figure></div>
2. **Llamado de error:** estos aparecen en lugar de la tabla de validación previa como mensajes de advertencia en rojo:

   * `MISSING_HEADER` — p. ej., un encabezado de columna obligatorio como *ID de cuenta* o *Valor de la recompensa* no está presente.
   * `CSV_PARSING` — p. ej., el archivo CSV contiene caracteres especiales con formato incorrecto.
   * `FILE_REF_IO` — p. ej., el archivo está dañado y no se puede leer.

   <div data-with-frame="true"><figure><img src="https://3147719151-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwMLlMoFBtKJa8ptd3zaw%2Fuploads%2FqSd1JDFy8AQDR2aGJdrz%2FScreenshot%202026-05-25%20at%2017.58.06.png?alt=media&amp;token=26f43eaf-904a-4e1f-8b3c-185700af5edc" alt="" width="563"><figcaption></figcaption></figure></div>
3. **Errores listados:** estos aparecen como una lista de conteos de errores en la *Importaciones y exportaciones* pantalla dentro de la *Informes* sección cuando el tipo de importación no tiene una tabla de validación previa. Los errores de fila y los errores de archivo se mostrarán juntos:

   <div data-with-frame="true"><figure><img src="https://3147719151-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FwMLlMoFBtKJa8ptd3zaw%2Fuploads%2FQuMoDG2ppJmsEdDwdw50%2FUntitled%20design%20(48).png?alt=media&amp;token=b1cbcb03-ffc7-4ad7-bbbd-c54b81ee3638" alt="" width="563"><figcaption></figcaption></figure></div>

#### Soporte

No tienes que afrontar la migración solo. Nuestro equipo de incorporación de Advocate está listo para ayudar con:

* Soporte para asignación de campos
* Orientación sobre el formato de datos
* Estrategia de migración de recompensas
* Pruebas y control de calidad

Contacta a tu [equipo de soporte de Advocate](mailto:support-advocate@impact.com).


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://help.impact.com/brand/es/what-would-you-like-to-learn-about/advocate-program/getting-started-with-advocate/import-your-referral-program-data.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
