HTTP Format Macros

Lists the macros you can use to create HTTP data files. HTTP sends data in a JSON format.

See the HTTP Format Macro Examples for a list and examples of some commonly used macro combinations.

Macro Method Type Description

AAM_UUID

GET

Audience Manager ID.

DP_UUID

GET

Data Partner Unique User ID. This macro returns the ID you’ve assigned to a user if their ID has already been synchronized with an Audience Manager device ID.

DPID

GET

Data Provider ID.

ECID

GET

Data Provider ID.

GENERATION_TIME

GET, POST

Unix UTC timestamp. An internal timestamp, represents the time AAM was notified to publish the S2S destination to our partners.

IP

GET

The user's IP address.

MCID

GET

Experience Cloud ID. (MCID stands for Marketing Cloud, which is the legacy name of the Experience Cloud)

NUM_REMOVED_SEGMENTS

GET

The number (integer) of segments a user no longer belongs to.

NUM_SEGMENTS

GET

The number of segments a user belongs to.

ORDER_ID

GET, POST

Order or destination ID.

PID_ALIAS

GET, POST

An alias for the partner ID. Also known as Foreign Account ID.

RANDOM

GET

Generates a random number.

REGION_ID_LIST

GET

The Audience Manager DCS region where the activity originated.

REMOVED_SEGMENT_LIST

GET

Returns a list of segment IDs, if any, that a user no longer qualifies for.

REMOVED_SEGMENTS

GET

A list of segments that a user no longer qualifies for. You can also return specific segment fields that include:

  • traitAlias
  • legacySegmentId (formerly segmentId)
  • newSegmentId
  • status
  • dateTime

Specify these fields in an array as shown in this example:

[<REMOVED_SEGMENTS:{seg|<OPEN_BRACKET>"Mapping":<seg.traitAlias>,"Status:"<seg.status>, "Time":<seg.dateTime>,"LegacySegmentId":<seg.LegacySegmentId>, "NewSegmentId":<seg.NewSegmentId><CLOSE_BRACKET>}; "separator=",">]

See also HTTP Format Macro Examples .

REMOVED_TIME_LIST

GET

A list of last realizations for segments that the user no longer qualifies for.

REMOVED_TRAITALIAS_LIST

GET

A list of aliased names of segments that a user no longer qualifies for.

SEGMENT_LIST

GET

Returns a list of segment IDs.

SEGMENTS

GET

A list of segments a user qualifies for. You can also return specific segment fields that include:

  • traitAlias
  • legacySegmentId (formerly segmentId)
  • newSegmentId
  • status
  • dateTime

Specify these fields in an array as shown in this example:

[<SEGMENTS:{seg|<OPEN_BRACKET>"Mapping":<seg.traitAlias>,"Status:"<seg.status>, "Time":<seg.dateTime>,"LegacySegmentId":<seg.LegacySegmentId>, "NewSegmentId":<seg.NewSegmentId><CLOSE_BRACKET>}; "separator=",">]

See also HTTP Format Macro Examples .

TIME_LIST

GET

A list of last realizations.

TIMESTAMP

GET

Unix, UTC timestamp. Represents the last realization of the segment.

TRAITALIAS_LIST

GET

A list of aliased names for a particular segment.

USER_AGENT

GET

User agent of the initial request.

USER_LIST

POST

A list of Audience Manager user IDs. You can also return specific fields that include the following:

  • user.aamUuid
  • user.dpUuid
  • user.segments
  • user.removedSegments
  • user.userAgent
  • user.ip
  • user.dpuuids
  • user.timestamp
  • user.random
  • user.regionIds

Specify these fields as shown in this example:

"AAM_UUID": "<user.aamUuid>" "DataPartner_UUID": "<user.dpUuid>"

See also HTTP Format Macro Examples for a full example.

On this page