{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-guides/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"GET Alerts API Developer Guide","description":"Sprinklr offers robust, convenient, and simple RESTful Web service APIs to integrate data from Sprinklr to any external system.","keywords":["Sprinklr API","Sprinklr Developer Portal","OAuth 2.0","RESTful API","Social Media API","Customer Experience API","Unified-CXM","Social Listening API"]},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"get-alerts-api-developer-guide","__idx":0},"children":["GET Alerts API Developer Guide"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Applies to:"]}," Listening Alerts API (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /api/v3/listening/alert"]},")"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"1-overview","__idx":1},"children":["1. Overview"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use the GET Alerts API to retrieve the configuration and details of existing Listening Alerts, including alert metadata, filter configurations, notification recipients, distribution settings, and alert-specific conditions."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can retrieve alerts by:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Providing a single alert ID."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Providing multiple alert IDs as a comma-separated list."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Specifying a module name."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The API supports partial-success responses. When a request contains valid and invalid identifiers, successfully retrieved alerts are returned in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data"]},", while identifier-specific failures are returned in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["errors"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"2-base-url-and-endpoint","__idx":2},"children":["2. Base URL and Endpoint"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"text","header":{"controls":{"copy":{}}},"source":"https://api3.sprinklr.com/{env}/api/v3/listening/alert\n","lang":"text"},"children":[]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Attribute"},"children":["Attribute"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Value"},"children":["Value"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["HTTP method"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Resource path"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v3/listening/alert"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Response format"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["JSON"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Authentication"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["OAuth 2.0 bearer token and API key"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"3-authentication-and-common-headers","__idx":3},"children":["3. Authentication and Common Headers"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Header"},"children":["Header"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"right","data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Value"},"children":["Value"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Accept"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"right"},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["application/json"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Specifies the expected response media type."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Authorization"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"right"},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Bearer {accessToken}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["OAuth 2.0 bearer token used to authenticate the request."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Key"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"right"},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{apiKey}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["API key used to authorize the client application."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Cookie"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"right"},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["JSESSIONID={sessionId}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Session identifier used for browser-based authenticated sessions. Generally unnecessary for OAuth-based integrations."]}]}]}]}]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Security note:"]}," Do not publish real access tokens, API keys, or session IDs in API documentation. Use placeholders in all examples."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"4-query-parameters","__idx":4},"children":["4. Query Parameters"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"right","data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"right"},"children":["Conditional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String or comma-separated string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unique identifier of a Listening Alert. Provide multiple IDs as a comma-separated list."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["module"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"right"},"children":["Conditional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Module whose alerts should be retrieved. Use instead of ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]},"."]}]}]}]}]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Either ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["module"]}," must be provided."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"5-retrieve-an-alert-by-a-single-id","__idx":5},"children":["5. Retrieve an Alert by a Single ID"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Retrieves the complete configuration of one Listening Alert."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-request","__idx":6},"children":["Example Request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl --location --globoff '{{baseUrl}}/api/v3/listening/alert?id=6995ba46d7890350f0e0ce12' \\\n  --header 'Accept: application/json' \\\n  --header 'Authorization: Bearer {{accessToken}}' \\\n  --header 'Key: {{apiKey}}'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"request-parameters","__idx":7},"children":["Request Parameters"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Sub-Parameter"},"children":["Sub-Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"In"},"children":["In"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"right","data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Query"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"right"},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unique identifier of the Listening Alert to retrieve."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Accept"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Header"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"right"},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Expected response type. Supported value: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["application/json"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Authorization"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["accessToken"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Header"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"right"},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["OAuth access token prefixed with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Bearer"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Key"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["apiKey"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Header"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"right"},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["API key associated with the client application."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-response","__idx":8},"children":["Example Response"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"data\": [\n    {\n      \"id\": \"6995ba46d7890350f0e0ce12\",\n      \"name\": \"Test-Alert-Fetch-API\",\n      \"description\": \"Test-Alert-Fetch-API desc\",\n      \"category\": \"SMART_ALERT\",\n      \"module\": \"LISTENING\",\n      \"status\": \"SUCCESS\",\n      \"filterDimensions\": [\n        {\n          \"dimensionName\": \"QUERY\",\n          \"filterType\": \"IN\",\n          \"values\": [\"india\"],\n          \"details\": {\n            \"contentType\": \"DB_FILTER\",\n            \"DB_FILTER_REPORT_NAME\": \"SPRINKSIGHTS\",\n            \"OLD_DIM_NAME\": \"TOPIC_QUERY\",\n            \"INPUT_TYPE\": \"FREE_TEXT\",\n            \"EXCLUDE_IN_THEME_PREVIEW\": \"true\",\n            \"displayNameForWarning\": \"Keyword Query\",\n            \"EXIST_FILTER\": false,\n            \"singleSelect\": \"true\",\n            \"uniqueId\": \"D_QUERY\"\n          }\n        }\n      ],\n      \"tags\": [],\n      \"enabled\": true,\n      \"distributionConfig\": {\n        \"userIds\": [66006626, 66062939, 66007863],\n        \"userGroupIds\": [],\n        \"emailIds\": [],\n        \"sendEmailNotification\": true,\n        \"customEmailSubject\": \"Listening Alert Test \"\n      },\n      \"smartAlertConfig\": {\n        \"smartAlertMetrics\": [\"NEGATIVE_SENTIMENT\"],\n        \"suddenAnomalyEnabled\": true,\n        \"longTermTrendsEnabled\": false\n      },\n      \"createdTime\": 1771420230634,\n      \"modifiedTime\": 1782478947322,\n      \"ownerUserId\": 66006626,\n      \"lastModifiedUserId\": 0,\n      \"clientId\": 66000002\n    }\n  ],\n  \"errors\": []\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"6-retrieve-multiple-alerts-by-id","__idx":9},"children":["6. Retrieve Multiple Alerts by ID"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Retrieves multiple Listening Alerts by supplying a comma-separated list of IDs."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-request-1","__idx":10},"children":["Example Request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl --location --globoff '{{baseUrl}}/api/v3/listening/alert?id=6995ba46d7890350f0e0ce12%2C699588f0bc163922661c691d' \\\n  --header 'Accept: application/json' \\\n  --header 'Authorization: Bearer {{accessToken}}' \\\n  --header 'Key: {{apiKey}}'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"request-parameters-1","__idx":11},"children":["Request Parameters"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Sub-Parameter"},"children":["Sub-Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"In"},"children":["In"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"right","data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Query"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"right"},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Comma-separated list of Listening Alert IDs. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["%2C"]}," is the URL-encoded comma."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Accept"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Header"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"right"},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Expected response type. Supported value: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["application/json"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Authorization"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["accessToken"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Header"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"right"},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["OAuth access token prefixed with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Bearer"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Key"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["apiKey"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Header"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"right"},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["API key associated with the client application."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-response-1","__idx":12},"children":["Example Response"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"data\": [\n    {\n      \"id\": \"6995ba46d7890350f0e0ce12\",\n      \"name\": \"Test-Alert-Fetch-API\",\n      \"description\": \"Test-Alert-Fetch-API desc\",\n      \"category\": \"SMART_ALERT\",\n      \"module\": \"LISTENING\",\n      \"status\": \"IN_PROGRESS\",\n      \"filterDimensions\": [\n        {\n          \"dimensionName\": \"QUERY\",\n          \"filterType\": \"IN\",\n          \"values\": [\"india\"],\n          \"details\": {\n            \"contentType\": \"DB_FILTER\",\n            \"DB_FILTER_REPORT_NAME\": \"SPRINKSIGHTS\",\n            \"OLD_DIM_NAME\": \"TOPIC_QUERY\",\n            \"INPUT_TYPE\": \"FREE_TEXT\",\n            \"EXCLUDE_IN_THEME_PREVIEW\": \"true\",\n            \"displayNameForWarning\": \"Keyword Query\",\n            \"EXIST_FILTER\": false,\n            \"singleSelect\": \"true\",\n            \"uniqueId\": \"D_QUERY\"\n          }\n        }\n      ],\n      \"tags\": [],\n      \"enabled\": true,\n      \"distributionConfig\": {\n        \"userIds\": [66006626, 66062939, 66007863],\n        \"userGroupIds\": [],\n        \"emailIds\": [],\n        \"sendEmailNotification\": true,\n        \"customEmailSubject\": \"Listening Alert Test \"\n      },\n      \"smartAlertConfig\": {\n        \"smartAlertMetrics\": [\"NEGATIVE_SENTIMENT\"],\n        \"suddenAnomalyEnabled\": true,\n        \"longTermTrendsEnabled\": true\n      },\n      \"createdTime\": 1771420230634,\n      \"modifiedTime\": 1771420279441,\n      \"ownerUserId\": 66006626,\n      \"lastModifiedUserId\": -100,\n      \"clientId\": 66000002\n    },\n    {\n      \"id\": \"699588f0bc163922661c691d\",\n      \"name\": \"AlertManagerStatic_011771407491199\",\n      \"description\": \"Alert Created Via Automation\",\n      \"category\": \"STATIC_ALERT\",\n      \"module\": \"LISTENING\",\n      \"status\": \"SUCCESS\",\n      \"filterDimensions\": [\n        {\n          \"dimensionName\": \"TOPIC_IDS\",\n          \"filterType\": \"IN\",\n          \"values\": [\"692feaaab7d0a90babc9f775\"],\n          \"details\": {\n            \"displayNameForWarning\": \"Topic\",\n            \"USE_SNAPSHOT_VALUE\": false,\n            \"type\": \"DIMENSION\",\n            \"dF\": true,\n            \"OLD_DIM_NAME\": \"TOPIC\",\n            \"nameQueryLookupSupported\": \"true\",\n            \"DRILLDOWN\": false,\n            \"EXIST_FILTER\": false,\n            \"reportName\": \"SPRINKSIGHTS\",\n            \"reports\": [\"SPRINKSIGHTS\"]\n          }\n        }\n      ],\n      \"tags\": [\"testtags\"],\n      \"enabled\": true,\n      \"distributionConfig\": {\n        \"userIds\": [],\n        \"userGroupIds\": [],\n        \"emailIds\": [\"autouser1@sprinklr.com\"],\n        \"sendEmailNotification\": true,\n        \"customEmailSubject\": \"Automation Alert\",\n        \"senderAlias\": \"autouser2@sprinklr.com\"\n      },\n      \"volumetricAlertConfig\": {\n        \"alertTriggerConditionType\": \"ALERT_TRIGGER_TYPE_THRESHOLD\",\n        \"conditions\": [\n          {\n            \"dimensionName\": \"STATIC_ALERT_MENTIONS_VOLUME\",\n            \"filterType\": \"GT\",\n            \"values\": [100],\n            \"details\": {\n              \"displayNameForWarning\": \"Volume of Mentions\",\n              \"USE_SNAPSHOT_VALUE\": false,\n              \"type\": \"DIMENSION\",\n              \"ALLOWED_FILTER_TYPES\": [\"GT\"],\n              \"MEASUREMENT_NAME\": \"MENTIONS_COUNT\",\n              \"STATIC_ALERT_TYPE\": \"STATIC_ALERT_MENTIONS_VOLUME\",\n              \"INPUT_TYPE\": \"NUMERIC\",\n              \"reportName\": \"SPRINKSIGHTS\",\n              \"reports\": [\"SPRINKSIGHTS\"],\n              \"MEASUREMENT_AGG_TYPE\": \"SUM\"\n            }\n          }\n        ]\n      },\n      \"createdTime\": 1771407600013,\n      \"modifiedTime\": 1771408982373,\n      \"ownerUserId\": 66070831,\n      \"lastModifiedUserId\": -100,\n      \"clientId\": 66000002\n    }\n  ],\n  \"errors\": []\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"7-retrieve-multiple-alerts-with-partial-success","__idx":13},"children":["7. Retrieve Multiple Alerts with Partial Success"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Retrieves available alerts while returning identifier-specific errors for empty, malformed, inaccessible, or non-existent values."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-request-2","__idx":14},"children":["Example Request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl --location --globoff '{{baseUrl}}/api/v3/listening/alert?id=6995ba46d7890350f0e0ce12%2C699588f0bc163922661c691d%2C%2Cinvalid%2Ctest' \\\n  --header 'Accept: application/json' \\\n  --header 'Authorization: Bearer {{accessToken}}' \\\n  --header 'Key: {{apiKey}}'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-partial-success-error-fragment","__idx":15},"children":["Example Partial-Success Error Fragment"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"data\": [\n    {\n      \"id\": \"6995ba46d7890350f0e0ce12\",\n      \"category\": \"SMART_ALERT\"\n    },\n    {\n      \"id\": \"699588f0bc163922661c691d\",\n      \"category\": \"STATIC_ALERT\"\n    }\n  ],\n  \"errors\": [\n    {\n      \"id\": \"6995baaef58d8b601be9edb2\",\n      \"code\": 400,\n      \"message\": \"Invalid id format: ''. Value cannot be empty or blank.\"\n    },\n    {\n      \"id\": \"6995baaef58d8b601be9edb3\",\n      \"code\": 404,\n      \"message\": \"Alert not found for id: 'invalid'. Verify the alert exists and you have access permissions.\"\n    },\n    {\n      \"id\": \"6995baaef58d8b601be9edb4\",\n      \"code\": 404,\n      \"message\": \"Alert not found for id: 'test'. Verify the alert exists and you have access permissions.\"\n    }\n  ]\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A partial-success response can contain both populated ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["errors"]}," arrays."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"8-response-parameters","__idx":16},"children":["8. Response Parameters"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Sub-Parameter"},"children":["Sub-Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array",{"$$mdtype":"Tag","name":"object","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Listening Alerts successfully returned by the API."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data[]"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unique identifier of the alert."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data[]"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Name of the alert."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data[]"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["description"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Description of the alert."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data[]"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["category"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Alert category, such as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SMART_ALERT"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["STATIC_ALERT"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data[]"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["module"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Module associated with the alert, such as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LISTENING"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data[]"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["status"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Current processing status, such as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["IN_PROGRESS"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SUCCESS"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data[]"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filterDimensions"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array",{"$$mdtype":"Tag","name":"object","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Filters that define the alert criteria."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data[]"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tags"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array",{"$$mdtype":"Tag","name":"string","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Tags associated with the alert."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data[]"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["enabled"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Indicates whether the alert is enabled."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data[]"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["distributionConfig"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Alert recipient and notification configuration."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data[]"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["smartAlertConfig"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Smart Alert configuration. Returned for Smart Alerts."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data[]"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["volumetricAlertConfig"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Static or volumetric alert configuration. Returned for applicable alerts."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data[]"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["createdTime"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Long"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Alert creation time in epoch milliseconds."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data[]"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["modifiedTime"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Long"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Alert modification time in epoch milliseconds."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data[]"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ownerUserId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Long"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["User ID of the alert owner."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data[]"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lastModifiedUserId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Long"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["User ID of the last modifier. System-generated updates can use a system identifier."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data[]"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["clientId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Long"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Identifier of the client account or workspace."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["errors"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array",{"$$mdtype":"Tag","name":"object","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Request-item errors. Empty when no item-level errors occur."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"81-filter-dimensions","__idx":17},"children":["8.1 Filter Dimensions"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Sub-Parameter"},"children":["Sub-Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filterDimensions[]"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["dimensionName"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Name of the filter dimension."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filterDimensions[]"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filterType"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Filter operation applied to the dimension."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filterDimensions[]"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["values"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Values used by the filter."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filterDimensions[]"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["details"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Additional filter metadata."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"82-filter-dimension-details","__idx":18},"children":["8.2 Filter Dimension Details"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["contentType"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Filter content type."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DB_FILTER_REPORT_NAME"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Report associated with the database filter."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OLD_DIM_NAME"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Legacy dimension name."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["INPUT_TYPE"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Input type supported by the filter."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EXCLUDE_IN_THEME_PREVIEW"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Indicates whether the filter is excluded from theme preview."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["displayNameForWarning"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Display label used in warnings."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EXIST_FILTER"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Indicates whether the filter is an existence filter."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["singleSelect"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Indicates whether only one value can be selected."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["uniqueId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unique identifier of the dimension configuration."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["USE_SNAPSHOT_VALUE"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Indicates whether a snapshot value is used."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Dimension configuration type."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["dF"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Internal dimension flag returned by the API."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["nameQueryLookupSupported"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Indicates whether name-based lookup is supported."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DRILLDOWN"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Indicates whether drill-down is supported."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["reportName"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Associated report name."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["reports"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array",{"$$mdtype":"Tag","name":"string","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Associated reports."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"83-distribution-configuration","__idx":19},"children":["8.3 Distribution Configuration"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["userIds"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array",{"$$mdtype":"Tag","name":"long","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["User IDs configured to receive alert notifications."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["userGroupIds"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array",{"$$mdtype":"Tag","name":"long","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["User group IDs configured to receive notifications."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["emailIds"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array",{"$$mdtype":"Tag","name":"string","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Email addresses configured as recipients."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sendEmailNotification"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Indicates whether email notifications are enabled."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["customEmailSubject"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Custom subject line for alert emails."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["senderAlias"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Sender email alias used for notifications."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"84-smart-alert-configuration","__idx":20},"children":["8.4 Smart Alert Configuration"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["smartAlertMetrics"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array",{"$$mdtype":"Tag","name":"string","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Metrics monitored by the Smart Alert."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["suddenAnomalyEnabled"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Indicates whether sudden-anomaly detection is enabled."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["longTermTrendsEnabled"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Indicates whether long-term trend analysis is enabled."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"85-volumetric-alert-configuration","__idx":21},"children":["8.5 Volumetric Alert Configuration"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["alertTriggerConditionType"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Trigger condition type used by the alert."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["conditions"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array",{"$$mdtype":"Tag","name":"object","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Conditions evaluated against the configured threshold."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"86-volumetric-condition","__idx":22},"children":["8.6 Volumetric Condition"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["dimensionName"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Metric or dimension monitored by the condition."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filterType"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Comparison operator used to evaluate the condition."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["values"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array",{"$$mdtype":"Tag","name":"number","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Threshold values used to trigger the alert."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["details"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Additional condition metadata."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"87-volumetric-condition-details","__idx":23},"children":["8.7 Volumetric Condition Details"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["displayNameForWarning"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["User-friendly metric label."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["USE_SNAPSHOT_VALUE"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Indicates whether a snapshot value is used."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Condition dimension type."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ALLOWED_FILTER_TYPES"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array",{"$$mdtype":"Tag","name":"string","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Supported filter operators."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["MEASUREMENT_NAME"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Measurement tracked by the condition."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["STATIC_ALERT_TYPE"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Static alert metric type."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["INPUT_TYPE"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Input type supported by the metric."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["reportName"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Associated report name."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["reports"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array",{"$$mdtype":"Tag","name":"string","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Associated reports."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["MEASUREMENT_AGG_TYPE"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Aggregation method applied to the metric."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"88-error-object","__idx":24},"children":["8.8 Error Object"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unique identifier associated with the error record."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["code"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Integer"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["HTTP-style error code for the failed item."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["message"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Description of the validation or retrieval failure."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"9-response-codes","__idx":25},"children":["9. Response Codes"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"HTTP Code"},"children":["HTTP Code"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200 OK"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Alerts returned successfully. The body can also contain item-level errors for a partial-success request."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["400 Bad Request"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["One or more request parameters are invalid, empty, or malformed."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["401 Unauthorized"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Authentication failed."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["403 Forbidden"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The authenticated user does not have sufficient permission."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["404 Not Found"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A requested alert cannot be found or accessed."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"10-use-cases","__idx":26},"children":["10. Use Cases"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"101-retrieve-a-specific-alert","__idx":27},"children":["10.1 Retrieve a Specific Alert"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Provide a single alert ID to retrieve its complete configuration."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"102-retrieve-multiple-alerts","__idx":28},"children":["10.2 Retrieve Multiple Alerts"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Supply multiple alert IDs as a comma-separated list to fetch several alert definitions in one request."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"103-retrieve-alerts-by-module","__idx":29},"children":["10.3 Retrieve Alerts by Module"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Provide the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["module"]}," parameter to retrieve alerts associated with a module."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"104-review-distribution-configuration","__idx":30},"children":["10.4 Review Distribution Configuration"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Inspect recipients, sender configuration, and email settings before updating alert delivery."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"105-audit-alert-conditions","__idx":31},"children":["10.5 Audit Alert Conditions"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Review Smart Alert and Volumetric Alert conditions to validate anomaly-detection settings and configured thresholds."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":["All IDs, email addresses, timestamps, and configuration values in this guide are sample values for documentation purposes."]}]}]},"headings":[{"value":"GET Alerts API Developer Guide","id":"get-alerts-api-developer-guide","depth":1},{"value":"1. Overview","id":"1-overview","depth":2},{"value":"2. Base URL and Endpoint","id":"2-base-url-and-endpoint","depth":2},{"value":"3. Authentication and Common Headers","id":"3-authentication-and-common-headers","depth":2},{"value":"4. Query Parameters","id":"4-query-parameters","depth":2},{"value":"5. Retrieve an Alert by a Single ID","id":"5-retrieve-an-alert-by-a-single-id","depth":2},{"value":"Example Request","id":"example-request","depth":3},{"value":"Request Parameters","id":"request-parameters","depth":3},{"value":"Example Response","id":"example-response","depth":3},{"value":"6. Retrieve Multiple Alerts by ID","id":"6-retrieve-multiple-alerts-by-id","depth":2},{"value":"Example Request","id":"example-request-1","depth":3},{"value":"Request Parameters","id":"request-parameters-1","depth":3},{"value":"Example Response","id":"example-response-1","depth":3},{"value":"7. Retrieve Multiple Alerts with Partial Success","id":"7-retrieve-multiple-alerts-with-partial-success","depth":2},{"value":"Example Request","id":"example-request-2","depth":3},{"value":"Example Partial-Success Error Fragment","id":"example-partial-success-error-fragment","depth":3},{"value":"8. Response Parameters","id":"8-response-parameters","depth":2},{"value":"8.1 Filter Dimensions","id":"81-filter-dimensions","depth":3},{"value":"8.2 Filter Dimension Details","id":"82-filter-dimension-details","depth":3},{"value":"8.3 Distribution Configuration","id":"83-distribution-configuration","depth":3},{"value":"8.4 Smart Alert Configuration","id":"84-smart-alert-configuration","depth":3},{"value":"8.5 Volumetric Alert Configuration","id":"85-volumetric-alert-configuration","depth":3},{"value":"8.6 Volumetric Condition","id":"86-volumetric-condition","depth":3},{"value":"8.7 Volumetric Condition Details","id":"87-volumetric-condition-details","depth":3},{"value":"8.8 Error Object","id":"88-error-object","depth":3},{"value":"9. Response Codes","id":"9-response-codes","depth":2},{"value":"10. Use Cases","id":"10-use-cases","depth":2},{"value":"10.1 Retrieve a Specific Alert","id":"101-retrieve-a-specific-alert","depth":3},{"value":"10.2 Retrieve Multiple Alerts","id":"102-retrieve-multiple-alerts","depth":3},{"value":"10.3 Retrieve Alerts by Module","id":"103-retrieve-alerts-by-module","depth":3},{"value":"10.4 Review Distribution Configuration","id":"104-review-distribution-configuration","depth":3},{"value":"10.5 Audit Alert Conditions","id":"105-audit-alert-conditions","depth":3}],"frontmatter":{"seo":{"title":"GET Alerts API Developer Guide"}},"lastModified":"2026-10-12T13:44:14.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/guides/topics/get-alerts","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}