Ga naar inhoud

Report activity

POST
/api/v1/telemetry/events
curl --request POST \
--url https://example.com/api/v1/telemetry/events \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "events": [ { "at": "2026-04-15T12:00:00Z", "kind": "example", "counterparty_did": "example", "process_ref": "example" } ] }'

A member’s connector reports metadata of what happened (never payloads); only kept when the participant’s telemetry level is activity.

Media typeapplication/json
object
events
required

At most 1000 are kept per call.

Array<object>
object
at
required
string format: date-time
kind
required

E.g. negotiation.finalized, transfer.started.

string
counterparty_did
string | null
process_ref
string | null

Example generated

{
"events": [
{
"at": "2026-04-15T12:00:00Z",
"kind": "example",
"counterparty_did": "example",
"process_ref": "example"
}
]
}

OK.

Media typeapplication/json
object
accepted
required

How many events were stored; 0 when the participant’s level does not include activity.

integer format: int64
note
string | null

Example generated

{
"accepted": 1,
"note": "example"
}

Not authenticated.

Media typeapplication/json

The body of every failed call to a management API.

object
error
required
object
code
required

Stable, machine-readable: invalid_request, unauthenticated, forbidden, not_found, conflict, upstream_unavailable, unavailable, internal, or a more specific code of the operation.

string
message
required

For people; may change between versions.

string

Example

{
"error": {
"code": "not_found",
"message": "unknown negotiation"
}
}

Not an active member.

Media typeapplication/json

The body of every failed call to a management API.

object
error
required
object
code
required

Stable, machine-readable: invalid_request, unauthenticated, forbidden, not_found, conflict, upstream_unavailable, unavailable, internal, or a more specific code of the operation.

string
message
required

For people; may change between versions.

string

Example

{
"error": {
"code": "not_found",
"message": "unknown negotiation"
}
}