CdrDetailedRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/telnyx/main/json-schema/telnyx-cdr-detailed-request-schema.json",
  "title": "CdrDetailedRequest",
  "description": "Request object for CDR detailed report",
  "x-generated": "2026-10-08",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/telnyx-cdr-reports-api-openapi.yml#/components/schemas/CdrDetailedRequest",
  "properties": {
    "call_types": {
      "description": "List of call types to filter by (Inbound = 1, Outbound = 2)",
      "items": {
        "format": "int32",
        "type": "integer"
      },
      "type": "array"
    },
    "connections": {
      "description": "List of connections to filter by",
      "items": {
        "format": "int64",
        "type": "integer"
      },
      "type": "array"
    },
    "end_time": {
      "description": "End time in ISO format",
      "format": "date-time",
      "type": "string"
    },
    "fields": {
      "description": "Set of fields to include in the report",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "filters": {
      "description": "List of filters to apply",
      "items": {
        "$ref": "#/$defs/Filter"
      },
      "type": "array"
    },
    "include_all_metadata": {
      "description": "Whether to include all metadata",
      "type": "boolean"
    },
    "managed_accounts": {
      "description": "List of managed accounts to include",
      "items": {
        "format": "uuid",
        "type": "string"
      },
      "type": "array"
    },
    "record_types": {
      "description": "List of record types to filter by (Complete = 1, Incomplete = 2, Errors = 3)",
      "items": {
        "format": "int32",
        "type": "integer"
      },
      "type": "array"
    },
    "report_name": {
      "description": "Name of the report",
      "type": "string"
    },
    "select_all_managed_accounts": {
      "description": "Whether to select all managed accounts",
      "type": "boolean"
    },
    "source": {
      "description": "Source of the report. Valid values: calls (default), call-control, fax-api, webrtc",
      "type": "string"
    },
    "start_time": {
      "description": "Start time in ISO format",
      "format": "date-time",
      "type": "string"
    },
    "timezone": {
      "description": "Timezone for the report",
      "type": "string"
    }
  },
  "required": [
    "start_time",
    "end_time"
  ],
  "type": "object",
  "$defs": {
    "Filter": {
      "description": "Query filter criteria. Note: The first filter object must specify filter_type as 'and'. You cannot follow an 'or' with another 'and'.",
      "properties": {
        "billing_group": {
          "description": "Billing group UUID to filter by",
          "type": "string"
        },
        "cld": {
          "description": "Called line identification (destination number)",
          "type": "string"
        },
        "cld_filter": {
          "description": "Filter type for CLD matching",
          "enum": [
            "contains",
            "starts_with",
            "ends_with"
          ],
          "type": "string"
        },
        "cli": {
          "description": "Calling line identification (caller ID)",
          "type": "string"
        },
        "cli_filter": {
          "description": "Filter type for CLI matching",
          "enum": [
            "contains",
            "starts_with",
            "ends_with"
          ],
          "type": "string"
        },
        "filter_type": {
          "description": "Logical operator for combining filters",
          "enum": [
            "and",
            "or"
          ],
          "type": "string"
        },
        "tags_list": {
          "description": "Tag name to filter by",
          "type": "string"
        }
      },
      "type": "object"
    }
  }
}