Skip to content
API Documents/CDP(Audience) API/
/Realtime Journeys

Get realtime setting for the Audience

Request

Get realtime setting for the Audience

Path
audienceIdinteger, (int64)required

Audience ID

curl -i -X GET \
  'https://api-cdp.treasuredata.com/audiences/{audienceId}/realtime_setting'

Responses

Returns the realtime setting for the Audience

Bodyapplication/json
idstring[1-9][0-9]*
keyColumnsArray of objects(partial_realtime_journey.yaml-RealtimeKeyColumn)required
eventTablesArray of objects(partial_realtime_journey.yaml-RealtimeEventTable)required
batchAttributesArray of objects(partial_realtime_journey.yaml-RealtimeBatchAttribute)required
extLookupKeystring or nullrequired

one of the attribute of the audience. It can be null at first but once set it cannot be null again.

statusstringrequired
Enum:"initialized""updating""ok""inconsistent""not_initialized"
statusDetailedobject or nullrequired

Detailed status information from realtime-api

Response
{
  "id": "string",
  "keyColumns": [
    { … }
  ],
  "eventTables": [
    { … }
  ],
  "batchAttributes": [
    { … }
  ],
  "extLookupKey": "string",
  "status": "initialized",
  "statusDetailed": {}
}