Input and Output for Lead Activity
The
Input tab and the
Output tab have the following fields for retrieving lead activity.
Table 1. Input for Retrieving Lead Activity
| Input Item
|
Data Type
|
Description
|
| ParamsGetLeadActivity
|
| leadKey
|
string
|
The lead keys that are used to query the lead. The selector contains a key type and a key value.
Note: Only some specific values are valid for this field, see the Marketo documentation for details.
|
| activityFilter
|
string
|
Filters the activities for the lead identified by the provided lead keys . The filter contains the following two items:
- includeAttributes: Lists the activity types to be returned only.
- excludeAttributes: Lists the activity types not to be returned.
Note:
- The
includeAttributes and
excludeAttributes items cannot be specified within a query.
- If no values are given to this filter, it indicates that all the activity types will be returned.
|
| startPosition
|
complex
|
Paginates through a large number of returned activity types. All the values in this field are returned by the previous batch. It contains the following items:
- latestCreatedAt
- oldestCreatedAt
- ActivityCreatedAt
- offset
|
| batchSize
|
integer
|
The maximum number of leads to be queried each time.
|
Table 2. Output for Retrieving Lead Activity
| Output Item
|
Data Type
|
Description
|
| SuccessGetLeadActivity
|
| returnCount
|
integer
|
The number of activity types that have been returned in this batch.
|
| remaining
Count
|
integer
|
The number of activity types that have not been returned.
|
| newStart
Position
|
string
|
The new start position for the next batch.
|
| activityRecord
List
|
N/A
|
The activity types of the identified lead supposed to be returned.
|
Copyright © Cloud Software Group, Inc. All Rights Reserved.