# Review Tracker (`afaqahmadijaz/review-tracker`) Actor

Google and Yelp review tracker

- **URL**: https://apify.com/afaqahmadijaz/review-tracker.md
- **Developed by:** [Afaq Ahmad](https://apify.com/afaqahmadijaz) (community)
- **Categories:** SEO tools
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

Pay per usage

This Actor is paid per platform usage. The Actor is free to use, and you only pay for the Apify platform usage, which gets cheaper the higher subscription plan you have.

Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-usage

## What's an Apify Actor?

Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases.
In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours,
and optionally produces a well-defined JSON output, datasets with results, or files in key-value store.
In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server.
Actors are written with capital "A".

## How to integrate an Actor?

If asked about integration, you help developers integrate Actors into their projects.
You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready.
The best way to integrate Actors is as follows.

In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js.md):

```bash
npm install apify-client
```

In Python projects, use official [Python client library](https://docs.apify.com/api/client/python.md):

```bash
pip install apify-client
```

In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md):

````bash
# MacOS / Linux
curl -fsSL https://apify.com/install-cli.sh | bash
# Windows
irm https://apify.com/install-cli.ps1 | iex
```bash

In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/platform/integrations/mcp.md).

If your project is in a different language, use the [REST API](https://docs.apify.com/api/v2.md).

For usage examples, see the [API](#api) section below.

For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt).


# README

## SerpAPI Review Tracker

A Java CLI for small businesses and developers who want to fetch, cache, and analyze **Google Maps** and **Yelp** reviews through [SerpAPI](https://serpapi.com/). Export CSV history, track rating trends, and project how many reviews you need to reach a target average.


### Badges

[![MIT License](https://img.shields.io/badge/License-MIT-green.svg)](https://choosealicense.com/licenses/mit/)
[![Java](https://img.shields.io/badge/Java-17+-blue.svg)](https://www.oracle.com/java/)
[![Maven](https://img.shields.io/badge/Maven-3.8+-red.svg)](https://maven.apache.org/)
[![CI](https://github.com/afaqahmadijaz/serpapi-review-tracker/actions/workflows/ci.yml/badge.svg)](https://github.com/afaqahmadijaz/serpapi-review-tracker/actions/workflows/ci.yml)


### CLI Reference

##### Fetch Google Maps reviews

```bash
mvn exec:java -Dexec.args="google"
````

| Variable | Type | Description |
| :-------- | :------- | :------------------------- |
| `SERPAPI_API_KEY` | `string` | **Required**. Your SerpAPI API key |
| `SERPAPI_PLACE_ID` | `string` | **Required**. Google Maps place ID |
| `QUERY` | `string` | Optional text filter inside reviews |
| `FORCE_FULL_BACKFILL` | `boolean` | Rebuild cache from scratch (`true` / `false`) |

##### Fetch Yelp reviews

```bash
mvn exec:java -Dexec.args="yelp"
```

| Variable | Type | Description |
| :-------- | :------- | :------------------------- |
| `SERPAPI_API_KEY` | `string` | **Required**. Your SerpAPI API key |
| `SERPAPI_YELP_PLACE_ID` | `string` | **Required**. Yelp business place ID |
| `YELP_RATING` | `string` | Optional rating filter, e.g. `5` or `5,4,3` |

##### Run tests

```bash
mvn test
```

### SerpAPI Endpoints Used

This project calls SerpAPI over HTTP — it does not expose its own REST server.

##### Google Maps reviews

```http
GET https://serpapi.com/search?engine=google_maps_reviews
```

| Parameter | Type | Description |
| :-------- | :------- | :------------------------- |
| `api_key` | `string` | **Required**. SerpAPI key |
| `place_id` | `string` | **Required**. Google place ID |
| `next_page_token` | `string` | Pagination token from previous response |

##### Yelp reviews

```http
GET https://serpapi.com/search.json?engine=yelp_reviews
```

| Parameter | Type | Description |
| :-------- | :------- | :------------------------- |
| `api_key` | `string` | **Required**. SerpAPI key |
| `place_id` | `string` | **Required**. Yelp place ID |
| `start` | `number` | Pagination offset |
| `num` | `number` | Page size |

### Environment Variables

To run this project, add the following environment variables to your `.env` file (see `.env.example`):

`SERPAPI_API_KEY`

`SERPAPI_PLACE_ID`

`SERPAPI_YELP_PLACE_ID`

`TARGET_AVG`

`PROJECTION_STAR`

`QUERY`

`FORCE_FULL_BACKFILL`

`YELP_RATING`

| Variable | Required | Default | Description |
| :-------- | :------- | :-------- | :------------------------- |
| `SERPAPI_API_KEY` | Yes | — | SerpAPI API key |
| `SERPAPI_PLACE_ID` | Google | — | Google Maps place ID |
| `SERPAPI_YELP_PLACE_ID` | Yelp | — | Yelp business place ID |
| `TARGET_AVG` | No | `4.60` | Target average for projections |
| `PROJECTION_STAR` | No | `5` | Star rating assumed for future reviews |
| `QUERY` | No | — | Optional text filter inside reviews |
| `FORCE_FULL_BACKFILL` | No | `false` | Rebuild Google cache and reset Google CSV |
| `YELP_RATING` | No | — | Rating filter, e.g. `5` or `5,4,3` |

### Prerequisites

- **Java 17+** — [Download](https://adoptium.net/)
- **Maven 3.8+** — [Download](https://maven.apache.org/download.cgi)
- **SerpAPI account** — [Sign up](https://serpapi.com/) (free tier available)

Verify your setup:

```bash
java -version   # should print 17 or higher
mvn -version    # should print 3.8 or higher
```

### Run Locally

Clone the project

```bash
git clone https://github.com/afaqahmadijaz/serpapi-review-tracker.git
```

Go to the project directory

```bash
cd serpapi-review-tracker
```

Copy the environment template

```bash
cp .env.example .env
```

Export your variables (or load `.env` in your shell / IDE)

```bash
export SERPAPI_API_KEY=your_key
export SERPAPI_PLACE_ID=your_google_place_id
```

Run the tracker

```bash
mvn exec:java -Dexec.args="google"
```

### Usage / Examples

**First run (full backfill)** — empty cache triggers a full paginated fetch:

```bash
export SERPAPI_API_KEY=your_key
export SERPAPI_PLACE_ID=ChIJxxxxxxxxxxxx
mvn exec:java -Dexec.args="google"
```

**Incremental run** — fetches only new reviews since the last run:

```bash
mvn exec:java -Dexec.args="google"
```

**Yelp with rating filter:**

```bash
export SERPAPI_YELP_PLACE_ID=your_yelp_place_id
export YELP_RATING=5,4
mvn exec:java -Dexec.args="yelp"
```

**Force a full Google cache rebuild:**

```bash
export FORCE_FULL_BACKFILL=true
mvn exec:java -Dexec.args="google"
```

### Output (local only, gitignored)

| Path | Description |
| :-------- | :------------------------- |
| `.cache/` | JSON review caches for deduplication |
| `history/` | CSV exports appended on each run |
| `summaries/` | Timestamped summary text files |

### Disclaimer

This tool is provided as-is. You are responsible for complying with [SerpAPI's terms](https://serpapi.com/terms), Google and Yelp platform policies, and applicable privacy laws when fetching, storing, or using review data.

### Contributing

Contributions are welcome! See [CONTRIBUTING.md](CONTRIBUTING.md).

For security issues, see [SECURITY.md](SECURITY.md).

### License

[MIT](https://choosealicense.com/licenses/mit/)

## Actor input object example

```json
{}
```

# API

You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.

## JavaScript example

```javascript
import { ApifyClient } from 'apify-client';

// Initialize the ApifyClient with your Apify API token
// Replace the '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {};

// Run the Actor and wait for it to finish
const run = await client.actor("afaqahmadijaz/review-tracker").call(input);

// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
    console.dir(item);
});

// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs

```

## Python example

```python
from apify_client import ApifyClient

# Initialize the ApifyClient with your Apify API token
# Replace '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = {}

# Run the Actor and wait for it to finish
run = client.actor("afaqahmadijaz/review-tracker").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"])
for item in client.dataset(run["defaultDatasetId"]).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{}' |
apify call afaqahmadijaz/review-tracker --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "command": "npx",
            "args": [
                "mcp-remote",
                "https://mcp.apify.com/?tools=afaqahmadijaz/review-tracker",
                "--header",
                "Authorization: Bearer <YOUR_API_TOKEN>"
            ]
        }
    }
}

```

## OpenAPI specification

```json
{
    "openapi": "3.0.1",
    "info": {
        "title": "Review Tracker",
        "description": "Google and Yelp review tracker",
        "version": "0.0",
        "x-build-id": "7u5PKb23fTQJI4Wbe"
    },
    "servers": [
        {
            "url": "https://api.apify.com/v2"
        }
    ],
    "paths": {
        "/acts/afaqahmadijaz~review-tracker/run-sync-get-dataset-items": {
            "post": {
                "operationId": "run-sync-get-dataset-items-afaqahmadijaz-review-tracker",
                "x-openai-isConsequential": false,
                "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
                "tags": [
                    "Run Actor"
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/inputSchema"
                            }
                        }
                    }
                },
                "parameters": [
                    {
                        "name": "token",
                        "in": "query",
                        "required": true,
                        "schema": {
                            "type": "string"
                        },
                        "description": "Enter your Apify token here"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "OK"
                    }
                }
            }
        },
        "/acts/afaqahmadijaz~review-tracker/runs": {
            "post": {
                "operationId": "runs-sync-afaqahmadijaz-review-tracker",
                "x-openai-isConsequential": false,
                "summary": "Executes an Actor and returns information about the initiated run in response.",
                "tags": [
                    "Run Actor"
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/inputSchema"
                            }
                        }
                    }
                },
                "parameters": [
                    {
                        "name": "token",
                        "in": "query",
                        "required": true,
                        "schema": {
                            "type": "string"
                        },
                        "description": "Enter your Apify token here"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "OK",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/runsResponseSchema"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/acts/afaqahmadijaz~review-tracker/run-sync": {
            "post": {
                "operationId": "run-sync-afaqahmadijaz-review-tracker",
                "x-openai-isConsequential": false,
                "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
                "tags": [
                    "Run Actor"
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/inputSchema"
                            }
                        }
                    }
                },
                "parameters": [
                    {
                        "name": "token",
                        "in": "query",
                        "required": true,
                        "schema": {
                            "type": "string"
                        },
                        "description": "Enter your Apify token here"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "OK"
                    }
                }
            }
        }
    },
    "components": {
        "schemas": {
            "inputSchema": {
                "type": "object",
                "properties": {}
            },
            "runsResponseSchema": {
                "type": "object",
                "properties": {
                    "data": {
                        "type": "object",
                        "properties": {
                            "id": {
                                "type": "string"
                            },
                            "actId": {
                                "type": "string"
                            },
                            "userId": {
                                "type": "string"
                            },
                            "startedAt": {
                                "type": "string",
                                "format": "date-time",
                                "example": "2025-01-08T00:00:00.000Z"
                            },
                            "finishedAt": {
                                "type": "string",
                                "format": "date-time",
                                "example": "2025-01-08T00:00:00.000Z"
                            },
                            "status": {
                                "type": "string",
                                "example": "READY"
                            },
                            "meta": {
                                "type": "object",
                                "properties": {
                                    "origin": {
                                        "type": "string",
                                        "example": "API"
                                    },
                                    "userAgent": {
                                        "type": "string"
                                    }
                                }
                            },
                            "stats": {
                                "type": "object",
                                "properties": {
                                    "inputBodyLen": {
                                        "type": "integer",
                                        "example": 2000
                                    },
                                    "rebootCount": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "restartCount": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "resurrectCount": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "computeUnits": {
                                        "type": "integer",
                                        "example": 0
                                    }
                                }
                            },
                            "options": {
                                "type": "object",
                                "properties": {
                                    "build": {
                                        "type": "string",
                                        "example": "latest"
                                    },
                                    "timeoutSecs": {
                                        "type": "integer",
                                        "example": 300
                                    },
                                    "memoryMbytes": {
                                        "type": "integer",
                                        "example": 1024
                                    },
                                    "diskMbytes": {
                                        "type": "integer",
                                        "example": 2048
                                    }
                                }
                            },
                            "buildId": {
                                "type": "string"
                            },
                            "defaultKeyValueStoreId": {
                                "type": "string"
                            },
                            "defaultDatasetId": {
                                "type": "string"
                            },
                            "defaultRequestQueueId": {
                                "type": "string"
                            },
                            "buildNumber": {
                                "type": "string",
                                "example": "1.0.0"
                            },
                            "containerUrl": {
                                "type": "string"
                            },
                            "usage": {
                                "type": "object",
                                "properties": {
                                    "ACTOR_COMPUTE_UNITS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATASET_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATASET_WRITES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "KEY_VALUE_STORE_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "KEY_VALUE_STORE_WRITES": {
                                        "type": "integer",
                                        "example": 1
                                    },
                                    "KEY_VALUE_STORE_LISTS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "REQUEST_QUEUE_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "REQUEST_QUEUE_WRITES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATA_TRANSFER_INTERNAL_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATA_TRANSFER_EXTERNAL_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "PROXY_SERPS": {
                                        "type": "integer",
                                        "example": 0
                                    }
                                }
                            },
                            "usageTotalUsd": {
                                "type": "number",
                                "example": 0.00005
                            },
                            "usageUsd": {
                                "type": "object",
                                "properties": {
                                    "ACTOR_COMPUTE_UNITS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATASET_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATASET_WRITES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "KEY_VALUE_STORE_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "KEY_VALUE_STORE_WRITES": {
                                        "type": "number",
                                        "example": 0.00005
                                    },
                                    "KEY_VALUE_STORE_LISTS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "REQUEST_QUEUE_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "REQUEST_QUEUE_WRITES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATA_TRANSFER_INTERNAL_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATA_TRANSFER_EXTERNAL_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "PROXY_SERPS": {
                                        "type": "integer",
                                        "example": 0
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}
```