Scan API

Event history

OpenAPI Since 0.5.10 Changed 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 ID getEventHistory

Published 0.7.4

Specification Download OpenAPI

## Inputs ### Request body

application/json

OpenAPI type: `UpdateHistoryRequestAfter`. OpenAPI type: `integer (int32)`. The maximum number of events returned for this request. 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

### 400

application/json

### 500

application/json

## History

Changed 0.6.10

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

Changed 0.6.0

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

Changed 0.5.17

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

Changed 0.5.15

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

Introduced 0.5.10

```bash Request theme={null} 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"}' ``` ```json 200 response theme={null} { "events": [ {} ] } ```