Items

Count linked items and rows

Returns, for each of up to 100 items, how many active items an edge type links to it, by status group, or how many rows it holds in one table. Name exactly one of backref, edge and table.

POST
/items/counts

Authorization

bearerAuth
headerAuthorizationBearer <token>

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

Header parameters

X-Marfa-Instance-Id?string

The ID of the instance you expect, as GET / returns it. If another instance answers at this address, Marfa returns 409 instance_changed and doesn't write. Leave it out to send the request to whichever instance answers.

Match^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

Request body

application/json
  1. body
ids*array<string>

The IDs of the items to count for, at most 100. An ID named twice is answered once.

backref?string

An edge type. Counts the active items that edges of this type leave each item for, as backref[<edge type>] selects them: parent-of counts children.

edge?string

An edge type. Counts the active items that have an edge of this type to each item, as edge[<edge type>] selects them: in-collection counts a collection's members.

table?string

A table name. Counts the rows each item holds in that table. An item whose type declares no such table counts 0.

Response body

About errors

Returns one count for each ID, in the order ids named them.

application/json
  1. response
counts*array<>

The counts, in the order ids named them, each ID once.

  • missing_required_field: ids is missing.
  • validation_error: ids is not a list or has more than 100 IDs, none or more than one of backref, edge and table is named, an edge type or a table name is blank or malformed, or the body has a field this endpoint doesn't take.
  • invalid_id: an ID in ids is not a valid item ID.
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. If it reaches some types, items of the others are left out instead.
  • edge_type_not_permitted: you can't read the edge type.
application/json
  1. response

An error response.

error*

What went wrong.

request_timeout: the request body didn't arrive whole within 180 seconds. Nothing changed, and Marfa closed the connection. Send the request again. A body larger than about 21 MiB can't arrive in that time over a 1 Mbit/s link, so send it in smaller requests.

application/json
  1. response

An error response.

error*

What went wrong.

instance_changed: X-Marfa-Instance-Id names another instance. Nothing is written. Rebuild the working copy from the instance at this address.

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.

request_too_large: the request body is larger than this instance accepts.

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 POST 'http://localhost:8600/items/counts' \  -H 'Content-Type: application/json' \  -d '{  "ids": [    "string"  ]}'
About errors
{  "counts": [    {      "id": "01a1011a-4902-76cf-a4a9-88e99c038c8d",      "total": 7,      "status_groups": {        "not_started": 2,        "in_progress": 1,        "completed": 3,        "canceled": 1      }    },    {      "id": "01a1011c-2f86-76b6-9594-050c109f4957",      "total": 0,      "status_groups": {        "not_started": 0,        "in_progress": 0,        "completed": 0,        "canceled": 0      }    }  ]}