---
title: "Signal"
method: GET
path: "/sites/{site}/signals/{signal_id}"
tags: ["Signals"]
---

# Signal

`GET /sites/{site}/signals/{signal_id}`

## Request

- Base URL: `https://api.onelence.com/v1`
- URL: `https://api.onelence.com/v1/sites/{site}/signals/{signal_id}`
- Auth: one of:
  - OAuth 2 (authorization code, authorization URL `https://api.onelence.com/oauth/authorize`, token URL `https://api.onelence.com/oauth/token`, scopes: `decisions:read`)
  - HTTP bearer

One signal by id, including suppressed ones.

## Path parameters

- `site` string, required
- `signal_id` string, required

## Response `200`

Success.

- object
  - `object` 'signal', required
  - `id` string, required
  - `kind` 'observation', required
  - `title` string, nullable, required
  - `summary` string, nullable, required
  - `subject` object, required
    - `kind` string, nullable, required
    - `id` string, nullable, required
    - `label` string, nullable, required
  - `source_ids` string[], required
  - `metric` string, required
  - `unit` string, nullable, required
  - `direction` string, nullable, required
  - `materiality` string, nullable, required
  - `stability` string, nullable, required
  - `status` 'active' | 'expired' | 'retracted' | 'superseded', required
  - `group` 'active' | 'recent', required
  - `current_window` object, required
    - `start` string, required
    - `end` string, required
  - `comparison_window` object, nullable, required
    - `start` string, required
    - `end` string, required
  - `current` object, required
    - `state` 'measured' | 'missing' | 'unavailable' | 'not_applicable', required
    - `value` number, nullable, required
    - `currency` string, nullable, required
  - `comparison` object, required
    - `state` 'measured' | 'missing' | 'unavailable' | 'not_applicable', required
    - `value` number, nullable, required
    - `currency` string, nullable, required
  - `change` object, required
    - `state` 'measured' | 'missing' | 'unavailable' | 'not_applicable', required
    - `value` number, nullable, required
    - `currency` string, nullable, required
  - `relative_change` object, required
    - `state` 'measured' | 'missing' | 'unavailable' | 'not_applicable', required
    - `value` number, nullable, required
    - `currency` string, nullable, required

## Other responses

- `400`: Invalid input; `error.param` names the field.
- `401`: Missing, expired or revoked token. WWW-Authenticate points to the resource metadata.
- `402`: subscription_required or upgrade_required; the error carries billing_url.
- `403`: insufficient_scope or admin_required.
- `404`: Unknown endpoint, site, source or record.
- `429`: Rate limited. Retry after Retry-After seconds.
- `500`: OneLence could not complete the request.

---

[API](https://skmtc.dev/onelence/apis/onelence-api.md) · [All operations](https://skmtc.dev/onelence/apis/onelence-api/llms.txt) · [OpenAPI document](https://skmtc.dev/onelence/apis/onelence-api/revisions/971c72fe9a42?raw)