Log events

PUT  /automation/v3/logevents/workflows/:workflowId/filter

Method Details

HTTP Methods:

PUT

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

Marketing

Get a history of events for a specific workflow, filtered for a specific contact and/or event type(s).

This endpoint is particularly useful for integrations that pull data on a contact and display them in an application, like a CRM or Support Desk integration.

Required Parameters How to use Description
OAuth Access Token or API Key Authorization: Bearer {token} header
or hapikey={key} query parameter.
Used to authenticate the request. Please see this page for more details about authentication.
Workflow ID Used in the request URL The ID of the workflow you wish to see metadata for.
Filter JSON Used in the request body This JSON represents the desired Contact VID, and/or the list of event types. You can include multiple filter types, but you must include at least one filter type. See the examples for more details.
Optional Parameters How to use Description
Offset &offset=X - UTC millis The date in which the resultset cursor should start from, time descending. Defaults to current time.
Limit Date &limitDate=X - UTC millis The earliest date of an event that will be return from the resultset. Defaults to 180 days in the past from current time.