Skip to content

GraphQL Overview

Download GraphQL schema
sdl.gql

Queries

Overview

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

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

smsOutUdrReport

(...args)
SmsOutUdrQueryResult

Query for smsOutUdrReport.

Arguments

customerId
String!,non-nullrequired

Your customer ID.

datePeriod
DatePeriod!,non-nullrequired
filter
SmsOutColumnUdrFilters
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 refer to our asynchronous reporting.

sort
SortDirection
Default:"ASC"

Return type

SmsOutUdrQueryResult
content
[SmsOutUdrReportRecord!]!,non-null

List of SMS outbound usage detail records.

pageIndex
Int

Page number of the response, starting at 0.

pageSize
Int

Page size of the response.

hasMoreElements
Boolean

Flag indicating if more pages are available.

Query sample
query smsOutUdrReport(
  $customerId: String!
  $datePeriod: DatePeriod!
  $filter: SmsOutColumnUdrFilters
  $page: Int
  $size: Int
  $sort: SortDirection
) {
  smsOutUdrReport(
    customerId: $customerId
    datePeriod: $datePeriod
    filter: $filter
    page: $page
    size: $size
    sort: $sort
  ) {
    content {
      __typename
      # ...SmsOutUdrReportRecordFragment
    }
    pageIndex 
    pageSize 
    hasMoreElements 
  }
}
Variables
{
  "customerId": "Example String",
  "datePeriod": {
    "fromIncluded": "Example String",
    "toExcluded": "Example String"
  },
  "filter": {
    "service": {
      "__typename": "ColumnFilter"
    },
    "statusCode": {
      "__typename": "ColumnFilter"
    },
    "recipient": {
      "__typename": "ColumnFilter"
    },
    "reference": {
      "__typename": "ColumnFilter"
    }
  },
  "page": 40,
  "size": 40,
  "sort": "ASC"
}
Response sample
{
  "data": {
    "content": [
      {
        "__typename": "SmsOutUdrReportRecord"
      }
    ],
    "pageIndex": 40,
    "pageSize": 40,
    "hasMoreElements": true
  }
}

transactionalEmailUdrReport

(...args)
TransactionalEmailUdrQueryResult

Query for transactionalEmailUdrReport

Arguments

customerId
String!,non-nullrequired
datePeriod
DatePeriod!,non-nullrequired
filter
TransactionalEmailColumnUdrFilters
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 refer to our asynchronous reporting.

sort
SortDirection
Default:"ASC"

Return type

TransactionalEmailUdrQueryResult
content
[TransactionalEmailUdrReportRecord!]!,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 transactionalEmailUdrReport(
  $customerId: String!
  $datePeriod: DatePeriod!
  $filter: TransactionalEmailColumnUdrFilters
  $page: Int
  $size: Int
  $sort: SortDirection
) {
  transactionalEmailUdrReport(
    customerId: $customerId
    datePeriod: $datePeriod
    filter: $filter
    page: $page
    size: $size
    sort: $sort
  ) {
    content {
      __typename
      # ...TransactionalEmailUdrReportRecordFragment
    }
    pageIndex 
    pageSize 
    hasMoreElements 
  }
}
Variables
{
  "customerId": "Example String",
  "datePeriod": {
    "fromIncluded": "Example String",
    "toExcluded": "Example String"
  },
  "filter": {
    "usageId": {
      "__typename": "ColumnFilter"
    },
    "usageType": {
      "__typename": "ColumnFilter"
    },
    "userId": {
      "__typename": "ColumnFilter"
    }
  },
  "page": 40,
  "size": 40,
  "sort": "ASC"
}
Response sample
{
  "data": {
    "content": [
      {
        "__typename": "TransactionalEmailUdrReportRecord"
      }
    ],
    "pageIndex": 40,
    "pageSize": 40,
    "hasMoreElements": true
  }
}

transactionalEmailEventReport

(...args)
TransactionalEmailEventQueryResult

Query for transactionalEmailEventReport

Arguments

customerId
String!,non-nullrequired

Your customer ID.

datePeriod
DatePeriod!,non-nullrequired
filter
TransactionalEmailColumnEventFilters
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
  }
}

Directives

Overview

Objects

Overview

Interfaces

Overview

Enums

Overview

Inputs

Overview

Scalars

Overview