> ## 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 Message Reports Summary

> Returns aggregated messaging metrics by date

#### Description

This endpoint returns aggregated messaging metrics grouped by date. You must provide a date range and channel. 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>

#### Query Parameters

<ParamField query="start_date" type="string" required placeholder="2024-01-01T00:00:00Z">
  Start of the date range in RFC3339 format (`YYYY-MM-DDTHH:mm:ssZ`). Required. Sample: `2024-01-01T00:00:00Z`.
</ParamField>

<ParamField query="end_date" type="string" required placeholder="2024-01-31T00:00:00Z">
  End of the date range in RFC3339 format (`YYYY-MM-DDTHH:mm:ssZ`). Required. Sample: `2024-01-31T00:00:00Z`.
</ParamField>

<ParamField query="channel" type="string" required placeholder="whatsapp">
  Channel to query. Required. Possible values: `sms`, `whatsapp`, `rcs`, `email`, `push`. Sample: `whatsapp`.
</ParamField>

<ParamField query="type" type="string" placeholder="campaign">
  Optional delivery type filter. If omitted, metrics include all types. Possible values: `campaign`, `api`, `flow`. Sample: `campaign`.
</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="array">
  An array of date summary objects, each containing:
</ResponseField>

<ResponseField name="data[].date" type="string">
  The date for this summary row.
</ResponseField>

<ResponseField name="data[].audience" type="integer">
  Audience size for the date.
</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[].undelivered" type="integer">
  Number of undelivered messages.
</ResponseField>

<ResponseField name="data[].failed" type="integer">
  Number of failed messages.
</ResponseField>

<ResponseField name="data[].read" type="integer">
  Number of messages marked as read.
</ResponseField>

<ResponseField name="data[].opened" type="integer">
  Number of emails opened.
</ResponseField>

<ResponseField name="data[].clicked" type="integer">
  Number of clicks.
</ResponseField>

<ResponseField name="data[].bounce" type="integer">
  Number of bounced emails.
</ResponseField>

<ResponseField name="data[].complaint" type="integer">
  Number of spam complaints.
</ResponseField>

<ResponseField name="data[].unsubscribed" type="integer">
  Number of unsubscribes.
</ResponseField>

<ResponseField name="data[].sms_submitted" type="integer">
  Number of SMS messages submitted.
</ResponseField>

<ResponseField name="data[].sms_sent" type="integer">
  Number of SMS messages sent.
</ResponseField>

<ResponseField name="data[].sms_delivered" type="integer">
  Number of SMS messages delivered.
</ResponseField>

<ResponseField name="data[].sms_undelivered" type="integer">
  Number of SMS messages undelivered.
</ResponseField>

<ResponseField name="data[].cost" type="number">
  Total cost for the date.
</ResponseField>

<ResponseExample>
  ```json 200-Success theme={null}
  {
    "success": true,
    "message": "Message reports summary retrieved successfully",
    "data": [
      {
        "date": "2024-01-15",
        "audience": 5000,
        "submitted": 4980,
        "sent": 4900,
        "delivered": 4720,
        "undelivered": 80,
        "failed": 100,
        "read": 2100,
        "opened": 0,
        "clicked": 340,
        "bounce": 0,
        "complaint": 0,
        "unsubscribed": 12,
        "sms_submitted": 0,
        "sms_sent": 0,
        "sms_delivered": 0,
        "sms_undelivered": 0,
        "cost": 58.4
      }
    ]
  }
  ```

  ```json 400-Bad Request theme={null}
  {
    "success": false,
    "message": "start_date, end_date, and channel are required"
  }
  ```

  ```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>