Requests Made from the Client

The Auspice client will make a number of requests to various endpoints, which this document aims to provide an overview of. Some of these are dependent on the build-time customisations in use, and we plan to allow more flexibility here using this mechanism.

Requests to the Auspice Server

For the purposes of this section we are assuming you are running locally on “localhost:4000”, however the idea is the same if Auspice is deployed to a server.

Auspice Client JavaScript Code

The (bundled) client code (which is generated by auspice build) is broken up into a number of “chunks” which are delivered to the client as needed. These originate from the following block in the index.html file:

<script async src="/dist/auspice.bundle.js"></script>

“Charon” GET requests

When a dataset, narrative, or listing of available datasets is to be displayed in Auspice, a selection of the following requests are made to localhost:4000.

• /charon/getAvailable – return a list of available datasets and narratives

• /charon/getDataset – return the requested dataset

• /charon/getNarrative – return the requested narrative

See the server API documentation for more details about the requests, or the client customisation API for the ability to change “/charon” to a different value.

Image Requests

The initial Auspice page (i.e. the one which displays a listing of available datasets) requests some images for the footer.

External Requests

Leaflet + MapLibre GL

We use Leaflet with MapLibre GL JS to display the map. MapLibre renders Mapbox Vector Tiles (MVT) client-side from a Mapbox style URL. Map tiles, sprites and fonts are requested from OpenFreeMap by default.

Note

Where map assets are sourced from may be modified at build time, see see the client customisation API documentation for more.

Web Analytics (Optional)

By default Auspice has no telemetry / tracking. There is an opt-in customisation to use Plausible Analytics, see the client customisation API documentation for how to set this when you build the Auspice client.

Note: For nextstrain.org we do customise the Auspice client to use Plausible Analytics.)