Stream Item Action Data

Create Stream item action data in JSON or CSV using Khoros Marketing Analytics API.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Details

The JSON export contains lists of Items and Events, broken down by Day and Stream. In other words, the export is structured as a list of days, each of which contains a list of requested Streams, each of which contains two lists - a list of items and a list of Events. Events are also referred to in this documentation as Actions, and they represent actions taken on an Item.

When the export is generated by create date (use_action_date = false), each day/stream will contain a list of Action Items (workflow transitions or other actions) that were created on that day and a list of the events associated with them.

When the export is generated by action date (use_action_date = true), each day/stream will contain a list of the Items that underwent workflow transitions or other actions on that day and a list of the events associated with them.

Response

The export response contains the export’s id. Use this key at the /v2/analytics/export/{id}/status endpoint to query for the export status, and retrieve a download url when the export is complete.

Query Params
string
Defaults to csv

Supports json and csv.

boolean
Defaults to true

If true then include CSV column headers.

string
Defaults to ,

Allows you to specify a custom delimiter for CSV exports.

email_recipients
array of strings

(Optional) When an Export completes, a notification-email will be sent to each email-recipient on this list. Each email-address must also have an associated Spredfast account to access the file. Submitting no email addresses will result in no email notifications being sent. Example: “[email protected],[email protected]

email_recipients
Body Params
query
object
Responses

Language
LoadingLoading…
Response
Choose an example:
application/json