Retrieve Federated Account Activities (Beta)
This endpoint retrieves the activities associated with a specified account in the federated system. You can use various query parameters to filter and paginate the results, including limits on the number of activities and actions, timestamps, success status, direction, and more.
{account}
Path Parameters
account
Requiredstring
Retrieve activities from the specified account. This account is a unique identifier within the federated system.
Query Parameters
limit
integer
Specify the number of activities to retrieve. By default, this is set to 100, and the maximum allowed value is 100.
100
Minimum: 1
Maximum: 100
action_limit
integer
Specify the number of actions within the activity to retrieve
50
Minimum: 1
Maximum: 100
cursor
string
Specify the cursor used for pagination. This helps in retrieving the next set of results in a paginated response.
since_timestamp
integer
Retrieve activities starting from this timestamp. The timestamp is specified in Unix epoch time.
until_timestamp
integer
Retrieve activities up to this timestamp. The timestamp is specified in Unix epoch time.
success
boolean
Retrieve activities based on success status. Specify true for successful activities or false for unsuccessful ones.
direction
string
Retrieve activities based on direction. The direction specifies whether the activity is incoming or outgoing.
"in" | "out" | "self"
network
array<string>
Retrieve activities from the specified federated network(s). You can specify one or more federated networks.
tag
array<string>
Retrieve activities from the specified tag(s). Tags can be used to categorize activities.
type
array<string>
Retrieve activities from the specified type(s). Types can help filter activities based on their nature or category.
platform
array<string>
Retrieve activities from the specified platform(s). Platforms refer to the systems or environments where the activities occurred.
A successful response with the activities from the specified account. The response includes details about each activity, such as its ID, timestamp, and associated actions.