> 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/pt-br/what-would-you-like-to-learn-about/account-administration/account-settings/enable-and-view-data-feeds.md).

# Habilite e visualize feeds de dados

<a href="https://pxa.impact.com/student/activity/1117597?sid=0c0e3e5c-54c9-4435-9bee-ebcdccb7f292&#x26;sid_i=0?utm_source=app.impact.com&#x26;utm_medium=owned-platform&#x26;utm_content=tra-350&#x26;utm_campaign=help-center" class="button primary">Faça o curso PXA</a>

{% hint style="info" %}
**Atualização de versão**: A versão mais recente do feed de ações é **Versão 5 (V5)**. Se você estiver usando uma versão mais antiga, consulte a *seção de atualização* para saber como atualizar.
{% endhint %}

Os Feeds de dados são arquivos automatizados e agendados que podem relatar diversos dados da sua campanha. O recurso principal é o **Feed de ações**, que relata tanto novas ações quanto quaisquer atualizações de ações existentes.

Um *Feed de ações* pode ser personalizado em termos de frequência de entrega, formato de dados e método de entrega.

#### Ativar o feed de ações

1. Na barra de navegação superior, selecione ![](/files/45f862e198f73982700ff092afe256a7fe2e0fff) **\[Perfil do usuário] → Configurações**.
2. Na coluna da esquerda, role até *Técnica* seção.
3. Selecione [Feeds de dados](https://app.impact.com/secure/advertiser/accountSettings/techintegration/view-edit-adv-daily-feeds-flow.ihtml).
4. No lado direito da tela, selecione ![](/files/f1c5fe94457426459cac3548436ce2a195dcde68) **\[Editar]**.
5. Selecione ![](/files/56148a29d7f42673dde9884eb52356c45eca06c3) **\[Ativar]** para ativar o feed de ações.

A partir daqui, você pode personalizar os detalhes do seu feed de ações.

|                       |                                                                                                                                                                                                                                                                                                                           |
| --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Frequência**        | Escolha a frequência com que você deseja receber o feed, de hora em hora até mensal.                                                                                                                                                                                                                                      |
| **Formato dos dados** | <p>Isso determina o tipo de arquivo do feed de ações:</p><p>• XML entrega os dados em um arquivo de Extensible Markup Language (XML).</p><p>• TAB entrega os dados em um arquivo .txt com itens separados por tabulações.</p><p>• PIPE entrega os dados em um arquivo .txt com itens separados por barras verticais (</p> |
| **Método de entrega** | Escolha seu método de entrega preferido: FTP da impact.com (ou seja, você obtém seu feed de ações dos nossos servidores FTP), FTP do parceiro (ou seja, enviamos o arquivo do feed de ações para o seu servidor FTP) ou Email (ou seja, enviamos este arquivo por e-mail como anexo para um endereço de e-mail).          |

**Personalizar o feed de ações**

Depois que o feed de ações for ativado, você sempre poderá desativá-lo ou alterar seus detalhes — como a frequência, o formato dos dados e muito mais.

1. Na barra de navegação superior, selecione ![](/files/45f862e198f73982700ff092afe256a7fe2e0fff) **\[Perfil do usuário] → Configurações**.
2. Na coluna da esquerda, role até *Técnica* seção.
3. Selecione **Notificações de eventos**.
4. Na parte superior da tela, selecione o **Feeds de dados** aba.
5. No lado direito da tela, selecione ![](/files/f1c5fe94457426459cac3548436ce2a195dcde68) **\[Editar]**.

Consulte a lista de descrições na seção anterior para obter detalhes sobre cada configuração.

#### Entenda o arquivo do feed de ações

O arquivo do feed de ações pode ser lido usando um editor de texto simples ou importado para uma planilha.

Consulte a tabela abaixo como referência para os cabeçalhos de **Feed de Ações Versão 5 (V5)**.

<details>

<summary>Referência de cabeçalhos do Feed de Ações V5</summary>

|                               |                                |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| ----------------------------- | ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| **Campo**                     | **Formato**                    | **Descrição**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| `ID do anunciante`            | Inteiro                        | O ID exclusivo da conta do anunciante ao qual a ação foi enviada.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| `ID da campanha`              | Inteiro                        | O ID exclusivo da campanha à qual a ação corresponde.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| `Nome da campanha`            | Texto                          | O nome da campanha à qual a ação corresponde.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| `ActionTrackerId`             | Inteiro                        | O ID exclusivo do rastreador de ações ao qual a ação corresponde.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| `Nome do rastreador de ações` | Texto                          | O nome do rastreador de ações ao qual a ação corresponde.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| `Nome do termo do modelo`     | Texto                          | O nome do termo do modelo ao qual a ação corresponde.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| `ID do parceiro de mídia`     | Inteiro                        | O ID exclusivo do parceiro de mídia ao qual a ação foi creditada.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| `Nome do parceiro de mídia`   | Texto                          | O nome do parceiro de mídia ao qual a ação foi creditada.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| `ActionId`                    | Texto                          | O ID exclusivo que a impact.com atribuiu à ação.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| `Status`                      | Texto                          | <p><strong>Importante:</strong> Este é um campo obsoleto e não está disponível na versão mais recente do Feed de Ações (versão 4).</p><p>Uma ação pode ter um dos status abaixo:</p><p><em>Padrão</em>: O status da ação quando ela é criada pela primeira vez. Se nenhuma alteração for feita na ação, este permanecerá como o status.</p><p><em>Aprovado</em>: O anunciante decidiu que essa era uma ação válida, mas ainda pode fazer uma alteração antes da data de bloqueio.</p><p><em>Rejeitada</em>: O anunciante decidiu que essa era uma ação inválida, então o parceiro de mídia não deve ser pago.</p><p><em>Modificado</em>: O anunciante decidiu que parte da ação era inválida (por exemplo, o cliente devolveu um item do pedido), então o pagamento foi reduzido.</p><p><strong>Observação:</strong> Todas as ações com status <em>acima do limite</em> podem ser aprovadas manualmente pelo anunciante.</p><p><em>Acima do limite - limite dos dias úteis</em>: A ação ocorreu depois que o limite dos dias úteis já havia sido atingido.</p><p><em>Acima do limite - limite de fim de semana</em>: A ação ocorreu depois que o limite de fim de semana já havia sido atingido.</p><p><em>Acima do limite - orçamento</em>: A ação ocorreu depois que o orçamento especificado na ordem de inserção já havia sido atingido.</p><p><em>Acima do limite - limite de ações</em>: A ação ocorreu depois que o número máximo de ações especificado na ordem de inserção já havia sido atingido.</p><p><em>Acima do limite - IO expirado</em>: A ação ocorreu depois que a ordem de inserção foi encerrada ou expirada.</p><p><em>Acima do limite - chamadas simultâneas</em>: A ação ocorreu depois que o número de chamadas simultâneas especificado na ordem de inserção já havia sido atingido.</p> |
| `Estado`                      | Texto                          | Este valor é um status que indica a resposta do anunciante à ação, com um dos seguintes valores: "APPROVED", "PENDING" ou "REVERSED". Este valor não pode ser alterado após a data de bloqueio da ação.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| `Motivo da modificação`       | Texto                          | Importante: este é um campo obsoleto e não está disponível na versão mais recente do Feed de Ações (versão 4).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| `ID do anúncio`               | Inteiro                        | O ID exclusivo do anúncio com o qual o consumidor interagiu para iniciar a ação.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| `Custo do cliente`            | Decimal (8,2)                  | O custo líquido da ação para o anunciante.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| `Pagamento`                   | Decimal (8,2)                  | O pagamento a ser recebido pelo parceiro de mídia. Para ações modificadas, este é o pagamento líquido. Para ações acima do limite, o pagamento é US$ 0,00.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| `Pagamento diferencial`       | Decimal (8,2)                  | A alteração no pagamento em relação ao estado anterior. Por exemplo, se o anunciante modificou a ação devido a uma devolução do cliente, este valor representa o ajuste negativo no pagamento. Se a ação não tiver sido modificada, este será o mesmo valor de Payout.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| `Pagamento pretendido`        | Decimal (8,2)                  | O pagamento da ação antes de ser modificada. Se a ação não tiver sido modificada, este será o mesmo valor de Payout.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| `Valor`                       | Decimal (8,2)                  | O valor de vendas, ou receita, da ação. Este valor é relevante apenas para eventos de pagamento por venda.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| `Valor diferencial`           | Decimal (8,2)                  | A alteração no valor de vendas se a ação tiver sido modificada. Se a ação não tiver sido modificada, este será o mesmo valor de Amount.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| `Valor pretendido`            | Decimal (8,2)                  | O valor de vendas antes de a ação ser modificada. Se a ação não tiver sido modificada, este será o mesmo valor de Amount.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| `Moeda`                       | Cadeia de caracteres (3)       | O código da moeda com o qual a ação foi enviada (a moeda nas configurações do anunciante é a padrão se o valor do código da moeda não for enviado).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| `Moeda original`              | Cadeia de caracteres (3)       | O código da moeda original detectado com a ação.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| `Data de referência`          | Carimbo de data/hora, ISO 8601 | A data e hora da referência associada à ação. Isso será o mesmo que EventDate para ações em lote sem um ClickId.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| `Data do evento`              | Carimbo de data/hora, ISO 8601 | A data e hora em que o evento ocorreu.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| `Data de criação`             | Carimbo de data/hora, ISO 8601 | A data e hora em que a ação foi processada e criada no sistema da impact.com.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| `Data de bloqueio`            | Carimbo de data/hora, ISO 8601 | A data em que a ação é bloqueada. Após essa data, a ação não pode ser modificada pelo anunciante e passa a estar elegível para pagamento ao parceiro de mídia.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| `Data de liberação`           | Carimbo de data/hora, ISO 8601 | Se o parceiro de mídia já tiver sido pago por esta ação, esta é a data e hora em que os fundos foram transferidos para a conta dele.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| `Tipo de referência`          | Texto                          | O tipo de referência correspondente a esta ação. Por exemplo, ‘CLICK\_COOKIE’ para uma referência de clique, ou ‘REPORTED\_PARTNER\_ID’ se a ação foi agrupada com um ID de parceiro de mídia.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| `Domínio de referência`       | Texto                          | A URL de onde veio a referência de clique.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| `Endereço IP`                 | Texto                          | O endereço IP do cliente.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| `Código promocional`          | Cadeia de caracteres (64)      | O código promocional enviado com a ação, se houver.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| `ID do pedido`                | Cadeia de caracteres (64)      | O ID exclusivo e rastreável do pedido da ação.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| `CustomerId`                  | Texto (50)                     | O ID do cliente enviado com a ação.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| `CEP do cliente`              | Numérico                       | O código postal do cliente, se tiver sido enviado com a ação.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| `CustomerStatus`              | Texto (40)                     | O status do cliente (Novo ou Recorrente), se tiver sido enviado com a ação.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| `Observação`                  | Texto (255)                    | Uma observação pode incluir qualquer informação extra que o anunciante queira incluir na ação. Se uma observação tiver sido enviada com a ação, ela aparecerá aqui.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| `ID do chamador`              | Inteiro                        | Se esta for uma ação de rastreamento de chamadas, o valor obrigatório de CallerId para a ação aparecerá aqui.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| `Área do cliente`             | Texto                          | A área geográfica do cliente, se tiver sido detectada com a ação (ou seja, código DMA).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| `Cidade do cliente`           | Texto                          | A cidade do cliente, se tiver sido detectada com a ação.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| `Região do cliente`           | Texto                          | A região do cliente, se tiver sido detectada com a ação.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| `País do cliente`             | Texto                          | O país do cliente.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| `SharedId`                    | Texto (32)                     | Este valor é específico do parceiro de mídia, mas está disponível tanto para o parceiro de mídia quanto para o anunciante.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| `Itens`                       | Texto (255)                    | Categoria por item, sku, valor, quantidade, pagamento, nome, desconto do item e lista de itens (respectivamente) separados pelo caractere “^”. Vários itens são separados pelo caractere “\~”.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |

</details>


---

# 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://help.impact.com/brand/pt-br/what-would-you-like-to-learn-about/account-administration/account-settings/enable-and-view-data-feeds.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.
