{

company_name: string,Account Name

api_identifier: string,API Identifier

timezone: string,Timezone name

date_format: string,Date Format

transactions_limited: boolean,Transactions limited [TRUE,FALSE]

transactions_balance: integerCurrent Transaction Balance

}

{

0: {

workflow_id: integer,Our internal ID for the Workflow

workflow_api_identifier: string,Workflow API identifier

workflow_description: string,Workflow description

workflow_notes: string,Workflow notes

workflow_status: stringWorkflow status

}...

}

{

0: {

workflow_action_id: integer,Internal ID for the Email Action

workflow_action_description: string,Email Action description

workflow_action_notes: string,Email Action notes

status: string,Action Status [ACTIVE, DELETED]

date_created: string,

date_deleted: stringShown when the action has a status of DELETED

}...

}

{

0: {

workflow_id: integer,Our internal ID for the Workflow

workflow_api_identifier: string,Workflow API identifier

workflow_description: string,Workflow description

workflow_notes: string,Workflow notes

workflow_date_created: datetime,Workflow date created

workflow_status: string,Workflow Status

stats: {

trigger_requests: integer,

triggered: integer,

ignored: integer,

failed: integer,

completed: integer,

emails_queued: integer,

webhooks_queued: integer,

notifications_queued: integer,

tags_applied: integer,

lists_subscribed: integer,

lists_unsubscribed: integer,

global_suppression: integer,

global_unsuppression: integer,

additional_workflows: integer,

transactions: integer

}

emails: {

workflow_action_id: integer,

workflow_action_description: string,

template_id: string,

stats: {

queued: integer,

delivered: integer,

soft_bounced: integer,

hard_bounced: integer,

undelivered: integer,

opened: integer,

clicked: integer,

opted_out: integer,

viewed_online: integer,

workflows_triggered: integer,

auto_cleansed: integer,

email_returns: integer,

complained: integer,

conversions: integer,

conversions_value: float

}

}...

}...

}

{

launched: boolean,Whether the launch was successful

launch_id: integer,Identifier to access workflow launch details

launch_date: datetime,The date & time the launch is due

workflow_status: date,Current Workflow status

workflow_description: dateWorkflow Description

}

{

user_id: integer,Internal User ID

email_address: string,

cancelled_workflows: {A collection of cancelled Workflow Journeys in the following format

journey_id: integer,Internal ID for triggered Workflow

workflow_id: integer,Internal ID for the Workflow

workflow_api_identifier: string,

workflow_description: string

}...

}

{

0: {

success: boolean,

workflow_status: stringWorkflow Status

}...

}

{

0: {

user_id: integer,

email_address: string,

journey_label: string,

journey_status: string,[ACTIVE, COMPLETED, IGNORED, CANCELLED, FAILED]

journey_start_date: datetime,Date the Workflow was triggered

journey_last_action_date: datetime,Last date an action was processed

journey_next_action_date: datetime,Next date an action is due to be processed (where applicable)

trigger_source: string,Where the Workflow Journey was triggered from

contacts_workflow_cancel_source: string,If present, where the workflow was cancelled from [UI, WORKFLOW, API]

workflow_api_identifier: string,

workflow_description: string,

workflow_session_variables: string,Raw JSON encoded string of Workflow Session Variables

actions: {Collection of Workflow Actions taken for this Workflow Journey

0: {START action

workflow_action_id: string,Our internal identifier for this Workflow Action

workflow_action_type: string,This will be set to START

cancel_rule: string,Whether other workflows were cancelled

workflow_action_status: string,[COMPLETE, PENDING]

date_completed: datetimeDate the action was completed

}

1: {EMAIL action

workflow_action_id: string,Our internal identifier for this Workflow Action

workflow_action_type: string,This will be set to EMAIL

workflow_action_description: string,

workflow_action_status: string,

date_completed: datetime,

email_details: {

description: string,

subject: string,

email_profile: {

type: string,How the Email Profile was selected [VARIABLE, TEMPLATE]

email_profile_name: string,

email_profile_api_identifier: string,

from_address: string

}

user_engagement: {

opened: string,[Y, N]

first_open: datetime,

clicked: string,[Y, N]

first_click: datetime,

opted_out: string,[Y, N]

first_optout: datetime

}

smtp_log: {

result_code: numeric,SMTP response code

result_message: string,SMTP response message

email_status: string,[BUILDING, QUEUED, DELIVERED, HARD_BOUNCE, SOFT_BOUNCE, IGNORED]

mail_server: stringRecipient mail server

}

}

}...

2: {DELAY action

workflow_action_id: string,Our internal identifier for this Workflow Action

workflow_action_type: string,This will be set to DELAY

workflow_action_description: string,

workflow_action_status: string,

date_completed: datetime,

details: {

offset_type: string,

delay_until: string,When the next action will be processed

offset_source: string,Where the delay information comes from

offset_execution: string,

offset: {

days: integer,

hours: integer,

minutes: integer

}

}

}...

3: {DECISION action

workflow_action_id: string,Our internal identifier for this Workflow Action

workflow_action_type: string,This will be set to DECISION

workflow_action_description: string,

winning_decision: string,Name of the winning Decision path

workflow_action_status: string,

date_completed: datetime

}...

4: {USER_DATA action

workflow_action_id: string,Our internal identifier for this Workflow Action

workflow_action_type: string,This will be set to USER_DATA

workflow_action_description: string,

workflow_action_status: string,

date_completed: datetime,

user_updated: string,Whether User Data was actually updated [Y, N]

changes: {

0: {

field: string,Personalisation field name

type: string,

previous_value: string,The value of the field prior to the update

new_value: string,The value of the field after the update

valid: booleanIf the User update request was valid

}...

}

}...

5: {TAG_USER action

workflow_action_id: string,Our internal identifier for this Workflow Action

workflow_action_type: string,This will be set to TAG_USER

workflow_action_description: string,

workflow_action_status: string,

date_completed: datetime,

added: {Collection of Tag associations created for this User

0: {

type: string,[STATIC, DYNAMIC]

tag_name: string

}...

}

removed: {Collection of Tag associations removed for this User

0: {

type: string,[STATIC, DYNAMIC]

tag_name: string

}...

}

}...

6: {EMAIL_PREFERENCE action

workflow_action_id: string,Our internal identifier for this Workflow Action

workflow_action_type: string,This will be set to EMAIL_PREFERENCE

workflow_action_description: string,

workflow_action_status: string,

date_completed: datetime,

global_optout: {

action: string[NO_CHANGE, SUPPRESS, UNSUPRESS]

}

lists: {

0: {

list_description: string,List Name

type: string,[OPT_IN, OPT_OUT]

previously_subscribed: string[Y, N]

}...

}

}...

7: {WEBHOOK action

workflow_action_id: string,Our internal identifier for this Workflow Action

workflow_action_type: string,This will be set to WEBHOOK

workflow_action_description: string,

workflow_action_status: string,

date_completed: datetime,

request: {Details of the web request

url: string,

status: string,[SENT, FAILED]

response_code: string,HTTP Response Code

response_details: stringHTTP Response Detail (if status FAILED)

}...

}...

8: {NOTIFICATION action

workflow_action_id: string,Our internal identifier for this Workflow Action

workflow_action_type: string,This will be set to NOTIFICATION

workflow_action_description: string,

workflow_action_status: string,

date_completed: datetime,

details: {Notification message details

to: {Collection of To recipients

0: {

name: string,

email_address: string

}...

}

bcc: {Collection of BCC recipients

0: {

name: string,

email_address: string

}...

}

subject: string,

message: string,

email_profile: {Details of the Email Profile used

email_profile_name: string,

email_profile_api_identifier: string,

from_address: string

}

}

}...

9: {END action

workflow_action_id: string,Our internal identifier for this Workflow Action

workflow_action_type: string,This will be set to END

workflow_action_description: string,

workflow_action_status: string,

date_completed: datetime,

workflows: {

triggered: {Collection of triggered Workflows

0: {

workflow_api_identifier: string,

workflow_description: string

}

}

cancelled: {Collected of cancelled Workflows

0: {

workflow_api_identifier: string,

workflow_description: string

}

}

}

}

10: {Action present when contacts_workflow_status is FAILED

workflow_action_type: string,This will be set to FAILED

workflow_action_description: string,

date_cancelled: datetime,Datetime the Workflow Journey was cancelled

reason: stringFailure reason

}

11: {Action present when contacts_workflow_status is CANCELLED

workflow_action_type: string,This will be set to CANCELLED

source: string,Where the workflow was cancelled from [UI, WORKFLOW]

date_cancelled: datetime,Datetime the Workflow Journey was cancelled

workflow_api_identifier: stringIf present, the API Identifier of the Workflow that initiated the cancellation

}

}...

}...

}

{

}

{

}

{

}

{

0: {

campaign_id: integer,Internal Campaign ID

campaign_code: string,Campaign Code

campaign_description: string,

campaign_date: date,Delivery date as YYYY-MM-DD HH:MM:SS

social_share_url: string,

thumbnails: {Collection of thumbnail URLs

small: string,

medium: string,

large: string

}

}...

}

{

0: {

campaign_id: integer,Internal Campaign ID

campaign_code: string,Campaign Code

campaign_description: string,

campaign_date: date,Delivery date as YYYY-MM-DD HH:MM:SS

email_spooler_split_subject: string,Subject - will be "N/A" for Split Test Campaigns

tags: string,CSV string of Spotlight Tags

}

}

{

summary: {An array containing User Tags in the following format

campaign_count: integer,Number of Campaigns included in the comparison

first_date: date,Date of the first Campaign in YYYY-MM-DD

latest_date: date,Date of the latest Campaign in YYYY-MM-DD

}

campaigns: {An array containing multiple Campaign objects in this format

}

}