signalk-server
Version:
An implementation of a [Signal K](http://signalk.org) server for boats.
78 lines (71 loc) • 16.3 kB
HTML
<html class="default" lang="en" data-base="../../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>History API | Signal K</title><meta name="description" content="Documentation for Signal K"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../../assets/style.css?cache=1767726585343"/><link rel="stylesheet" href="../../assets/highlight.css?cache=1767726585343"/><script defer src="../../assets/main.js?cache=1767726585343"></script><script async src="../../assets/icons.js?cache=1767726585343" id="tsd-icons-script"></script><script async src="../../assets/search.js?cache=1767726585343" id="tsd-search-script"></script><script async src="../../assets/navigation.js?cache=1767726585343" id="tsd-nav-script"></script><script async src="../../assets/hierarchy.js?cache=1767726585343" id="tsd-hierarchy-script"></script><link rel="stylesheet" href="../../assets/theme.css"/></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../../index.html" class="title"><img src="../../assets/logo.svg" alt="Signal K"/></a><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../../assets/icons.svg#icon-search"></use></svg><span class="visible@s">Search</span></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><div id="tsd-toolbar-links"><a href="https://discord.gg/uuZrwz4dCS" target="_blank" rel="noopener" class="toolbar-icon visible@s" aria-label="Discord"><svg width="24" height="24" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 640 512"><path d="M524.5 69.8a1.5 1.5 0 0 0 -.8-.7A485.1 485.1 0 0 0 404.1 32a1.8 1.8 0 0 0 -1.9 .9 337.5 337.5 0 0 0 -14.9 30.6 447.8 447.8 0 0 0 -134.4 0 309.5 309.5 0 0 0 -15.1-30.6 1.9 1.9 0 0 0 -1.9-.9A483.7 483.7 0 0 0 116.1 69.1a1.7 1.7 0 0 0 -.8 .7C39.1 183.7 18.2 294.7 28.4 404.4a2 2 0 0 0 .8 1.4A487.7 487.7 0 0 0 176 479.9a1.9 1.9 0 0 0 2.1-.7A348.2 348.2 0 0 0 208.1 430.4a1.9 1.9 0 0 0 -1-2.6 321.2 321.2 0 0 1 -45.9-21.9 1.9 1.9 0 0 1 -.2-3.1c3.1-2.3 6.2-4.7 9.1-7.1a1.8 1.8 0 0 1 1.9-.3c96.2 43.9 200.4 43.9 295.5 0a1.8 1.8 0 0 1 1.9 .2c2.9 2.4 6 4.9 9.1 7.2a1.9 1.9 0 0 1 -.2 3.1 301.4 301.4 0 0 1 -45.9 21.8 1.9 1.9 0 0 0 -1 2.6 391.1 391.1 0 0 0 30 48.8 1.9 1.9 0 0 0 2.1 .7A486 486 0 0 0 610.7 405.7a1.9 1.9 0 0 0 .8-1.4C623.7 277.6 590.9 167.5 524.5 69.8zM222.5 337.6c-29 0-52.8-26.6-52.8-59.2S193.1 219.1 222.5 219.1c29.7 0 53.3 26.8 52.8 59.2C275.3 311 251.9 337.6 222.5 337.6zm195.4 0c-29 0-52.8-26.6-52.8-59.2S388.4 219.1 417.9 219.1c29.7 0 53.3 26.8 52.8 59.2C470.7 311 447.5 337.6 417.9 337.6z"></path></svg></a><a href="https://github.com/SignalK/signalk-server" target="_blank" rel="noopener" class="toolbar-icon visible@s" aria-label="Discord"><svg width="24" height="24" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 496 512"><path d="M165.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3 .3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6zm-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5 .3-6.2 2.3zm44.2-1.7c-2.9 .7-4.9 2.6-4.6 4.9 .3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9zM244.8 8C106.1 8 0 113.3 0 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8zM97.2 352.9c-1.3 1-1 3.3 .7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1zm-10.8-8.1c-.7 1.3 .3 2.9 2.3 3.9 1.6 1 3.6 .7 4.3-.7 .7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3 .7zm32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3 .7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1zm-11.4-14.7c-1.6 1-1.6 3.6 0 5.9 1.6 2.3 4.3 3.3 5.6 2.3 1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2z"></path></svg></a><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../../Developing.html">Developing</a></li><li><a href="../REST_APIs.html">REST APIs</a></li><li><a href="" aria-current="page">History API</a></li></ul></div><div class="tsd-panel tsd-typography"><h1 id="history-api" class="tsd-anchor-link">History API<a href="#history-api" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../../assets/icons.svg#icon-anchor"></use></svg></a></h1><p>The <em>History API</em> provides access to historical data, typically stored in a database. The actual storage backend is not defined by this API and can be implemented in various ways, typically as a plugin like <a href="https://www.npmjs.com/package/signalk-parquet">signalk-parquet</a> and <a href="https://www.npmjs.com/package/signalk-to-influxdb2">signalk-to-influxdb2</a>. The most common use case for the API is to show graphs of past values.</p>
<p>The API is available under the path <code>/signalk/v2/api/history</code>.</p>
<p><em>Note: You can view the _History API</em> OpenAPI definition in the Admin UI (Documentation => OpenApi)._</p>
<hr>
<h2 id="time-range-parameters" class="tsd-anchor-link">Time Range Parameters<a href="#time-range-parameters" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../../assets/icons.svg#icon-anchor"></use></svg></a></h2><p>The time range for queries can be defined as a combination of <strong>from</strong>, <strong>to</strong> and <strong>duration</strong> parameters.</p>
<ul>
<li><strong>from</strong>: Start of the time range, inclusive as ISO 8601 timestamp (e.g. <code>2018-03-20T09:13:28Z</code>)</li>
<li><strong>to</strong>: End of the time range, inclusive. Defaults to 'now' if omitted.</li>
<li><strong>duration</strong>: Duration of the time range in milliseconds (integer) or as an ISO8601 Duration string (e.g. <code>PT15M</code>). Can be specified with either 'from' or 'to'. If they are both omitted is relative to 'now'.</li>
</ul>
<h2 id="retrieving-historical-data" class="tsd-anchor-link">Retrieving Historical Data<a href="#retrieving-historical-data" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../../assets/icons.svg#icon-anchor"></use></svg></a></h2><p>To retrieve historical data series for specific paths, submit a HTTP <code>GET</code> request to <code>/signalk/v2/api/history/values</code>.</p>
<pre><code class="typescript"><span class="hl-2">HTTP</span><span class="hl-0"> </span><span class="hl-2">GET</span><span class="hl-0"> </span><span class="hl-4">'http://hostname:3000/signalk/v2/api/history/values?paths=navigation.speedOverGround&duration=PT1H'</span>
</code><button type="button">Copy</button></pre>
<h3 id="query-parameters" class="tsd-anchor-link">Query Parameters<a href="#query-parameters" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../../assets/icons.svg#icon-anchor"></use></svg></a></h3><table>
<thead>
<tr>
<th>Parameter</th>
<th>Description</th>
<th>Required</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>paths</code></td>
<td>Comma separated list of Signal K paths whose data should be retrieved. Optional aggregation methods for each path as postfix separated by a colon. Aggregation methods: 'average' | 'min' | 'max' | 'first' | 'last' | 'mid' | 'middle_index'. Example: <code>navigation.speedOverGround,navigation.speedThroughWater:max</code></td>
<td>Yes</td>
</tr>
<tr>
<td><code>context</code></td>
<td>Signal K context that the data is about, defaults to 'vessels.self'. Example: <code>vessels.urn:mrn:imo:mmsi:123456789</code></td>
<td>No</td>
</tr>
<tr>
<td><code>resolution</code></td>
<td>Length of data sample time window in milliseconds or as a time expression ('1s', '1m', '1h', '1d'). If resolution is not specified the server should provide data in a reasonable time resolution, depending on the time range in the request.</td>
<td>No</td>
</tr>
<tr>
<td><code>from</code></td>
<td>Start of the time range</td>
<td>No</td>
</tr>
<tr>
<td><code>to</code></td>
<td>End of the time range</td>
<td>No</td>
</tr>
<tr>
<td><code>duration</code></td>
<td>Duration of the time range</td>
<td>No</td>
</tr>
</tbody>
</table>
<h3 id="response-format" class="tsd-anchor-link">Response Format<a href="#response-format" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../../assets/icons.svg#icon-anchor"></use></svg></a></h3><p>The response contains the requested data series with header information.</p>
<pre><code class="JSON"><span class="hl-0">{</span><br/><span class="hl-0"> </span><span class="hl-3">"context"</span><span class="hl-0">: </span><span class="hl-4">"vessels.urn:mrn:imo:mmsi:123456789"</span><span class="hl-0">,</span><br/><span class="hl-0"> </span><span class="hl-3">"range"</span><span class="hl-0">: {</span><br/><span class="hl-0"> </span><span class="hl-3">"from"</span><span class="hl-0">: </span><span class="hl-4">"2018-03-20T09:12:28Z"</span><span class="hl-0">,</span><br/><span class="hl-0"> </span><span class="hl-3">"to"</span><span class="hl-0">: </span><span class="hl-4">"2018-03-20T09:13:28Z"</span><br/><span class="hl-0"> },</span><br/><span class="hl-0"> </span><span class="hl-3">"values"</span><span class="hl-0">: [</span><br/><span class="hl-0"> {</span><br/><span class="hl-0"> </span><span class="hl-3">"path"</span><span class="hl-0">: </span><span class="hl-4">"navigation.speedOverGround"</span><span class="hl-0">,</span><br/><span class="hl-0"> </span><span class="hl-3">"method"</span><span class="hl-0">: </span><span class="hl-4">"average"</span><br/><span class="hl-0"> }</span><br/><span class="hl-0"> ],</span><br/><span class="hl-0"> </span><span class="hl-3">"data"</span><span class="hl-0">: [</span><br/><span class="hl-0"> [</span><span class="hl-4">"2023-11-09T02:45:38.160Z"</span><span class="hl-0">, </span><span class="hl-2">13.2</span><span class="hl-0">],</span><br/><span class="hl-0"> [</span><span class="hl-4">"2023-11-09T02:45:39.160Z"</span><span class="hl-0">, </span><span class="hl-2">13.4</span><span class="hl-0">]</span><br/><span class="hl-0"> ]</span><br/><span class="hl-0">}</span>
</code><button type="button">Copy</button></pre>
<p>The <code>data</code> array contains arrays where the first element is the timestamp in ISO 8601 format, and subsequent elements correspond to the values for the requested paths in order. Missing data for a path is returned as <code>null</code>.</p>
<h2 id="listing-available-contexts" class="tsd-anchor-link">Listing Available Contexts<a href="#listing-available-contexts" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../../assets/icons.svg#icon-anchor"></use></svg></a></h2><p>To get a list of contexts that have some historical data available for a specified time range, submit a HTTP <code>GET</code> request to <code>/signalk/v2/api/history/contexts</code>.</p>
<pre><code class="typescript"><span class="hl-2">HTTP</span><span class="hl-0"> </span><span class="hl-2">GET</span><span class="hl-0"> </span><span class="hl-4">'http://hostname:3000/signalk/v2/api/history/contexts?duration=P1D'</span>
</code><button type="button">Copy</button></pre>
<h3 id="response-format-1" class="tsd-anchor-link">Response Format<a href="#response-format-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../../assets/icons.svg#icon-anchor"></use></svg></a></h3><p>Returns an array of context strings.</p>
<pre><code class="JSON"><span class="hl-0">[</span><br/><span class="hl-0"> </span><span class="hl-4">"vessels.urn:mrn:imo:mmsi:123456789"</span><span class="hl-0">,</span><br/><span class="hl-0"> </span><span class="hl-4">"vessels.urn:mrn:imo:mmsi:987654321"</span><br/><span class="hl-0">]</span>
</code><button type="button">Copy</button></pre>
<h2 id="listing-available-paths" class="tsd-anchor-link">Listing Available Paths<a href="#listing-available-paths" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../../assets/icons.svg#icon-anchor"></use></svg></a></h2><p>To get a list of paths that have some historical data available for a specified time range, submit a HTTP <code>GET</code> request to <code>/signalk/v2/api/history/paths</code>.</p>
<pre><code class="typescript"><span class="hl-2">HTTP</span><span class="hl-0"> </span><span class="hl-2">GET</span><span class="hl-0"> </span><span class="hl-4">'http://hostname:3000/signalk/v2/api/history/paths?duration=P1D'</span>
</code><button type="button">Copy</button></pre>
<h3 id="response-format-2" class="tsd-anchor-link">Response Format<a href="#response-format-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../../assets/icons.svg#icon-anchor"></use></svg></a></h3><p>Returns an array of path strings.</p>
<pre><code class="JSON"><span class="hl-0">[</span><br/><span class="hl-0"> </span><span class="hl-4">"navigation.speedOverGround"</span><span class="hl-0">,</span><br/><span class="hl-0"> </span><span class="hl-4">"navigation.courseOverGroundTrue"</span><br/><span class="hl-0">]</span>
</code><button type="button">Copy</button></pre>
</div></div><div class="col-sidebar"><div class="page-menu"><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#time-range-parameters"><span>Time <wbr/>Range <wbr/>Parameters</span></a><a href="#retrieving-historical-data"><span>Retrieving <wbr/>Historical <wbr/>Data</span></a><ul><li><a href="#query-parameters"><span>Query <wbr/>Parameters</span></a></li><li><a href="#response-format"><span>Response <wbr/>Format</span></a></li></ul><a href="#listing-available-contexts"><span>Listing <wbr/>Available <wbr/>Contexts</span></a><ul><li><a href="#response-format-1"><span>Response <wbr/>Format</span></a></li></ul><a href="#listing-available-paths"><span>Listing <wbr/>Available <wbr/>Paths</span></a><ul><li><a href="#response-format-2"><span>Response <wbr/>Format</span></a></li></ul></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../../modules.html">Signal K</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>