reviews:list

List a product's published reviews with the DERIVED average and count, and how many are hidden

Effect: ask; Awaits an outcome — the call returns the response below.
Caller: public; The class of authority the caller must already hold, decided from the attested context with no round trip.
Cost: free; What one call costs, so you can budget before acting.
Reversible: yes; The effect can be undone by a later call.
Idempotent: yes; Safe to retry as-is.

Send it with your agent

One click hands your coding agent a prompt that registers the substrate, reads this contract, and makes the call. Launch opens the app; the others copy the prompt.

Claude Code

Codex

Cursor

Gemini CLI

Claude Desktop

ChatGPT

curl -X POST https://one.ie/api/ask/reviews:list \
  -H "Authorization: Bearer $ONE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"data": { "workspace": "acme", "pid": "prod_mug" }}'

The key is never in a link. npx -y @oneie/cli login writes it to ~/.config/oneie/key on your machine.

Request

Validated before dispatch — an invalid payload is refused with the fix, never half-applied.

workspace string required The seller's slug.
pid string required The product.
limit number optional Page size, default 20, clamped to 1..50.

Response

What comes back from the call.

ok boolean
average number | null Mean rating over published reviews, 2 decimals; null when there are none — never a default.
count number EXACT count of published reviews.
hidden number Count of reviews the seller hid.
returned number
truncated boolean True when `returned` < `count` — this page is short of the whole.
reviews any Fenced foreign data: rows of { rid, rating, body, vid, createdAt }. No buyer hash, no order id.
error string

Traffic

Every call to reviews:list, counted where it is dispatched — over HTTP or in-process alike. Aggregate only — no actor, no payload, no workspace.

Counting…

Wiring

Every place in the open source that names reviews:list, and the file that answers it. Read from the tree at build time — a receiver is reached by NAME through one door, so there is no import edge to follow and a grep is the honest shape of the question. Structure, not volume — the count is in Traffic above.

Called from

API route 1

one.ie/web/src/lib/receiver-index.generated.ts:287

→

Answered by

reviews:list one.ie/web/src/lib/resolvers/reviews.ts:49 Dispatched through POST /api/ask/reviews:list, after the envelope validates the payload.

reviews family · 2 more

reviews:moderate reviews:write

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "workspace": {
      "type": "string",
      "description": "The seller's slug."
    },
    "pid": {
      "type": "string",
      "description": "The product."
    },
    "limit": {
      "description": "Page size, default 20, clamped to 1..50.",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991
    }
  },
  "required": [
    "workspace",
    "pid"
  ]
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "ok": {
      "type": "boolean"
    },
    "average": {
      "description": "Mean rating over published reviews, 2 decimals; null when there are none — never a default.",
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ]
    },
    "count": {
      "description": "EXACT count of published reviews.",
      "type": "number"
    },
    "hidden": {
      "description": "Count of reviews the seller hid.",
      "type": "number"
    },
    "returned": {
      "type": "number"
    },
    "truncated": {
      "description": "True when `returned` < `count` — this page is short of the whole.",
      "type": "boolean"
    },
    "reviews": {
      "description": "Fenced foreign data: rows of { rid, rating, body, vid, createdAt }. No buyer hash, no order id."
    },
    "error": {
      "type": "string"
    }
  },
  "additionalProperties": {}
}