engageReportsList

List email delivery events (send/open/click/bounce/etc.) across campaigns, with filters and pagination.

Each row is a DeliveryReport. Narrow with engageMessageId for a single campaign’s report, or use engageEmailPercentages for workspace-wide averages instead of a single campaign.

Auth · x-app-token · required permission showEngagesMessages

QUERY

engageReportsList(page: Int, perPage: Int, customerId: String, status: String, searchValue: String, engageMessageId: String): DeliveryReportPaginatedResponse

Arguments

page

Int

1-based page index. Default: 1. See Pagination.

perPage

Int

Page size. Default: 20. See Pagination.

customerId

String

Filter to delivery events for one recipient.

status

String

Filter by delivery status (e.g. send, open, click, bounce).

searchValue

String

Case-insensitive partial match on recipient email.

engageMessageId

String

Filter to delivery events for one campaign.

Returns

DeliveryReportPaginatedResponse

data

[DeliveryReport]!

DeliveryReport rows for the current page.

pagination

PaginationInfo!

Standard pagination metadata: totalCount, currentPage, totalPages, hasNextPage, hasPreviousPage, perPage.

Query

query EngageReportsList {
  engageReportsList {
    data {
      _id
      customerId
      mailId
      status
      engage {
        _id
        kind
        tagIds
        customerTagIds
        segmentIds
        customerIds
      }
      createdAt
    }
    pagination {
      currentPage
      perPage
      totalCount
      totalPages
      hasNextPage
      hasPreviousPage
    }
  }
}

Response

{
  "data": {
    "engageReportsList": {
      "data": [
        {
          "_id": "string",
          "customerId": "string",
          "mailId": "string",
          "status": "string",
          "engage": {
            "_id": "string",
            "kind": "string",
            "tagIds": [
              "string"
            ],
            "customerTagIds": [
              "string"
            ],
            "segmentIds": [
              "string"
            ],
            "customerIds": [
              "string"
            ]
          },
          "createdAt": "value"
        }
      ],
      "pagination": {
        "currentPage": 1,
        "perPage": 1,
        "totalCount": 1,
        "totalPages": 1,
        "hasNextPage": true,
        "hasPreviousPage": true
      }
    }
  }
}

آخر تعديل في ١١ أغسطس ٢٠٢٦

⌘I

Query

query EngageReportsList {
  engageReportsList {
    data {
      _id
      customerId
      mailId
      status
      engage {
        _id
        kind
        tagIds
        customerTagIds
        segmentIds
        customerIds
      }
      createdAt
    }
    pagination {
      currentPage
      perPage
      totalCount
      totalPages
      hasNextPage
      hasPreviousPage
    }
  }
}

Response

{
  "data": {
    "engageReportsList": {
      "data": [
        {
          "_id": "string",
          "customerId": "string",
          "mailId": "string",
          "status": "string",
          "engage": {
            "_id": "string",
            "kind": "string",
            "tagIds": [
              "string"
            ],
            "customerTagIds": [
              "string"
            ],
            "segmentIds": [
              "string"
            ],
            "customerIds": [
              "string"
            ]
          },
          "createdAt": "value"
        }
      ],
      "pagination": {
        "currentPage": 1,
        "perPage": 1,
        "totalCount": 1,
        "totalPages": 1,
        "hasNextPage": true,
        "hasPreviousPage": true
      }
    }
  }
}

البداية

أدلة

جرّب

Queries

Mutations

Types

engageReportsList

Arguments

Returns