List Reports

Example Request

{
  "jsonrpc": "2.0",
  "method": "cartesi_listReports",
  "params": {
    "application": "<name-or-address>",
    "limit": 10,
    "offset": 0
  },
  "id": 1
}

The cartesi_listReports method returns a paginated list of reports for a specific application.

Parameters

Name	Type	Required	Description
application	string	Yes	The application's name or hex encoded address
epoch_index	string	No	Optional filter by epoch index (hex encoded)
input_index	string	No	Optional filter by input index (hex encoded)
limit	number	No	Maximum number of reports to return (default: 50, minimum: 1)
offset	number	No	Starting point for the list (default: 0, minimum: 0)

Response

{
  "jsonrpc": "2.0",
  "result": {
    "data": [
      {
        "epoch_index": "0x1",
        "input_index": "0x1",
        "index": "0x1",
        "raw_data": "0x48656c6c6f",
        "created_at": "2024-01-01T00:00:00Z",
        "updated_at": "2024-01-01T00:00:00Z"
      }
    ],
    "pagination": {
      "total_count": 1,
      "limit": 50,
      "offset": 0
    }
  },
  "id": 1
}

Response Fields

Data

Name	Type	Description
epoch_index	string	The epoch index this report belongs to (hex encoded)
input_index	string	The input index this report belongs to (hex encoded)
index	string	The report index (hex encoded)
raw_data	string	The report payload in hexadecimal format
created_at	string	Timestamp when the report was created
updated_at	string	Timestamp when the report was last updated

Pagination

Name	Type	Description
total_count	number	Total number of reports available
limit	number	Number of reports returned in this response
offset	number	Starting point of the returned reports

Error Codes

Code	Message	Description
-32602	Invalid params	Invalid parameter values
-32603	Internal error	An internal error occurred
-32000	Application not found	The specified application does not exist