Skip to content
API Documents/
/
/
Return a list of Realtime...

Return a list of Realtime Key Events for the Audience

Request

Return a list of Realtime Key Events for the Audience

Security
TdApikeyAuth
Path
audienceIdinteger, (int64)required

Audience ID

Query
page[after]string

A string to fetch more page. The next value should be present at the pagination.nextPage in the previous response if more pages exist.

page[size]number, [ 1 .. 1000 ]

The maximum number of results to return per page

Default:100
sorted_bystring

Specify the sort order in the format foo:asc or foo:desc.

name_includestring

filter by the resource's name

curl -i -X GET \
  'https://api-cdp.treasuredata.com/audiences/{audienceId}/realtime_key_events?page%5Bafter%5D=string&page%5Bsize%5D=100&sorted_by=string&name_include=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

A list of Realtime Key Events for the Audience

Bodyapplication/json
dataArray of objects(partial_realtime_journey.yaml-RealtimeKeyEventAttributes)required
paginationobjectrequired
Response
{
  "data": [
    { … }
  ],
  "pagination": {
    "nextPage": "string"
  }
}