# G2 Product API Documentation

<p><strong>G2 Product API</strong> returns one product. <code>product</code> holds the id, uuid, slug, name, vendor, rating, review count, description, categories and image from the G2 search result of the exact slug (unchanged).</p><p><code>details</code> adds data from the first review page: the aggregate <code>rating</code> and <code>review_count</code>, the star <code>distribution</code> (<code>count</code> and <code>percent</code> for 5 to 1 stars), <code>facets</code> (review counts per company size, role, category, industry and region), <code>pros</code> and <code>cons</code> with mention counts and the <code>ai_summary</code>. A product request makes two lookups. If the second one fails, you still get <code>product</code> and billed <code>details: null</code>.</p><p>Set <code>include=sub_ratings</code> to add <code>details.sub_ratings</code> (<code>meets_requirements</code>, <code>ease_of_use</code>, <code>ease_of_setup</code>, <code>ease_of_admin</code>, <code>quality_of_support</code>, each with <code>score</code> from 0 to 10 and <code>votes</code>) and <code>details.compared_with</code>, the slug of the product used for the comparison. This needs two more lookups (the first alternative, then the comparison), so the call is slower. If G2 has no comparison for the pair, <code>sub_ratings</code> is <code>null</code> and the call is still billed. The credit cost is one credit either way.</p><p>An unknown slug, or a slug that does not appear in the search result of its own name, returns 404 and is not billed.</p>

- **Documentation:** [https://scrappa.co/docs/g2-api/g2_product](https://scrappa.co/docs/g2-api/g2_product)
- **API group:** G2 API
- **Endpoint:** `GET https://scrappa.co/api/g2/products/{slug}`

## Authentication

Send your Scrappa API key in the `X-API-KEY` request header. Paid endpoints also support accountless x402 payments when called without an API key.

## Parameters

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `slug` | string | Yes | G2 product slug (path parameter). Example: slack. |
| `include` | array | No | sub_ratings adds sub-ratings (two more lookups). Repeat the parameter or send a comma list. |

## Example response

```json
{
    "data": {
        "details": {
            "cons": [
                {
                    "id": "1059540",
                    "count": 605,
                    "label": "Learning Curve"
                }
            ],
            "pros": [
                {
                    "id": "1059298",
                    "count": 1525,
                    "label": "Ease of Use"
                }
            ],
            "facets": {
                "role": [
                    {
                        "id": "1",
                        "count": 8839,
                        "label": "User"
                    }
                ],
                "region": [
                    {
                        "id": "North America",
                        "count": 9752,
                        "label": "North America"
                    }
                ],
                "category": [
                    {
                        "id": "7",
                        "count": 437,
                        "label": "Marketing Resource Management"
                    }
                ],
                "industry": [
                    {
                        "id": "333",
                        "count": 1819,
                        "label": "Marketing and Advertising"
                    }
                ],
                "company_size": [
                    {
                        "id": "179",
                        "count": 7915,
                        "label": "Small Business (50 or fewer emp.)"
                    }
                ]
            },
            "rating": 4.4,
            "ai_summary": "Users consistently praise Asana for its user-friendly interface and ease of use, which simplifies task organization and\u2026",
            "sub_ratings": {
                "ease_of_use": {
                    "score": 8.6,
                    "votes": 11820
                }
            },
            "distribution": [
                {
                    "count": 9240,
                    "stars": 5,
                    "percent": 65.74
                },
                {
                    "count": 3871,
                    "stars": 4,
                    "percent": 27.54
                }
            ],
            "review_count": 14056,
            "compared_with": "monday-com"
        },
        "product": {
            "id": 576,
            "url": "https://www.g2.com/products/zoho-crm/reviews",
            "name": "Zoho CRM",
            "slug": "zoho-crm",
            "uuid": "00000000-0000-0000-0000-000000000000",
            "rating": 4.1,
            "source": "search",
            "vendor": "Zoho",
            "image_url": "https://images.g2crowd.com/uploads/product/image/example/zoho-crm.png",
            "vendor_id": 1,
            "categories": [
                {
                    "id": 179,
                    "name": "CRM",
                    "slug": "crm"
                }
            ],
            "description": "Zoho CRM is a customer relationship management platform.",
            "vendor_slug": "zoho",
            "review_count": 2955
        }
    },
    "meta": {
        "billable": true,
        "endpoint_family": "product"
    },
    "success": true
}
```

## Errors

| Status | Error | Description |
| --- | --- | --- |
| 404 | Not Found | The slug is unknown. This response is not billable. |
| 422 | Validation Error | A required parameter or a value is invalid. This response is not billable. |
| 503 | Upstream Unavailable | G2 could not be reached or returned data that does not match the request. This response is not billable and is retryable. |

## More Scrappa resources

- [API documentation](https://scrappa.co/docs)
- [Full LLM-readable API reference](https://scrappa.co/llms-full.txt)
- [OpenAPI specification](https://scrappa.co/docs/api.json)
- [Pricing](https://scrappa.co/pricing)