--- title: "Get G2 reviews for a product" method: GET path: "/g2/reviews" tags: ["g2"] --- # Get G2 reviews for a product `GET /g2/reviews` ## Request - Base URL: `https://www.socialcrawl.dev/v1` - URL: `https://www.socialcrawl.dev/v1/g2/reviews` - Auth: API key in header `x-api-key` Returns written G2 reviews for a software product, 10 per page. Filter by star rating, company segment, industry, reviewer role, region, or keyword, and sort by G2 relevance, recency, helpfulness, or rating. G2 caps each filter combination at 10 pages; use the returned cursor until has_more is false. Get the product slug from GET /v1/g2/product. ## Query parameters - `id` string - `url` string - `page` integer - `industry` string - `keywords` string - `region` string - `role` string - `segment` 'small-business' | 'mid-market' | 'enterprise' - `sort` 'default' | 'most-recent' | 'most-helpful' | 'highest-rated' | 'lowest-rated' - `stars` string - `label` string - `reports` string - `judgments` 'on' | 'off' - `dry_run` '1' - `label_evidence` '1' - `fit` 'goal' - `goal` string - `fit_tokens` integer - `since` string - `until` string - `cursor` string ## Headers - `Cache-Control` string - `Idempotency-Key` string ## Response `200` Successful response - object - `success` boolean, required: Whether the request succeeded - `platform` string, required: Platform name - `endpoint` string, required: API endpoint path - `data` object, required: Platform-specific response data - `items` object[]: Array of canonical review wrappers ({ review }) - `review` object: Canonical Review object (shared across commerce platforms) - `id` string: Review ID (parsed from the review URL when not first-class) - `entity_id` string, nullable: ID of the reviewed entity (e.g. the Amazon ASIN) - `url` string, nullable: String at review.url - `title` string, nullable: String at review.title - `text` string, nullable: Full review body - `rating` object: Star rating (value + max) - `value` integer, nullable: Numeric at review.rating.value - `max` integer, nullable: Numeric at review.rating.max - `author` object: Nested object: review.author - `name` string, nullable: String at review.author.name - `avatar_url` string, nullable: String at review.author.avatar_url - `url` string, nullable: String at review.author.url - `location` string, nullable: String at review.author.location - `reviews_count` integer, nullable: Numeric at review.author.reviews_count - `helpful_votes` integer, nullable: Helpful-vote count (Amazon; null elsewhere) - `verified` boolean, nullable: Verified-purchase flag (Amazon; null elsewhere) - `source` string, nullable: String at review.source - `language` string, nullable: String at review.language - `original_language` string, nullable: String at review.original_language - `translated` boolean, nullable: Boolean at review.translated - `images` string[], nullable: Array at review.images - `responses` object[], nullable: Owner/brand/management replies to the review, each `{id, author, text, published_at}` with `published_at` as an ISO 8601 UTC string (REL-07.6). - `id` string, nullable: String at review.responses.id - `author` string, nullable: String at review.responses.author - `text` string, nullable: String at review.responses.text - `published_at` union: Union: string | integer | null - string - integer - `published_at` union: Review creation timestamp as an ISO 8601 UTC string (REL-07.6). Upstreams that send only a calendar date land on midnight UTC. When the upstream sent a Unix epoch it is converted here and the raw epoch is preserved under `review.ext.published_at_epoch`. - string - integer - `ext` object, nullable: Nested object: review.ext - `appdata` string, nullable: Leaf at review.ext.appdata - `tiktokshop` string, nullable: Leaf at review.ext.tiktokshop - `next_cursor` string, nullable: Opaque cursor for the next page. Pass it back as a query parameter on endpoints that support pagination. Present only when the upstream reports more results. - `total` integer, nullable: Total number of matching results, when the upstream provides a count. Omitted otherwise. - `dropped` integer, required: Number of upstream list items dropped because they could not be repaired to the endpoint schema. Valid list responses include 0. - `_warnings` string[]: Non-fatal notices about this response (field-map drift, clamped computed values). Advisory only: its presence never means the request failed. Omitted entirely when there is nothing to report, so treat absent as 'no warnings'. - `credits_used` integer, required: Number of credits consumed - `credits_remaining` integer, nullable, required: Current account balance, or null when this response could not establish one. Free cache hits always return null because they do not establish an authoritative post-request balance. An idempotency replay also returns null when its current-balance lookup fails. It is never a fabricated zero, so a zero here means the account really is empty. The authoritative reading is the one on a billed response, which comes straight from the deduction. - `request_id` string, required: Unique request identifier for support - `cached` boolean, required: Whether the response was served from cache - `idempotent_replay` boolean: True only when this response is an idempotency replay - `meta` object: Optional. Present only when this call completed a pattern that one other call does more cheaply or in one step, at most once per pattern per API key per day. Send the header `X-SocialCrawl-Hints: off` to never receive it. - `hint` object: One suggestion: what to call instead and why, with the price when the suggested call costs more than the calls it replaces. - `code` string: creator_card | batch_profiles | search_multi | incremental_sync | comment_labels | search_repeat - `message` string: One sentence for a person or an agent to read. - `method` string: GET or POST. - `path` string: The call the hint points to. - `pagination` object, required: Cursor state for this page. Present on every list response. - `next_cursor` string, nullable, required: Opaque token to send back as `cursor` for the next page, or null at end-of-list. Pass it back verbatim; never decode or trim it. - `has_more` boolean, required: Explicit stop signal. Prefer this over inspecting next_cursor or comparing against total. - `page_size` integer, required: Number of items in THIS page. - `stopped_at` 'since' | 'known_id' | 'end' | 'null', nullable: Present only when the request sent `since` or `stop_at_id`. Why the walk stopped: `since` (this page reached a post older than the date), `known_id` (this page reached the post you already hold), `end` (the list ran out first), or null (not yet, keep walking with `next_cursor`). ## Other responses - `400`: Invalid request - missing or malformed parameters - `401`: Unauthorized - missing or invalid API key - `402`: Payment required - the account balance is too low, or the calling key has spent its own per-key credit limit - `404`: Not found - the endpoint does not exist, or the requested resource was not found upstream - `405`: Method not allowed - wrong HTTP verb for this endpoint - `409`: Conflict - an idempotent request is still in flight, its completed body exceeded the replay limit, or the cohort resource is not in a state that allows this operation - `410`: Gone - the discover run's retention passed and its rows were deleted; start a new run - `413`: Payload too large: the JSON request body exceeds the 1 MB size limit and is rejected before parsing, or a single cohort result cannot fit beneath the 1 MB response-page ceiling - `422`: Idempotency payload mismatch - this Idempotency-Key was already used with a different request payload; or a discover request with async=false is over what one call can answer (NEEDS_ASYNC) - `429`: Rate or concurrency limit exceeded. `RATE_LIMITED`: more than 600 requests in a 1-minute sliding window on this API key (headers `X-RateLimit-Limit`/`Remaining`/`Reset`; `Retry-After` is seconds until the window resets). `CONCURRENCY_LIMIT`: more than 50 simultaneous in-flight requests (headers `X-Concurrency-Limit`/`Remaining`; short static `Retry-After`). Both are unbilled. Honor `Retry-After`, then back off with jitter. See /docs/rate-limits. - `500`: Internal server error - an immediate refund is attempted; credits_used reports the committed net charge and exact compensation is queued if that refund cannot commit - `502`: Upstream error - the platform returned an error; an immediate refund is attempted and credits_used reports the committed net charge - `503`: Service unavailable - the request is unbilled when rejected before deduction, otherwise an immediate refund is attempted and credits_used reports the committed net charge - `504`: Gateway timeout - the request was still running close to the platform time limit and is answered as UPSTREAM_ERROR, the same code as 502. An immediate refund is attempted and credits_used reports the committed net charge. When details.retry_with is set, retryable is false and there is no Retry-After --- [API](https://skmtc.dev/socialcrawl/apis/socialcrawl-api.md) · [All operations](https://skmtc.dev/socialcrawl/apis/socialcrawl-api/llms.txt) · [OpenAPI document](https://skmtc.dev/socialcrawl/apis/socialcrawl-api/revisions/a0ad2511004a?raw)