Company reviews

A company review is about dealing with you — the service, the delivery, the support — rather than about one thing you sell. It is what belongs on a homepage, in a footer, or beside a “contact us” form.

Collecting one

Mint an invitation without naming a product, and the review that comes back is about the business. This is the right shape for a service: a translation agency, a clinic, a contractor — anywhere the thing being judged is the work, not an item.

bash
curl -X POST https://trueavis.com/api/admin/invitations \
  -H "Authorization: Bearer sk_your_secret_key" \
  -H "Content-Type: application/json" \
  -d '{
    "customerEmail": "[email protected]",
    "customerName": "Amina",
    "orderRef": "ORDER-1042",
    "baseUrl": "https://your-site.com"
  }'
FieldRequiredWhat it does
customerEmailYesWho the invitation is for.
customerNameNoPre-fills the name on the review form.
orderRefNoYour own order number. Also what stops a retried webhook minting a second invitation.
baseUrlNoYour site. Given, the response includes a ready-made url; omitted, you build the link yourself from the token.

Showing them

The widget with no data-product shows the project’s reviews. To show only reviews about the business — excluding anything attached to a product — ask for the site scope:

html
<div data-trueavis data-key="pk_your_public_key"
     data-scope="site"></div>

What the rating counts

This is worth deciding deliberately, because there are three answers and they give different numbers:

ScopeCounts
data-scope="site"Only reviews with no product attached. The business itself.
data-product="slug"Only reviews of that product.
neither (default)Everything — company reviews and every product review, in one average.

The default merges the two

Left alone, a five-star product review raises your company average as well. That is often what a small shop wants, and it is not what larger review platforms do — they keep the two scores entirely separate. If you want that separation, set data-scope="site" on the widget that represents the business.

Whichever you choose, the average, the review count and the star distribution are computed together in a single pass, so the badge in your header and the list further down the page can never disagree about what your rating is.