Adobe Suite Alert Subscriptions API

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 mat

# --- truncated at 32 KB (56 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/adobe-suite/refs/heads/main/openapi/adobe-suite-alert-subscriptions-api-openapi.yml