Adobe Experience Platform Query Service API

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

GitHub OpenAPI

Operations 28

GET /connection_parameters List connection parameters #
GET /queries List queries #
POST /queries Create a query #
GET /queries/{queryid} Retrieve a query #
PATCH /queries/{queryid} Request cancellation or query soft delete #
GET /schedules List schedules #
POST /schedules Create a scheduled query #
GET /schedules/{schedulesId} Retrieve a schedule #
DELETE /schedules/{schedulesId} Delete a schedule #
PATCH /schedules/{schedulesId} Update a schedule #
GET /schedules/{schedulesId}/runs List all runs for a schedule #
POST /schedules/{schedulesId}/runs Trigger an immediate run of a scheduled query #
GET /schedules/{schedulesId}/runs/{runId} Retrieve details of a query schedule run #
PATCH /schedules/{schedulesId}/runs/{runId} Cancel a run of a scheduled query #
GET /query-templates List query templates #
POST /query-templates Create a query template #
GET /query-templates/count Retrieve the count of query templates #
GET /query-templates/{queryTemplateId} Retrieve a query template #
PUT /query-templates/{queryTemplateId} Update a query template #
DELETE /query-templates/{queryTemplateId} Delete a query template #
GET /alert-subscriptions List alerts #
POST /alert-subscriptions Create an alert and subscribe users #
GET /alert-subscriptions/{assetId} List alert subscription information for a query or schedule #
GET /alert-subscriptions/{assetId}/{alertType} List alert subscription information for a particular query and alert type #
DELETE /alert-subscriptions/{assetId}/{alertType} Delete the alert for a particular query and alert type #
PATCH /alert-subscriptions/{assetId}/{alertType} Enable or disable an alert #
GET /alert-subscriptions/user-subscriptions/{emailID} List information on all alerts that a user is subscribed to #
POST /accelerated-queries Query the accelerated store #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/adobe:adobe-aep-query-service-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

adobe-aep-query-service-openapi.yml Raw ↑
openapi: 3.0.1
info:
  title: Query Service 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: (NEW) Interactive API documentation
  description: You can now interact with the Experience Platform API endpoints directly from this API reference page. Get your [authentication credentials](https://www.adobe.com/go/platform-api-get-credentials-en) and use the **Try it** functionality in the right rail. Note that by using this functionality, you are making real API calls. Keep this in mind when you interact with production sandboxes.
- name: Queries
  description: The queries endpoint uses standard SQL to query data held in Adobe Experience Platform. For example, you can join any number of datasets in the data lake and capture the results as a new dataset.
- name: Connections
  description: The connections endpoint retrieves connection parameters for the interactive interface.
- name: Schedules
  description: Schedules let you perform SQL functions on a regular cadence from a start date to an end date or set a maximum number of runs.
- 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.
- name: Query Templates
  description: Query templates let you create, store, and execute any query as an ad hoc or scheduled service.


# --- truncated at 32 KB (198 KB total) ---
# Full source: https://artifacts.apis.io/adobe/openapi/adobe-aep-query-service-openapi.yml