Real-Time Outbound Data Transfers

The outbound real-time data transfer process returns user data as a series of JSON objects passed in with a POST method.

Recommendations

To use this method, we recommend that your data partner:

Frequency

This data transfer method can send data in near real-time as users qualify for segments. Additionally, this method can send batches of offline or onboarded data as frequently as every 24-hours.

Required Responses

By default, the recipient server must return the 200 OK code to indicate successful receipt. Other codes will be interpreted as failures. This response is expected within 3000 milliseconds. In response to a failure, Audience Manager will make 1 retry attempt only.

Parameters

The following table defines the elements in the returned JSON data file.
Parameter Data Type Description
ProcessTime

DateTime

Time when the request was executed.

User_DPID

Integer

An ID that indicates if the file contains Android or iOS IDs. Uses the following ID values:

  • Android IDs (GAID): 20914
  • iOS IDs (IDFA): 20915
Client_ID

String

Client ID used by the system you're sending data to.

AAM_Destination_ID

Integer

The ID assigned to you by your destination partner.

User_count

Integer

Total number of users in the POST request.

Users

Array

An array of user objects.

AAM_UUID

String

The Audience Manager UUID.

DataPartner_UUID

String

Data partner UUID. Leave blank if your data partner does not have a UUID.

AAM_Regions Array The Audience Manager region ID where we've seen this device. For instance, if the device had some activity in Paris (Europe), the region ID would be 6. See DCS Region IDs, Locations, and Host Names.
Segments

Array

An array of segment objects.

Segment_ID

Integer

The segment ID destination mapping.

Status

Integer

Defines the status of a user in the segment. Accepts the following:

  • 1: Active (default)
  • 0: Inactive, opted-out, or unsegmented.

Users are unsegmented when they are:

  • Removed from a segment based on the segment rule.
  • Removed from a segment based on the segment's time-to-live interval.
  • Moved to an inactive state if they have not been seen for the last 120-days.

All partner IDs that are synced to an Audience Manager ID will receive the "Status":"0" flag when a user is unsegmented.

DateTime

DateTime

Time that a site visitor qualified for the trait.

Security

You can secure your real-time outbound data transfer process by encrypting HTTP requests with private keys or by having Audience Manager authenticate through the OAuth 2.0 protocol.

Code Sample

A real-time data response can look similar to the following:
{
"ProcessTime": "Wed Jul 27 16:17:42 UTC 2016",
"User_DPID": "12345",
"Client_ID": "74323",
"AAM_Destination_Id": "423",
"User_count": "2",
"Users": [{		
   "AAM_UUID": "19393572368547369350319949416899715727",
   "DataPartner_UUID": "4250948725049857",
   "Segments": [{
            "Segment_ID": "14356",
            "Status": "1",
            "DateTime": "Wed Jul 27 16:17:22 UTC 2016"
         },
         {
            "Segment_ID": "12176",
            "Status": "0",  
            "DateTime": "Wed Jul 27 16:17:22 UTC 2016"
         }
      ]
   },
   {
   "AAM_UUID": "0578240750487542456854736923319946899715232",
   "DataPartner_UUID": "848457757347734",
   "Segments": [{
            "Segment_ID": "10329",
            "Status": "1",
            "DateTime": "Wed Jul 27 16:17:21 UTC 2016"
         },
         {
            "Segment_ID": "23954",
            "Status": "1",
            "DateTime": "Wed Jul 27 16:17:21 UTC 2016"
        }]
    }]
}