Get Message Report Logs

curl --request GET \
  --url https://api-ai.zixflow.com/api/data/messages/v1/reports/logs \
  --header 'x-api-key: <x-api-key>' \
  --header 'x-workspace-id: <x-workspace-id>'

import requests

url = "https://api-ai.zixflow.com/api/data/messages/v1/reports/logs"

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/messages/v1/reports/logs', 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/messages/v1/reports/logs",
  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/messages/v1/reports/logs"

	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/messages/v1/reports/logs")
  .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/messages/v1/reports/logs")

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": "Message report logs retrieved successfully",
  "data": [
    {
      "recipient": "+15551234567",
      "status": "delivered",
      "sent_at": "2024-01-15T10:30:00Z",
      "delivered_at": "2024-01-15T10:30:08Z",
      "cost": 0.012,
      "refunded": 0,
      "message": "Your order has been shipped",
      "message_count": 1,
      "failed_reason": "",
      "remark": "",
      "platform": "whatsapp",
      "phone_number": "123456789",
      "bot_id": "",
      "sender_id": "",
      "route": "",
      "from_email": "",
      "from_name": "",
      "subject": "",
      "buttons": ["Track order"],
      "people": {
        "id": "65f1a2b3c4d5e6f7a8b9c0d2",
        "name": "Jane Doe"
      }
    }
  ],
  "pagination": {
    "size": 150,
    "count": 50,
    "pageSize": 50
  }
}

{
  "success": false,
  "message": "start_date, end_date, and channel are required"
}

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

messages

reports

logs

Get Message Report Logs

curl --request GET \
  --url https://api-ai.zixflow.com/api/data/messages/v1/reports/logs \
  --header 'x-api-key: <x-api-key>' \
  --header 'x-workspace-id: <x-workspace-id>'

import requests

url = "https://api-ai.zixflow.com/api/data/messages/v1/reports/logs"

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/messages/v1/reports/logs', 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/messages/v1/reports/logs",
  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/messages/v1/reports/logs"

	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/messages/v1/reports/logs")
  .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/messages/v1/reports/logs")

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": "Message report logs retrieved successfully",
  "data": [
    {
      "recipient": "+15551234567",
      "status": "delivered",
      "sent_at": "2024-01-15T10:30:00Z",
      "delivered_at": "2024-01-15T10:30:08Z",
      "cost": 0.012,
      "refunded": 0,
      "message": "Your order has been shipped",
      "message_count": 1,
      "failed_reason": "",
      "remark": "",
      "platform": "whatsapp",
      "phone_number": "123456789",
      "bot_id": "",
      "sender_id": "",
      "route": "",
      "from_email": "",
      "from_name": "",
      "subject": "",
      "buttons": ["Track order"],
      "people": {
        "id": "65f1a2b3c4d5e6f7a8b9c0d2",
        "name": "Jane Doe"
      }
    }
  ],
  "pagination": {
    "size": 150,
    "count": 50,
    "pageSize": 50
  }
}

{
  "success": false,
  "message": "start_date, end_date, and channel are required"
}

{
  "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 delivery logs. You must provide a date range and channel. 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.

Query Parameters

string

required

Start of the date range in RFC3339 format (YYYY-MM-DDTHH:mm:ssZ). Required. Sample: 2024-01-01T00:00:00Z.

string

required

End of the date range in RFC3339 format (YYYY-MM-DDTHH:mm:ssZ). Required. Sample: 2024-01-31T00:00:00Z.

string

required

Channel to query. Required. Possible values: sms, whatsapp, rcs, email, push. Sample: whatsapp.

integer

default:"1"

Page number to return. Default is 1. Sample: 1.

integer

default:"50"

Number of items to return per page. Default is 50. Sample: 50.

string

Optional delivery status filter. If omitted, logs for all statuses are returned. Sample: delivered.

string

Optional delivery type filter. If omitted, logs for all types are returned. Possible values: campaign, api, flow, inbox, otpflow. Sample: campaign.

string

Optional recipient search term (phone or email). If omitted, no search filter is applied. Sample: +1555.

Response

boolean

Indicates whether the API call was successful.

string

Success or error message from the API.

array

An array of message report log objects, each containing:

string

The recipient address (phone number or email).

string

The delivery status of the message.

string

Timestamp when the message was sent.

string

Timestamp when the message was delivered.

number

Cost of the message.

number

Refunded amount, if any.

string

Message content.

integer

Number of message parts (for example, SMS segments).

string

Failure reason when the message was not delivered.

string

Additional remarks about the delivery.

string

Platform used to send the message.

string

Sender or account phone number, when applicable.

string

RCS bot ID, when applicable.

string

SMS sender ID, when applicable.

string

SMS route, when applicable.

string

From email address, when applicable.

string

From display name, when applicable.

string

Email subject, when applicable.

array

Button labels associated with the message, when applicable.

object

Associated people record, when available.

string

The people record ID.

string

The people record name.

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": "Message report logs retrieved successfully",
  "data": [
    {
      "recipient": "+15551234567",
      "status": "delivered",
      "sent_at": "2024-01-15T10:30:00Z",
      "delivered_at": "2024-01-15T10:30:08Z",
      "cost": 0.012,
      "refunded": 0,
      "message": "Your order has been shipped",
      "message_count": 1,
      "failed_reason": "",
      "remark": "",
      "platform": "whatsapp",
      "phone_number": "123456789",
      "bot_id": "",
      "sender_id": "",
      "route": "",
      "from_email": "",
      "from_name": "",
      "subject": "",
      "buttons": ["Track order"],
      "people": {
        "id": "65f1a2b3c4d5e6f7a8b9c0d2",
        "name": "Jane Doe"
      }
    }
  ],
  "pagination": {
    "size": 150,
    "count": 50,
    "pageSize": 50
  }
}

{
  "success": false,
  "message": "start_date, end_date, and channel are required"
}

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

Events

WhatsApp

RCS

SMS

Email

Messages

Get Message Report Logs

Description

Headers

Query Parameters

Response

​Description

​Headers

​Query Parameters

​Response

Description

Headers

Query Parameters

Response