Event history

POST /api/scan/v0/events

Request

curl --request POST \
  --url 'https://scan.sv-1.global.canton.network.sync.global/api/scan/v0/events' \
  --header 'Content-Type: application/json' \
  --data '{"after":{"after_migration_id":0,"after_record_time":"string"},"page_size":0,"daml_value_encoding":"compact_json"}'

200 response

{
  "events": [
    {}
  ]
}

Scan API

Event history

OpenAPISince 0.5.10Changed 0.6.10

Returns the event history in ascending order, paged, from ledger begin or optionally starting after a record time. An event bears some combination of a transaction, a contract reassignment, and a verdict. Events are ordered lexicographically by (migration id, record time). For a given migration id, each event has a unique record time.

Protocol Details

Operation IDgetEventHistory

Published0.7.4

SpecificationDownload OpenAPI

Inputs

Request body

application/json

after · object

OpenAPI type: UpdateHistoryRequestAfter.

page_size · number · required

OpenAPI type: integer (int32).

The maximum number of events returned for this request.

daml_value_encoding · object

OpenAPI type: DamlValueEncoding.

How daml values should be encoded in the response. “compact_json” is a compact, human-readable JSON encoding. It is the same encoding as the one used in the HTTP JSON API or the JavaScript codegen. “protobuf_json” is a verbose JSON encoding that is more difficult to parse, but contains type information, i.e., the values can be parsed losslessly without having access to the Daml source code. Optional and defaults to “compact_json”.

Outputs

200

application/json

events · EventHistoryItem[] · required

400

application/json

error · string · required

500

application/json

error · string · required

History

Changed0.6.10

The POST /v0/events operation changed in this snapshot.

Changed0.6.0

The POST /v0/events operation changed in this snapshot.

Changed0.5.17

The POST /v0/events operation changed in this snapshot.

Changed0.5.15

The POST /v0/events operation changed in this snapshot.

Introduced0.5.10

Request

curl --request POST \
  --url 'https://scan.sv-1.global.canton.network.sync.global/api/scan/v0/events' \
  --header 'Content-Type: application/json' \
  --data '{"after":{"after_migration_id":0,"after_record_time":"string"},"page_size":0,"daml_value_encoding":"compact_json"}'

200 response

{
  "events": [
    {}
  ]
}