v1

latestOpenAPI 3.1.0Apache 2.02026-07-2265186296.2 KB
Activity Log

Search activity log

Retrieve logged activity filtered by various parameters over a date range.

See here for information on how to use the activity log and why.

get/activity-log

Query parameters

startstring date-time required

Start date/time of the date range.

ISO DateTime Format yyyy-MM-dd'T'HH:mm:ss e.g. '2021-02-15T10:30:00.000-08:00'

Time zone must match the time zone of the end date/time if also present.

endstring date-time required

End date/time of the date range.

ISO DateTime Format yyyy-MM-dd'T'HH:mm:ss e.g. '2021-02-15T11:30:00.000-08:00'

Time zone must match the time zone of the start date/time if also present.

actionsstring

Comma separated list of actions to include.

Only include activity for these actions.

requestIdstring

Only include activity that occurred during this request.

customerIdstring

Only include activity for this customer.

The customerId and externalCustomerId fields cannot be used in the same request.

externalCustomerIdstring

Only include activity for this customer.

The customerId and externalCustomerId fields cannot be used in the same request.

connectionIdsstring

Comma separated list of connection ids to include.

Only include activity for these connections.

financialAccountIdsstring

Comma separated list of financial account ids to include.

Only include activity for these financial accounts.

eventTypestring

Only include activity for this event type.

beforestring

Unique key corresponding to an activity's position in the paginated list of results -- used to indicate that only activity residing before this key will be retrieved.

Each activity carries a unique key. Reference Pagination

The before and after fields cannot be used in the same request.

afterstring

Unique key corresponding to an activity's position in the paginated list of results -- used to indicate that only activity residing after this key will be retrieved.

Each activity carries a unique key. Reference Pagination

The before and after fields cannot be used in the same request.

limitinteger

Limits number of returned activity.

Default value: 10

Minimum value: 1

Maximum value: 100

Response

Activity is returned