Documentation Experience Platform Destinations Guide

Generate sample profiles based on a source schema sample-profile-api-operations

Last update: Wed Nov 01 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

Topics:
Destinations

CREATED FOR:

Admin
User

IMPORTANT

API endpoint: https://platform.adobe.io/data/core/activation/authoring/sample-profiles

This page lists and describes all the API operations that you can perform using the /authoring/sample-profiles API endpoint.

Generate different profile types for different APIs different-profiles-different-apis

IMPORTANT

Use this API endpoint to generate sample profiles for two separate use cases. You can either:

generate profiles to use when crafting and testing a message transformation template - by using destination ID as a query parameter.
generate profiles to use when making calls to test if your destination is configured correctly - by using destination instance ID as a query parameter.

You can generate sample profiles based on either the Adobe XDM source schema (to use when testing your destination), or the target schema supported by your destination (to use when crafting your template). To understand the difference between Adobe XDM source schema and target schema, read the overview section of the Message format article.

Note that the purposes for which the sample profiles can be used are not interchangeable. Profiles generated based on the destination ID can only be used to craft your message transformation templates and profiles generated based on the destination instance ID can only be used to test your destination endpoint.

Getting started with sample profile generation API operations get-started

Before continuing, please review the getting started guide for important information that you need to know in order to successfully make calls to the API, including how to obtain the required destination authoring permission and required headers.

Generate sample profiles based on the source schema to use when testing your destination generate-sample-profiles-source-schema

IMPORTANT

Add the sample profiles generated here to HTTP calls when testing your destination.

You can generate sample profiles based on the source schema by making a GET request to the authoring/sample-profiles/ endpoint and providing the ID of a destination instance that you created based on the destination configuration that you want to test.

To get the ID of a destination instance, you must first create a connection in the Experience Platform UI to your destination before attempting to test your destination. Read the activate destination tutorial and see the tip below for how to get the destinations instance ID to use for this API.

IMPORTANT

In order to use this API, you must have an existing connection to your destination in the Experience Platform UI. Read connect to destination and activate profiles and audiences to a destination for more information.
After establishing the connection to your destination, get the destination instance ID that you should use in API calls to this endpoint when browsing a connection with your destination.

API format

GET authoring/sample-profiles?destinationInstanceId={DESTINATION_INSTANCE_ID}&count={COUNT}

Query Parameter

Description

{DESTINATION_INSTANCE_ID}

The ID of the destination instance based on which you are generating sample profiles.

{COUNT}

Optional. The number of sample profiles that you are generating. The parameter can take values between 1 - 1000.
If the count parameter is not specified, then the default number of generated profiles is determined by the maxUsersPerRequest value in the destination server configuration. If this property is not defined, then Adobe will generate one sample profile.

Request

The following request generates sample profiles, configured by the {DESTINATION_INSTANCE_ID} and {COUNT} query parameters.


curl --location --request GET 'https://platform.adobe.io/data/core/activation/authoring/sample-profiles?destinationInstanceId=49966037-32cd-4457-a105-2cbf9c01826a&count=3' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'x-api-key: {API_KEY}' \
--header 'Authorization: Bearer {ACCESS_TOKEN}' \
--header 'x-gw-ims-org-id: {ORG_ID}' \
--header 'x-sandbox-name: {SANDBOX_NAME}' \

Response

A successful response returns HTTP status 200 with the specified number of sample profiles, with audience membership, identities, and profile attributes that correspond to the source XDM schema.

TIP

The response returns only audience membership, identities, and profile attributes that are used in the destination instance. Even if your source schema has other fields, these are ignored.


[
    {
        "segmentMembership": {
            "ups": {
                "03fb9938-8537-4b4c-87f9-9c4d413a0ee5": {
                    "lastQualificationTime": "2021-06-30T18:40:07.591378Z",
                    "status": "realized"
                },
                "27e05542-d6a3-46c7-9c8e-d59d50229530": {
                    "lastQualificationTime": "2021-06-30T18:40:07.591380Z",
                    "status": "realized"
                }
            }
        },
        "personalEmail": {
            "address": "john.smith@abc.com"
        },
        "identityMap": {
            "ECID": [
                {
                    "id": "ECID-7VEsJ"
                }
            ]
        },
        "person": {
            "name": {
                "firstName": "string"
            }
        }
    },
    {
        "segmentMembership": {
            "ups": {
                "03fb9938-8537-4b4c-87f9-9c4d413a0ee5": {
                    "lastQualificationTime": "2021-06-30T18:40:07.591378Z",
                    "status": "realized"
                },
                "27e05542-d6a3-46c7-9c8e-d59d50229530": {
                    "lastQualificationTime": "2021-06-30T18:40:07.591380Z",
                    "status": "realized"
                }
            }
        },
        "personalEmail": {
            "address": "john.smith@abc.com"
        },
        "identityMap": {
            "ECID": [
                {
                    "id": "ECID-Y55JJ"
                }
            ]
        },
        "person": {
            "name": {
                "firstName": "string"
            }
        }
    },
    {
        "segmentMembership": {
            "ups": {
                "03fb9938-8537-4b4c-87f9-9c4d413a0ee5": {
                    "lastQualificationTime": "2021-06-30T18:40:07.591378Z",
                    "status": "realized"
                },
                "27e05542-d6a3-46c7-9c8e-d59d50229530": {
                    "lastQualificationTime": "2021-06-30T18:40:07.591380Z",
                    "status": "realized"
                }
            }
        },
        "personalEmail": {
            "address": "john.smith@abc.com"
        },
        "identityMap": {
            "ECID": [
                {
                    "id": "ECID-Nd9GK"
                }
            ]
        },
        "person": {
            "name": {
                "firstName": "string"
            }
        }
    }
]

Property

Description

segmentMembership

A map object which describes the individual’s audience memberships. For more information on segmentMembership, read Audience Membership Details.

lastQualificationTime

A timestamp of the last time this profile qualified for the segment.

xdm:status

A string field that indicates whether the audience membership has been realized as part of the current request. The following values are accepted:

realized: The profile is part of the segment.
exited: The profile is exiting the audience as part of the current request.

identityMap

A map-type field that describes the various identity values for an individual, along with their associated namespaces. For more information on identityMap, read Basis of schema composition.

Generate sample profiles based on the target schema to use when crafting a message transformation template generate-sample-profiles-target-schema

IMPORTANT

Use the sample profiles generated here when crafting your template, in the render template step.

You can generate sample profiles based on the target schema making a GET request to the authoring/sample-profiles/ endpoint and providing the destination ID of the destination configuration based on which you are creating your template.

TIP

The destination ID that you should use here is the instanceId that corresponds to a destination configuration, created using the /destinations endpoint. Refer to retrieve a destination configuration for more details.

API format

GET authoring/sample-profiles?destinationId={DESTINATION_ID}&count={COUNT}

Query Parameter

Description

{DESTINATION_ID}

The ID of the destination configuration based on which you are generating sample profiles.

{COUNT}

Request

The following request generates sample profiles, configured by the {DESTINATION_ID} and {COUNT} query parameters.


curl --location --request GET 'https://platform.adobe.io/data/core/activation/authoring/sample-profiles?destinationId=49966037-32cd-4457-a105-2cbf9c01826a&count=3' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'x-api-key: {API_KEY}' \
--header 'Authorization: Bearer {ACCESS_TOKEN}' \
--header 'x-gw-ims-org-id: {ORG_ID}' \
--header 'x-sandbox-name: {SANDBOX_NAME}' \

Response

A successful response returns HTTP status 200 with the specified number of sample profiles, with audience membership, identities, and profile attributes that correspond to the target XDM schema.


[
    {
        "segmentMembership": {
            "ups": {
                "segmentid1": {
                    "lastQualificationTime": "2021-06-30T18:42:27.609326Z",
                    "status": "realized"
                },
                "segmentid3": {
                    "lastQualificationTime": "2021-06-30T18:42:27.609328Z",
                    "status": "exited"
                },
                "segmentid2": {
                    "lastQualificationTime": "2021-06-30T18:42:27.609328Z",
                    "status": "realized"
                }
            }
        },
        "identityMap": {
            "phone_sha256": [
                {
                    "id": "phone_sha256-vizii"
                }
            ],
            "gaid": [
                {
                    "id": "gaid-adKYs"
                }
            ],
            "idfa": [
                {
                    "id": "idfa-t4sKv"
                }
            ],
            "extern_id": [
                {
                    "id": "extern_id-C3enB"
                }
            ],
            "email_lc_sha256": [
                {
                    "id": "email_lc_sha256-bfnbs"
                }
            ]
        }
    },
    {
        "segmentMembership": {
            "ups": {
                "segmentid1": {
                    "lastQualificationTime": "2021-06-30T18:42:27.609626Z",
                    "status": "realized"
                },
                "segmentid3": {
                    "lastQualificationTime": "2021-06-30T18:42:27.609627Z",
                    "status": "exited"
                },
                "segmentid2": {
                    "lastQualificationTime": "2021-06-30T18:42:27.609627Z",
                    "status": "realized"
                }
            }
        },
        "identityMap": {
            "phone_sha256": [
                {
                    "id": "phone_sha256-6YjGc"
                }
            ],
            "gaid": [
                {
                    "id": "gaid-SfJ21"
                }
            ],
            "idfa": [
                {
                    "id": "idfa-eQMWS"
                }
            ],
            "extern_id": [
                {
                    "id": "extern_id-d3WzP"
                }
            ],
            "email_lc_sha256": [
                {
                    "id": "email_lc_sha256-eWfFn"
                }
            ]
        }
    },
    {
        "segmentMembership": {
            "ups": {
                "segmentid1": {
                    "lastQualificationTime": "2021-06-30T18:42:27.609823Z",
                    "status": "realized"
                },
                "segmentid3": {
                    "lastQualificationTime": "2021-06-30T18:42:27.609824Z",
                    "status": "exited"
                },
                "segmentid2": {
                    "lastQualificationTime": "2021-06-30T18:42:27.609824Z",
                    "status": "realized"
                }
            }
        },
        "identityMap": {
            "phone_sha256": [
                {
                    "id": "phone_sha256-2PMjZ"
                }
            ],
            "gaid": [
                {
                    "id": "gaid-3aLez"
                }
            ],
            "idfa": [
                {
                    "id": "idfa-D2H1J"
                }
            ],
            "extern_id": [
                {
                    "id": "extern_id-i6PsF"
                }
            ],
            "email_lc_sha256": [
                {
                    "id": "email_lc_sha256-VPUtZ"
                }
            ]
        }
    }
]

API error handling api-error-handling

Destination SDK API endpoints follow the general Experience Platform API error message principles. Refer to API status codes and request header errors in the Platform troubleshooting guide.

Next steps

After reading this document, you now know how to generate sample profiles to be used when testing a message transformation template or when testing if your destination is configured correctly.

recommendation-more-help

7f4d1967-bf93-4dba-9789-bb6b505339d6