Search for Activities

The queryActivities endpoint is designed for exploratory search and filtering across all activities. Example use-cases:

• A search bar where users can search by text
• A "My posts" page that shows a user their own posts across all feeds (useful for applications like Reddit, where users post across different communities instead of posting to a single feed like user:alice)

Scope

When called from client-side

queryActivities endpoint searches for activities in public and visible feeds. It also respects activity visibility:

• private activities are only returned for the activity author
• if an activity has tag visibilty, and user doesn't have access to the full activity, only a preview is returned (for text based searches the search is performed across the whole activity text, not just the preview)

When called from server-side

queryActivities endpoint searches for activities in all feeds, regardless of visibility. It also respects activity visibility:

• private activities are not returned, unless include_private_activities is set to true see example below)
• activities with tag visibility are returned with full content, not just a preview
• user_id can be passed to turn a server-side request into a client-side request see example below

Examples

You can query & search activities. Here's an example of how to query activities:

$response = $feedsClient->queryActivities(
    new GeneratedModels\QueryActivitiesRequest(
        limit: 10,
        filter: (object)['activity_type' => 'post'],
        sort: [['field' => 'created_at', 'direction' => -1]]
    )
);

When searching activities, the activity.current_feed field contains information about the feed the activity belongs to. However, if an activity is posted to multiple feeds, this field will be empty. In this case, you can use the activity.feeds array to read all feed IDs the activity was posted to and fetch feeds separately if needed.

Search filter syntax emulates a MongoDB style query syntax. (It emulates it, we don't use MongoDB, but the query syntax is nice here).

Querying activities by text

// search for activities where the text includes the word 'popularity'.
$response = $feedsClient->queryActivities(
    new GeneratedModels\QueryActivitiesRequest(
        filter: (object)[
            'text' => (object)[
                '$q' => 'popularity'
            ]
        ]
    )
);

Querying activities by search data

Consider this example activity:

{
  "id": "activity-123",
  "type": "post",
  "text": "Check out our spring sale!",
  "search_data": {
    "campaign": {
      "id": "spring-sale-2025",
      "location": {
        "mall": "yorkdale",
        "city": "toronto",
        "country": "canada"
      }
    }
  }
  // ... other activity fields
}

You can search this activity using the search_data field in several ways:

// search for activities associated with the campaign ID 'spring-sale-2025'
$response = $feedsClient->queryActivities(
    new GeneratedModels\QueryActivitiesRequest(
        filter: (object)[
            'search_data' => (object)[
                '$contains' => (object)[
                    'campaign' => (object)[
                        'id' => 'spring-sale-2025'
                    ]
                ]
            ]
        ]
    )
);

// search for activities where the campaign took place in a mall
$response2 = $feedsClient->queryActivities(
    new GeneratedModels\QueryActivitiesRequest(
        filter: (object)[
            'search_data' => (object)[
                '$path_exists' => 'campaign.location.mall'
            ]
        ]
    )
);

Querying private activities

For server-side requests, you can set include_private_activities to true to include private activities in the results (the default is false).

$response = $feedsClient->queryActivities(
    new GeneratedModels\QueryActivitiesRequest(
        include_private_activities: true,
        filter: (object)[
            // your filter here
        ]
    )
);

user_id for server-side requests

For server-side requests, you can provide a user_id to perform the search as if it were made by that specific user. It turns the server-side request into a client-side request.

$response = $feedsClient->queryActivities(
    new GeneratedModels\QueryActivitiesRequest(
        user_id: 'john',
        filter: (object)[
            // your filter here
        ]
    )
);

Activities Queryable Built-In Fields

The filter syntax also supports $or and $and:

$filter = (object)['and' => [
  'filter_tags' => ['green'],
  'filter_tags' => ['orange'],
]]

Be sure to reach out to support if you need additional query activity capabilities.

Activities sort options

Fields:

• created_at
• popularity

Direction: 1 or -1