Skip to content

faxInUdrReport

(...args)
FaxInUdrQueryResult

Retrieves inbound fax usage detail records (UDR) for reporting and analytics. Returns paginated fax reception data, including delivery status, caller information, and billing details.

Arguments
customerId
String!,non-nullrequired
Customer ID used for account identification.
datePeriod
DatePeriod!,non-nullrequired
filter
FaxInColumnUdrFilters
page
Int
Default: 0
The requested page index. The first page is 0.
size
Int
Default: 500
Maximum 10,000 rows per page. For larger reports, please use our asynchronous reporting.
sort
SortDirection
Default: "ASC"
Return type
FaxInUdrQueryResult
content
[FaxInUdrReportRecord!]!,non-null
List of fax reception records.
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 faxInUdrReport(
  $customerId: String!
  $datePeriod: DatePeriod!
  $filter: FaxInColumnUdrFilters
  $page: Int
  $size: Int
  $sort: SortDirection
) {
  faxInUdrReport(
    customerId: $customerId
    datePeriod: $datePeriod
    filter: $filter
    page: $page
    size: $size
    sort: $sort
  ) {
    content {
      __typename
      # ...FaxInUdrReportRecordFragment
    }
    pageIndex
    pageSize
    hasMoreElements
  }
}
Variables
{
  "customerId": "Example String",
  "datePeriod": {
    "fromIncluded": "Example String",
    "toExcluded": "Example String"
  },
  "filter": {
    "faxId": {
      "__typename": "ColumnFilter"
    },
    "documentDeliveryStatus": {
      "__typename": "ColumnFilter"
    },
    "calledNumber": {
      "__typename": "ColumnFilter"
    },
    "archivingStatus": {
      "__typename": "ColumnFilter"
    },
    "billingCode": {
      "__typename": "ColumnFilter"
    },
    "accountingService": {
      "__typename": "ColumnFilter"
    },
    "faxTransmitStatus": {
      "__typename": "ColumnFilter"
    },
    "resolution": {
      "__typename": "ColumnFilter"
    },
    "calledCountry": {
      "__typename": "ColumnFilter"
    },
    "callingTsId": {
      "__typename": "ColumnFilter"
    }
  },
  "page": 40,
  "size": 40,
  "sort": "ASC"
}
Response sample
{
  "data": {
    "content": [
      {
        "__typename": "FaxInUdrReportRecord"
      }
    ],
    "pageIndex": 40,
    "pageSize": 40,
    "hasMoreElements": true
  }
}