RSS3 Documentation

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.

GET
/federated/{account}
/federated/{account}?direction=out

Path Parameters

account
Required
string

Retrieve activities from the specified account. This account is a unique identifier within the federated system.

Query Parameters

limitinteger

Specify the number of activities to retrieve. By default, this is set to 100, and the maximum allowed value is 100.

Default: 100Minimum: 1Maximum: 100

action_limitinteger

Specify the number of actions within the activity to retrieve

Default: 50Minimum: 1Maximum: 100

cursorstring

Specify the cursor used for pagination. This helps in retrieving the next set of results in a paginated response.

since_timestampinteger

Retrieve activities starting from this timestamp. The timestamp is specified in Unix epoch time.

until_timestampinteger

Retrieve activities up to this timestamp. The timestamp is specified in Unix epoch time.

successboolean

Retrieve activities based on success status. Specify true for successful activities or false for unsuccessful ones.

directionstring

Retrieve activities based on direction. The direction specifies whether the activity is incoming or outgoing.

Value in: "in" | "out" | "self"

networkarray<string>

Retrieve activities from the specified federated network(s). You can specify one or more federated networks.

tagarray<string>

Retrieve activities from the specified tag(s). Tags can be used to categorize activities.

typearray<string>

Retrieve activities from the specified type(s). Types can help filter activities based on their nature or category.

platformarray<string>

Retrieve activities from the specified platform(s). Platforms refer to the systems or environments where the activities occurred.

curl -X GET "https://gi.rss3.io/federated/string?limit=100&action_limit=50&cursor=string&since_timestamp=0&until_timestamp=0&success=true&direction=out&network=%5B%0A++%22mastodon%22%0A%5D&tag=%5B%0A++%22social%22%0A%5D&type=%5B%0A++%22post%22%0A%5D&platform=%5B%0A++%22Mastodon%22%0A%5D"

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.

{
  "data": [
    {
      "id": "https://universeodon.com/users/woofers/statuses/113324128515491294/activity",
      "owner": "@georgetakei@universeodon.com",
      "network": "mastodon",
      "from": "@woofers@universeodon.com",
      "to": "@georgetakei@universeodon.com",
      "index": 0,
      "platform": "Mastodon",
      "success": true,
      "tag": "social",
      "type": "comment",
      "direction": "out",
      "timestamp": 1729188972,
      "total_actions": 1,
      "actions": [
        {
          "tag": "social",
          "type": "comment",
          "platform": "Mastodon",
          "from": "@woofers@universeodon.com",
          "to": "@georgetakei@universeodon.com",
          "metadata": {
            "handle": "@woofers@universeodon.com",
            "body": "@ georgetakei ( https://universeodon.com/@georgetakei ) now hold on just a minute...\n\n# woof ( https://universeodon.com/tags/woof )",
            "publication_id": "113324128515491294",
            "tags": [
              "@georgetakei",
              "#woof"
            ],
            "author_url": "https://universeodon.com/users/woofers",
            "timestamp": 1729188972,
            "target": {
              "handle": "@georgetakei@universeodon.com",
              "body": "Just a little treat.",
              "media": [
                {
                  "address": "https://media.universeodon.com/media_attachments/files/113/319/346/314/075/495/original/26e989bcf15840a6.png",
                  "mime_type": "image/png"
                }
              ],
              "publication_id": "113319346448373294",
              "author_url": "https://universeodon.com/users/georgetakei",
              "timestamp": 1729116004
            },
            "target_url": "https://universeodon.com/users/georgetakei/statuses/113319346448373294"
          },
          "related_urls": [
            "https://universeodon.com/users/woofers/statuses/113324128515491294"
          ]
        }
      ]
    }
  ],
  "meta": {
    "cursor": "string"
  }
}