Adobe Experience Platform

https://experienceleague.adobe.com/en/docs/experience-platform
Admin
Adobe Experience Platform is a comprehensive data management and customer experience platform that...
Tokens:4,440,572
Snippets:39,431
Trust Score:10
Update:2 days ago
Show doc for...
Tokens:
Raw
### Profile Access API GET request formats

Source: https://experienceleague.adobe.com/en/docs/experience-platform/ingestion/tutorials/streaming-record-data

Examples of GET requests for the /access/entities endpoint, including a specific example using schema name, entity ID, and entity namespace.

```http
GET /access/entities
GET /access/entities?{QUERY_PARAMETERS}
GET /access/entities?schema.name=_xdm.context.profile&entityId=janedoe@example.com&entityIdNS=email
```

--------------------------------

### Web SDK Base Code and Command Queuing

Source: https://experienceleague.adobe.com/en/docs/experience-platform/collection/js/install/base-code

This example shows the base code installation and how to queue commands for the Web SDK. Commands called before the base code runs are not captured, while commands called after are queued until the library is ready.

```html
<head>
  <script>
    // Calls made before the base code runs are not captured (alloy is not yet defined).
    // Always make sure that the base code runs before any attempt to call commands.
    // alloy("getLibraryInfo").then(console.log).catch(console.error);
  </script>

  <!-- Base code -->
  <script>
    !function(n,o){o.forEach(function(o){n[o]||((n.__alloyNS=n.__alloyNS||
    []).push(o),n[o]=function(){var u=arguments;return new Promise(
    function(i,l){n.setTimeout(function(){n[o].q.push([i,l,u])})})},n[o].q=[])})}
    (window,["alloy"]);
  </script>

  <!-- Queued command -->
  <script>
    alloy("getLibraryInfo").then(result => {
      console.log("Queued call resolved:", result);
    }).catch(console.error);
  </script>

  <!-- Load the Web SDK using the JavaScript loader -->
  <script src="https://cdn1.adoberesources.net/alloy/<VERSION>/alloy.min.js" async></script>
  <!-- or the tag extension -->
  <!-- <script src=".../launch-<ENV>.min.js" async></script> -->

  <!-- Another call (queued if the library is still loading; immediate if it is ready) -->
  <script>
    alloy("getLibraryInfo").then(result => {
      console.log("Immediate call resolved:", result);
    }).catch(console.error);
  </script>
</head>
```

--------------------------------

### Example connection string with FLATTEN

Source: https://experienceleague.adobe.com/en/docs/experience-platform/query/key-concepts/flatten-nested-data

A concrete example of a connection string using the prod sandbox and the all identifier.

```bash
prod:all?FLATTEN
```

--------------------------------

### Get map value example

Source: https://experienceleague.adobe.com/en/docs/experience-platform/segmentation/pql/map-functions

Retrieves the value of the identity map for the key example@example.com.

```sql
identityMap.get("example@example.com")
```

--------------------------------

### Configure SDK with full context

Source: https://experienceleague.adobe.com/en/docs/experience-platform/collection/js/commands/configure/context

Example of configuring the SDK with all available context options, including high entropy client hints and one-time analytics referrers.

```js
alloy("configure", {
  datastreamId: "ebebf826-a01f-4458-8cec-ef61de241c93",
  orgId: "ADB3LETTERSANDNUMBERS@AdobeOrg",
  context: ["web", "device", "environment", "placeContext", "highEntropyUserAgentHints", "oneTimeAnalyticsReferrer"]
});
```

--------------------------------

### Example API Request with Authentication Headers

Source: https://experienceleague.adobe.com/en/docs/experience-platform/sources/sdk/config/authspec

Shows an example HTTP GET request that includes authentication keys as query parameters.

```APIDOC
## Example API Request with Authentication Headers

### Description
Example of an API request format that includes authentication keys as query parameters.

### Method
GET

### Endpoint
/data

### Query Parameters
- **X-Auth-Key1** (string) - Required - Your authentication key 1
- **X-Auth-Key2** (string) - Required - Your authentication key 2

### Request Example
```
GET /data?X-Auth-Key1={YOUR_AUTH_KEY1}&X-Auth-Key2={YOUR_AUTH_KEY2}
```
```

--------------------------------

### Case-insensitive name matching example

Source: https://experienceleague.adobe.com/en/docs/experience-platform/segmentation/pql/string-functions

A PQL query example that checks if a person's name starts with 'John' in a case-insensitive manner.

```sql
person.name.matches("(?i)^John")
```

--------------------------------

### Import GPG key example

Source: https://experienceleague.adobe.com/en/docs/experience-platform/tags/api/guides/encrypting-values

An example command showing the import of the specific Adobe public key file.

```shell
gpg --import launch@adobe.com_pub.gpg
```

--------------------------------

### startsWith case-sensitive example

Source: https://experienceleague.adobe.com/en/docs/experience-platform/segmentation/pql/string-functions

A PQL query example that checks if the person.name field starts with the string 'Joe' using case-sensitive matching.

```sql
person.name.startsWith("Joe")
```

--------------------------------

### EXPLAIN Query Example

Source: https://experienceleague.adobe.com/en/docs/experience-platform/query/sql/syntax

A simple example showing how to retrieve the execution plan for a SELECT query on a table.

```sql
EXPLAIN SELECT * FROM foo;
```

--------------------------------

### SHOW FOREIGN KEYS output example

Source: https://experienceleague.adobe.com/en/docs/experience-platform/query/sql/syntax

Example output showing table names, column names, datatypes, referenced tables, referenced columns, and namespaces.

```console
    tableName   |     columnName      | datatype | referencedTableName | referencedColumnName | namespace      
|------------------+---------------------+----------+---------------------+----------------------+----------- 
  table_name_1   | column_name1        | text     | table_name_3        | column_name3         |  "ECID"        
  table_name_2   | column_name2        | text     | table_name_4        | column_name4         |  "AAID"        
```

--------------------------------

### doesNotStartWith case-sensitive example

Source: https://experienceleague.adobe.com/en/docs/experience-platform/segmentation/pql/string-functions

A PQL query example that checks if a person's name does not start with the string 'Joe' using case-sensitive matching.

```sql
person.name.doesNotStartWith("Joe")
```

--------------------------------

### Initialize App Builder Project

Source: https://experienceleague.adobe.com/en/docs/experience-platform/observability/alerts/slack-integration

Create a new App Builder project structure using the aio CLI.

```bash
aio app init slack-webhook-proxy
```

--------------------------------

### GET /mappingSets with query parameters

Source: https://experienceleague.adobe.com/en/docs/experience-platform/data-prep/api/mapping-set

Use these HTTP GET requests to list mapping sets. The start and limit parameters are required; other parameters are optional and can be combined with ampersands.

```http
GET /mappingSets?limit={LIMIT}&start={START}
GET /mappingSets?limit={LIMIT}&start={START}&name={NAME}
GET /mappingSets?limit={LIMIT}&start={START}&orderBy={ORDER_BY}
GET /mappingSets?limit={LIMIT}&start={START}&expandSchema={EXPAND_SCHEMA}
```

--------------------------------

### GET request to global container

Source: https://experienceleague.adobe.com/en/docs/experience-platform/xdm/api/getting-started

Example of a list request performed against the global container.

```http
GET /global/classes
```

--------------------------------

### Create table with basic transformations

Source: https://experienceleague.adobe.com/en/docs/experience-platform/query/advanced-statistics/models

Example of creating a table while applying String Indexer, One Hot Encoder, and Tokenizer transformations.

```sql
CREATE TABLE ctas_transform_table
TRANSFORM(
  String_Indexer(additional_comments) si_add_comments,
  one_hot_encoder(si_add_comments) as ohe_add_comments,
  tokenizer(comments) as token_comments
)
AS SELECT * FROM movie_review;
```

--------------------------------

### Configuration JSON example

Source: https://experienceleague.adobe.com/en/docs/experience-platform/data-science-workspace/authoring/feature-pipeline

An example of key-value pairs in a configuration JSON file used to define runtime variables like dataset IDs and tenant IDs.

```json
[
    {
        "name": "fp",
        "parameters": [
            {
                "key": "dataset_id",
                "value": "000"
            },
            {
                "key": "featureDatasetId",
                "value": "111"
            },
            {
                "key": "tenantId",
                "value": "_tenantid"
            }
        ]
    }
]
```

--------------------------------

### GET /datasets with property parameters

Source: https://experienceleague.adobe.com/en/docs/experience-platform/catalog/api/filter-data

Example of using multiple property parameters in a GET request to filter datasets. At least one property must apply to the id or created field.

```APIDOC
## GET /datasets

### Description
Retrieves datasets filtered by the specified property parameters. When combining multiple property parameters, at least one must apply to the id or created field.

### Method
GET

### Endpoint
/datasets

### Parameters
#### Query Parameters
- **property** (string) - Required - Filter criteria in the format field==value or field!=value. Multiple property parameters can be combined.

### Request Example
GET /datasets?property=id==abc123&property=name!=test

### Response
#### Success Response (200)
Returns a list of datasets matching the filter criteria.

#### Response Example
(No response example provided in the source.)
```

--------------------------------

### Get dataflow response

Source: https://experienceleague.adobe.com/en/docs/experience-platform/destinations/api/export-datasets

Example JSON response containing the dataflow ID and associated sourceConnectionIds.

```json
{
    "id": "eb54b3b3-3949-4f12-89c8-64eafaba858f",
    "name": "Dataset export dataflow",
    "sourceConnectionIds": [
        "f8b5e8e0-6d50-4e32-a48a-9e9e8a42b5c2"
    ]
}
```

--------------------------------

### Manual session tracking for adStart

Source: https://experienceleague.adobe.com/en/docs/experience-platform/collection/js/commands/sendmediaevent

This example demonstrates how to manually track an ad start event using the sendMediaEvent command within a session promise.

```javascript
sessionPromise.then(sessionID => {
    alloy("sendMediaEvent", {
        xdm: {
        eventType: "media.adStart",
        mediaCollection: {
            playhead: parseInt(document.getElementById("movie-test").currentTime, 10),
            sessionID,
            advertisingDetails: {
              friendlyName: "Ad 1",
              name: "/uri-reference/001",
              length: 10,
              advertiser: "Adobe Marketing",
              campaignID: "Adobe Analytics",
              creativeID: "creativeID",
              creativeURL: "https://creativeurl.com",
              placementID: "placementID",
              siteID: "siteID",
              podPosition: 11,
              playerName: "HTML5 player"
            },
            customMetadata: [
              {
                name: "myCustomValue3",
                value: "c3"
              },
              {
                name: "myCustomValue2",
                value: "c2"
              },
              {
                name: "myCustomValue1",
                value: "c1"
              }
```

--------------------------------

### sendMediaEvent - Ad Start

Source: https://experienceleague.adobe.com/en/docs/experience-platform/collection/js/commands/sendmediaevent

Sends a media event for ad start using the Adobe Experience Platform Web SDK. The example shows how to configure the advertising details and custom metadata for the ad.

```APIDOC
## sendMediaEvent

### Description
Sends a media event to Adobe Experience Platform. This example demonstrates the ad start event.

### Method
sendMediaEvent

### Parameters
- **playerId** (string) - Required - The ID of the player.
- **xdm.eventType** (string) - Required - The type of media event. For ad start, use "media.adStart".
- **xdm.mediaCollection.advertisingDetails** (object) - Required - Details about the ad.
  - **friendlyName** (string) - Optional - Friendly name of the ad.
  - **name** (string) - Required - Ad name or URI reference.
  - **length** (number) - Required - Length of the ad in seconds.
  - **advertiser** (string) - Optional - Advertiser name.
  - **campaignID** (string) - Optional - Campaign ID.
  - **creativeID** (string) - Optional - Creative ID.
  - **creativeURL** (string) - Optional - URL of the creative.
  - **placementID** (string) - Optional - Placement ID.
  - **siteID** (string) - Optional - Site ID.
  - **podPosition** (number) - Optional - Position of the ad in the pod.
  - **playerName** (string) - Optional - Name of the player.
- **xdm.mediaCollection.customMetadata** (array) - Optional - Array of custom metadata objects.
  - **name** (string) - Required - Metadata name.
  - **value** (string) - Required - Metadata value.

### Request Example
```javascript
alloy("sendMediaEvent", {
    playerId: "movie-test",
    xdm: {
        eventType: "media.adStart",
        mediaCollection: {
            advertisingDetails: {
                friendlyName: "Ad 1",
                name: "/uri-reference/001",
                length: 10,
                advertiser: "Adobe Marketing",
                campaignID: "Adobe Analytics",
                creativeID: "creativeID",
                creativeURL: "https://creativeurl.com",
                placementID: "placementID",
                siteID: "siteID",
                podPosition: 11,
                playerName: "HTML5 player"
            },
            customMetadata: [
                { name: "myCustomValue3", value: "c3" },
                { name: "myCustomValue2", value: "c2" },
                { name: "myCustomValue1", value: "c1" }
            ]
        }
    }
});
```

### Response
No response is documented in the source.
```

--------------------------------

### CREATE VIEW and CREATE OR REPLACE VIEW Examples

Source: https://experienceleague.adobe.com/en/docs/experience-platform/query/sql/syntax

Demonstrates creating a view and using the OR REPLACE clause to update an existing view definition.

```sql
CREATE VIEW V1 AS SELECT color, type FROM Inventory

CREATE OR REPLACE VIEW V1 AS SELECT model, version FROM Inventory
```

--------------------------------

### SESS_START_IF SQL Query Example

Source: https://experienceleague.adobe.com/en/docs/experience-platform/query/sql/adobe-defined-functions

A query demonstrating the use of SESS_START_IF to calculate session information based on application launches.

```sql
SELECT
    endUserIds._experience.mcid.id AS id,
    timestamp,
    IF(application.launches.value > 0, true, false) AS isLaunch,
    SESS_START_IF(timestamp, application.launches.value > 0)
        OVER (PARTITION BY endUserIds._experience.mcid.id
            ORDER BY timestamp
            ROWS BETWEEN UNBOUNDED PRECEDING AND CURRENT ROW)
        AS session
    FROM experience_events
    ORDER BY id, timestamp ASC
    LIMIT 10
```

--------------------------------

### API format for start parameter

Source: https://experienceleague.adobe.com/en/docs/experience-platform/catalog/api/filter-data

Shows the HTTP GET request format using the 'start' query parameter to offset the response list. The {OBJECT_TYPE} can be batches, dataSets, or dataSetFiles, and {OFFSET} is an integer for the offset.

```http
GET /{OBJECT_TYPE}?start={OFFSET}
```
Tokens:
Raw