Decide best-matching series to return, enable continue-at

apidoc/src/bins.md

@@ -1 +1,17 @@
 # Binned Data
+
+Binned data can be fetched like this:
+
+```bash
+curl "https://data-api.psi.ch/api/4/binned?backend=sf-databuffer&channelName=S10BC01-DBPM010:Q1&begDate=2024-02-15T00:00:00Z&endDate=2024-02-15T12:00:00Z&binCount=500"
+```
+
+This returns for each bin the average, minimum, maximum and count of events.
+
+Note: the server may return more than `binCount` bins.
+That is because most of the time, the requested combination of date range and bin count
+does not fit well on the common time grid, which is required for caching to work.
+
+If absolutely required, we could re-crunch the numbers to calculate the exact
+requested specification of date range and bin count. Please get in touch
+if your use case demands this.

apidoc/src/events.md

@@ -1 +1,11 @@
 # Event Data
+
+Event data can be fetched like this:
+
+```bash
+curl "https://data-api.psi.ch/api/4/events?backend=sf-databuffer&channelName=S10BC01-DBPM010:Q1&begDate=2024-02-15T12:41:00Z&endDate=2024-02-15T12:42:00Z"
+```
+
+Note: if the channel changes data type within the requested date range, then the
+server will return values for that data type which covers the requested
+date range best.

apidoc/src/intro.md

@@ -1 +1,7 @@
 # Introduction
+
+The data retrieval api is a simple http api.
+Examples are given in terms of `cURL` commands.
+This documentation is a work in progress.
+
+Please get in touch with questions and comments: [dominik.werder@psi.ch](dominik.werder@psi.ch)

apidoc/src/search.md

@@ -1 +1,11 @@
 # Search Channels
+
+To search for e.g. DBPM channels in `sf-databuffer` that end in `:Q1` the request
+looks like this:
+
+```bash
+curl "https://data-api.psi.ch/api/4/search/channel?backend=sf-databuffer&nameRegex=DBPM.*Q1$"
+```
+
+Parameters:
+- `icase=true` uses case-insensitive search (default: case-sensitive).