Get AI Flow Report Logs

curl --request GET \
  --url https://api-ai.zixflow.com/api/data/aiflow/v1/reports/logs/{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/logs/{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/logs/{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/logs/{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/logs/{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/logs/{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/logs/{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 report logs retrieved successfully",
  "data": [
    {
      "request_id": "66e120d1b9eht5059e5e01d",
      "date": "2024-01-15T10:30:00Z",
      "status": "Completed",
      "delivery_status": "delivered",
      "recipients": [
        {
          "id": "65f1a2b3c4d5e6f7a8b9c0d2",
          "name": "Jane Doe",
          "phone": "+15551234567",
          "email": "jane@example.com"
        }
      ]
    }
  ],
  "pagination": {
    "size": 42,
    "count": 20,
    "pageSize": 20
  }
}

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

logs

{flowId}

Get AI Flow Report Logs

curl --request GET \
  --url https://api-ai.zixflow.com/api/data/aiflow/v1/reports/logs/{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/logs/{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/logs/{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/logs/{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/logs/{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/logs/{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/logs/{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 report logs retrieved successfully",
  "data": [
    {
      "request_id": "66e120d1b9eht5059e5e01d",
      "date": "2024-01-15T10:30:00Z",
      "status": "Completed",
      "delivery_status": "delivered",
      "recipients": [
        {
          "id": "65f1a2b3c4d5e6f7a8b9c0d2",
          "name": "Jane Doe",
          "phone": "+15551234567",
          "email": "jane@example.com"
        }
      ]
    }
  ],
  "pagination": {
    "size": 42,
    "count": 20,
    "pageSize": 20
  }
}

{
  "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 paginated AI flow execution logs for a specific flow. You can filter by run status, date range, and a search term (request ID, profile ID, phone, or email). Results are cached for 5 seconds 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

integer

Page number.

integer

Number of items to return per page.

string

Run status filter. Possible values: Pending, Running, Completed, Failed, Stopped.

string

Start date in RFC3339 format.

string

End date in RFC3339 format.

string

Search by request ID, profile ID, phone, or email.

Response

boolean

Indicates whether the API call was successful.

string

Success or error message from the API.

array

An array of AI flow execution log objects, each containing:

string

The unique request ID for this flow run.

string

The date of the flow execution.

string

The run status of the flow execution. Possible values: Pending, Running, Completed, Failed, Stopped.

string

The message delivery status for this execution.

array

Recipients associated with this execution.

string

The profile ID of the recipient.

string

The name of the recipient.

string

The phone number of the recipient.

string

The email address of the recipient.

object

Pagination information containing:

integer

The total number of logs available.

integer

The number of logs returned in this response.

integer

The page size used for this request.

{
  "success": true,
  "message": "AI flow report logs retrieved successfully",
  "data": [
    {
      "request_id": "66e120d1b9eht5059e5e01d",
      "date": "2024-01-15T10:30:00Z",
      "status": "Completed",
      "delivery_status": "delivered",
      "recipients": [
        {
          "id": "65f1a2b3c4d5e6f7a8b9c0d2",
          "name": "Jane Doe",
          "phone": "+15551234567",
          "email": "jane@example.com"
        }
      ]
    }
  ],
  "pagination": {
    "size": 42,
    "count": 20,
    "pageSize": 20
  }
}

{
  "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 Report Logs

Description

Headers

Path Parameters

Query Parameters

Response

​Description

​Headers

​Path Parameters

​Query Parameters

​Response

Description

Headers

Path Parameters

Query Parameters

Response