Column
List of string values to filter by (logical OR).
{ "values": [ "Example String" ] }
Fax
Filter for fax reception record identifier.
Filter for document delivery status code.
Filter for receiving phone number.
Filter for document archiving status.
Filter for billing code used for cost allocation.
Filter for accounting service identifier.
Filter for fax transmission status.
Filter for fax reception quality/resolution.
Filter for originating country.
Filter for Transmitting Station Identifier of the sending fax machine.
{ "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" } }
Fax
Filter by fax transmission record identifier.
Filter by transmission status name.
Filter by destination phone number.
Filter by job customer reference identifier.
Filter by fax-specific customer reference identifier.
Filter by job billing code.
Filter by account service type.
Filter by fax resolution quality setting.
Filter by destination country of fax transmission.
Filter by Transmitting Station Identifier (TSI) of the sending fax machine.
{ "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" } }
Sms
Filter options for SMS outbound usage detail records.
Filter for the Retarus service used for sending (e.g., 'SMS4AREST').
Filter for the status code of the SMS.
Filter for the recipient phone number.
Filter for the job reference.
{ "service": { "__typename": "ColumnFilter" }, "statusCode": { "__typename": "ColumnFilter" }, "recipient": { "__typename": "ColumnFilter" }, "reference": { "__typename": "ColumnFilter" } }
Transactional
Filter by the value of the 'usageId' field.
Filter by event type. This can be either 'OPEN' or 'CLICK'.
Filter by event subtype. This can be 'LINK_CLICKED' for click event types or 'MAIL_OPENED' for mail event types.
Filter for user ID (technical account) of the client using the service.
{ "usageId": { "__typename": "ColumnFilter" }, "eventType": { "__typename": "ColumnFilter" }, "eventSubType": { "__typename": "ColumnFilter" }, "userId": { "__typename": "ColumnFilter" } }
Transactional
Filter by the value of the 'usageId' field.
Filter by usage type. This can be either 'mail' or 'traceRecover'.
Filter for user ID (technical account) of the client using the service.
{ "usageId": { "__typename": "ColumnFilter" }, "usageType": { "__typename": "ColumnFilter" }, "userId": { "__typename": "ColumnFilter" } }