{ "openapi": "3.0.1", "info": { "title": "Review Policy Auditor: 1-star review violations & briefs", "description": "Find 1- and 2-star reviews that break Google review policy: conflict of interest, off-topic, personal info, harassment, false allegations, wrong business, spam, review bursts, second-hand stories. Removal score, evidence, takedown brief, flag text and public reply.", "version": "0.1", "x-build-id": "4rbUCAv8K3bOeJJyC" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/translucent_wire~unfair-review-policy-auditor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-translucent_wire-unfair-review-policy-auditor", "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/translucent_wire~unfair-review-policy-auditor/runs": { "post": { "operationId": "runs-sync-translucent_wire-unfair-review-policy-auditor", "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/translucent_wire~unfair-review-policy-auditor/run-sync": { "post": { "operationId": "run-sync-translucent_wire-unfair-review-policy-auditor", "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": { "reviews": { "title": "Reviews", "type": "array", "description": "One object per review: businessName, reviewerName, rating, reviewText, reviewDate (ISO date), optional reviewUrl, reviewId, ownerReplyText and reviewerReviewCount (how many reviews the reviewer has written). Common review-scraper field names (name, stars, text, publishedAtDate, title, reviewerNumberOfReviews) are understood too." }, "reviewsDatasetId": { "title": "Or: reviews dataset ID", "type": "string", "description": "ID of a dataset of reviews on your own Apify account, for example the output of a Google Maps reviews scraper run. Its reviews are added to the list above." }, "maxDatasetItems": { "title": "Maximum reviews read from the dataset", "minimum": 1, "maximum": 50000, "type": "integer", "description": "Upper limit on reviews read from the dataset. Only low-star reviews are audited and charged.", "default": 5000 }, "defaultBusinessName": { "title": "Business name (if the reviews don't say)", "type": "string", "description": "Used when a review has no business name, e.g. a dataset of one business's reviews." }, "businesses": { "title": "Business profiles (optional, improves accuracy)", "type": "array", "description": "One object per business: businessName (as in the reviews), businessCategory, businessPhone, staffNames, competitorNames and otherBusinessNames (neighbours or similar names). Used to spot conflicts of interest, insults to staff, wrong-business reviews and to ignore the business's own phone number." }, "platform": { "title": "Review platform", "enum": [ "google", "other" ], "type": "string", "description": "Google uses Google Maps' published content policy names. Other platforms get generic wording; check their own guidelines.", "default": "google" }, "auditRatingsAtOrBelow": { "title": "Audit reviews rated at or below", "minimum": 1, "maximum": 5, "type": "integer", "description": "2 = audit 1- and 2-star reviews. Higher-rated reviews are skipped for free.", "default": 2 }, "burstWindowHours": { "title": "Burst window (hours)", "minimum": 1, "maximum": 720, "type": "integer", "description": "Low ratings that arrive this close together count as a possible burst (rating manipulation).", "default": 48 }, "burstMinReviews": { "title": "Reviews needed for a burst", "minimum": 2, "maximum": 50, "type": "integer", "description": "How many low ratings inside the window make a burst.", "default": 3 }, "minScoreForBrief": { "title": "Minimum score for a takedown brief", "minimum": 45, "maximum": 100, "type": "integer", "description": "Only reviews with at least this removal-likelihood score (0-100) get a brief. Genuine experiences never do.", "default": 60 }, "maxBriefs": { "title": "Maximum takedown briefs", "minimum": 0, "maximum": 1000, "type": "integer", "description": "Evidence briefs (policy clause, highlighted quotes, ready-to-paste flag text, public reply) for the highest-scoring reviews. Each brief is a paid event.", "default": 1 }, "maxBusinessReports": { "title": "Maximum business reports", "minimum": 0, "maximum": 1000, "type": "integer", "description": "One audit report per business (all audited reviews, scores, bursts, next steps). Each report is a paid event; 0 = none.", "default": 0 }, "brandName": { "title": "Your company name", "type": "string", "description": "Shown on briefs and reports (your agency or the business)." }, "brandLogoUrl": { "title": "Your logo URL (https)", "type": "string", "description": "Public https link to your logo image." }, "brandColor": { "title": "Your brand colour", "type": "string", "description": "Hex colour like #7c3aed." }, "brandContact": { "title": "Contact for public replies", "type": "string", "description": "Email or phone the public replies point to, for example hello@yourbusiness.com" } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }