# Create Alert

POST /v3/alerts

Endpoint: POST /v3/alerts
Security: API_Key

## Request fields (application/json):

  - `name` (string, required)
    User-defined name of the alert

  - `labels` (array)
    Passing null instead of this array while updating an entity will prevent API from changing associated labels

  - `metricType` (string, required)
    Deprecated metric types:
  - ACCOUNT_USAGE_THIS_MONTH_AUDIT_PAGE_SCANNED_COUNT
  - ACCOUNT_USAGE_12_MONTH_AUDIT_PAGE_SCANNED_COUNT
  - ACCOUNT_USAGE_12_MONTH_WJ_RUN_COUNT
  - ACCOUNT_USAGE_THIS_MONTH_WJ_RUN_COUNT
  - ACCOUNT_USAGE_LAST_30_DAYS_LOGIN_USER_COUNT
  - PAGE_SUMMARY_FAILED_RULE_COUNT
    Enum: "ACCOUNT_USAGE_THIS_MONTH_AUDIT_PAGE_SCANNED_COUNT", "ACCOUNT_USAGE_12_MONTH_AUDIT_PAGE_SCANNED_COUNT", "ACCOUNT_USAGE_12_MONTH_WJ_RUN_COUNT", "ACCOUNT_USAGE_THIS_MONTH_WJ_RUN_COUNT", "ACCOUNT_USAGE_LAST_30_DAYS_LOGIN_USER_COUNT", "ACCOUNT_USAGE_V2_THIS_MONTH_AUDIT_PAGE_USAGE_PERCENTAGE", "ACCOUNT_USAGE_V2_CURRENT_TERM_PAGE_USAGE_PERCENTAGE", "ACCOUNT_USAGE_V2_CURRENT_TERM_WJ_RUN_USAGE_PERCENTAGE", "ACCOUNT_USAGE_V2_THIS_MONTH_WJ_RUN_USAGE_PERCENTAGE", "ACCOUNT_USAGE_V2_LAST_30_DAYS_LOGIN_USER_COUNT", "SCORE_TOTAL", "SCORE_TAG_PRESENCE", "SCORE_TAG_PERFORMANCE", "SCORE_RULES", "SCORE_PAGE_PERFORMANCE", "SCORE_COOKIE", "PAGE_SUMMARY_PAGE_COUNT", "PAGE_SUMMARY_AVG_PAGE_LOAD_TIME", "PAGE_SUMMARY_BROKEN_INITIAL_PAGE_COUNT", "PAGE_SUMMARY_BROKEN_FINAL_PAGE_COUNT", "PAGE_SUMMARY_PAGE_WITH_BROKEN_LINKS_COUNT", "PAGE_SUMMARY_FAILED_RULE_COUNT", "PAGE_SUMMARY_WEB_VITALS_P75_LARGEST_CONTENTFUL_PAINT", "PAGE_SUMMARY_WEB_VITALS_P75_FIRST_CONTENTFUL_PAINT", "PAGE_SUMMARY_WEB_VITALS_P75_TIME_TO_FIRST_BYTE", "PAGE_SUMMARY_WEB_VITALS_P75_CUMULATIVE_LAYOUT_SHIFT", "TAG_INVENTORY_PAGE_COUNT", "TAG_INVENTORY_UNIQUE_TAG_COUNT", "TAG_INVENTORY_BROKEN_TAG_COUNT", "TAG_INVENTORY_BROKEN_PAGE_COUNT", "TAG_HEALTH_PAGE_COUNT", "TAG_HEALTH_AVG_TAG_LOAD_TIME", "TAG_HEALTH_AVG_TAG_REQUEST_SIZE", "TAG_HEALTH_SLOW_TAG_PERCENTAGE", "TAG_HEALTH_BROKEN_TAG_PERCENTAGE", "TAG_HEALTH_TAG_REQUEST_COUNT", "TAG_DUPLICATES_AND_MULTIPLES_PAGE_COUNT", "TAG_DUPLICATES_AND_MULTIPLES_UNIQUE_TAG_COUNT", "TAG_DUPLICATES_AND_MULTIPLES_TAG_REQUEST_COUNT", "TAG_DUPLICATES_AND_MULTIPLES_TAG_DUPLICATE_COUNT", "TAG_DUPLICATES_AND_MULTIPLES_TAG_MULTIPLE_COUNT", "VARIABLE_INVENTORY_PAGE_COUNT", "VARIABLE_INVENTORY_UNIQUE_TAG_COUNT", "VARIABLE_INVENTORY_TAG_REQUEST_COUNT", "VARIABLE_INVENTORY_UNIQUE_VARIABLE_COUNT", "VARIABLE_INVENTORY_UNIQUE_VARIABLE_VALUE_COUNT", "BROWSER_LOGS_PAGE_COUNT", "BROWSER_LOGS_ERROR_LOG_COUNT", "BROWSER_LOGS_WARN_LOG_COUNT", "BROWSER_LOGS_INFO_LOG_COUNT", "BROWSER_LOGS_DEBUG_LOG_COUNT", "BROWSER_LOGS_OTHER_LOG_COUNT", "COOKIE_INVENTORY_PAGE_COUNT", "COOKIE_INVENTORY_UNIQUE_COOKIE_COUNT", "COOKIE_INVENTORY_FIRST_PARTY_COOKIE_COUNT", "COOKIE_INVENTORY_THIRD_PARTY_COOKIE_COUNT", "COOKIE_INVENTORY_NON_SECURE_COOKIE_COUNT", "COOKIE_INVENTORY_SAME_SITE_EMPTY_COOKIE_COUNT", "PRIVACY_COOKIES_PAGE_COUNT", "PRIVACY_COOKIES_PAGE_WITH_UNAPPROVED_COOKIES_COUNT", "PRIVACY_COOKIES_UNIQUE_COOKIE_COUNT", "PRIVACY_COOKIES_APPROVED_COOKIE_COUNT", "PRIVACY_COOKIES_UNAPPROVED_COOKIE_COUNT", "PRIVACY_TAGS_PAGE_COUNT", "PRIVACY_TAGS_PAGE_WITH_UNAPPROVED_TAGS_COUNT", "PRIVACY_TAGS_UNIQUE_TAG_COUNT", "PRIVACY_TAGS_APPROVED_TAG_COUNT", "PRIVACY_TAGS_UNAPPROVED_TAG_COUNT", "PRIVACY_REQUESTS_PAGE_COUNT", "PRIVACY_REQUESTS_PAGE_WITH_UNAPPROVED_REQUESTS_COUNT", "PRIVACY_REQUESTS_REQUEST_COUNT", "PRIVACY_REQUESTS_UNIQUE_DOMAIN_COUNT", "PRIVACY_REQUESTS_UNIQUE_LOCATION_COUNT", "PRIVACY_REQUESTS_APPROVED_REQUEST_COUNT", "PRIVACY_REQUESTS_UNAPPROVED_REQUEST_COUNT", "FILE_CHANGES_PAGE_COUNT", "FILE_CHANGES_CHANGED_FILE_COUNT", "FILE_CHANGES_NEW_FILE_COUNT", "FILE_CHANGES_FILE_DATE_CHANGE_COUNT", "FILE_CHANGES_FILE_SIZE_CHANGE_COUNT", "RULE_RESULTS_PAGE_COUNT", "RULE_RESULTS_RULE_COUNT", "RULE_RESULTS_RULE_FAILURE_COUNT", "RULE_RESULTS_FAILED_RULE_COUNT", "RULE_RESULTS_PASSED_RULE_COUNT", "RULE_RESULTS_NOT_APPLIED_RULE_COUNT", "RULE_RESULTS_FAILED_RULE_PAGE_COUNT", "RULE_RESULTS_PASSED_RULE_PAGE_COUNT", "RULE_RESULTS_NOT_APPLIED_RULE_PAGE_COUNT"

  - `metricChangeType` (string)
    Behaviour per type:
- VALUE_CHANGE: current - previous
- VALUE_CHANGE_ABS: ABS(current - previous)
- RELATIVE_VALUE_CHANGE: 100% * (current - previous) / previous
- RELATIVE_VALUE_CHANGE: ABS(100% * (current - previous) / previous)

Composite metric change operators shown on ObservePoint UI should be defined as described below:
-  = VALUE_CHANGE_ABS + GREATER_OR_EQUAL(positive number)
-  = VALUE_CHANGE + GREATER_OR_EQUAL(positive number)
-  = VALUE_CHANGE + LESS_OR_EQUAL(negative number)
-  = VALUE_CHANGE_ABS (or VALUE_CHANGE) + NOT_EQUAL(0)
-  = RELATIVE_CHANGE_ABS + GREATER_OR_EQUAL(positive number)
-  = RELATIVE_CHANGE + GREATER_OR_EQUAL(positive number)
-  = RELATIVE_CHANGE + LESS_OR_EQUAL(negative number)
    Enum: "VALUE_CHANGE", "VALUE_CHANGE_ABS", "RELATIVE_VALUE_CHANGE", "RELATIVE_VALUE_CHANGE_ABS"

  - `targetValueComparator` (object, required)
    Subtypes: - AlertMetricSpecificValueComparator - AlertMetricValueInRangeComparator - AlertMetricValueNotInRangeComparator

  - `targetValueComparator.operator` (string, required)
    Enum: "GREATER", "GREATER_OR_EQUAL", "EQUAL", "NOT_EQUAL", "LESS_OR_EQUAL", "LESS", "BETWEEN", "NOT_BETWEEN"

  - `filtersV0` (object, required)
    Filters to be applied before computing the alert. Exact type depends on , see mapping in

  - `emails` (array)
    List of email addresses that receive notifications when alert triggers. Will be replaced with Notification Profiles
    Example: ["user@example.com"]

  - `customAlertMessage` (string)

  - `notificationPolicy` (string)
    Behaviour per type:
- WHEN_NEWLY_TRIGGERED: () send alert when goes from "ok" to "triggered" (resets when no longer triggered)
- ALWAYS_WHEN_TRIGGERED: send alert notification each time it is triggered per run
    Enum: "WHEN_NEWLY_TRIGGERED", "ALWAYS_WHEN_TRIGGERED"

  - `isDefaultForNewDataSources` (boolean)
    Makes this alert selected by default in data-source (audit/WJ) creation UI.
This is a user-specific flag.

  - `assignments` (array)
    Passing null instead of this array while updating an alert will prevent API from changing its assignments.   
To pass only updates of assignments (additions/removals) for existing alert use  endpoint

  - `assignments.itemType` (string, required)
    Enum: "AUDIT", "WEB_JOURNEY"

  - `assignments.itemId` (integer, required)
    ID of the item that can have assigned Alert(s) onto it. See also

  - `skipSendingAlertSharedWithYouEmail` (boolean)
    When TRUE, "Alert shared with you" email will NOT be sent to newly added email addresses.
When NOT specified or FALSE, it will be sent.

## Response 201 fields (application/json):

  - `id` (integer)

## Response 400 fields (application/json):

  - `timestamp` (string)

  - `message` (string)

  - `details` (string)

  - `validationReport` (object)

## Response 401 fields (application/json):

  - `timestamp` (string)

  - `message` (string)

  - `details` (string)

  - `validationReport` (object)

## Response 403 fields (application/json):

  - `timestamp` (string)

  - `message` (string)

  - `details` (string)

  - `validationReport` (object)