# Get Alerts Library items

POST /v3/alerts/library

Endpoint: POST /v3/alerts/library
Security: API_Key

## Query parameters:

  - `size` (integer)

  - `page` (integer)
    Number of results page of an endpoint with paginated results

  - `sortDesc` (boolean)
    Controls sorting order

  - `sortBy` (string)
    Enum: "ALERT_NAME", "TARGET_ITEMS", "REPORT_METRIC", "UPDATED_AT", "SUBSCRIBERS"

## Request fields (application/json):

  - `alertName` (string)
    when present works as "alert  contains give substring` filter

  - `metricType` (string)
    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"

  - `labels` (array)

  - `createdByUserId` (integer)
    ID of a user
    Example: 123

  - `isSubscribed` (boolean)
    When  then only those alerts will be returned that have Notification Profile of a requestor user assigned onto them

## Response 200 fields (application/json):

  - `metadata` (object, required)
    Common metadata for iterable

  - `metadata.pagination` (object, required)

  - `metadata.pagination.totalCount` (integer, required)
    Total number of items available from all result pages combined

  - `metadata.pagination.totalPageCount` (integer, required)
    Total number of pages available

  - `metadata.pagination.pageSize` (integer, required)
    Page size - number of items per result page configured by  query parameter or default page size

  - `metadata.pagination.currentPageSize` (integer, required)
    Number of items in current result page

  - `metadata.pagination.currentPageNumber` (integer, required)
    Current page number/ordinal

  - `alerts` (array, required)

  - `alerts.id` (integer, required)

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

  - `alerts.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"

  - `alerts.labels` (array, required)

  - `alerts.updatedAt` (string, required)
    Date-time in [RFC3339 profile ISO 8601 format](https://www.ietf.org/rfc/rfc3339.txt) with
the following additional restrictions:
1. An uppercase T must separate the date and time portions.
2. An uppercase Z must denote that a numeric time zone offset isn't present.

In general, these timestamp requirements are the same in
[AWS Step Functions - Choice Rules](https://docs.aws.amazon.com/step-functions/latest/dg/amazon-states-language-choice-state.html)
    Example: "2016-08-18T17:33:00Z"

  - `alerts.targetItemCount` (integer, required)
    Number of audits/journeys that have this alert configured

  - `alerts.subscribedCount` (integer, required)
    Number of notification profiles configured for this alert

  - `alerts.isOwner` (boolean, required)
    Indicates whether the current user is the owner of this alert

## 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)

## Response 404 fields (application/json):

  - `timestamp` (string)

  - `message` (string)

  - `details` (string)

  - `validationReport` (object)