Search

Important

The GraphQL Search API for feed queries is currently in Early Availability status for customers on the AWS-US cluster. For more information, see GraphQL API policy.

With AppDirect Search, marketplace owners (merchants) can use APIs to consolidate information into a single database on the AppDirect platform. APIs are then used to query the database, and merchants present the information that is returned on their platforms, with front-end designs that they develop.

Search supports two forms of query:

• Search content—Searches the database for items that match user-entered search terms, and returns results in order of relevance, like a standard search engine.

• Feed resources—Searches the database for activity of the user's connected applications, and returns results in order of those most recently updated, like an event timeline.

Both types of query return only those resources that the user has access to, as determined by the permissions set on each resource.

Both types of query can also apply filters to the results that are returned. These filters can limit results to those that meet user-specified criteria on the resource fields.

To use the Search API

The Search API framework is a combination of REST and GraphQL APIs. The feeds query is the only GraphQL API. Before you can use it, you must complete steps 1-3, as follows:

1. Configure products: To aggregate data related to a product, enable the Search integration settings for it. See Configure products for Search.

2. Connect a user and product: To aggregate and search data related to a user and their app account, associate the user, product, and Search. See Connect users and applications to Search.

3. Publish content: Publish user data related to a product to Search. See Publish data to Search.

4. Do one or both of the following:

   • Search content: Search for keywords in the aggregated data that are visible to a connected user and product. See Search content.

   • Query content for feeds: Retrieve the resources that have been most recently updated and their associated attributes, and are visible to a connected user and product. See Query feed resources (GraphQL API).

5. Disconnect a user and product: When the subscription ends, disconnect the user and app account from Search. See Disconnect users and applications from Search.

The REST APIs needed to perform these tasks are discussed in the main Search topic, which describes the Search feature and how to use it. To set up the prerequisites to search and to query feeds, see the Getting started with Search.

After you have created user connections and published data, use the Feeds API (feedResources). See Query feed resources.