Dow Jones Alert API

openapi: 3.2.0
info:
  title: Advanced Screening and Monitoring Alert API
  description: 'Dow Jones


    ### Rate limits


    Most endpoints are subject to a general rate limit of 10,000 requests per user per 15 minutes.


    Some endpoints are also subject to a global concurrent request limit of 5 simultaneous requests per customer.'
  version: '3'
  license: {}
  contact: {}
servers:
- url: API_INSTANCE
security:
- basicAuth: []
- jwt: []
- clientCert: []
tags:
- name: Alert
  description: The Alert API allows clients to interact with alerts that have been raised through continuous monitoring.
paths:
  /alert/{alert_id}/close:
    post:
      summary: Close an alert
      description: 'Close an alert with the specified reasons, actions and consequences.

        NOTE: Alerts can only be closed if they are eligible for closure according to the workflow configuration.

        ### Rate Limits


        This endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes.


        <!-- operational-characteristics:start -->


        ### Operational characteristics


        Values below are measured from production traffic. Only collected values are shown.


        *Generated from limited sample size.*


        **Latency distribution**


        Latency values are shown as milliseconds below 1 s, seconds with one decimal place below 1 min, otherwise as M:SS (min).


        | Metric | Value |

        | --- | --- |

        | Median | 552 ms |

        | 90th percentile | 1.4 s |

        | 95th percentile | 2.4 s |

        | 98th percentile | 3.0 s |

        | 99th percentile | 3.2 s |

        <!-- operational-characteristics:end -->

        '
      operationId: alertClose
      parameters:
      - name: alert_id
        in: path
        required: true
        description: The ID of the alert to close
        schema:
          type: number
      tags:
      - Alert
      x-operational-characteristics:
        description: 'Operational characteristics from production log analysis (generatedAt: 2026-06-11T10:43:09.536Z).

          '
        latencyDistribution:
          median: 551.06
          p90: 1382.98
          p95: 2437.39
          p98: 3040.02
          p99: 3235.88
          sampleSize: 26
      requestBody:
        required: true
        content:
          application/json:
            schema:
              allOf:
              - type: object
                required:
                - status
                - reason
                properties:
                  comment:
                    type: string
                    description: a comment providing details of the closure decision.
                  status:
                    type: number
                    description: A 3 digit number made up of internal alert state (1 digit) and the alert status as configured by your system administrator (2 digits).
                    example: 300
                  reason:
                    type: number
                    description: The ID of the closure reason. Reasons are configured by your system administrator.
              - type: object
                description: The reasons, actions and consequence associated with the alert closure. Note that different attributes are required depending on the closure status selected.
                required:
                - consequence
                properties:
                  consequence:
                    type: number
                    description: The ID of the consequence to apply to the closure. Consequences are configured by your system administrator.
            example:
              comment: Comment providing details of closure
              status: 201
              reason: 4
              consequence: 0
      responses:
        '200':
          description: The updated alert
          content:
            application/json:
              schema:
                type: object
                description: Alert object
                properties:
                  id:
                    type: integer
                    description: The id of the alert
                    example: 10001
                  namespace:
                    type: string
                    description: Internal field
                  target:
                    type: string
                    description: The target object (client) that encapsulates the activity
                    example: eoi:10001
                  description:
                    type: string
                    description: A brief description of the alert
                    example: torch
                  clientKey:
                    type: string
                    description: Internal field
                  state:
                    type: string
                    description: Current state of the alert
                    example: OPENED
                    enum:
                    - MONITORING
                    - OPENED
                    - CLOSED
                    - REOPENED
                    - OPENED_FIXED_PERIOD
                  mode:
                    type: string
                    description: alert mode
                    example: sum
                  threshold:
                    type: integer
                    description: The value of the threshold to breach an alert when this alert breached
                    example: 100
                  score:
                    type: integer
                    description: Score of the alert, based on the evidence accrued
                    example: 100
                  sortKey:
                    type: integer
                    description: Internal field
                  currentStatus:
                    type: object
                    description: records details of the alerts status (versus state)
                    properties:
                      status:
                        type: integer
                        description: the current status value
                        example: 101
                      timestamp:
                        type: integer
                        description: timestamp of the last status change
                        example: 1590989346512
                  assignedUsers:
                    type: array
                    description: list of user ids the alert has been assigned to.
                    items:
                      type: number
                      example: 990
                  assignedGroups:
                    type: array
                    description: list of group ids the alert has been assigned to, where appropriate.
                    items:
                      type: number
                      example: 10
                  time:
                    type: object
                    description: set of relevant timestamps for the alert
                    properties:
                      created:
                        type: integer
                        description: when the alert was created
                        example: 1600427478761
                      lastUpdated:
                        type: integer
                        description: when the alert last received updated information
                        example: 1600427478761
                      breached:
                        type: integer
                        description: when the alert transitioned from monitoring to opened
                        example: 1600427478860
                      lastEvidence:
                        type: integer
                        description: when the last piece of evidence was added to the alert
                        example: 1600427478860
                  security:
                    type: object
                    description: The alert\'s security object
                    example: {}
                  tags:
                    type: array
                    description: list of tags that relevant to the alert.
                    items:
                      type: string
                      example: policy-20037
                  client:
                    type: object
                    description: details of the alert's associated client
              example:
                id: 187504
                namespace: torch
                target: eoi:cba_entity_55
                description: alert for Pedro Castillo
                clientKey: sandbox
                state: CLOSED
                mode: sum
                threshold: 100
                score: 100
                sortKey: 400
                docCount: 1
                currentStatus:
                  status: 201
                  consequence: 0
                  reason: 4
                  timestamp: 1706707504238
                  comment:
                    value: Comment providing details of closure
                    user:
                      id: 10024
                      email: sandbox1677001704151@ripjar.com
                      externalId: sandbox1677001704151@ripjar.com
                      cn: sandbox1677001704151@ripjar.com
                assignedUsers:
                - 10024
                assignedGroups: []
                time:
                  created: 1705550372510
                  lastUpdated: 1706707504238
                  breached: 1705550373303
                  lastEvidence: 1705550373303
                  lastAssigned: 1706705385116
                  closed: 1706707504238
                security: {}
                tags:
                - context-alerting
                - dj:sanctions
                - policy-10119
                client:
                  id: eoi:cba_entity_55
                  _start_rev: 20287
                  _revision: 20287
                  clientId: cba_entity_55
                  status: ACTIVE
                  lastReviewed: 1420070400000
                  entityType: PERSON
                  name: Pedro Castillo
                  clientKey: sandbox
                  alertsDisabled: false
                  monitorStartDate: 1420070400000
                  displayname: Pedro Castillo
                  _type: person
                  relationships: []
                  relationshipGrouping: []
                  observedEntityIds: []
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                type: object
                required:
                - status
                - message
                properties:
                  status:
                    type: integer
                    description: The HTTP status code of the error
                    example: 500
                  message:
                    type: string
                    description: Human-readable description of the error, which will usually indicate possible next steps if applicable
                    example: Internal server error
                  details:
                    type: object
                    description: A JSON object containing additional details relating to the error
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                required:
                - status
                - message
                properties:
                  status:
                    type: integer
                    description: The HTTP status code of the error
                    example: 500
                  message:
                    type: string
                    description: Human-readable description of the error, which will usually indicate possible next steps if applicable
                    example: Internal server error
                  details:
                    type: object
                    description: A JSON object containing additional details relating to the error
        '403':
          description: Forbidden (e.g. the user does not have the CloseAlert permission or the alert evidence has not been assessed and the alert type has mandatoryAssessment set to true)
          content:
            application/json:
              schema:
                type: object
                required:
                - status
                - message
                properties:
                  status:
                    type: integer
                    description: The HTTP status code of the error
                    example: 500
                  message:
                    type: string
                    description: Human-readable description of the error, which will usually indicate possible next steps if applicable
                    example: Internal server error
                  details:
                    type: object
                    description: A JSON object containing additional details relating to the error
        '404':
          description: Not Found (e.g. the alert could not be found or the alert status and close reason were not found in configuration)
          content:
            application/json:
              schema:
                type: object
                required:
                - status
                - message
                properties:
                  status:
                    type: integer
                    description: The HTTP status code of the error
                    example: 500
                  message:
                    type: string
                    description: Human-readable description of the error, which will usually indicate possible next steps if applicable
                    example: Internal server error
                  details:
                    type: object
                    description: A JSON object containing additional details relating to the error
        '409':
          description: Conflict (e.g. the alert is already closed)
          content:
            application/json:
              schema:
                type: object
                required:
                - status
                - message
                properties:
                  status:
                    type: integer
                    description: The HTTP status code of the error
                    example: 500
                  message:
                    type: string
                    description: Human-readable description of the error, which will usually indicate possible next steps if applicable
                    example: Internal server error
                  details:
                    type: object
                    description: A JSON object containing additional details relating to the error
        '422':
          description: Unprocessable Entity (e.g. the alert is in monitoring state)
          content:
            application/json:
              schema:
                type: object
                required:
                - status
                - message
                properties:
                  status:
                    type: integer
                    description: The HTTP status code of the error
                    example: 500
                  message:
                    type: string
                    description: Human-readable description of the error, which will usually indicate possible next steps if applicable
                    example: Internal server error
                  details:
                    type: object
                    description: A JSON object containing additional details relating to the error
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                type: object
                required:
                - status
                - message
                properties:
                  status:
                    type: integer
                    description: The HTTP status code of the error
                    example: 500
                  message:
                    type: string
                    description: Human-readable description of the error, which will usually indicate possible next steps if applicable
                    example: Internal server error
                  details:
                    type: object
                    description: A JSON object containing additional details relating to the error
  /alert/{alert_id}/assign:
    post:
      summary: Assign alert to user
      description: 'Assign an alert to a user, optionally changing the status. NOTE: Alerts can only be assigned if they are eligible for assignment to the specified user in the specified status according to the workflow configuration. ### Rate Limits

        This endpoint is subject to a general rate limit of 10,000 requests per user per 15 minutes.

        '
      operationId: alertAssign
      parameters:
      - name: alert_id
        in: path
        required: true
        description: The ID of the alert to assign
        schema:
          type: number
      tags:
      - Alert
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              description: Details of the users to be assigned / unassigned and the optional new status
              required:
              - users
              properties:
                users:
                  type: object
                  description: The users to be added / removed from the assignment. Note that one one user can be assigned to an alert at a time.
                  oneOf:
                  - required:
                    - add
                    - remove
                  - required:
                    - addExternalIds
                    - remove
                  - required:
                    - add
                    - removeExternalIds
                  - required:
                    - addExternalIds
                    - removeExternalIds
                  required:
                  - add
                  - remove
                  - addExternalIds
                  - removeExternalIds
                  properties:
                    add:
                      type: array
                      description: internal user id to add. Cannot be used in conjunction with addExternalIds.
                      maxlength: 1
                      items:
                        type: number
                        example: 10006
                    addExternalIds:
                      type: array
                      description: external user id to add. Cannot be used in conjunction with add.
                      maxlength: 1
                      items:
                        type: string
                        example: john.smith@ripjar.com
                    remove:
                      type: array
                      description: internal user id to remove. Cannot be used in conjunction with removeExternalIds.
                      maxlength: 1
                      items:
                        type: number
                        example: 10005
                    removeExternalIds:
                      type: array
                      description: external user id to remove. Cannot be used in conjunction with remove.
                      maxlength: 1
                      items:
                        type: string
                        example: john.smith@ripjar.com
                newStatus:
                  type: object
                  description: New status
                  properties:
                    status:
                      type: integer
                      description: New status code
      responses:
        '200':
          description: The updated alert
          content:
            application/json:
              schema:
                type: object
                description: The details of the alert following the requested changes being applied.
                properties:
                  alert:
                    type: object
                    properties:
                      assignedUsers:
                        description: Details of the user currently assigned to the alert
                        type: array
                        example:
                        - username: John Smith
                          email: john.smith@ripjar.com
                          externalId: john.smith@ripjar.com
                          mobile: 01234567890
                          roles:
                          - ROLE_1
                          cn: john.smith@ripjar.com
                          clientKey: lowercasekey
                          customerExcludedApps:
                          - app
                          security: {}
                          lastLogin: 1596188918065
                          username_lowercase: john smith
                          lineNumber: 4
                          lastModified: 1595437138430
                          id: 10003
                          dateCreated: 1595437138459
                        oneOf:
                        - type: array
                          description: IDs of users assigned to the result, returned when results enrichment is disabled
                          items:
                            type: number
                          example:
                          - 1
                        - type: array
                          description: Objects representing users assigned to the result, returned when results enrichment is enabled
                          items:
                            type: object
                            properties:
                              username:
                                type: string
                                example: John Smith
                              email:
                                type: string
                                example: john.smith@ripjar.com
                              externalId:
                                type: string
                                example: john.smith@ripjar.com
                              mobile:
                                type: string
                                example: 01234567890
                              roles:
                                type: array
                                items:
                                  type: string
                                  example: ADMINISTRATOR
                              cn:
                                type: string
                                example: john.smith@ripjar.com
                              clientKey:
                                type: string
                                example: lowercasekey
                              customerExcludedApps:
                                type: array
                                nullable: true
                                items:
                                  type: string
                                  example: app
                              security:
                                type: object
                              lastLogin:
                                type: number
                                example: 1596188918065
                              username_lowercase:
                                type: string
                                example: john smith
                              lineNumber:
                                type: number
                                example: 4
                              lastModified:
                                type: number
                                example: 1595437138430
                              id:
                                type: number
                                example: 1
                              dateCreated:
                                type: number
                                example: 1595437138459
                          components:
                            schemas:
                              AssignedUserEnriched:
                                type: object
                                properties:
                                  username:
                                    type: string
                                    example: John Smith
                                  email:
                                    type: string
                                    example: john.smith@ripjar.com
                                  externalId:
                                    type: string
                                    example: john.smith@ripjar.com
                                  mobile:
                                    type: string
                                    example: 01234567890
                                  roles:
                                    type: array
                                    items:
                                      type: string
                                      example: ADMINISTRATOR
                                  cn:
                                    type: string
                                    example: john.smith@ripjar.com
                                  clientKey:
                                    type: string
                                    example: lowercasekey
                                  customerExcludedApps:
                                    type: array
                                    nullable: true
                                    items:
                                      type: string
                                      example: app
                                  security:
                                    type: object
                                  lastLogin:
                                    type: number
                                    example: 1596188918065
                                  username_lowercase:
                                    type: string
                                    example: john smith
                                  lineNumber:
                                    type: number
                                    example: 4
                                  lastModified:
                                    type: number
                                    example: 1595437138430
                                  id:
                                    type: number
                                    example: 1
                                  dateCreated:
                                    type: number
                                    example: 1595437138459
                      assignedGroups:
                        type: array
                        description: assignment to groups is not currently supported.
                        items:
                          type: number
                      tags:
                        type: array
                        description: list of tags that relevant to the alert.
                        items:
                          type: string
                          example: policy-20037
                      state:
                        type: integer
                        description: 'A number representing the overall state of the alert.

                          0 = Monitoring

                          1 = Open

                          2 = Closed

                          3 = Reopened

                          '
                        enum:
                        - 0
                        - 1
                        - 2
                        - 3
                      score:
                        type: integer
                        description: The total alert score, calculated from the evidence within the alert
                      sortKey:
                        type: number
                      currentStatus:
                        type: object
                      time:
                        type: object
                        description: set of relevant timestamps for the alert
                        example:
                          created: 1664330051195
                          lastUpdated: 1664468061574
                          breached: 1664330051277
                          lastEvidence: 1664340367378
                          lastAssigned: 1664468061574
                        properties:
                          created:
                            type: integer
                            description: when the alert was created
                            example: 1600427478761
                          lastUpdated:
                            type: integer
                            description: when the alert last received updated information
                            example: 1600427478761
                          breached:
                            type: integer
                            description: when the alert transitioned from monitoring to opened
                            example: 1600427478860
                          lastEvidence:
                            type: integer
                            description: when the last piece of evidence was added to the alert
                            example: 1600427478860
                          lastAssigned:
                            type: integer
                            description: when the alert was last assigned
                            example: 1600427478860
                      namespace:
                        type: string
                      type:
                        type: number
                      target:
                        type: string
                      security:
                        type: object
                        description: The alert\'s security object
                      description:
                        type: string
                        example: alert for some company
                      name:
                        type: string
                        example: alert
                      clientKey:
                        type: string
                        example: lowercasekey
                      mode:
                        type: string
                        example: sum
                      id:
                        type: number
                        example: 12345
                      threshold:
                        type: number
                        example: 0
                      sortKey2:
                        type: number
                        example: 1.1959140198
                      history:
                        type: array
                        description: The assignment history of the alert
                        items:
                          type: object
                          properties:
                            assignedUsers:
                              type: array
                              description: The user objects for the assigned users.
                              items:
                                type: object
                                description: An object representing a user in the system.
                                required:
                                - username
                                - email
                                - cn
                                properties:
                                  excludedApps:
                                    type: array
                                    items:
                                      type: string
                                    description: A list of the applications that this user is excluded from accessing. Not used in Screening.
                                  username:
                                    type: string
                                    description: The name of the user. This is the value displayed when the user is referenced in the UI.
                                  email:
                                    type: string
                                    description: The email address of the user. Can be used as part of basic authentication.
                                  mobile:
                                    type: string
                                    description: The mobile/cell phone number of the user.
                                  roles:
                                    type: array
                                    items:
                                      type: string
                                    description: 'A list of the user roles that this user has.

                                      Labyrinth Screening makes use of defined user roles to control the actions a user may perform and to tailor the inte

# --- truncated at 32 KB (186 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/dow-jones/refs/heads/main/openapi/dow-jones-alert-api-openapi.yml