Ga naar inhoud
buildinglinksbuildinglinks

Read the request log

GET
/api/v1/request-log
curl --request GET \
  --url 'https://example.com/api/v1/request-log?from=example&to=example' \
  --cookie bl_%3Cslug%3E_session=%3Cbl_%3Cslug%3E_session%3E

The data plane’s log of data requests of this participant (decisions #61, #62), from the log storage, as JSON Lines in time order, streamed hour by hour. A line with error (log_store_failed) ends a stream that failed halfway.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
from
required
string

Start, RFC 3339.

to
required
string

End, RFC 3339; at most 31 days after from.

level
string

The lowest level: error, warn or info (default).

counterparty
string

Only requests with this counterparty (a DID).

process
string

Only requests of this process (a transfer id).

Responses

Section titled “Responses”

200

Section titled “200”

One JSON object per logged request.

Media typeapplication/x-ndjson
object

Example generated

{}

400

Section titled “400”

from or to is not RFC 3339, the period is empty or longer than 31 days, or the level is unknown.

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"
  }
}

401

Section titled “401”

No valid session, DPoP-bound token or API key.

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"
  }
}

403

Section titled “403”

The caller lacks the role this operation needs; or a change with the session cookie came from a page of another site (cross_site_request, decisions #83).

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"
  }
}

503

Section titled “503”

log_store_not_configured: the connector has no log storage.

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"
  }
}