Signals Notebook: Retrieving Open Notebook Experiments via API

This article explains how to use the API (including Swagger UI) to search for and export all open notebook experiments within a specific time frame.

Test

Solution

1. Use the POST/entities/search endpoint to filter experiments:

Note: Set the query to filter by 'state' as 'open', 'type' as 'experiment', and specify the desired time range for 'createdAt'.

• The query example is:

{
    "query": {
        "$and": [
            {
                "$match": {
                    "field": "state",
                    "value": "open",
                    "mode": "keyword"
                }
            },
            {
                "$match": {
                    "field": "type",
                    "value": "experiment",
                    "mode": "keyword"
                }
            },
            {
                "$range": {
                    "field": "createdAt",
                    "as": "date",
                    "from": "2021-11-05T00:00:00Z",
                    "to": "2024-11-07T00:00:00Z"
                }
            }
        ]
    }
}

2. Use the eids from the experiments found on step 1 with API get /entities/{eid}/pdf.