Signals Notebook: How to Search Experiments by Custom Fields Using API

Overview
This article explains how to search for Experiments using the Signals Notebook External API based on custom fields that have been added to an Experiment Template, beyond the default fields such as Name and Description.

Example
Suppose you have added a custom field called "Project" to the Experiment Template as shown below, and you want to search for Experiments created from this template using the custom field "Project".

The procedure in this case is as follows:

1.Sign in with an administrator account and navigate to "App Launcher > Signals Configuration > System Settings > API Key".

2.Click "Open External API Document".

3.Expand "Entities".

4.Expand "POST /entities/search".

5.Click "Try it out".

6.Set the following in the Request body*1:

{
   "query": {
       "$and": [
           {
               "$match": {
                   "field": "type",
                   "value": "experiment",
                   "mode": "keyword"
               }
           },
           {
               "$match": {
                   "field": "isTemplate",
                   "value": false
               }
           },
           {
               "$match": {
                   "field": "fields.Project",
                   "in": "tags",
                   "as": "text",
                   "value": "ProjectA",
                   "mode": "keyword"
                 }
           }
       ]
   }
}

7.Click "Execute"
8.Confirm that the Server response returns 200, then review the returned data*2.

Note: 
*1
・Replace "Project" in "field": "fields.Project" with your custom field name.
・Replace "ProjectA" in "value": "ProjectA" with the actual value you want to search for.

*2
The API will only return experiments for which the administrator executing this API has Read permission or higher. Experiments to which the administrator does not have access will not be included in the search results.