Skip to content
Browsabledocs
↑ ↓ to navigate · Enter to openQuick links
Staging API reference · Requests use https://api-ingress-worker-staging.browsable-staging.workers.dev
Documentation Google Maps reviews
Markdown ↗
Google Maps APIs

Google Maps reviews

Fetch reviews for a Google Maps place — author, rating, date, text, owner response, plus an overall rating breakdown.

POST/v1/googlemaps/reviews
Authenticate every request

Send Authorization: Bearer YOUR_API_KEY. Get an API key →

Parameters

Send these fields in a flat JSON body. Add _run to choose execution options.

Provide at least one of: url; placeUrl.

urlstringOptional

Full Google Maps place URL — pass the `link` field from a `googlemaps/search`, `googlemaps/area`, or `googlemaps/place` response. Preferred name; placeUrl remains supported.

limitintegerOptional

Maximum reviews to extract. Defaults to 50. Preferred name; maxReviews remains supported. Default: 50. Minimum: 1. Maximum: 2000.

Advanced & compatibility inputs 2
maxReviewsintegerOptional

Maximum reviews to extract. Defaults to 50. You can also use limit. Default: 50. Minimum: 1. Maximum: 2000.

placeUrlstringOptional

Full Google Maps place URL — pass the `link` field from a `googlemaps/search`, `googlemaps/area`, or `googlemaps/place` response. You can also use url.

Response

Every response describes a run. Read result once run_status is succeeded.

run_id
The run to track. Keep it when contacting support.
run_status
Queued, running, waiting for sign-in, succeeded, or failed. Check this even after an HTTP 200.
status_url
Poll this URL while the run is pending. Keep the same run instead of starting another request.
result
The endpoint’s returned data. The example is illustrative; actual fields may be empty or unavailable.
error
On failure, inspect its code, message, retryable and action fields.
View the complete output schema
JSON
{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "placeName",
    "rating",
    "reviewsCount",
    "ratingBreakdown",
    "reviews"
  ],
  "properties": {
    "rating": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ]
    },
    "reviews": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "reviewId",
          "author",
          "rating",
          "relativeDate",
          "text",
          "ownerResponse",
          "photoCount"
        ],
        "properties": {
          "text": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "author": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "rating": {
            "anyOf": [
              {
                "type": "number"
              },
              {
                "type": "null"
              }
            ]
          },
          "reviewId": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "photoCount": {
            "type": "number"
          },
          "relativeDate": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "ownerResponse": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          }
        },
        "additionalProperties": false
      }
    },
    "placeName": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "reviewsCount": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ]
    },
    "ratingBreakdown": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "stars",
          "count"
        ],
        "properties": {
          "count": {
            "type": "number"
          },
          "stars": {
            "type": "number"
          }
        },
        "additionalProperties": false
      }
    }
  },
  "additionalProperties": false
}
View a polled run response
JSON
{
  "run_id": "00000000-0000-4000-8000-000000000001",
  "task_key": "googlemaps-reviews",
  "task_name": "Google Maps reviews",
  "run_status": "succeeded",
  "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001",
  "result": {
    "rating": 4.91,
    "reviews": [
      {
        "text": "Sample text 1",
        "author": "user_1",
        "rating": 4.91,
        "reviewId": "id-1",
        "photoCount": 1,
        "relativeDate": "sample",
        "ownerResponse": "sample"
      }
    ],
    "placeName": "Stylish Shoreditch Loft with Balcony",
    "reviewsCount": 1,
    "ratingBreakdown": [
      {
        "count": 1,
        "stars": 1.5
      }
    ]
  },
  "error": null
}

Errors & retries

  • 400Fix the fields listed in errors before retrying.
  • 428Connect the requested website account using the returned sign-in link.
  • 429Wait for the duration in Retry-After.
  • 5xxRetry transient failures with backoff. Keep the request ID.

A failed run has its own error inside the response. Retry it only when error.retryable is true.

Validation, pagination and recovery →

More examples

Async request with polling
RUN=$(curl -s -X POST "https://api-ingress-worker-staging.browsable-staging.workers.dev/v1/googlemaps/reviews" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://example.com/item-1"}')

RUN_ID=$(echo "$RUN" | jq -er '.run_id // empty') || { echo "$RUN" >&2; exit 1; }
POLL_DELAY=3

while true; do
  RESULT=$(curl -s -H "Authorization: Bearer YOUR_API_KEY" "https://api-ingress-worker-staging.browsable-staging.workers.dev/v1/runs/$RUN_ID")
  STATUS=$(echo "$RESULT" | jq -r '.run_status')
  if [[ "$STATUS" =~ ^(succeeded|failed|errored|cancelled|canceled|expired)$ ]]; then
    echo "$RESULT"
    break
  fi
  sleep "$(awk "BEGIN { print $POLL_DELAY * (0.9 + ($RANDOM % 21) / 100) }")"
  POLL_DELAY=$((POLL_DELAY < 30 ? POLL_DELAY * 2 : 30))
  [ "$POLL_DELAY" -gt 30 ] && POLL_DELAY=30
done
Wait-for-results request
curl -X POST "https://api-ingress-worker-staging.browsable-staging.workers.dev/v1/googlemaps/reviews" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://example.com/item-1","_run":{"async":false}}'
Canonical & compatibility routes

You can also send the same JSON body to /v1/tasks/googlemaps-reviews/runs.