Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Adobe Campaign Query Definition API

Execute queries against Campaign schemas using the xtk:queryDef interface. Supports get, getIfExists, select, and count operations with XPath field expressions, WHERE conditions, and pagination.

Adobe Campaign Query Definition API is one of 20 APIs that Adobe Campaign publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Query Definition. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, authentication docs, and an AsyncAPI specification.

This API exposes 1 operation across 1 path, and defines 3 schemas. It is described by OpenAPI 3.1.0, at version 8.0.0.

Requests are made against a single base URL, https://{instance}.campaign.adobe.com.

1 operations 1 paths 3 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
8.0.0
Base URL
https://mc.adobe.io/{ORGANIZATION}/campaign
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Adobe Campaign Query Definition API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-Security-Token (SessionToken).

  • SessionToken — Security token obtained from xtk:sessionLogon. Must be passed alongside the session token cookie (sessiontoken) on all authenticated requests. Tokens have a 24…

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

Query Definition 1

Execute queries against Campaign schemas using the xtk:queryDef interface. Supports get, getIfExists, select, and count operations with XPath field expressions, WHERE conditions,…

POST
/nl/jsp/soaprouter.jsp/xtk-queryDef/ExecuteQuery
Adobe Campaign Execute a Query
executeQuery 1 param body → 200500

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are SOAPFault (3 properties), QueryResult (1 property), QueryDefinition (1 property). Each schema is shown below with its type and property counts.

QueryDefinition
object
SOAP envelope containing a query definition with schema, operation, selected fields, conditions, and pagination parameters.
1 property
QueryResult
object
SOAP response containing query result set as XML elements matching the target schema structure.
1 property
SOAPFault
object
SOAP fault response indicating an error during operation processing.
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

adobe-campaign-query-definition-api-openapi.yml Raw ↑

Other APIs Adobe Campaign publishes across the network.

Adobe Campaign Classic JavaScript SDK
Adobe I/O Campaign Standard SDK
Adobe Experience Platform Mobile SDK - Campaign Extensions
Adobe Campaign Custom Resources API
Adobe Campaign Data Management API
Adobe Campaign Delivery API
Adobe Campaign Marketing History API
Adobe Campaign Metadata API
Adobe Campaign Organizational Units API
Adobe Campaign Privacy API
Adobe Campaign ProfileAndServices API
Adobe Campaign Profiles API