List a component's recent events

GET

/components/{name}/events

const url = 'https://example.com/api/v1/components/example/events';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/v1/components/example/events

Returns the component’s recent log occurrences (the log-kind sink), newest first, bounded to the last 24 hours. Gated by component:read; an out-of-scope component is a non-disclosing 404.

Parameters

Path Parameters

name

required

The component’s unique name

string

The component’s unique name

Responses

200

application/json

object

$schema

A URL to the JSON Schema for this object.

string format: uri

component

required

string

events

required

Array<object> | null

object

attributes

Structured attributes, when the occurrence carried a JSON payload

instance

The series discriminator (e.g. the interface), when set

string

key

required

The property name of the log (e.g. syslog.line)

string

message

required

The occurrence message

string

property_type_id

required

The property’s uuid, the stable form of key

string

provenance

required

The lineage of the occurrence (observed for direct collection)

string

source

The interface type that produced the occurrence

string

required

When the occurrence was observed

string format: date-time

Example

{
  "$schema": "/api/v1/schemas/EventsOutputBody.json"
}

default

Error

application/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": "/api/v1/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"
}