Get a Google review

import app from '@adonisjs/core/services/app'
import { SiteClient } from '@fetchski/attract-cms-sdk'

const site = await app.container.make(SiteClient)
const googleReview = await site.googleReviews().getGoogleReview({ id: 'clx8m2k4p0000a1b2c3d4e5f6' })

{
  "title": "Example title",
  "reviewerName": "Example reviewer name",
  "isAnonymous": false,
  "rating": 5,
  "reviewText": "Example review text",
  "reviewedAt": "2026-10-24",
  "featured": false,
  "slug": "example-slug",
  "visibility": "public",
  "scheduledPublish": "Example scheduled publish",
  "scheduledUnpublish": "Example scheduled unpublish",
  "reviewerPhotoUrl": "https://acme.example/example",
  "ownerReply": "Example owner reply",
  "replyState": "Example reply state",
  "replyPolicyViolation": "Example reply policy violation",
  "stagedReply": "Example staged reply",
  "stagedReplyAction": "Example staged reply action",
  "reviewUrl": "https://acme.example/example",
  "source": "manual",
  "sourceId": "clx8m2k4p0000a1b2c3d4e5f6",
  "gbpLocationId": "clx8m2k4p0000a1b2c3d4e5f6",
  "archived": false,
  "_id": "clx8m2k4p0000a1b2c3d4e5f6",
  "type": "Example type",
  "createdAt": "2026-10-24T09:30:00.000Z",
  "updatedAt": "2026-10-24T09:30:00.000Z",
  "aposShareKey": "k3v9x2m7q1z8w4p6"
}

import app from '@adonisjs/core/services/app'
import { SiteClient } from '@fetchski/attract-cms-sdk'

const site = await app.container.make(SiteClient)
const googleReview = await site.googleReviews().getGoogleReview({ id: 'clx8m2k4p0000a1b2c3d4e5f6' })

{
  "title": "Example title",
  "reviewerName": "Example reviewer name",
  "isAnonymous": false,
  "rating": 5,
  "reviewText": "Example review text",
  "reviewedAt": "2026-10-24",
  "featured": false,
  "slug": "example-slug",
  "visibility": "public",
  "scheduledPublish": "Example scheduled publish",
  "scheduledUnpublish": "Example scheduled unpublish",
  "reviewerPhotoUrl": "https://acme.example/example",
  "ownerReply": "Example owner reply",
  "replyState": "Example reply state",
  "replyPolicyViolation": "Example reply policy violation",
  "stagedReply": "Example staged reply",
  "stagedReplyAction": "Example staged reply action",
  "reviewUrl": "https://acme.example/example",
  "source": "manual",
  "sourceId": "clx8m2k4p0000a1b2c3d4e5f6",
  "gbpLocationId": "clx8m2k4p0000a1b2c3d4e5f6",
  "archived": false,
  "_id": "clx8m2k4p0000a1b2c3d4e5f6",
  "type": "Example type",
  "createdAt": "2026-10-24T09:30:00.000Z",
  "updatedAt": "2026-10-24T09:30:00.000Z",
  "aposShareKey": "k3v9x2m7q1z8w4p6"
}

In your app

A controller answers a route on your app: it calls getGoogleReview() and returns the answer.

Add the controller

app/controllers/get_google_review_controller.ts

import { inject } from '@adonisjs/core'
import type { HttpContext } from '@adonisjs/core/http'
import { SiteClient } from '@fetchski/attract-cms-sdk'

@inject()
export default class GetGoogleReviewController {
  constructor(protected site: SiteClient) {}

  async handle({ params }: HttpContext) {
    return this.site.googleReviews().getGoogleReview({ id: params.id })
  }
}

Add the route

start/routes.ts

import router from '@adonisjs/core/services/router'

const GetGoogleReviewController = () => import('#controllers/get_google_review_controller')

router.get('/google-review/:id', [GetGoogleReviewController])

Call it

Terminal

curl http://localhost:3333/google-review/clx8m2k4p0000a1b2c3d4e5f6

With node ace serve running, it prints its answer as JSON.

Find the id

id is the document’s _id, from a list. Ask the list for only the fields you need: each row is a document’s id and those fields.

AdonisJS

import app from '@adonisjs/core/services/app'
import { SiteClient } from '@fetchski/attract-cms-sdk'

const site = await app.container.make(SiteClient)
const row = (await site.googleReviews().listGoogleReviewsPick(['title', 'slug'])).find((each) => each.slug === 'getting-started') // { id, title, slug }, or undefined

Pass row.id as id. Drafts: list with { aposMode: 'draft' } to get the draft’s id (Find an id).

Required parameters

One object, e.g. getGoogleReview({ id }); leave out the optional fields.

string

required

Required. The document’s _id: a full id names its own locale and mode (the draft’s …:en:draft, the published one’s …:en:published; no aposMode needed), a bare aposDocId takes the request’s (aposLocale, aposMode).

Optional parameters

AposMode | null | undefined

Optional. Leave it out and the site uses "published". published (the default) or draft. Drafts need a credential that may see them: an API key with the type’s write scope (content:<type>:write), or a signed-in editor. The public and a key with only the read scope get 403. One of draft, published.

string | null | undefined

Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. The locale to read or write, e.g. en (default: the site’s default locale).

boolean | null | undefined

Optional. Leave it out and the site uses false. true: each area’s widgets come back rendered as HTML (_rendered), beside their data.

Returns

A GoogleReview. GoogleReview content type. Read its properties (googleReview.title): each says whether the site always sends it. The example answer is the site’s wire JSON: one key differs from the property names (_id → id).

string

Always sent. Its title: the name it goes by in every list, and the heading of its page where it has one.

string

Always sent. Reviewer name.

string

Always sent. The URL name: lowercase words joined by hyphens (letters outside a–z, even emoji, are kept).

string

Always sent. The document’s id. On a type with drafts it ends in its locale and mode (…:en:published, …:en:draft): the part before the first colon is its aposDocId, shared by both copies. The {_id} the type’s routes take.

string

Always sent. The document type’s name: always this type’s.

boolean | null

Sometimes sent: undefined when the site leaves it out, and it can be null. Set when Google returned no reviewer name. The frontend shows a generic label + initial avatar.

number | null

Sometimes sent: undefined when the site leaves it out, and it can be null. Rating (1–5).

string | null

Sometimes sent: undefined when the site leaves it out, and it can be null. Review text.

Date | null

Sometimes sent: undefined when the site leaves it out, and it can be null. Review date. Format: an ISO 8601 date (YYYY-MM-DD).

boolean | null

Sometimes sent: undefined when the site leaves it out, and it can be null. Hand-curation flag. The widget can be set to show only featured reviews.

Visibility | null

Sometimes sent: undefined when the site leaves it out, and it can be null. Select whether this content is public or private. One of public, loginRequired; a newer site may send others, so keep a fallback.

string | null

Sometimes sent: undefined when the site leaves it out, and it can be null. An ISO 8601 date and time, e.g. 2026-10-21T14:30:00.000Z.

string | null

Sometimes sent: undefined when the site leaves it out, and it can be null. An ISO 8601 date and time, e.g. 2026-10-21T14:30:00.000Z.

string | null

Sometimes sent: undefined when the site leaves it out, and it can be null. The reviewer’s Google avatar URL, stored as-is (not downloaded). The frontend renders it directly and falls back to a lettered avatar if missing or stale. When set, a URL; empty or null when not.

string | null

Sometimes sent: undefined when the site leaves it out, and it can be null. The business’s public reply to this review, if any.

string | null

Sometimes sent: undefined when the site leaves it out, and it can be null. Google moderates owner replies asynchronously: PENDING until reviewed, then APPROVED or REJECTED. Synced from the Business Profile API; blank for manual rows or replies predating moderation visibility.

string | null

Sometimes sent: undefined when the site leaves it out, and it can be null. The policy reason Google gave when it rejected the owner reply, if any.

string | null

Sometimes sent: undefined when the site leaves it out, and it can be null. A reply drafted in the Google Business Dashboard and not yet pushed to Google. Managed by the dashboard’s Review & push flow, never edited here.

string | null

Sometimes sent: undefined when the site leaves it out, and it can be null. What the staged reply will do when pushed: “reply” (create/update the owner reply) or “delete” (remove it). Blank when nothing is staged.

string | null

Sometimes sent: undefined when the site leaves it out, and it can be null. Permalink to the review on Google, when the provider supplies one. When set, a URL; empty or null when not.

GoogleReviewSource | null

Sometimes sent: undefined when the site leaves it out, and it can be null. Source. One of manual, places-api, business-profile, demo; a newer site may send others, so keep a fallback.

string | null

Sometimes sent: undefined when the site leaves it out, and it can be null. The review’s stable Google resource id — the de-duplication key set by a sync. Leave blank for manual entries.

string | null

Sometimes sent: undefined when the site leaves it out, and it can be null. The Google Business Profile location this review belongs to (bare location id) — set by the Business Profile sync; ties the review to its gbp-location mirror row and the dashboard’s Reviews section.

boolean | null

Sometimes sent: undefined when the site leaves it out, and it can be null. In the archive: kept, but out of every list and off the site until it is restored. false (or null) for a live document.

Date | null

Sometimes sent: undefined when the site leaves it out, and it can be null. When it was created (ISO 8601). Format: an ISO 8601 date and time.

Date | null

Sometimes sent: undefined when the site leaves it out, and it can be null. When it last changed (ISO 8601). Format: an ISO 8601 date and time.

Sometimes sent: undefined when the site leaves it out, and it can be null. The draft’s preview share key, while its share link is on: the link is the draft’s _url with aposShareKey and aposShareId (the draft’s _id) in its query. Absent otherwise, and on published documents.

Errors

Nothing to catch: the SDK retries what is safe, and throws the rest as the classes below. Your exception handler turns them into your app’s own answers, once for every call (see Map SDK errors to responses); catch only what you want to react to here.

400

The site refused what was sent: errors lists each field’s problem, siteMessage the first.Retried first: No. Read: errors (field → messages), siteMessage.

401

The API key is missing or refused (malformed, revoked, expired), or a signature its signing mode needs is missing or stale.Retried first: No. Read: siteMessage, errorName, data.

403

The key may not do this: a scope it lacks, or an address outside its allowlist. siteMessage names it.Retried first: No. Read: siteMessage, errorName, data.

404

Nothing matches, or the caller may not see it.Retried first: No. Read: siteMessage, errorName, data.

500

The site failed. Its logs say why.Retried first: No (only a 502, 503 or 504 is retried). Read: siteMessage, errorName, data.

no answer

No answer: DNS, a refused connection, TLS, or the timeout (15 s per attempt by default).Retried first: Yes, after 0.5 s then 1 s. Read: reason, neverConnected.

not sent

The client refused to send it (e.g. a path segment of ..); the site never saw it.Retried first: No. Read: reason (what to change).

any other

Any other status, or a success whose JSON doesn’t match this SDK version’s types (update the SDK).Retried first: No. Read: reason, status.

setup

sites.forSite('acme') named a slug config/attract.ts doesn’t list (with the keys in the database: no row in attract_api_keys).Retried first: No: nothing was sent. Read: message, slug.

setup

The site’s entry is wrong: a malformed baseUrl or key, a key filed under another slug, or no default site. node ace attract:check names the fix.Retried first: No: nothing was sent. Read: message (what to fix).

Behavior

Access: an API key with content:google-reviews:read (or a master above it: content:google-reviews:all, content:all, admin:all) reads the published documents; drafts (aposMode=draft, or a draft _id) need content:google-reviews:write (or a master above it). A signed-in person reads as far as their own permissions allow, and anyone else reads the published documents’ public fields.
Rate limit: the key’s own reads-per-minute limit, set when the key is created (default 600); over it, 429 with Retry-After. The client waits and retries for you; you see RateLimited only if that runs out.
Retries: a read is safe to repeat: the client retries it on no answer, a 502/503/504 and a 429.
Timeout: 15 s per attempt by default; raise timeout (milliseconds) in config/attract.ts for longer.

More examples

import app from '@adonisjs/core/services/app'
import { SiteClient } from '@fetchski/attract-cms-sdk'

const site = await app.container.make(SiteClient)
const googleReview = await site.googleReviews().findGoogleReview({ id: 'clx8m2k4p0000a1b2c3d4e5f6' }) // GoogleReview | null: null when the site answers 404

Test it

It calls the controller above with the SDK faked: fakeAttract() puts the fake in the container for this one test, and it answers every call with a valid example, so nothing leaves your machine and no key is read. Save it as tests/unit/google_reviews_get_google_review.spec.ts, then run your tests:

tests/unit/google_reviews_get_google_review.spec.ts

import { test } from '@japa/runner'
import app from '@adonisjs/core/services/app'
import testUtils from '@adonisjs/core/services/test_utils'
import { fakeAttract } from '@fetchski/attract-cms-adonis/testing'
import GetGoogleReviewController from '#controllers/get_google_review_controller'

test('googleReviews.getGoogleReview', async () => {
  const site = fakeAttract()

  const ctx = await testUtils.createHttpContext()
  ctx.params = { id: 'clx8m2k4p0000a1b2c3d4e5f6' }
  const controller = await app.container.make(GetGoogleReviewController)
  await controller.handle(ctx)

  site.assertCalled('googleReviews.getGoogleReview', (args) => args.id === 'clx8m2k4p0000a1b2c3d4e5f6')
})

Terminal

node ace test

Answer with your own values: fake googleReviews.getGoogleReview with factories.GoogleReview({...}), the fields you give over a valid example.

tests/unit/google_reviews_get_google_review_answers.spec.ts

import { test } from '@japa/runner'
import { factories, fakeAttract } from '@fetchski/attract-cms-adonis/testing'

test('googleReviews.getGoogleReview answers your values', async ({ assert }) => {
  const site = fakeAttract({
    'googleReviews.getGoogleReview': factories.GoogleReview({ title: 'Your value' }),
  })

  const googleReview = await site.googleReviews().getGoogleReview({ id: 'clx8m2k4p0000a1b2c3d4e5f6' })
  assert.containSubset(googleReview, { title: 'Your value' })
})

List a Google review’s locales

site.googleReviews().getGoogleReviewLocales()

List Google reviews

site.googleReviews().listGoogleReviews()

Create a Google review

site.googleReviews().createGoogleReview()

Replace a Google review

site.googleReviews().replaceGoogleReview()

Delete a Google review

site.googleReviews().deleteGoogleReview()

Update a Google review

site.googleReviews().updateGoogleReview()

GET /google-review/{_id}

The endpoint this calls, in the API reference: the HTTP request and answer, and every rule the site checks.

import app from '@adonisjs/core/services/app'
import { SiteClient } from '@fetchski/attract-cms-sdk'

const site = await app.container.make(SiteClient)
const googleReview = await site.googleReviews().getGoogleReview({ id: 'clx8m2k4p0000a1b2c3d4e5f6' })

{
  "title": "Example title",
  "reviewerName": "Example reviewer name",
  "isAnonymous": false,
  "rating": 5,
  "reviewText": "Example review text",
  "reviewedAt": "2026-10-24",
  "featured": false,
  "slug": "example-slug",
  "visibility": "public",
  "scheduledPublish": "Example scheduled publish",
  "scheduledUnpublish": "Example scheduled unpublish",
  "reviewerPhotoUrl": "https://acme.example/example",
  "ownerReply": "Example owner reply",
  "replyState": "Example reply state",
  "replyPolicyViolation": "Example reply policy violation",
  "stagedReply": "Example staged reply",
  "stagedReplyAction": "Example staged reply action",
  "reviewUrl": "https://acme.example/example",
  "source": "manual",
  "sourceId": "clx8m2k4p0000a1b2c3d4e5f6",
  "gbpLocationId": "clx8m2k4p0000a1b2c3d4e5f6",
  "archived": false,
  "_id": "clx8m2k4p0000a1b2c3d4e5f6",
  "type": "Example type",
  "createdAt": "2026-10-24T09:30:00.000Z",
  "updatedAt": "2026-10-24T09:30:00.000Z",
  "aposShareKey": "k3v9x2m7q1z8w4p6"
}

Get started

Using the SDK

Going further

Pages & Site

Content

Media

Forms

Ads & Conversions

Analytics

In your app

Find the id

Behavior

More examples

Test it

List a Google review’s locales

List Google reviews

Create a Google review

Replace a Google review

Delete a Google review

Update a Google review

GET /google-review/{_id}

In your app

Find the id

Behavior

More examples

Test it

Related

List a Google review’s locales

List Google reviews

Create a Google review

Replace a Google review

Delete a Google review

Update a Google review

GET /google-review/{_id}