Skip to content
Exhale

A glance at what comes next

GET
/api/v1/glance
curl --request GET \
  --url http://127.0.0.1:8484/api/v1/glance \
  --header 'Authorization: Bearer <token>'

The next charges with their amounts already written for the member’s language, what the next 30 days cost per currency, and whether this computer is kept awake. Made for small places: the menu bar icon, a widget.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
limit
integer format: int64
<= 20

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
$schema

A URL to the JSON Schema for this object.

string format: uri
charges
required
Array<object> | null
object
amount
required
string
date
required
string
daysUntil
required
integer format: int64
kind
required
string
Allowed values: renewal trial expiry
name
required
string
subscriptionId
required
string
keepAwake
required
object
$schema

A URL to the JSON Schema for this object.

string format: uri
batteryFloor
required
integer format: int64
<= 95
from
required
string
keepDisplayOn
required
boolean
lidClosed
required
boolean
mode
required
string
Allowed values: off always hours
onlyOnPower
required
boolean
session
object
active
required
boolean
left
integer format: int64
until
string
status
required
object
error
string
lid
required
string
Allowed values: off active setup unavailable failed
lidError
string
power
object
hasBattery
required
boolean
onBattery
required
boolean
percent
required
integer format: int64
reason
string
Allowed values: container unsupported other power battery
session
required
boolean
state
required
string
Allowed values: off active waiting paused unavailable failed unknown
until
string
timezone
required
string
to
required
string
language
required
string
overdue
required
integer format: int64
today
required
string
totals
required
Array<string> | null

Example 

{
  "$schema": "https://example.com/api/schemas/Glance.json",
  "charges": [
    {
      "kind": "renewal"
    }
  ],
  "keepAwake": {
    "$schema": "https://example.com/api/schemas/KeepAwakeInfo.json",
    "mode": "off",
    "status": {
      "lid": "off",
      "reason": "container",
      "state": "off"
    }
  }
}

default

Section titled “default”

Error

Media typeapplication/problem+json
object
$schema

A URL to the JSON Schema for this object.

string format: uri
detail

A human-readable explanation specific to this occurrence of the problem.

string
errors

Optional list of individual error details

Array<object> | null
object
location

Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’

string
message

Error message text

string
value

The value at the given location

instance

A URI reference that identifies the specific occurrence of the problem.

string format: uri
status

HTTP status code

integer format: int64
title

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string
type

A URI reference to human-readable documentation for the error.

string format: uri
default: about:blank

Example 

{
  "$schema": "https://example.com/api/schemas/ErrorModel.json",
  "detail": "Property foo is required but is missing.",
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}