> 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/ja/what-would-you-like-to-learn-about/advocate-program/manage-advocate-participant-experiences/widget-and-microsite-statistics-explained.md).

# ウィジェットとマイクロサイトの統計の解説

確認済みアクセスのウィジェットとマイクロサイトは、参加者に紹介数、報酬、プログラムの統計情報を表示するように設定できます。この機能により、参加者は自分が達成したことと、次に何を目指せるかを把握できます。

{% hint style="warning" %}
**制限あり**: 既定のテンプレートに含まれるもの以外のコンポーネントは、特定の製品エディションまたはアドオンでのみ利用できます。ウィジェットやマイクロサイトで使用するコンポーネントをより細かく制御したい場合は、プログラムのアップグレードについてお問い合わせください。
{% endhint %}

### 参加者に表示される統計を調整する

当社のテンプレートでは、既定で一般的な主要統計がいくつか参加者に表示されます。プログラムのカスタム統計を参加者にさらに表示するには:

1. 左側のナビゲーションメニューから、 ![](/files/7ddd72d8e69e7055d9408cf4847c5c54abf9f71d) **\[Engage] → コンテンツ**.
2. 次を選択してコンテンツエディターを開きます **ウィジェットを編集** または **コンテンツを編集**.
   * エディターの使い方については、次を参照してください [プログラムのウィジェットをカスタマイズ](/brand/ja/what-would-you-like-to-learn-about/advocate-program/manage-advocate-participant-experiences/widget-experiences/customize-program-widgets.md) または [マイクロサイトのレイアウトとページをカスタマイズ](/brand/ja/what-would-you-like-to-learn-about/advocate-program/manage-advocate-participant-experiences/microsite-experiences/customize-microsite-layouts-and-pages.md).
3. プログラムを選択します *ウィジェット* または *マイクロサイト* を左側のスライドアウトから編集したいページを選択します。

<div data-with-frame="true"><figure><img src="/files/e3b1e2507b06df4066acc7f770f362c4fb931fa2" alt="" width="375"><figcaption></figcaption></figure></div>

4. 右側のメニューから、次を選択します **追加** → **統計** を選択し、 *統計* グループのいずれかを選びます。
   * 既存の統計を編集するには、キャンバス上でその統計を選択してから、以下の手順6に進んでください。
   * 利用可能な統計コンポーネントの詳細については、次を参照してください [ウィジェットとマイクロサイトのコンポーネント解説](https://help.impact.com/brand/what-would-you-like-to-learn-about/advocate-program/manage-advocate-participant-experiences/widget-and-microsite-components-explained#statistics).
5. キャンバス上で、統計コンポーネントを追加したい場所を見つけて選択します。
6. コンポーネントを選択してキャンバスに配置すると、右側に統計ビルダーが表示されます。この右側パネルでは、コンポーネントをさらにカスタマイズするための多くの編集オプションを利用できます。以下の *統計リファレンス* を参照してください。

### 統計リファレンス

次のセクションでは、 *編集* タブに表示される可能性のあるすべての設定を説明します。

#### **ポイント残高、獲得したギフトカード、紹介、その他の統計コンポーネント**

以下の設定は、 *タイプ* ドロップダウンメニューから選択したユーザー統計に基づいてグループ化されています。

<details>

<summary>紹介</summary>

アドボケイトの紹介活動を表示します。紹介活動のリアルタイム件数を表示することで、パフォーマンスを追跡でき、成功する紹介の要因を把握できるため、アドボケイトの動機付けに活用できます。

| ユーザー統計設定    | 説明                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| ----------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **期間**      | <p>ドロップダウンメニューを使用して、紹介データを特定の期間に絞り込みます。</p><ul><li><strong>全期間</strong> - プログラムの全履歴のデータを使用して統計を計算します。</li><li><strong>今月</strong> - 計算を現在の暦月のデータのみに制限します。</li><li><strong>今週</strong> - 計算を現在の暦週のデータのみに制限します。</li></ul>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| **紹介ステータス** | <p>ドロップダウンメニューを使用して、変換ステータスに基づいて紹介データを区分します。</p><ul><li><strong>開始済みの紹介すべて</strong> - ユーザーによって開始されたすべての紹介を含み、変換に至ったかどうかは問いません。</li><li><strong>変換された紹介のみ</strong> - 望ましい結果（例: 購入完了、登録完了）につながった紹介のみを含みます。</li></ul>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| **追加設定**    | <p>追加設定を選択します。設定の利用可否は、ウィジェットまたはマイクロサイトのどちらを作業しているかによって異なります。</p><ul><li><strong>配置</strong> - フレックスボックスの配置を制御します。</li><li><strong>説明のフォントサイズ</strong> （マイクロサイトのみ）- 説明テキストのサイズをピクセル単位で設定します。フォントサイズを調整するには数値を入力してください。</li><li><strong>説明テキストの色</strong> （マイクロサイトのみ）- 説明テキストの色を設定します。色を設定するには16進カラーコード（例: 白の場合は #FFFFFF）を入力してください。</li><li><strong>フレックスを逆順にする</strong> - <img src="/files/966a7b9c51811043ca7c1811ec6f6b9ef39fd26f" alt=""> <strong>\[オンにする]</strong> と、説明が統計値の前に表示されます。</li><li><strong>プログラムID</strong> - 特定のプログラムの統計を表示するには、プログラムIDを選択します。IDが指定されていない場合は、現在のプログラムコンテキストの統計が既定で表示されます。</li><li><strong>統計のフォントサイズ</strong> （マイクロサイトのみ）- 統計値のテキストサイズをピクセル単位で設定します。</li><li><strong>統計のフォントウェイト</strong> （マイクロサイトのみ）- 統計値のテキストの太さを選択します。</li><li><strong>統計テキストの色</strong> （マイクロサイトのみ）- 統計値のテキストの色を設定します。色を設定するには16進カラーコードを入力してください。</li></ul> |

</details>

<details>

<summary>すべての報酬</summary>

ユーザーが保有しているすべての種類の報酬を表示します。このユーザー統計タイプを使用すると、プログラム内のすべての報酬で獲得した累計価値を強調表示し、アドボケイトの長期的なロイヤルティを育むことができます。

| ユーザー統計設定                 | 説明                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| ------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **期間**                   | <p>ドロップダウンメニューを使用して、紹介データを特定の期間に絞り込みます。</p><ul><li><strong>全期間</strong> - プログラムの全履歴のデータを使用して統計を計算します。</li><li><strong>今月</strong> - 計算を現在の暦月のデータのみに制限します。</li><li><strong>今週</strong> - 計算を現在の暦週のデータのみに制限します。</li></ul>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| **すべてのプログラムにわたる報酬合計を計算** | ![](/files/966a7b9c51811043ca7c1811ec6f6b9ef39fd26f) **\[オンにする]** このユーザー統計を使用して、参加しているすべてのプログラムにわたって蓄積された報酬合計を表示します。 ![](/files/ff9165c3126806be1a33d221d3816f6adc58908c) **\[オフにする]** この統計を使用して、現在のプログラムの報酬のみを表示します。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| **追加設定**                 | <p>追加設定を選択します。設定の利用可否は、ウィジェットまたはマイクロサイトのどちらを作業しているかによって異なります。</p><ul><li><strong>配置</strong> - フレックスボックスの配置を制御します。</li><li><strong>説明のフォントサイズ</strong> （マイクロサイトのみ）- 説明テキストのサイズをピクセル単位で設定します。フォントサイズを調整するには数値を入力してください。</li><li><strong>説明テキストの色</strong> （マイクロサイトのみ）- 説明テキストの色を設定します。色を設定するには16進カラーコード（例: 白の場合は #FFFFFF）を入力してください。</li><li><strong>フレックスを逆順にする</strong> - <img src="/files/966a7b9c51811043ca7c1811ec6f6b9ef39fd26f" alt=""> <strong>\[オンにする]</strong> と、説明が統計値の前に表示されます。</li><li><strong>プログラムID</strong> - 特定のプログラムの統計を表示するには、プログラムIDを選択します。IDが指定されていない場合は、現在のプログラムコンテキストの統計が既定で表示されます。</li><li><strong>統計のフォントサイズ</strong> （マイクロサイトのみ）- 統計値のテキストサイズをピクセル単位で設定します。</li><li><strong>統計のフォントウェイト</strong> （マイクロサイトのみ）- 統計値のテキストの太さを選択します。</li><li><strong>統計テキストの色</strong> （マイクロサイトのみ）- 統計値のテキストの色を設定します。色を設定するには16進カラーコードを入力してください。</li></ul> |

</details>

<details>

<summary>Fueltank、クレジット、および割引の報酬</summary>

* **Fueltankの報酬** - Fueltankプログラム固有の報酬を表示します。
* **クレジットの報酬** - クレジットとして発行された報酬の残高を表示します。
* **割引の報酬** - 利用可能な割引ベースの報酬を表示します。

これらのユーザー統計タイプを使用して、アドボケイトが獲得した報酬を利用するよう促すことができます。

| ユーザー統計設定                 | 説明                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| ------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **タイプ - 報酬単位**           | <p>選択した報酬タイプの単位または通貨を選択します。</p><p>例としては、Percent（%）、Credit - CAD や Cash - USD などの各種通貨、さらに Tshirt - TSHIRT のようなカスタム単位があります。</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| **合計**                   | <p>統計の計算方法と表示方法を選択します。総額（Sum）または報酬の総数（Number）を、現在のステータスでフィルタリングして表示できます。</p><p><strong>計算タイプ</strong>: すべての報酬に対して実行する計算の種類を選択します:</p><ul><li><strong>合計</strong> - 報酬の合計値を計算します。</li><li><strong>数</strong> - 報酬の総数を計算します。</li></ul><p><strong>報酬ステータス</strong>: ライフサイクルにおける現在の状態に基づいて報酬を選択します:</p><ul><li><strong>獲得済み</strong> - ユーザーに付与されたすべての報酬。</li><li><strong>割り当て済み</strong> - ユーザーに割り当てられた報酬。</li><li><strong>利用可能</strong> - 現在ユーザーが利用できる報酬。</li><li><strong>保留中</strong> - 送信はされたが、承認や清算期間などの最終処理を待っている報酬。</li><li><strong>利用済み</strong> - ユーザーがすでに使用または換金した報酬。</li><li><strong>キャンセル済み</strong> - 無効化または取り消され、もはや有効ではない報酬。</li><li><strong>期限切れ</strong> - 有効期限までに使用されず、もはや有効ではない報酬。</li></ul>                                                                                                                                                      |
| **すべてのプログラムにわたる報酬合計を計算** | ![](/files/966a7b9c51811043ca7c1811ec6f6b9ef39fd26f) **\[オンにする]** このユーザー統計を使用して、参加しているすべてのプログラムにわたって蓄積された報酬合計を表示します。 ![](/files/ff9165c3126806be1a33d221d3816f6adc58908c) **\[オフにする]** この統計を使用して、現在のプログラムの報酬のみを表示します。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| **追加設定**                 | <p>追加設定を選択します。設定の利用可否は、ウィジェットまたはマイクロサイトのどちらを作業しているかによって異なります。</p><ul><li><strong>配置</strong> - フレックスボックスの配置を制御します。</li><li><strong>説明のフォントサイズ</strong> （マイクロサイトのみ）- 説明テキストのサイズをピクセル単位で設定します。フォントサイズを調整するには数値を入力してください。</li><li><strong>説明テキストの色</strong> （マイクロサイトのみ）- 説明テキストの色を設定します。色を設定するには16進カラーコード（例: 白の場合は #FFFFFF）を入力してください。</li><li><strong>フレックスを逆順にする</strong> - <img src="/files/966a7b9c51811043ca7c1811ec6f6b9ef39fd26f" alt=""> <strong>\[オンにする]</strong> と、説明が統計値の前に表示されます。</li><li><strong>プログラムID</strong> - 特定のプログラムの統計を表示するには、プログラムIDを選択します。IDが指定されていない場合は、現在のプログラムコンテキストの統計が既定で表示されます。</li><li><strong>統計のフォントサイズ</strong> （マイクロサイトのみ）- 統計値のテキストサイズをピクセル単位で設定します。</li><li><strong>統計のフォントウェイト</strong> （マイクロサイトのみ）- 統計値のテキストの太さを選択します。</li><li><strong>統計テキストの色</strong> （マイクロサイトのみ）- 統計値のテキストの色を設定します。色を設定するには16進カラーコードを入力してください。</li></ul> |

</details>

<details>

<summary>ギフトカード報酬</summary>

ギフトカード報酬の残高を表示します。このユーザー統計タイプを使用すると、アドボケイトが獲得した報酬を把握し、利用するよう促すことができます。

| ユーザー統計設定                 | 説明                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| ------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **報酬ステータス**              | <p>ライフサイクルにおける現在の状態に基づいて表示する報酬を選択します。</p><ul><li><strong>獲得済み</strong> - ユーザーに付与されたすべての報酬。</li><li><strong>割り当て済み</strong> - ユーザーに割り当てられた報酬。</li><li><strong>利用可能</strong> - 現在ユーザーが利用できる報酬。</li><li><strong>保留中</strong> - 送信はされたが、承認や清算期間などの最終処理を待っている報酬。</li><li><strong>利用済み</strong> - ユーザーがすでに使用または換金した報酬。</li><li><strong>キャンセル済み</strong> - 無効化または取り消され、もはや有効ではない報酬。</li><li><strong>期限切れ</strong> - 有効期限までに使用されず、もはや有効ではない報酬。</li></ul>                                                                                                                                                                                                                                                                                                                                                                                                                |
| **すべてのプログラムにわたる報酬合計を計算** | ![](/files/966a7b9c51811043ca7c1811ec6f6b9ef39fd26f) **\[オンにする]** このユーザー統計を使用して、参加しているすべてのプログラムにわたって蓄積された報酬合計を表示します。 ![](/files/ff9165c3126806be1a33d221d3816f6adc58908c) **\[オフにする]** この統計を使用して、現在のプログラムの報酬のみを表示します。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| **追加設定**                 | <p>追加設定を選択します。設定の利用可否は、ウィジェットまたはマイクロサイトのどちらを作業しているかによって異なります。</p><ul><li><strong>配置</strong> - フレックスボックスの配置を制御します。</li><li><strong>説明のフォントサイズ</strong> （マイクロサイトのみ）- 説明テキストのサイズをピクセル単位で設定します。フォントサイズを調整するには数値を入力してください。</li><li><strong>説明テキストの色</strong> （マイクロサイトのみ）- 説明テキストの色を設定します。色を設定するには16進カラーコード（例: 白の場合は #FFFFFF）を入力してください。</li><li><strong>フレックスを逆順にする</strong> - <img src="/files/966a7b9c51811043ca7c1811ec6f6b9ef39fd26f" alt=""> <strong>\[オンにする]</strong> と、説明が統計値の前に表示されます。</li><li><strong>プログラムID</strong> - 特定のプログラムの統計を表示するには、プログラムIDを選択します。IDが指定されていない場合は、現在のプログラムコンテキストの統計が既定で表示されます。</li><li><strong>統計のフォントサイズ</strong> （マイクロサイトのみ）- 統計値のテキストサイズをピクセル単位で設定します。</li><li><strong>統計のフォントウェイト</strong> （マイクロサイトのみ）- 統計値のテキストの太さを選択します。</li><li><strong>統計テキストの色</strong> （マイクロサイトのみ）- 統計値のテキストの色を設定します。色を設定するには16進カラーコードを入力してください。</li></ul> |

</details>

<details>

<summary>支払い残高</summary>

ユーザーの現在の換金残高を表示します。このユーザー統計タイプを使用すると、支払い可能なリアルタイムの現金残高を表示し、直接的な金銭的動機付けを提供できます。

| ユーザー統計設定 | 説明                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **追加設定** | <p>追加設定を選択します。設定の利用可否は、ウィジェットまたはマイクロサイトのどちらを作業しているかによって異なります。</p><ul><li><strong>配置</strong> - フレックスボックスの配置を制御します。</li><li><strong>説明のフォントサイズ</strong> （マイクロサイトのみ）- 説明テキストのサイズをピクセル単位で設定します。フォントサイズを調整するには数値を入力してください。</li><li><strong>説明テキストの色</strong> （マイクロサイトのみ）- 説明テキストの色を設定します。色を設定するには16進カラーコード（例: 白の場合は #FFFFFF）を入力してください。</li><li><strong>フレックスを逆順にする</strong> - <img src="/files/966a7b9c51811043ca7c1811ec6f6b9ef39fd26f" alt=""> <strong>\[オンにする]</strong> と、説明が統計値の前に表示されます。</li><li><strong>プログラムID</strong> - 特定のプログラムの統計を表示するには、プログラムIDを選択します。IDが指定されていない場合は、現在のプログラムコンテキストの統計が既定で表示されます。</li><li><strong>統計のフォントサイズ</strong> （マイクロサイトのみ）- 統計値のテキストサイズをピクセル単位で設定します。</li><li><strong>統計のフォントウェイト</strong> （マイクロサイトのみ）- 統計値のテキストの太さを選択します。</li><li><strong>統計テキストの色</strong> （マイクロサイトのみ）- 統計値のテキストの色を設定します。色を設定するには16進カラーコードを入力してください。</li></ul> |

</details>

<details>

<summary>カスタム</summary>

カスタム定義の統計を使用できます。このユーザー統計タイプを使用すると、特定機能の有効化やイベント登録の追跡など、標準以外の指標を表示できます。

| ユーザー統計設定 | 説明                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **パス**   | <p>表示したいカスタム統計を指す、特定のデータパスを入力します。このパスは、コンポーネントをユーザーのデータオブジェクト内の正確なデータポイントの場所へ導きます。<br>例: <code>/programGoals/count/\[goalId]</code>, <code>/customFields/\[customFieldKey]</code></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| **追加設定** | <p>追加設定を選択します。設定の利用可否は、ウィジェットまたはマイクロサイトのどちらを作業しているかによって異なります。</p><ul><li><strong>配置</strong> - フレックスボックスの配置を制御します。</li><li><strong>説明のフォントサイズ</strong> （マイクロサイトのみ）- 説明テキストのサイズをピクセル単位で設定します。フォントサイズを調整するには数値を入力してください。</li><li><strong>説明テキストの色</strong> （マイクロサイトのみ）- 説明テキストの色を設定します。色を設定するには16進カラーコード（例: 白の場合は #FFFFFF）を入力してください。</li><li><strong>フレックスを逆順にする</strong> - <img src="/files/966a7b9c51811043ca7c1811ec6f6b9ef39fd26f" alt=""> <strong>\[オンにする]</strong> と、説明が統計値の前に表示されます。</li><li><strong>プログラムID</strong> - 特定のプログラムの統計を表示するには、プログラムIDを選択します。IDが指定されていない場合は、現在のプログラムコンテキストの統計が既定で表示されます。</li><li><strong>統計のフォントサイズ</strong> （マイクロサイトのみ）- 統計値のテキストサイズをピクセル単位で設定します。</li><li><strong>統計のフォントウェイト</strong> （マイクロサイトのみ）- 統計値のテキストの太さを選択します。</li><li><strong>統計テキストの色</strong> （マイクロサイトのみ）- 統計値のテキストの色を設定します。色を設定するには16進カラーコードを入力してください。</li></ul> |

</details>

#### **3つの統計コンポーネントを含むコンテナー**

このコンポーネントは、3つの統計（*ポイント残高*, *獲得したギフトカード*、および *紹介*）を表示し、必要に応じてカスタマイズできます。表示される統計を編集するには、それらを選択してから、上記の該当する展開項目を参照してください。

<details>

<summary>ユーザー統計設定</summary>

| ユーザー統計設定                | 説明                                                                                          |
| ----------------------- | ------------------------------------------------------------------------------------------- |
| **表示** （ウィジェットのみ）       | 統計コンテナーをグリッドとして表示するか、フレックスレイアウトで表示するかを選択します。                                                |
| **配置** （マイクロサイトのみ）      | フレックスボックスの配置を設定します。                                                                         |
| **間隔** （マイクロサイトのみ）      | 各統計コンポーネント内のスペース量を調整します。                                                                    |
| **境界線を非表示** （マイクロサイトのみ） | ![](/files/966a7b9c51811043ca7c1811ec6f6b9ef39fd26f) **\[オンにする]** コンテナー内の統計を区切る境界線を非表示にします。 |
| **統計間の間隔**              | 各統計コンポーネント間のスペース量を調整します。統計が詰まりすぎて見えるのを防ぐのに役立ちます。                                            |

</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/ja/what-would-you-like-to-learn-about/advocate-program/manage-advocate-participant-experiences/widget-and-microsite-statistics-explained.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.