Tables

Get table totals

Returns the total of each column that names adds_up, over the rows filter selects, or every row.

GET
/items/{id}/tables/{table}/totals

Authorization

bearerAuth
headerAuthorizationBearer <token>

Authenticate with an API key (marfa_k1_…) or an OAuth access token (marfa_at_…).

Path parameters

id*string

The ID of the item.

table*string

The name of the table.

Query parameters

filter?string

Only return rows that match this expression, in the item filter grammar, where values.<column> names a column and id and updated_at are the row's own.

Response body

About errors

Returns how many rows the filter selects and each column's total.

application/json
  1. response

The totals of a table's columns that add up, over the rows a filter selects.

row_count*integer

How many rows the filter selects.

Range0 <= value
totals*

For each column that names adds_up, an object with that way as its one key: sum and count are 0 over no values, and average, min and max are null.

  • invalid_id: the ID is not a valid item ID.
  • validation_error: a query parameter is unknown, or filter is malformed or names a column the table doesn't declare.
application/json
  1. response

An error response.

error*

What went wrong.

unauthorized: the request has no credential, or its credential is not valid. For a key that has expired, details.expired_at says when it expired.

application/json
  1. response

An error response.

error*

What went wrong.

  • type_not_permitted: your credential reaches no type.
application/json
  1. response

An error response.

error*

What went wrong.

  • item_not_found: no item has this ID, the item is in the trash (details.trashed is true if you can read its type), or its type is one you can't read.
  • table_not_found: the item's type declares no table of this name.
application/json
  1. response

An error response.

error*

What went wrong.

contract_mismatch: X-Marfa-Contract names another contract version than this instance speaks, or is not a whole number. Nothing was done.

application/json
  1. response

An error response.

error*

What went wrong.

rate_limited: you sent too many requests. Wait for the number of seconds in Retry-After, then try again.

application/json
  1. response

An error response.

error*

What went wrong.

internal_error: Marfa failed in a way it didn't expect, and the request may not have completed. Read what you changed before you repeat a write.

application/json
  1. response

An error response.

error*

What went wrong.

write_contention: the database was busy, and Marfa couldn't complete the request in time. Nothing changed. Try the request again. While a restore runs, details.reason is restore_running.

application/json
  1. response

An error response.

error*

What went wrong.

insufficient_storage: the disk that holds the instance's data has no room for the request, or the request would leave less free than the instance keeps in reserve. Nothing changed, unless details.write_outcome is unknown, which means the write may have landed: read what you changed before you repeat it. Free space on the disk, then try the request again.

application/json
  1. response

An error response.

error*

What went wrong.

curl -X GET 'http://localhost:8600/items/string/tables/string/totals'
About errors
{  "row_count": 2,  "totals": {    "amount": {      "sum": 20.5    },    "memo": {      "count": 1    }  }}