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

# Get AI Flow Reports Summary

> Returns aggregated AI flow (workflow) metrics

#### Description

This endpoint returns aggregated AI flow (workflow) metrics for a specific flow. You can filter by date range and channels. Results are cached for 5 minutes for the same workspace and query.

#### Headers

<ParamField header="x-api-key" type="string" required placeholder="Enter your API key">
  Your API key for authentication.
</ParamField>

<ParamField header="x-workspace-id" type="string" required placeholder="Enter your workspace ID">
  Your workspace ID for authentication.
</ParamField>

#### Path Parameters

<ParamField path="flowId" type="string" required placeholder="65f1a2b3c4d5e6f7a8b9c0d1">
  The unique identifier of the AI flow.
</ParamField>

#### Query Parameters

<ParamField query="start_date" type="string" placeholder="2024-01-01T00:00:00Z">
  Start date in RFC3339 or `YYYY-MM-DD` format.
</ParamField>

<ParamField query="end_date" type="string" placeholder="2024-01-31T00:00:00Z">
  End date in RFC3339 or `YYYY-MM-DD` format.
</ParamField>

<ParamField query="channels" type="string" placeholder="whatsapp,sms">
  Comma-separated channels. Possible values: `sms`, `email`, `whatsapp`, `rcs`.
</ParamField>

#### Response

<ResponseField name="success" type="boolean">
  Indicates whether the API call was successful.
</ResponseField>

<ResponseField name="message" type="string">
  Success or error message from the API.
</ResponseField>

<ResponseField name="data" type="object">
  Aggregated AI flow metrics containing:
</ResponseField>

<ResponseField name="data.requests" type="integer">
  Total number of flow requests.
</ResponseField>

<ResponseField name="data.submitted" type="integer">
  Number of messages submitted.
</ResponseField>

<ResponseField name="data.sent" type="integer">
  Number of messages sent.
</ResponseField>

<ResponseField name="data.delivered" type="integer">
  Number of messages delivered.
</ResponseField>

<ResponseField name="data.failed" type="integer">
  Number of failed executions or deliveries.
</ResponseField>

<ResponseField name="data.total_users_entered" type="integer">
  Total number of users who entered the flow.
</ResponseField>

<ResponseField name="data.goal_achieved" type="integer">
  Number of users who achieved the flow goal.
</ResponseField>

<ResponseField name="data.early_exit" type="integer">
  Number of users who exited the flow before completion.
</ResponseField>

<ResponseField name="data.journey_completion_rate" type="number">
  Percentage of users who completed the journey.
</ResponseField>

<ResponseField name="data.avg_time_to_conversion" type="number">
  Average time to conversion.
</ResponseField>

<ResponseField name="data.cost" type="number">
  Total cost for the selected period.
</ResponseField>

<ResponseExample>
  ```json 200-Success theme={null}
  {
    "success": true,
    "message": "AI flow reports summary retrieved successfully",
    "data": {
      "requests": 1200,
      "submitted": 1180,
      "sent": 1150,
      "delivered": 1100,
      "failed": 30,
      "total_users_entered": 1200,
      "goal_achieved": 420,
      "early_exit": 80,
      "journey_completion_rate": 35.0,
      "avg_time_to_conversion": 142.5,
      "cost": 86.4
    }
  }
  ```

  ```json 400-Bad Request theme={null}
  {
    "success": false,
    "message": "Invalid flowId or query parameter"
  }
  ```

  ```json 401-Unauthorized theme={null}
  {
    "success": false,
    "message": "Unauthorized. Please check your API key and workspace ID."
  }
  ```

  ```json 429-Too Many Requests theme={null}
  {
    "success": false,
    "message": "Too many requests, try again later!"
  }
  ```

  ```json 500-Internal Server Error theme={null}
  {
    "success": false,
    "message": "Internal server error. Please try again later."
  }
  ```
</ResponseExample>