Get AI Flow Reports Summary

curl --request GET \
  --url https://api-ai.zixflow.com/api/data/aiflow/v1/reports/summary/{flowId} \
  --header 'x-api-key: <x-api-key>' \
  --header 'x-workspace-id: <x-workspace-id>'

import requests

url = "https://api-ai.zixflow.com/api/data/aiflow/v1/reports/summary/{flowId}"

headers = {
    "x-api-key": "<x-api-key>",
    "x-workspace-id": "<x-workspace-id>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'x-api-key': '<x-api-key>', 'x-workspace-id': '<x-workspace-id>'}
};

fetch('https://api-ai.zixflow.com/api/data/aiflow/v1/reports/summary/{flowId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-ai.zixflow.com/api/data/aiflow/v1/reports/summary/{flowId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <x-api-key>",
    "x-workspace-id: <x-workspace-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api-ai.zixflow.com/api/data/aiflow/v1/reports/summary/{flowId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<x-api-key>")
	req.Header.Add("x-workspace-id", "<x-workspace-id>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api-ai.zixflow.com/api/data/aiflow/v1/reports/summary/{flowId}")
  .header("x-api-key", "<x-api-key>")
  .header("x-workspace-id", "<x-workspace-id>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-ai.zixflow.com/api/data/aiflow/v1/reports/summary/{flowId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<x-api-key>'
request["x-workspace-id"] = '<x-workspace-id>'

response = http.request(request)
puts response.read_body

{
  "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
  }
}

{
  "success": false,
  "message": "Invalid flowId or query parameter"
}

{
  "success": false,
  "message": "Unauthorized. Please check your API key and workspace ID."
}

{
  "success": false,
  "message": "Too many requests, try again later!"
}

{
  "success": false,
  "message": "Internal server error. Please try again later."
}

GET

api

data

aiflow

reports

summary

{flowId}

Get AI Flow Reports Summary

curl --request GET \
  --url https://api-ai.zixflow.com/api/data/aiflow/v1/reports/summary/{flowId} \
  --header 'x-api-key: <x-api-key>' \
  --header 'x-workspace-id: <x-workspace-id>'

import requests

url = "https://api-ai.zixflow.com/api/data/aiflow/v1/reports/summary/{flowId}"

headers = {
    "x-api-key": "<x-api-key>",
    "x-workspace-id": "<x-workspace-id>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'x-api-key': '<x-api-key>', 'x-workspace-id': '<x-workspace-id>'}
};

fetch('https://api-ai.zixflow.com/api/data/aiflow/v1/reports/summary/{flowId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-ai.zixflow.com/api/data/aiflow/v1/reports/summary/{flowId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <x-api-key>",
    "x-workspace-id: <x-workspace-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api-ai.zixflow.com/api/data/aiflow/v1/reports/summary/{flowId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<x-api-key>")
	req.Header.Add("x-workspace-id", "<x-workspace-id>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api-ai.zixflow.com/api/data/aiflow/v1/reports/summary/{flowId}")
  .header("x-api-key", "<x-api-key>")
  .header("x-workspace-id", "<x-workspace-id>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-ai.zixflow.com/api/data/aiflow/v1/reports/summary/{flowId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<x-api-key>'
request["x-workspace-id"] = '<x-workspace-id>'

response = http.request(request)
puts response.read_body

{
  "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
  }
}

{
  "success": false,
  "message": "Invalid flowId or query parameter"
}

{
  "success": false,
  "message": "Unauthorized. Please check your API key and workspace ID."
}

{
  "success": false,
  "message": "Too many requests, try again later!"
}

{
  "success": false,
  "message": "Internal server error. Please try again later."
}

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

string

required

Your API key for authentication.

string

required

Your workspace ID for authentication.

Path Parameters

string

required

The unique identifier of the AI flow.

Query Parameters

string

Start date in RFC3339 or YYYY-MM-DD format.

string

End date in RFC3339 or YYYY-MM-DD format.

string

Comma-separated channels. Possible values: sms, email, whatsapp, rcs.

Response

boolean

Indicates whether the API call was successful.

string

Success or error message from the API.

object

Aggregated AI flow metrics containing:

integer

Total number of flow requests.

integer

Number of messages submitted.

integer

Number of messages sent.

integer

Number of messages delivered.

integer

Number of failed executions or deliveries.

integer

Total number of users who entered the flow.

integer

Number of users who achieved the flow goal.

integer

Number of users who exited the flow before completion.

number

Percentage of users who completed the journey.

number

Average time to conversion.

number

Total cost for the selected period.

{
  "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
  }
}

{
  "success": false,
  "message": "Invalid flowId or query parameter"
}

{
  "success": false,
  "message": "Unauthorized. Please check your API key and workspace ID."
}

{
  "success": false,
  "message": "Too many requests, try again later!"
}

{
  "success": false,
  "message": "Internal server error. Please try again later."
}

Zixflow AI

Sendflow

AI Flow Reports

Campaign Reports

Events

WhatsApp

RCS

SMS

Email

Delivery Report

Get AI Flow Reports Summary

Description

Headers

Path Parameters

Query Parameters

Response

​Description

​Headers

​Path Parameters

​Query Parameters

​Response

Description

Headers

Path Parameters

Query Parameters

Response