openapi: 3.2.0
info:
  title: Query Service Alert Subscriptions API
  description: "Use the Adobe Experience Platform Query Service API to query Platform data with standard SQL. With this serverless tool, you can join any datasets in the [Experience Platform Data Lake](https://experienceleague.adobe.com/docs/experience-platform/landing/license/data-management-best-practices.html#understanding-adobe-experience-platform-data-storage) and capture the query results as a new dataset for use in reporting, Data Science Workspace, or for ingestion into Real-time Customer Profile.\n\n**Related Documentation**:\n  * [Query Service documentation](http://www.adobe.com/go/query-service-home-en)\n\n**Visualize API calls with Postman (a free, third-party software)**:\n  * [Query Service API Postman collection on GitHub](https://github.com/adobe/experience-platform-postman-samples/blob/master/apis/experience-platform/Query%20Service%20API.postman_collection.json)\n  * [Video guide for creating the Postman environment](https://video.tv.adobe.com/v/28832)\n  * [Steps for importing environments and collections in Postman](https://learning.getpostman.com/docs/postman/collection_runs/using_environments_in_collection_runs/)\n\n**API paths**:\n  * PLATFORM Gateway URL: https://<span>platform.adobe.io/\n  * Base path for this API: /data/foundation/query\n  * Example of a complete path: https://<span>platform.adobe.io/data/foundation/query/queries\n\n**Required headers**:\n  * All calls require the headers `Authorization`, `x-gw-ims-org-id`, and `x-api-key`. For more information on how to obtain these values, see the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).\n  * All resources in Experience Platform are isolated to specific virtual sandboxes. All requests to Platform APIs require the header `x-sandbox-name` whose value is the all-lowercase name of the sandbox the operation will take place in (for example, \"prod\"). See the [sandboxes overview](https://adobe.com/go/sandbox-overview-en) for more information.\n  * All requests with a payload in the request body (such as POST, PUT, and PATCH calls) must include the header `Content-Type` with a value of `application/json`.\n\n**API error handling**:\n  * Refer to the Experience Platform API troubleshooting guide for [FAQs](https://experienceleague.adobe.com/docs/experience-platform/landing/troubleshooting.html?lang=en#faq), [API status codes](https://experienceleague.adobe.com/docs/experience-platform/landing/troubleshooting.html?lang=en#api-status-codes), and [request header errors](https://experienceleague.adobe.com/docs/experience-platform/landing/troubleshooting.html?lang=en#request-header-errors).\n  * Refer to the Query Service troubleshooting guide for [common query related FAQs](https://experienceleague.adobe.com/docs/experience-platform/query/troubleshooting-guide.html)."
  version: '1.0'
servers:
- url: //{environment}.adobe.io/data/foundation/query
  variables:
    environment:
      default: platform
      enum:
      - platform
      - platform-stage
tags:
- name: Alert Subscriptions
  description: Alert subscriptions allow you to receive notifications on the different statuses of both ad hoc and scheduled queries. Alerts can be received by email, within the Platform UI, or both.
paths:
  /alert-subscriptions:
    get:
      tags:
      - Alert Subscriptions
      summary: List alerts
      description: This request provides a list of alerts.
      operationId: listAlertsPerImsOrgAndSandbox
      parameters:
      - name: Authorization
        in: header
        description: The access token which can be copied from your Experience Platform integration, prefixed with "Bearer " (for example, `Bearer {ACCESS_TOKEN}`). For more information on how to obtain this value, visit the documentation covering making API calls in the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-gw-ims-org-id
        in: header
        description: The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-api-key
        in: header
        description: The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-sandbox-name
        in: header
        description: The name of the sandbox in which the operation will take place. See the [sandboxes overview documentation](https://adobe.com/go/sandbox-overview-en) for more information.
        required: true
        schema:
          type: string
      - name: x-request-id
        in: header
        description: An optional header that serves as a tracking ID for the request. If one is not provided on the request, the server generates one automatically.
        schema:
          type: string
      - name: User-Agent
        in: header
        description: The type of the client making the HTTP request.
        schema:
          type: string
      - name: orderby
        in: query
        description: The field that specifies the order of results. The supported fields are `created` and `updated`. Prepend the property name with `+` for ascending and `-` for descending order. The default is `-created`. Note that the plus sign (`+`) has to be escaped with `%2B`. For example `%2Bcreated` is the value for an ascending created order.
        schema:
          type: string
      - name: pagesize
        in: query
        description: Control the number of records you want to fetch from the API call per page. The default limit is set to the maximum amount of 50 records per page.
        schema:
          type: integer
      - name: page
        in: query
        description: Indicate the page number of the returned results that you want to see the records for.
        schema:
          type: string
      - name: property
        in: query
        description: "Comma-separated filters. Multiple filters separated by commas can be passed. The examples below are given with unsafe HTML characters for clarity, but all content MUST be HTML escaped.\n\n The properties that allow filtering:\n * `id`\n * `assetId`\n * `status`\n * `alertType`\n\n The list of supported operators:\n\n `==` (equal to)\n\n Examples with filters that support the (`==`)operator:\n * Get me the alert with a match on the `id`:\n `id==query_flow_run_start-599442e0-433a-4708-85fc-e226e8092096`\n * Get me alerts with a match on the `assetId`:\n `assetId==700d43d9-3b99-4d4c-8dbb-29c911c0e0df`\n * Get me alerts with a match on the `status`:\n `status==enabled`\n * Get me alerts with a match on the `alertType`:\n `alertType==success`\n An example of a complex search with multiple filters:\n * Get me alerts that utilize multiple filters:\n `body: status==enabled,alertType==failure`"
        schema:
          type: string
      responses:
        200:
          x-summary: Success
          description: A list of alerts.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/alerts_per_imsorg_and_sandbox'
        401:
          x-summary: Unauthorized
          description: Unauthorized
          content: {}
        '500':
          x-summary: Internal server error
          description: There was an internal server error. Try the request again in a few minutes, and contact Adobe Support if the problem persists.
          content: {}
    post:
      tags:
      - Alert Subscriptions
      summary: Create an alert and subscribe users
      description: This request associates a query to a newly created alert using an `assetId` property, and subscribes users to alerts for that query through the use of `emailIds`.
      operationId: createAndSubscribeToAnAlert
      parameters:
      - name: Authorization
        in: header
        description: The access token which can be copied from your Experience Platform integration, prefixed with "Bearer " (for example, `Bearer {ACCESS_TOKEN}`). For more information on how to obtain this value, visit the documentation covering making API calls in the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-gw-ims-org-id
        in: header
        description: The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-api-key
        in: header
        description: The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-sandbox-name
        in: header
        description: The name of the sandbox in which the operation will take place. See the [sandboxes overview documentation](https://adobe.com/go/sandbox-overview-en) for more information.
        required: true
        schema:
          type: string
      - name: x-service-token
        in: header
        description: An optional key used to authenticate access.
        schema:
          type: string
      - name: x-request-id
        in: header
        description: An optional header that serves as a tracking ID for the request. If one is not provided on the request, the server generates one automatically.
        schema:
          type: string
      - name: User-Agent
        in: header
        description: The type of the client making the HTTP request.
        schema:
          type: string
      requestBody:
        description: Create an alert for a particular query or schedule ID and subscribe `emailId`s to different notification channels.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/subscribe_user_to_alert_body'
        required: true
      responses:
        200:
          x-summary: Success
          description: The subscription to an alert was successful.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/alert_subscription_response_body'
        400:
          x-summary: Request failed
          description: Bad Request. The payload may be malformed, the alert might be in a disabled state, or an `emailID` provided for subscribing to the alert might not be a registered Adobe ID.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/post_bad_request_error_message'
        401:
          x-summary: Unauthorized
          description: Unauthorized
          content: {}
        404:
          x-summary: Not found
          description: Not found. The request cannot be processed because the asset ID provided is invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/post_not_found_error_message'
        '500':
          x-summary: Internal server error
          description: There was an internal server error. Try the request again in a few minutes, and contact Adobe Support if the problem persists.
          content: {}
      x-codegen-request-body-name: alert subscription
  /alert-subscriptions/{assetId}:
    get:
      tags:
      - Alert Subscriptions
      summary: List alert subscription information for a query or schedule
      description: This request lists the alerts for the query ID or schedule ID provided in the request path. It returns subscription information that includes a list of all subscribed users by providing their email IDs and their chosen notification channels.
      operationId: listSubscribersForAnAlertByAssetsId
      parameters:
      - name: Authorization
        in: header
        description: The access token which can be copied from your Experience Platform integration, prefixed with "Bearer " (for example, `Bearer {ACCESS_TOKEN}`). For more information on how to obtain this value, visit the documentation covering making API calls in the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-gw-ims-org-id
        in: header
        description: The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-api-key
        in: header
        description: The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-sandbox-name
        in: header
        description: The name of the sandbox in which the operation will take place. See the [sandboxes overview documentation](https://adobe.com/go/sandbox-overview-en) for more information.
        required: true
        schema:
          type: string
      - name: x-request-id
        in: header
        description: An optional header that serves as a tracking ID for the request. If one is not provided on the request, the server generates one automatically.
        schema:
          type: string
      - name: User-Agent
        in: header
        description: The type of the client making the HTTP request.
        schema:
          type: string
      - name: assetId
        in: path
        description: A query or schedule ID that you want the subscription information for.
        required: true
        schema:
          type: string
      responses:
        200:
          x-summary: Success
          description: Information on the alerts subscribed to by a particular query ID or schedule ID. A maximum of 3 alerts are available in a single response. 1 alert for each `alertType` is contained in the response body.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/subscribers_for_alert_by_assetId'
        401:
          x-summary: Unauthorized
          description: Unauthorized
          content: {}
        404:
          x-summary: Not found
          description: There is no alert associated with the provided `assetId`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/get_alert_subscription_for_asset_id_error_message'
        '500':
          x-summary: Internal server error
          description: There was an internal server error. Try the request again in a few minutes, and contact Adobe Support if the problem persists.
          content: {}
  /alert-subscriptions/{assetId}/{alertType}:
    get:
      tags:
      - Alert Subscriptions
      summary: List alert subscription information for a particular query and alert type
      description: This request lists the alerts and alert subscription information for the query ID and alert type provided in the request path.
      operationId: listSubscribersForAnAlertByAssetIdAndAlertType
      parameters:
      - name: Authorization
        in: header
        description: The access token which can be copied from your Experience Platform integration, prefixed with "Bearer " (for example, `Bearer {ACCESS_TOKEN}`). For more information on how to obtain this value, visit the documentation covering making API calls in the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-gw-ims-org-id
        in: header
        description: The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-api-key
        in: header
        description: The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-sandbox-name
        in: header
        description: The name of the sandbox in which the operation will take place. See the [sandboxes overview documentation](https://adobe.com/go/sandbox-overview-en) for more information.
        required: true
        schema:
          type: string
      - name: x-request-id
        in: header
        description: An optional header that serves as a tracking ID for the request. If one is not provided on the request, the server generates one automatically.
        schema:
          type: string
      - name: User-Agent
        in: header
        description: The type of the client making the HTTP request.
        schema:
          type: string
      - name: assetId
        in: path
        description: A query or schedule ID that you want the subscription information for.
        required: true
        schema:
          type: string
      - name: alertType
        in: path
        description: This property describes the state of query execution that triggers an alert. The response will only include alert subscription information for alerts of this type. The alert type is one of three values (`start`, `success`, `failure`).
        required: true
        schema:
          type: string
      responses:
        200:
          x-summary: Success
          description: A successful response returns the user email IDs and notification channels for a particular query and alert type.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/subscribers_for_alert_by_assetId_and_alertType'
        400:
          x-summary: Request failed
          description: Bad Request. An invalid `alertType` was provided in the URL.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/get_alert_subscription_for_asset_id_and_alert_type_bad_request_error_message'
        401:
          x-summary: Unauthorized
          description: Unauthorized
          content: {}
        404:
          description: No alert was found for the given `assetId`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/get_alert_subscription_for_asset_id_and_alert_type_not_found_error_message'
        500:
          description: Internal Server Error.
          content: {}
    delete:
      tags:
      - Alert Subscriptions
      summary: Delete the alert for a particular query and alert type
      description: Delete a specific alert by providing either an alert type and a query ID or an alert type and a schedule ID in the request path.
      operationId: deleteAlert
      parameters:
      - name: Authorization
        in: header
        description: The access token which can be copied from your Experience Platform integration, prefixed with "Bearer " (for example, `Bearer {ACCESS_TOKEN}`). For more information on how to obtain this value, visit the documentation covering making API calls in the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-gw-ims-org-id
        in: header
        description: The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-api-key
        in: header
        description: The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-sandbox-name
        in: header
        description: The name of the sandbox in which the operation will take place. See the [sandboxes overview documentation](https://adobe.com/go/sandbox-overview-en) for more information.
        required: true
        schema:
          type: string
      - name: x-request-id
        in: header
        description: An optional header that serves as a tracking ID for the request. If one is not provided on the request, the server generates one automatically.
        schema:
          type: string
      - name: User-Agent
        in: header
        description: The type of the client making the HTTP request.
        schema:
          type: string
      - name: assetId
        in: path
        description: A query ID or a schedule ID that you want to delete the alert for.
        required: true
        schema:
          type: string
      - name: alertType
        in: path
        description: The state of query execution that triggers the alert to be deleted. The alert type is one of three values (`start`, `success`, `failure`).
        required: true
        schema:
          type: string
      responses:
        200:
          x-summary: Success
          description: Alert deleted successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/alert_deleted'
        400:
          x-summary: Request failed
          description: Bad Request. An invalid `alertType` was provided in the URL.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/alert_deleted_bad_request_error_message'
        401:
          x-summary: Unauthorized
          description: Unauthorized
          content: {}
        404:
          description: No alert was found for the given `assetId` and `alertType`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/alert_deleted_not_found_error_message'
        500:
          description: Internal Server Error.
          content: {}
    patch:
      tags:
      - Alert Subscriptions
      summary: Enable or disable an alert
      description: Update the status of an alert to either `enable` or `disable` by providing a query or schedule ID and an alert type in the request path.
      operationId: patchAlert
      parameters:
      - name: Authorization
        in: header
        description: The access token which can be copied from your Experience Platform integration, prefixed with "Bearer " (for example, `Bearer {ACCESS_TOKEN}`). For more information on how to obtain this value, visit the documentation covering making API calls in the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-gw-ims-org-id
        in: header
        description: The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-api-key
        in: header
        description: The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-sandbox-name
        in: header
        description: The name of the sandbox in which the operation will take place. See the [sandboxes overview documentation](https://adobe.com/go/sandbox-overview-en) for more information.
        required: true
        schema:
          type: string
      - name: x-request-id
        in: header
        description: An optional header that serves as a tracking ID for the request. If one is not provided on the request, the server generates one automatically.
        schema:
          type: string
      - name: User-Agent
        in: header
        description: The type of the client making the HTTP request.
        schema:
          type: string
      - name: assetId
        in: path
        description: A query ID or a schedule ID for the resource that you want to update.
        required: true
        schema:
          type: string
      - name: alertType
        in: path
        description: This property determines the state of query execution that triggers a user to receive an alert. The alert type is one of three values (`start`, `success`, `failure`).
        required: true
        schema:
          type: string
      requestBody:
        description: Use JSON PATCH formatting to enable or disable an alert.
        content:
          application/json:
            schema:
              type: object
              properties:
                op:
                  type: string
                  description: The operation to be performed. The only accepted value is `replace`. It replaces the current alert's status with the value provided in the request.
                  enum:
                  - replace
                path:
                  type: string
                  description: The path must be `/status` to ensure the alert `status` is updated.
                  enum:
                  - /status
                value:
                  type: string
                  description: The provided value will be the status of the alert after the update takes effect.
                  enum:
                  - enable
                  - disable
        required: true
      responses:
        200:
          x-summary: Success
          description: The alert status has been updated successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/alert_patched'
        400:
          x-summary: Request failed
          description: Bad Request. The payload may be malformed, or an invalid `alertType` may have been provided in URL.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/alert_patched_bad_request_error_message'
        401:
          x-summary: Unauthorized
          description: Unauthorized
          content: {}
        404:
          description: No alert found for the `assetId` and `alertType` provided.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/alert_patched_not_found_error_message'
        '500':
          x-summary: Internal server error
          description: There was an internal server error. Try the request again in a few minutes, and contact Adobe Support if the problem persists.
          content: {}
      x-codegen-request-body-name: operation
  /alert-subscriptions/user-subscriptions/{emailID}:
    get:
      tags:
      - Alert Subscriptions
      summary: List information on all alerts that a user is subscribed to
      description: This request lists the alerts subscribed to by the email ID provided in the request path. The returned information includes the alert name, IDs, status, alert type, and notification channels.
      operationId: listAllAlertsSubscribedToByEmailId
      parameters:
      - name: Authorization
        in: header
        description: The access token which can be copied from your Experience Platform integration, prefixed with "Bearer " (for example, `Bearer {ACCESS_TOKEN}`). For more information on how to obtain this value, visit the documentation covering making API calls in the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-gw-ims-org-id
        in: header
        description: The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-api-key
        in: header
        description: The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the documentation covering making API calls in the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-sandbox-name
        in: header
        description: The name of the sandbox in which the operation will take place. See the [sandboxes overview documentation](https://adobe.com/go/sandbox-overview-en) for more information.
        required: true
        schema:
          type: string
      - name: x-request-id
        in: header
        description: An optional header that serves as a tracking ID for the request. If one is not provided on the request, the server generates one automatically.
        schema:
          type: string
      - name: User-Agent
        in: header
        description: The type of the client making the HTTP request.
        schema:
          type: string
      - name: emailID
        in: path
        description: An Adobe-registered email address whose alert subscriptions you want to retrieve.
        required: true
        schema:
          type: string
      - name: orderby
        in: query
        description: The field that specifies the order of results. The supported fields are `created` and `updated`. Prepend the property name with `+` for ascending and `-` for descending order. The default is `-created`. Note that the plus sign (`+`) has to be escaped with `%2B`. For example `%2Bcreated` is the value for an ascending created order.
        schema:
          type: string
      - name: pagesize
        in: query
        description: Control the number of records you want to fetch from the API call per page. The default limit is set to the maximum amount of 50 records per page.
        schema:
          type: integer
      - name: page
        in: query
        description: Indicate the page number of the returned results that you want to see the records for.
        schema:
          type: string
      - name: property
        in: query
        description: "Comma-separated filters. Multiple filters separated by commas can be passed. The examples below are given with unsafe HTML characters for clarity, but all content MUST be HTML escaped.\n\n The properties that allow filtering:\n * `id`\n * `assetId`\n * `status`\n * `alertType`\n\n The list of supported operators:\n\n ‘==` (equal to)\n\n Examples with filters that support the (`==`)operator:\n * Get me the alert with a match on the `id`:\n `id==query_flow_run_start-599442e0-433a-4708-85fc-e226e8092096`\n * Get me alerts with a match on the `assetId`:\n `assetId==700d43d9-3b99-4d4c-8dbb-29c911c0e0df`\n * Get me alerts with a match on the `status`:\n `status==enabled`\n * Get me alerts with a match on the `alertType`:\n `alertType==success`\n An example of a complex search with multiple filters:\n * Get me alerts that utilize multiple filters:\n `body: status==enabled,alertType==failure`"
        schema:
          type: string
      responses:
        200:
          x-summary: Success
          description: Details of all alerts subscribed to by the `emailId` provided.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/alerts_to_which_user_subscribed_response'
        400:
          x-summary: Request failed
          description: Bad Request. The emailID is not an Adobe registered ID.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/get_alerts_to_which_user_subscribed_bad_request_error_message'
        401:
          x-summary: Unauthorized
          description: Unauthorized
          content: {}
        '500':
          x-summary: Internal server error
          description: There was an internal server error. Try the request again in a few minutes, and contact Adobe Support if the problem persists.
          content: {}
components:
  schemas:
    subscribers_for_alert_by_assetId:
      type: object
      properties:
        alerts:
          type: array
          description: A list of alerts that match the parameters of the listing call.
          items:
            type: object
            properties:
              id:
                $ref: '#/components/schemas/Id'
              alertType:
                $ref: '#/components/schemas/AlertType'
              status:
                $ref: '#/components/schemas/Status'
              assetId:
                $ref: '#/components/schemas/AssetId'
              subscriptions:
                $ref: '#/components/schemas/Subscriptions'
              _links:
                $ref: '#/components/schemas/alert_links'
      description: Alert information and Email IDs for all users subscribed for alerts on a particular query.
    AlertId:
      type: string
      description: The alert name that appears in the Alerts tab of the Adobe Experience Platform UI.
      example: a679dd0e-bcb2-4e69-a610-22d17ba98cac
    post_bad_request_error_message:
      type: object
      properties:
        message:
          type: string
          description: A description of the error.
          example: 'The provided emailId: scoobydoo@adobe.com is not an Adobe registered ID. Please use another emailId.'
        statusCode:
          $ref: '#/components/schemas/BadRequestError'
      description: The error response for a 400 status for a request to create and subscribe to a new alert.
    BadRequestError:
      type: object
      description: An HTTP status code that indicates the server cannot or will not process the request due to something that is perceived to be a client error.
      example: 400
    AlertName:
      type: string
      description: The name of the alert. This name is generated automatically by Adobe Experience Platform.
      example: query_service_flow_run_success-8f057161-b312-4274-b629-f346c7d15c1f
    AssetId:
      type: string
      description: The query or schedule ID that the alert is created for and subscribed to.
      example: 6df22232-f427-4250-a4e1-43cd30990641
    alert_patched_not_found_error_message:
      type: object
      properties:
        message:
          type: string
          description: A description of the error.
          example: 'No alert exists for assetId: 24a218c7-1738-4f56-95fb-df62928751a680 and alertType: start. Please resubmit with different assetId and alertType.'
        statusCode:
          $ref: '#/components/schemas/NotFoundError'
      description: The error response for a 404 status to patch an alert.
    query_list_links:
      type: object
      properties:
        next:
          $ref: '#/components/schemas/next'
        prev:
          $ref: '#/components/schemas/prev'
      description: Contains the URI reference that clients may use to obtain the next or previous page of resources.
    CoreAlertProperties:
      type: object
      properties:
        id:
          type: string
          description: A unique system-generated ID for the alert.
          example: query_service_flow_run_success-4422fc69-eaa7-464e-945b-63cfd435d3d1
        assetId:
          type: string
          description: The query or schedule ID that the alert is created for and subscribed to.
          example: 4422fc69-eaa7-464e-945b-63cfd435d3d1
        alertType:
          type: string
          description: This property determines the state of query execution that triggers a user to receive an alert. The alert type is one of three values (`start`, `success`, `failure`).
          example: start
        status:
          type: string
          description: This represents the status of the alert. It is one of four values (enabled, enabling, disabled, disabling).
          example: enabled
      description: Contains properties to describe the query ID, alert ID, type, and status of alert.
    Id:
      type: string
      description: The alert name that appears in the Alerts tab of the Adobe Experience Platform UI.
      example: query_service_flow_run_failure-5cdc3bbe-750a-4d80-9c43-96e5e09f1a96
    get_alert_subscription_for_asset_id_and_alert_type_not_found_error_message:
      type: object
      properties:
        message:
          type: string
          description: A description of the error to explain the problem and instruct how to resolve the issue.
          example: 'No alert exists for assetId: c4f67291-1161-4943-bc29-8736469bb928sa and alertType: failure. Please resubmit with different assetId and alertType.'
        statusCode:
          $ref: '#/components/schemas/NotFoundError'
      description: The error response for a 404 status when requesting subscriber information for an asset ID and alert type.
    notification_channels:
      type: object
      properties:
        inContextNotifications:
          type: boolean
          description: A true value indicates that the user, identified by their email ID, wants to receive an alert through the Experience Platform UI. A false value would not provide an alert in the Adobe Experience Platform UI.
          example: true
        emailNotifications:
          type: boolean
          description: A true value indicates that the user, identified by their email ID, wants to receive an alert by email. A false value would not provide an alert via email.
          example: false
      description: A boolean value to confirm the channel of alert notification subscribed to by the user.
    AlertType:
      type: string
      description: This property determines the state of query execution that triggers a user to receive an alert. The alert type is one of three values (`start`, `success`, `failure`).
      example: failure
    alerts_to_which_user_subscribed_response:
      type: object
      properties:
        items:
          type: array
          description: A list of alerts that match the parameters of the listing call.
          items:
            type: object
            properties:
              name:
                $ref: '#/components/schemas/AlertName'
              assetId:
                $ref: '#/components/schemas/AssetId'
              status:
                $ref: '#/components/schemas/Status'
              alertType:
                $ref: '#/components/schemas/AlertType'
              subscriptions:
                $ref: '#/components/schemas/notification_channels'
              _links:
                $ref: '#/components/schemas/alert_links'
        page:
          $ref: '#/components/schemas/PagingProperties'
        _links:
          $ref: '#/components/schemas/query_list_links'
        version:
          $ref: '#/components/schemas/version'
      description: Information about a particular alert.
    next:
      type: object
      properties:
        href:
          type: string
          description: A link to the next page of results.
          example: https://platform.adobe.io/data/foundation/query/queries/alert-subscriptions?orderby=-created&page=2
      description: Pre-constructed URI for the next page of results, if any exist.
    NotFoundError:
      type: object
      description: An HTTP status code that indicates the page, or resource you are looking for cannot be found.
      example: 404
    alert_deleted_not_found_error_message:
      type: object
      properties:
        message:
          type: string
          description: A description of the error.
          example: 'No alert exists for assetId: c4f67291-1161-4943-bc29-8736469bb92w8 and alertType: success. Please resubmit with different assetId and alertType.'
        statusCode:
          $ref: '#/components/schemas/NotFoundError'
      description: The error response for a 404 status to delete an alert.
    post_not_found_error_message:
      type: object
      properties:
        message:
          type: string
          description: A description of the error.
          example: 'The provided assetId: 24a218c7-1738-4f56-95fb-asda62928751a680 is invalid. Retry with another assetId.'
        statusCode:
          $ref: '#/components/schemas/NotFoundError'
      description: The error response for a 404 status for a request to create and subscribe to a new alert.
    get_alert_subscription_for_asset_id_error_message:
      type: object
      properties:
        message:
          type: string
          description: A description of the error to explain the problem and instruct how to resolve the issue.
          example: 'No alert exists for assetId: e5fb-62928751a680. Please resubmit with different assetId.'
        statusCode:
          $ref: '#/components/schemas/NotFoundError'
      description: The error response for a 404 status when requesting alert information for an asset ID.
    version:
      type: integer
      description: The version of this resource.
      example: 1
    AlertTypeSuccess:
      type: string
      description: This property determines the state of query execution that triggers a user to receive an alert. The alert type is one of three values (`start`, `success`, `failure`).
      example: success
    prev:
      type: object
      properties:
        href:
          type: string
          description: A link to the previous page of results.
          example: https://platform.adobe.io/data/foundation/query/queries/alert-subscriptions?orderby=-created&page=0
      description: Pre-constructed URI for the previous page of results, if any exist.
    get_alert_subscription_for_asset_id_and_alert_type_bad_request_error_message:
      type: object
      properties:
        message:
          type: string
          description: A description of the error to explain the problem and instruct how to resolve the issue.
          example: 'An invalid alertType was provided. Valid values are: start, success and failure.'
        statusCode:
          $ref: '#/components/schemas/BadRequestError'
      description: The error response for a 400 status when requesting subscriber information for an asset ID and alert type.
    get_alerts_to_which_user_subscribed_bad_request_error_message:
      type: object
      properties:
        message:
          type: string
          description: A description of the error.
          example: 'The emailId: unregistered@adobe.com is not an Adobe registered ID. Please use another emailId'
        statusCode:
          $ref: '#/components/schemas/BadRequestError'
      description: The error response for a 400 status for a request to return all the alerts a user is subscribed to.
    subscribers_for_alert_by_assetId_and_alertType:
      type: object
      properties:
        alerts:
          type: array
          description: A list of alerts that match the parameters of the listing call.
          items:
            type: object
            properties:
              id:
                $ref: '#/components/schemas/AlertId'
              assetId:
                $ref: '#/components/schemas/AssetId'
              alertType:
                $ref: '#/components/schemas/AlertTypeSuccess'
              status:
                $ref: '#/components/schemas/Status'
              subscriptions:
                $ref: '#/components/schemas/Subscriptions'
              _links:
                $ref: '#/components/schemas/alert_links'
      description: A list of alerts for an `assetId` and `alertType`.
    PagingProperties:
      type: object
      properties:
        orderby:
          type: string
          description: The property by which this page is ordered.
          example: -created
        page:
          type: integer
          description: The page number of the result.
          example: 1
        property:
          type: string
          description: If a `property` filter was used in the request path then this value is populated and displayed in the response body.
          example: status==enabled
        count:
          type: integer
          description: The number of items on the page.
          example: 26
        pageSize:
          type: integer
          description: The number of items on the page.
          example: 26
      description: Contains properties to describe the order, size, total number of pages, and current page.
    alert_deleted_bad_request_error_message:
      type: object
      properties:
        message:
          type: string
          description: A description of the error.
          example: 'An invalid alertType was provided. Valid values are: start, success and failure'
        statusCode:
          $ref: '#/components/schemas/BadRequestError'
      description: The error response for a 400 status to delete an alert.
    alert_subscription_response_body:
      type: object
      properties:
        id:
          type: string
          description: The alert name that appears in the Alerts tab of the Adobe Experience Platform UI.
          example: a679dd0e-bcb2-4e69-a610-22d17ba98cac
        assetId:
          type: string
          description: The query or schedule ID that the alert is created for and subscribed to.
          example: 4422fc69-eaa7-464e-945b-63cfd435d3d1
        alertType:
          type: string
          description: This property determines the state of query execution that triggers a user to receive an alert. The alert type is one of three values (`start`, `success`, `failure`).
          example: failure
        subscriptions:
          $ref: '#/components/schemas/SubscriptionsBasic'
        _links:
          $ref: '#/components/schemas/alert_links'
      description: The response when subscribing `emailID`s to an alert for an `assetId` and `alertType`.
    alert_patched_bad_request_error_message:
      type: object
      properties:
        message:
          type: string
          description: A description of the error.
          example: 'An invalid alertType was provided. Valid values are: start, success and failure.'
        statusCode:
          $ref: '#/components/schemas/BadRequestError'
      description: The error response for a 400 status to patch an alert.
    emailIdForSubscribing:
      type: string
      description: A list of Adobe registered `emailID`s that want to subscribe to the alert for a given `assetId` and `alertType`.
      example: rrunner@adobe.com
    subscribe_user_to_alert_body:
      required:
      - alertType
      - assetId
      - subscriptions
      type: object
      properties:
        assetId:
          type: string
          description: The query or schedule ID that you want the alert to track.
          example: a679dd0e-bcb2-4e69-a610-22d17ba98cac
        alertType:
          type: string
          description: The state of query execution that you want to trigger an alert. The alert type is one of three values (`start`, `success`, `failure`).
          example: failure
        subscriptions:
          required:
          - emailIds
          - emailNotifications
          - inContextNotifications
          type: object
          properties:
            emailIds:
              type: array
              description: A list of email address identifiers for the users you are subscribing. These must be Adobe-registered email addresses. The maximum number of `emailID`s that can be registered at once is five.
              items:
                $ref: '#/components/schemas/emailIdForSubscribing'
            inContextNotifications:
              type: boolean
              description: A `true` value indicates that the users want to receive an alert through the Platform UI. A `false` value means that the users will not be sent alerts in the Platform UI.
              example: true
            emailNotifications:
              type: boolean
              description: A `true` value indicates that the users want to receive an alert via email. A `false` value means that the users will not be sent alerts via email. To receive email alerts you must first enable this setting within the UI. See the documentation for [instructions on how to enable email alerts](https://experienceleague.adobe.com/docs/experience-platform/observability/alerts/ui.html?lang=en#enable-email-alerts).
              example: true
          description: This object provides the details of the users that you want to receive the alert, including the preferred delivery method. You must include their email ID and preferred notification channels for the alerts.
      description: The request payload used to subscribe `emailId`s to query or schedule IDs for a given alert type.
    Email_ID_inContextNotifications:
      type: array
      description: A list of the email IDs subscribed to notifications within the Platform UI.
      items:
        type: object
        example: jsnow@adobe.com, keverdeen@adobe.com
    Subscriptions:
      $ref: '#/components/schemas/SubscriptionEmailIdsByChannel'
    alert_links:
      type: object
      properties:
        self:
          type: object
          properties:
            href:
              type: string
              description: The URI to get subscribers information for a given `assetId`.
              example: https://platform.adobe.io/data/foundation/query/alert-subscriptions/c4f67291-1161-4943-bc29-8736469bb928
            method:
              type: string
              description: The HTTP method to use.
              example: GET
          description: An object that contains the method and URI required to return subscriber information for a given `assetId`.
        subscribe:
          type: object
          properties:
            href:
              type: string
              description: The URI to subscribe new users to an alert.
              example: https://platform.adobe.io/data/foundation/query/alert-subscriptions
            method:
              type: string
              description: The HTTP method to use.
              example: POST
            body:
              type: string
              description: The JSON body to send.
              example: '{\"assetId\": \"queryId/scheduleId\", \"alertType\": \"start/success/failure\", \"subscriptions\": {\n\"emailIds\": [\"xyz@example.com\", \"abc@example.com\"], \"email\": true, \"inContext\": false}}'
          description: An object that contains the method and URI required to subscribe new users to an alert.
        patch_status:
          type: object
          properties:
            href:
              type: string
              description: The URI to update the status of an alert for a given `assetId` and `alertType` between `enable` and `disable`.
              example: https://platform.adobe.io/data/foundation/query/alert-subscriptions/c4f67291-1161-4943-bc29-8736469bb928/failure
            method:
              type: string
              description: The HTTP method to use.
              example: PATCH
            body:
              type: string
              description: The JSON body to send.
              example: '{ \"op\": \"replace\", \"path\": \"/status\", \"value\": \"enable/disable\" }'
          description: An object that contains the method and URI required to update the status of an alert for a given `assetId` and `alertType` between `enable` and `disable`.
        get_list_of_subscribers_by_alert_type:
          type: object
          properties:
            href:
              type: string
              description: Return a list of all subscribers for given `assetId` and `alertType`.
              example: https://platform.adobe.io/data/foundation/query/alert-subscriptions/c4f67291-1161-4943-bc29-8736469bb928/failure
            method:
              type: string
              description: The HTTP method to use.
              example: GET
          description: An object that contains the method and URI required to return a list of all subscribers for given `assetId` and `alertType`.
        delete:
          type: object
          properties:
            href:
              type: string
              description: The URI to delete an alert for particular `assetId` and `alertType`.
              example: https://platform.adobe.io/data/foundation/query/alert-subscriptions/c4f67291-1161-4943-bc29-8736469bb928/failure
            method:
              type: string
              description: The HTTP method to use.
              example: DELETE
          description: An object that contains the method and URI required to delete an alert for particular `assetId` and `alertType`.
      description: An object that contains information such as the URIs and methods for common alert subscriptions use cases.
    Status:
      type: string
      description: This represents the status of the alert. It is one of four values (`enabled`, `enabling`, `disabled`, `disabling`).
      example: enabled
    SubscriptionsBasic:
      type: object
      properties:
        emailNotifications:
          type: array
          description: A list of the email IDs subscribed to notifications by email.
          items:
            type: object
            example: rrunner@adobe.com
        inContextNotifications:
          type: array
          description: A list of the email IDs subscribed to notifications within the Platform UI.
          items:
            type: object
            example: rrunner@adobe.com
      description: An object that contains two arrays of subscriber email IDs divided by their selected notification channel.
    Email_ID_emailNotifications:
      type: array
      description: A list of the email IDs subscribed to notifications by email.
      items:
        type: object
        example: rrunner@adobe.com, jsnow@adobe.com, keverdeen@adobe.com
    SubscriptionEmailIdsByChannel:
      type: object
      properties:
        emailNotifications:
          $ref: '#/components/schemas/Email_ID_emailNotifications'
        inContextNotifications:
          $ref: '#/components/schemas/Email_ID_inContextNotifications'
      description: An object that contains two arrays of subscriber email IDs divided by their selected notification channel.
    alert_patched:
      $ref: '#/components/schemas/CoreAlertProperties'
    alerts_per_imsorg_and_sandbox:
      type: object
      properties:
        alerts:
          type: array
          description: A list of alerts that match the parameters of the listing call.
          items:
            type: object
            properties:
              id:
                $ref: '#/components/schemas/Id'
              alertType:
                $ref: '#/components/schemas/AlertType'
              status:
                $ref: '#/components/schemas/Status'
              assetId:
                $ref: '#/components/schemas/AssetId'
              _links:
                $ref: '#/components/schemas/alert_links'
        _page:
          $ref: '#/components/schemas/PagingProperties'
        _links:
          $ref: '#/components/schemas/query_list_links'
        version:
          $ref: '#/components/schemas/version'
    alert_deleted:
      type: object
      properties:
        message:
          type: string
          description: A message string that contains the `assetId` and the `alertType`, confirms the alert has been deleted.
          example: 'Alert deleted successfully for assetId: 6df22232-f427-4250-a4e1-43cd30990641 and alertType: success'
        statusCode:
          type: string
          description: The status code.
          example: '200'
      description: An alert has been deleted for the `assetId` and `alertType` provided in the URI.