蜜豆视频

DocumentationCampaignCampaign v8 Documentation

Additional operations additional-operations

Last update: Tue Jul 08 2025 00:00:00 GMT+0000 (Coordinated Universal Time)
  • Applies to:
  • Campaign v8 Client Console

CREATED FOR:

  • Experienced
  • Developer

Sorting sorting

Sorting is available by default in ascending order. To sort in descending order, append %20desc to the _order parameter鈥檚 value.

To know if a field can be sorted, check the 鈥渟ortable鈥 parameter into the resource metadata. For more on this, refer to this section.

Sample requests

  • Sample GET request to retrieve emails in the database alphabetically ordered.

    code language-none 
    
-X GET https://mc.adobe.io/<ORGANIZATION>/campaign/profileAndServices/profile/email?_order=email \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
-H 'Cache-Control: no-cache' \
-H 'X-Api-Key: <API_KEY>'

    Response to the request.

    code language-none 
    
{
"content": [
    "adam@email.com",
    "allison.durance@example.com",
    "amy.dakota@mail.com",
    "andrea.johnson@mail.com",
    ...
]
...
}

  • Sample GET request to retrieve the email in the database in a descending alpha order.

    code language-none 
    
-X GET https://mc.adobe.io/<ORGANIZATION>/campaign/profileAndServices/profile/email?_order=email%20desc \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
-H 'Cache-Control: no-cache' \
-H 'X-Api-Key: <API_KEY>'

    Response to the request.

    code language-none 
    
{
"content": [
    "tombinder@example.com",
    "tombinder@example.com",
    "timross@example.com",
    "john.smith@example.com",
    ...
]
}

Filtering filtering

Retrieving filters metadata

Filters are available for each resource. To identify the filters associated to a resource, you need to perform a GET request on the resource metadata. This request returns the URL where all of the filters are defined for a given resource. For more on metadata, refer to this section.

To identify the metadata of a filter and determine how to use it, you have to perform a GET request on the previously returned URL.

Sample request

The sample payloads below show how to retrieve the 鈥渂yText鈥 filter metadata for the 鈥減rofile鈥 resource. First perform a GET request on the 鈥減rofile鈥 resource metada.


-X GET https://mc.adobe.io/<ORGANIZATION>/campaign/profileAndServices/resourceType/profile \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
-H 'Cache-Control: no-cache' \
-H 'X-Api-Key: <API_KEY>'

It returns the URL where the filters are described.


{
"filters": {
        "href": "https://mc.adobe.io/<ORGANIZATION>/campaign/profileAndServices/resourceType/<PKEY>/filters/"
    }
  }

Perform a GET request on the URL. It returns the list of filters for the profile resource, with the metadata associated to each filter.


{
"birthday": {
        "PKey": "@FL-CbDFXbnHbXcVpeCGWL46VXJLn1LqxLMPagt2vz8sCxQ52lvB15KiUaxXkxJYQw-tZXYrgUWG6K8QcB4gxVY9RKoba5bRFY3294YFshDmorRr8",
        "category": "0150_profile",
        "condition": ...,
        "data": "https://mc.adobe.io/<ORGANIZATION>/campaign/profileAndServices/profile/birthday?type=$value&precision=$value&operator=$value&day=$value&month=$value&includeStart=$value&endDay=$value&endMonth=$value&includeEnd=$value&relativeValue=$value&nextUnitsValue=$value&previousUnitsValue=$value",
        "formType": "webPage",
        "fragmentName": "",
        "label": "Birthday",
}

Filters metadata structure

The same metadata structure is available for each filter:

  • The @formType and @webPage fields are technical fields.
  • The data field gives a sample on how to use the filter.
  • The metadata node describes the filter parameters.
  • The condition node describes what the filter is intended to do. The filter parameters described in the metadata node are used to create filter conditions. For each filter condition, if enabledIf is true, the expr will be applied.

Filter metadata structure sample:


"byText": {
        "PKey": "...",
        "category": "99_none",
        "condition": ...,
        "data": "/profileAndServices/profile/byText?text=$value",
        "formType": "none",
        "fragmentName": "",
        "label": "By name or email",
    }

Using filters

Filtering is performed with the following request:

GET https://mc.adobe.io/<ORGANIZATION>/campaign/profileAndServices/<resourceName>/by<filterName>?<filterParam>=<filterValue>

It is possible to combine multiple filters in a single request:

GET https://mc.adobe.io/<ORGANIZATION>/campaign/profileAndServices/<resourceName>/<filter1name>/<filter2name>?<filter1param>=<filter1value>&<filter2param>=<filter2value>

Sample requests

  • Sample GET request to retrieve the 鈥渟ervice鈥 resources with the type 鈥渆mail鈥.

    code language-none 
    
-X GET https://mc.adobe.io/<ORGANIZATION>/campaign/profileAndServices/service/byChannel?channel=email \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
-H 'Cache-Control: no-cache' \
-H 'X-Api-Key: <API_KEY>'

    Response to the request.

    code language-none 
    
{
    "content": [
        {
            "PKey": "<PKEY>",
            "created": "2019-09-25 23:20:35.000Z",
            "href": "https://mc.adobe.io/<ORGANIZATION>/campaign/profileAndServices/service/@I_FIiDush4OQPc0mbOVR9USoh36Tt5CsD35lATvQjdWlXrYc0lFkvle2XIwZUbD8GqTVvSp8AfWFUvjkGMe1fPe5nok",
            "label": "Marketing Newsletter",
            "lastModified": "2019-09-25 23:20:35.000Z",
            "limitedDuration": false,
            "messageType": "email",
            "mode": "newsletter",
            ...
        },
        ...
    ],
    ...
}

  • Sample GET request to retrieve the 鈥減rofile鈥 resources containing 鈥淒oe鈥 in
    the email or last name fields (the byText filter searches into both the email and last name fields).

    code language-none 
    
-X GET https://mc.adobe.io/<ORGANIZATION>/campaign/profileAndServices/profile/byText?text=Doe \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
-H 'Cache-Control: no-cache' \
-H 'X-Api-Key: <API_KEY>'

    Response to the request.

    code language-none 
    
{
    "content": [
        {
            "PKey": "<PKEY>",
            "firstName": "John",
            "lastName":"Doe",
            "birthDate": "1980-10-24",
            ...
        }
        ...
    ],
    ...
}

  • Sample GET request to retrieve the services resources with the type 鈥渆mail鈥 and the label 鈥渟port鈥.

    code language-none 
    
-X GET https://mc.adobe.io/<ORGANIZATION>/campaign/profileAndServices/service/byChannel/byText?channel=email&text=sport \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
-H 'Cache-Control: no-cache' \
-H 'X-Api-Key: <API_KEY>'

    Response to the request.

    code language-none 
    
{
    "content": [
        {
            "PKey": "<PKEY>",
            "created": "2019-09-26 09:36:01.014Z",
            "href": "https://mc.adobe.io/<ORGANIZATION>/campaign/profileAndServices/service/<PKEY>",
            "label": "sport",
            "lastModified": "2019-09-26 09:36:01.014Z",
            "limitedDuration": false,
            "messageType": "email",
            "mode": "newsletter",
            "name": "SVC13",
            ...
        }
    ],
    ...
}

Custom filters

If you want to use a custom filter, you have to create and customize it in the 蜜豆视频 Campaign Standard interface. The custom filter will then have the same behavior as out of the box filters:

GET https://mc.adobe.io/<ORGANIZATION>/campaign/profileAndServicesExt/<resourceName>/by<customFilterName>?<customFilterparam>=<customFilterValue>

For more on this, refer to the Campaign Standard documentation:

Sample request

Sample GET request to retrieve the 鈥減rofile鈥 resources with transaction amounts of 100$ or more. Note that the 鈥渂yAmount鈥 filter has first been defined in the 蜜豆视频 Campaign Standard interface and linked to the 鈥淭ransaction鈥 custom table.


-X GET https://mc.adobe.io/<ORGANIZATION>/campaign/profileAndServicesExt/profile/byAmount?amount_parameter=100 \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
-H 'Cache-Control: no-cache' \
-H 'X-Api-Key: <API_KEY>'

Counting counting

The 蜜豆视频 Campaign REST API can count the number of records in a request. To do this, use the URL that is returned in the count node.

Sample request

To count all the services that have a messageType value equaling to 鈥渟ms鈥, perform a GET request with the byChannel filter.


-X GET https://mc.adobe.io/<ORGANIZATION>/campaign/profileAndServices/service/byChannel?channel=sms \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
-H 'Cache-Control: no-cache' \
-H 'X-Api-Key: <API_KEY>'

It returns the services corresponding to the filter.


{
    "content": [
        {
            ...
            "messageType": "sms",
            "mode": "newsletter",
            "name": "SVC6",
            ...
        },
        ...
    ],
    "count": {
        "href": "https://mc.adobe.io/<ORGANIZATION>/campaign/profileAndServices/service/byChannel/_count?channel=sms&_lineStart=@iKTZ2q3IiSEDqZ5Nw1vdoGnQCqF-8DAUJRaVwR9obqqTxhMy"
    },
    "serverSidePagination": true
}

Perform a GET request on the count node鈥檚 URL to retrieve the number of results.


-X GET https://mc.adobe.io/<ORGANIZATION>/campaign/profileAndServices/service/byChannel/_count?channel=sms&_lineStart=@iKTZ2q3IiSEDqZ5Nw1vdoGnQCqF-8DAUJRaVwR9obqqTxhMy \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
-H 'Cache-Control: no-cache' \
-H 'X-Api-Key: <API_KEY>'

It returns the number of records.


{
    "count": 26
}

Pagination pagination

By default, 25 resources are loaded in a list.

The _lineCount parameter allows you to limit the number of resources listed in the response. You can then use the next node to display the next results.

NOTE
Always use the URL value returned in the next node to perform a pagination request.
The _lineStart request is calculated and must always be used within the URL returned in the next node.

Sample request

Sample GET request to display 1 record of the profile resource.


-X GET https://mc.adobe.io/<ORGANIZATION>/campaign/profileAndServices/profile?_lineCount=1 \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
-H 'Cache-Control: no-cache' \
-H 'X-Api-Key: <API_KEY>'

Response to the request, with the next node to perform pagination.


{
    "content": [
        {
            "PKey": "<PKEY>",
            "firstName": "John",
            "lastName":"Doe",
            "birthDate": "1980-10-24",
            ...
        }
    ],
    "next": {
        "href": "https://mc.adobe.io/<ORGANIZATION>/campaign/profileAndServices/profile/email?_lineCount=10&_
        lineStart=@Qy2MRJCS67PFf8soTf4BzF7BXsq1Gbkp_e5lLj1TbE7HJKqc"
    }
    ...
}

By default, the next node is not available when interacting with tables with large amount of data. To be able to perform pagination, you must add the _forcePagination=true parameter to your call URL.


-X GET https://mc.adobe.io/<ORGANIZATION>/campaign/profileAndServices/profile?_forcePagination=true \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
-H 'Cache-Control: no-cache' \
-H 'X-Api-Key: <API_KEY>'
NOTE
The number of records above which a table is considered as large is defined in Campaign Standard XtkBigTableThreshold option. The default value is 100,000 records.
recommendation-more-help
35662671-8e3d-4f04-a092-029a056c566b