API Reference

Get metrics list

get
https://app.{clusterId}.lightup.ai/api//ws//metrics/

List all metrics based on query parameters

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
enum
required
Defaults to v1

An enumeration.

Allowed:
string
required

UUID of the workspace; visible in the workspace URL.

Query Params
string
enum

Filter by type of metric

Allowed:
string

Filter by name of the metric

boolean

Filter by whether metric is live or not

source_uuids
array of strings

Filter by list of source uuids

source_uuids
string

Filter by schema_uuid

table_uuids
array of strings

Filter by list of table uuids

table_uuids
column_uuids
array of strings

Filter by list of column uuids

column_uuids
monitor_uuids
array of strings

Filter by list of monitor uuids

monitor_uuids
metric_uuids
array of strings

Filter by list of metric uuids

metric_uuids
integer

Return metrics from offset

integer

Return only limit number of metrics

Headers
string
required

Input 'Bearer access-token'. To obtain access token, see API, API Credentials: Get access token.

Response

Updated 7 months ago

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 7 months ago