> ## Documentation Index
> Fetch the complete documentation index at: https://docs.abbyy.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 処理パフォーマンス レポート

> ABBYY FlexiCapture の処理パフォーマンス レポート用 Web API パラメーター。プロジェクト、バッチタイプ、ステージ全体のスループットを測定し、JSON の例を含みます。

処理パフォーマンス レポートは、処理パフォーマンスの算出に使用されます。レポートで収集される各種データの詳細については、[処理レポート](/ja/flexi-capture/web-stations/monitoring-console/reports-processing)を参照してください。

<div id="parameters">
  ## パラメーター
</div>

<table width="100%">
  <tbody>
    <tr>
      <td>
        <p>
          <strong>名前</strong>
        </p>
      </td>

      <td>
        <p>
          <strong>対応するUIオプション</strong>
        </p>
      </td>

      <td>
        <p>
          <strong>型</strong>
        </p>
      </td>

      <td>
        <p>
          <strong>説明</strong>
        </p>
      </td>
    </tr>

    <tr>
      <td>
        <p>projects</p>
      </td>

      <td>
        <p>プロジェクト</p>
      </td>

      <td>
        <p>int array</p>
      </td>

      <td>
        <p>
          レポートを生成する対象のプロジェクト ID の一覧です。Application Server 上のすべてのプロジェクトに関する情報を取得するには、<a href="/ja/flexi-capture/api/methods/get-projects">GetProjects</a> メソッドを使用します。既定値は null で、この場合はすべてのプロジェクトのデータがレポートに含まれます。
        </p>
      </td>
    </tr>

    <tr>
      <td>
        <p>dateFrom</p>
      </td>

      <td rowspan="2">
        <p>期間</p>
      </td>

      <td>
        <p>datetime</p>
      </td>

      <td>
        <p>
          レポートを生成する対象期間の開始日時です。既定値は、次の式で計算されます:「レポート生成時点の日時から 1 日を引いた日時」。
        </p>
      </td>
    </tr>

    <tr>
      <td>
        <p>dateTo</p>
      </td>

      <td>
        <p>datetime</p>
      </td>

      <td>
        <p>レポートを生成する対象期間の終了日時です。既定値は、レポート生成時点の日時です。</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>batchTypes</p>
      </td>

      <td>
        <p>バッチタイプ</p>
      </td>

      <td>
        <p>int array</p>
      </td>

      <td>
        <p>
          レポートを生成する対象のバッチタイプ ID の一覧です。プロジェクト内のすべてのバッチタイプに関する情報を取得するには、<a href="/ja/flexi-capture/api/methods/get-batch-types">GetBatchTypes</a> メソッドを使用します。既定値は null で、この場合はすべてのバッチタイプのデータがレポートに含まれます。
        </p>
      </td>
    </tr>

    <tr>
      <td>
        <p>stages</p>
      </td>

      <td>
        <p>ステージ</p>
      </td>

      <td>
        <p>int array</p>
      </td>

      <td>
        <p>
          レポートを生成する対象のステージの一覧です。使用可能な値については、<a href="/ja/flexi-capture/api/structures/t-processing-stage-type">ProcessingStageType</a> を参照してください。既定値は
          null で、この場合はすべてのステージのデータがレポートに含まれます。
        </p>
      </td>
    </tr>

    <tr>
      <td>
        <p>grouping</p>
      </td>

      <td>
        <p>グループ化の基準</p>
      </td>

      <td>
        <p>string</p>
      </td>

      <td>
        <p>レポート内でデータをどのようにグループ化するかを指定します。指定可能な値は次のとおりです。</p>

        <ul>
          <li>ProjectName</li>
          <li>BatchTypeName</li>
          <li>ProcessingStageName</li>
        </ul>

        <p>既定値は ProjectName です。</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>columns</p>
      </td>

      <td>
        <p>表示する列</p>
      </td>

      <td>
        <p>string array</p>
      </td>

      <td>
        <p>レポートに追加する列の一覧です。指定可能な値は次のとおりです。</p>

        <ul>
          <li>TenantName</li>
          <li>PagesOut</li>
          <li>PagesIn</li>
          <li>PagesAutoOut</li>
          <li>PagesHandOut</li>
          <li>PagesAutoQueue</li>
          <li>PagesHandQueue</li>
          <li>Sessions</li>
        </ul>

        <p>既定値は null で、この場合は追加可能なすべての列がレポートに追加されます。</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>showSummary</p>
      </td>

      <td>
        <p>集計レポート</p>
      </td>

      <td>
        <p>boolean</p>
      </td>

      <td>
        <p>集計レポートを生成するかどうかを指定します。指定可能な値は次のとおりです。</p>

        <ul>
          <li>true</li>
          <li>false</li>
        </ul>

        <p>既定値は false です。</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>groupByType</p>
      </td>

      <td>
        <p>期間</p>
      </td>

      <td>
        <p>int</p>
      </td>

      <td>
        <p>レポート内でデータをグループ化する時間単位を指定します。指定可能な値は次のとおりです。</p>

        <ul>
          <li>1=hour</li>
          <li>2=day</li>
          <li>3=month</li>
        </ul>

        <p>既定値は 1 です。</p>
      </td>
    </tr>
  </tbody>
</table>

<div id="example">
  ## 例
</div>

```
[ { "Name": "dateFrom", "Value": "2021-10-31T21:00:00.000Z" }, 
{ "Name": "dateTo", "Value": "2022-04-05T21:00:00.000Z" }, 
{ "Name": "projects", "Value": [ 1, 2, 3, 4, 5, 6, 7 ] },
{ "Name": "batchTypes", "Value": [ 1 ] },
{ "Name": "aggregateByBatchTypes", "Value": true },
{ "Name": "groupByType", "Value": 1 },
{ "Name": "grouping", "Value": "ProcessingStageName" },
{ "Name": "columns", "Value": [ "ProjectId", "BatchTypeName", "ProcessedBatchs", "ProcessedDocs" ] },
{ "Name": "stages", "Value": [ 60, 50 ] } ]
```