Skip to main content

List Data Patterns


This endpoint has been deprecated and may be removed in future versions of the API.

Lists all data patterns that satisfy the request filters.

Request Body
    modeFilter string[]

    Mode filter list

    timeRange object

    See the Time Range Model for details.


    relativeTimeType string

    Possible values: [BACKWARD, FORWARD]

    Direction in which to count time. Default = BACKWARD

    type string
    value object required

    Model for RelativeTimeDuration

    amount int32

    Number of time units

    unit string

    Possible values: [minute, hour, day, week, month, year]

    Time unit

    type string required

    Time type

    type string
    value object required

    Model for Time

    endTime int64

    End timestamp

    startTime int64

    Start timestamp

    updatedByFilter string[]

    Updated By list



    lastUpdatedByFilter string[]

    Last Updated By Filter

    modeFilter string[]

    Mode Filter

    patterns object[]

    Pattern List

  • Array [
  • confidenceLevels string[] required

    List of confidence levels

    delimiter string

    Delimiter to separate the regex and weight in UI

    description string required

    Pattern Description

    detectionTechnique string required

    Detection technique

    entity string


    grammar string


    id string required

    Pattern id

    mode string

    Mode (custom/predefined)

    name string required

    Pattern Name

    parentId string

    Parent ID

    proximityKeywords string[] required

    List of Proximity Keywords

    regexes object[] required

    List of regexes

  • Array [
  • regex string


    weight int32


  • ]
  • rootType string

    Root Type

    s3Path string

    S3 Path to the grammar

    status string required

    Pattern status

  • ]