Skip to content
StartupBuilder
by startups.studio
by Startups.Studio
Code
Changelog
APIGrowthReview

Review routes: create, get, list

The Review Verbs create, get, list as api.sb routes, with inputs, result, refusals and an example.

Reference for Review, one group of Review routes.

Review.create

Creates a Review. Verb page.

Text
POST /{namespace}/reviews

Body, as JSON: the inputs. Emits Review.created.

Inputs

InputTypeRequiredDescription
ratingintegerrequiredThe score, from 1 to 5.
bodytextThe reviewer’s words.
venuestringThe venue it was posted on, by id; empty for the Startup’s own Site.
displayConsentbooleanTrue once the reviewer agreed it may be shown on the Startup’s own Pages. Never randomized.
customerCustomerThe Customer who wrote it, when known.
offerOfferA Review evaluates one Offer; Reviews of a Product or Brand roll up through its Offers.

Returns

OutputTypeRequiredDescription
reviewReviewrequiredThe Review.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl -X POST https://api.sb/leaseline.app/reviews \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"rating":1}'
JSON
{
  "api": "https://api.sb/leaseline.app",
  "review": {
    "$id": "https://api.sb/leaseline.app/reviews/review_1XPL2xTlfx",
    "$type": "Review",
    "rating": 1,
    "status": "submitted"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Review.create",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Review.get

Returns one Review by id. Verb page.

Text
GET /{namespace}/reviews/{id}

Path: id. Query: the other inputs. Reads only: it emits no Event.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Review.
atstringA time or Version name: the record as it stood then. Unset: as it stands now.

Returns

OutputTypeRequiredDescription
reviewReviewrequiredThe Review.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl https://api.sb/leaseline.app/reviews/review_1XPL2xTlfx \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Review",
  "$id": "https://api.sb/leaseline.app/reviews/review_1XPL2xTlfx",
  "review": {
    "$id": "https://api.sb/leaseline.app/reviews/review_1XPL2xTlfx",
    "$type": "Review",
    "rating": 1,
    "status": "submitted"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/reviews/review_1XPL2xTlfx",
    "up": "https://api.sb/leaseline.app/reviews"
  },
  "actions": {
    "publish": "https://api.sb/leaseline.app/reviews/review_1XPL2xTlfx/publish",
    "remove": "https://api.sb/leaseline.app/reviews/review_1XPL2xTlfx/remove",
    "withhold": "https://api.sb/leaseline.app/reviews/review_1XPL2xTlfx/withhold"
  }
}

Review.list

Returns Reviews, newest first, one page at a time. Verb page.

Text
GET /{namespace}/reviews

Query: the inputs. Reads only: it emits no Event.

Inputs

InputTypeRequiredDescription
limitintegerAt most this many records, up to 100. The default is 20.
afterstringThe cursor from the previous page.
wherestringA filter over the properties, such as paidAt = null and total.amount > 500.
sortstringProperties to sort by, comma-separated; a leading minus sorts descending.
totalbooleanTrue adds the match count as meta.total, exact up to 10,000 matches and estimated above.
facetsstringProperties to count by value, comma-separated, returned as meta.facets.
fieldsstringProperties to return on each record, comma-separated; $id and $type always return.
includestringRelated records to embed in place of their URLs, comma-separated.
depthintegerHow many levels of related records to embed. The default is 1.
qstringWords to match across the text properties, ranked by relevance.
matchstringRanks the search by words, or meaning; words is the default.

Returns

OutputTypeRequiredDescription
reviewslist of ReviewrequiredOne page of Reviews.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl "https://api.sb/leaseline.app/reviews?limit=20" \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Review",
  "reviews": [
    {
      "$id": "https://api.sb/leaseline.app/reviews/review_1XPL2xTlfx",
      "$type": "Review",
      "rating": 1,
      "status": "submitted"
    }
  ],
  "meta": {
    "limit": 20,
    "after": "review_1XPL2xTlfx"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/reviews?limit=20",
    "next": "https://api.sb/leaseline.app/reviews?after=review_1XPL2xTlfx"
  }
}

Review

Previous

update

Next