Skip to content

faxOutUdrReport

(...args)
FaxOutUdrQueryResult

Retrieves fax outbound usage detail records (UDR) for reporting and analytics. Returns paginated fax transmission data, including delivery status, recipient information, and billing details.

Arguments
customerId
String!,non-nullrequired
Customer ID used for account identification.
datePeriod
DatePeriod!,non-nullrequired
filter
FaxOutColumnUdrFilters
page
Int
Default: 0
The requested page index. The first page is 0.
size
Int
Default: 500
Maximum 10,000 records per page. For larger reports, please refer to our asynchronous reporting.
sort
SortDirection
Default: "ASC"
Return type
FaxOutUdrQueryResult
content
[FaxOutUdrReportRecord!]!,non-null
List of fax outbound usage detail records.
pageIndex
Int
Page index of the response, starting at 0.
pageSize
Int
Page size of the response.
hasMoreElements
Boolean
Indicates whether there are more pages.
Query sample
query faxOutUdrReport(
  $customerId: String!
  $datePeriod: DatePeriod!
  $filter: FaxOutColumnUdrFilters
  $page: Int
  $size: Int
  $sort: SortDirection
) {
  faxOutUdrReport(
    customerId: $customerId
    datePeriod: $datePeriod
    filter: $filter
    page: $page
    size: $size
    sort: $sort
  ) {
    content {
      __typename
      # ...FaxOutUdrReportRecordFragment
    }
    pageIndex
    pageSize
    hasMoreElements
  }
}
Variables
{
  "customerId": "Example String",
  "datePeriod": {
    "fromIncluded": "Example String",
    "toExcluded": "Example String"
  },
  "filter": {
    "faxId": {
      "__typename": "ColumnFilter"
    },
    "statusName": {
      "__typename": "ColumnFilter"
    },
    "calledNumber": {
      "__typename": "ColumnFilter"
    },
    "jobCustomerRef": {
      "__typename": "ColumnFilter"
    },
    "faxCustomerRef": {
      "__typename": "ColumnFilter"
    },
    "jobBillingCode": {
      "__typename": "ColumnFilter"
    },
    "accountService": {
      "__typename": "ColumnFilter"
    },
    "jobCustomerResolution": {
      "__typename": "ColumnFilter"
    },
    "calledCountry": {
      "__typename": "ColumnFilter"
    },
    "callingTsId": {
      "__typename": "ColumnFilter"
    }
  },
  "page": 40,
  "size": 40,
  "sort": "ASC"
}
Response sample
{
  "data": {
    "content": [
      {
        "__typename": "FaxOutUdrReportRecord"
      }
    ],
    "pageIndex": 40,
    "pageSize": 40,
    "hasMoreElements": true
  }
}