Skip to content

transactionalEmailEventReport

(...args)
TransactionalEmailEventQueryResult

Query for transactionalEmailEventReport

Arguments
customerId
String!,non-nullrequired
Your customer ID.
datePeriod
DatePeriod!,non-nullrequired
page
Int
Default: 0
The requested page index. The first page is 0.
size
Int
Default: 500
A maximum of 10,000 rows per page. For larger reports, please refer to our asynchronous reporting.
sort
SortDirection
Default: "ASC"
Return type
TransactionalEmailEventQueryResult
content
[TransactionalEmailEventReportRecord!]!,non-null
pageIndex
Int
Page number of the response, starting at 0.
pageSize
Int
Page size of the response.
hasMoreElements
Boolean
Flag indicating whether there are more pages.
Query sample
query transactionalEmailEventReport(
  $customerId: String!
  $datePeriod: DatePeriod!
  $filter: TransactionalEmailColumnEventFilters
  $page: Int
  $size: Int
  $sort: SortDirection
) {
  transactionalEmailEventReport(
    customerId: $customerId
    datePeriod: $datePeriod
    filter: $filter
    page: $page
    size: $size
    sort: $sort
  ) {
    content {
      __typename
      # ...TransactionalEmailEventReportRecordFragment
    }
    pageIndex
    pageSize
    hasMoreElements
  }
}
Variables
{
  "customerId": "Example String",
  "datePeriod": {
    "fromIncluded": "Example String",
    "toExcluded": "Example String"
  },
  "filter": {
    "usageId": {
      "__typename": "ColumnFilter"
    },
    "eventType": {
      "__typename": "ColumnFilter"
    },
    "eventSubType": {
      "__typename": "ColumnFilter"
    },
    "userId": {
      "__typename": "ColumnFilter"
    }
  },
  "page": 40,
  "size": 40,
  "sort": "ASC"
}
Response sample
{
  "data": {
    "content": [
      {
        "__typename": "TransactionalEmailEventReportRecord"
      }
    ],
    "pageIndex": 40,
    "pageSize": 40,
    "hasMoreElements": true
  }
}