Skip to content
Daemun

Custom API

This widget can show information from custom self-hosted or third party API.

Fields need to be defined in the mappings section YAML object to correlate with the value in the APIs JSON object. Final field definition needs to be the key with the desired value information.

widget:
  type: customapi
  url: http://custom.api.host.or.ip:port/path/to/exact/api/endpoint
  refreshInterval: 10000 # optional - in milliseconds, defaults to 10s
  username: username # auth - optional
  password: password # auth - optional
  method: GET # optional, e.g. POST
  headers: # optional, must be object, see below
  requestBody: # optional, can be string or object, see below
  display: # optional, default to block, see below
  mappings:
    - field: key
      label: Field 1
      format: text # optional - defaults to text
    - field: path.to.key2
      format: number # optional - defaults to text
      label: Field 2
    - field: path.to.another.key3
      label: Field 3
      format: percent # optional - defaults to text
    - field: key
      label: Field 4
      format: date # optional - defaults to text
      locale: nl # optional
      dateStyle: long # optional - defaults to "long". Allowed values: `["full", "long", "medium", "short"]`.
      timeStyle: medium # optional - Allowed values: `["full", "long", "medium", "short"]`.
    - field: key
      label: Field 5
      format: relativeDate # optional - defaults to text
      locale: nl # optional
      style: short # optional - defaults to "long". Allowed values: `["long", "short", "narrow"]`.
      numeric: auto # optional - defaults to "always". Allowed values `["always", "auto"]`.
    - field: key
      label: Field 6
      format: text
      additionalField: # optional
        field: hourly.time.key
        color: theme # optional - defaults to "". Allowed values: `["theme", "adaptive", "black", "white"]`.
        format: date # optional
    - field: key
      label: Number of things in array
      format: size
    # This (no field) will take the root of the API response, e.g. when APIs return an array:
    - label: Number of items
      format: size

Supported formats for the values are text, number, float, percent, duration, bytes, bitrate, size, date and relativeDate.

The dateStyle and timeStyle options of the date format are passed directly to Intl.DateTimeFormat and the style and numeric options of relativeDate are passed to Intl.RelativeTimeFormat.

The duration format expects the duration to be specified in seconds. The scale transformation tool can be used if a conversion is required.

The size format will return the length of the array or string, or the number of keys in an object. This is then formatted as number.

Example

Section titled “Example”

For the following JSON object from the API:

{
  "id": 1,
  "name": "Rick Sanchez",
  "status": "Alive",
  "species": "Human",
  "gender": "Male",
  "origin": {
    "name": "Earth (C-137)"
  },
  "locations": [
    {
      "name": "Earth (C-137)"
    },
    {
      "name": "Citadel of Ricks"
    }
  ]
}

Define the mappings section as an array, for example:

mappings:
  - field: name # Rick Sanchez
    label: Name
  - field: status # Alive
    label: Status
  - field: origin.name # Earth (C-137)
    label: Origin
  - field: locations.1.name # Citadel of Ricks
    label: Location

Note that older versions of the widget accepted fields as a yaml object, which is still supported. E.g.:

mappings:
  - field:
      locations:
        1: name # Citadel of Ricks
    label: Location

Data Transformation

Section titled “Data Transformation”

You can manipulate data with the following tools remap, scale, prefix and suffix, for example:

- field: key4
  label: Field 4
  format: text
  remap:
    - value: 0
      to: None
    - value: 1
      to: Connected
    - any: true # will map all other values
      to: Unknown
- field: key5
  label: Power
  format: float
  scale: 0.001 # can be number or string e.g. 1/16
  suffix: "kW"
- field: key6
  label: Price
  format: float
  prefix: "$"

Display Options

Section titled “Display Options”

The widget supports different display modes that can be set using the display property.

Block View (Default)

Section titled “Block View (Default)”

The default display mode is block, which shows fields in a block format.

!!! note

The Custom API widget does not currently support [block highlighting](../../configs/services/#block-highlighting) in any display mode.

List View

Section titled “List View”

You can change the default block view to a list view by setting the display option to list.

The list view can optionally display an additional field next to the primary field.

additionalField: Similar to field, but only used in list view. Displays additional information for the mapping object on the right.

field: Defined the same way as other custom api widget fields.

color: Allowed options: "theme", "adaptive", "black", "white". The option adaptive will apply a color using the value of the additionalField, green for positive numbers, red for negative numbers.

- field: key
  label: Field
  format: text
  remap:
    - value: 0
      to: None
    - value: 1
      to: Connected
    - any: true # will map all other values
      to: Unknown
  additionalField:
    field: hourly.time.key
    color: theme
    format: date

Dynamic List View

Section titled “Dynamic List View”

To display a list of items from an array in the API response, set the display property to dynamic-list and configure the mappings object with the following properties:

widget:
  type: customapi
  url: https://example.com/api/servers
  display: dynamic-list
  mappings:
    items: data # optional, the path to the array in the API response. Omit this option if the array is at the root level
    name: id # required, field in each item to use as the item name (left side)
    label: ip_address # required, field in each item to use as the item label (right side)
    limit: 5 # optional, limit the number of items to display
    format: text # optional - format of the label field
    target: https://example.com/server/{id} # optional, makes items clickable with template support

This configuration would work with an API that returns a response like:

{
  "data": [
    { "id": "server1", "name": "Server 1", "ip_address": "192.168.0.1" },
    { "id": "server2", "name": "Server 2", "ip_address": "192.168.0.2" }
  ]
}

The widget would display a list with two items:

For nested fields in the items, you can use dot notation:

mappings:
  items: data.results.servers
  name: details.id
  label: details.name

Custom Headers

Section titled “Custom Headers”

Pass custom headers using the headers option, for example:

headers:
  X-API-Token: token

Custom Request Body

Section titled “Custom Request Body”

Pass custom request body using the requestBody option in either a string or object format. Objects will automatically be converted to a JSON string.

requestBody:
  foo: bar
# or
requestBody: "{\"foo\":\"bar\"}"

Both formats result in {"foo":"bar"} being sent as the request body. Don’t forget to set your Content-Type headers!