{
  "openapi": "3.0.1",
  "info": {
    "title": "Trustpilot Scraper 2026 — Delta Monitor (Birdeye alt, PPE)",
    "description": "Monitor Trustpilot reviews on a daily or hourly cron and receive ONLY new reviews since the previous run. Watermark-based delta engine, 8 locales (.com/.de/.fr/.it/.es/.nl/.se/.dk), Pay-Per-Event at $0.0015/review. Replaces $299/mo Birdeye Starter at $20-50/mo per brand.",
    "version": "0.3",
    "x-build-id": "NrWIOLw9zT3O3gM4i"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/zhorex~trustpilot-brand-watch/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-zhorex-trustpilot-brand-watch",
        "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/zhorex~trustpilot-brand-watch/runs": {
      "post": {
        "operationId": "runs-sync-zhorex-trustpilot-brand-watch",
        "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/zhorex~trustpilot-brand-watch/run-sync": {
      "post": {
        "operationId": "run-sync-zhorex-trustpilot-brand-watch",
        "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",
        "required": [
          "domains"
        ],
        "properties": {
          "domains": {
            "title": "Company domains to monitor",
            "type": "array",
            "description": "List of company domains as they appear on Trustpilot (e.g. 'stripe.com', 'ramp.com', 'zalando.de'). One review feed per domain. Submit 1-200 domains per run; use a Saved Task + cron for ongoing monitoring.",
            "default": [
              "stripe.com"
            ],
            "items": {
              "type": "string"
            }
          },
          "locale": {
            "title": "Trustpilot locale",
            "enum": [
              "com",
              "de",
              "fr",
              "it",
              "es",
              "nl",
              "se",
              "dk"
            ],
            "type": "string",
            "description": "Which Trustpilot locale to query. Locales have SEPARATE review pools — German consumers leave reviews on de.trustpilot.com that don't appear on .com. For DACH brand health pick 'de'; for Iberian / LATAM-Spanish pick 'es'; default 'com' is global English.",
            "default": "com"
          },
          "mode": {
            "title": "Mode",
            "enum": [
              "delta",
              "full"
            ],
            "type": "string",
            "description": "'delta' (default) returns ONLY reviews newer than the watermark stored from your last scheduled run — turns this Actor into a real-time reputation monitor and keeps PPE cost near zero on quiet days. 'full' returns every review up to maxReviewsPerDomain — use once for the initial backfill, then switch to delta for the cron.",
            "default": "delta"
          },
          "minStarRating": {
            "title": "Minimum star rating",
            "minimum": 1,
            "maximum": 5,
            "type": "integer",
            "description": "Only return reviews at or above this rating. Set 1 (default) to catch crisis-level 1- and 2-star reviews; set 4 if you only care about positive testimonials.",
            "default": 1
          },
          "maxReviewsPerDomain": {
            "title": "Max reviews per domain (hard cap)",
            "minimum": 1,
            "maximum": 10000,
            "type": "integer",
            "description": "Safety cap on the number of reviews extracted per domain per run. Delta mode usually returns far fewer (only new reviews); this cap mainly applies to 'full' mode backfills.",
            "default": 500
          },
          "includeReply": {
            "title": "Include company reply",
            "type": "boolean",
            "description": "If the brand has replied publicly on Trustpilot, include the reply text and timestamp. Default on — this is one of the most useful signals for customer-experience auditing.",
            "default": true
          },
          "watermarkKey": {
            "title": "Custom watermark key (optional)",
            "type": "string",
            "description": "Override the default watermark key (auto-derived per domain+locale). Use this if you want two independent cron schedules over the same domain — e.g. a daily 'crisis' delta filtered to 1-star and a weekly 'highlights' delta filtered to 5-star."
          },
          "cookieString": {
            "title": "Optional Trustpilot cookie string",
            "type": "string",
            "description": "Optional. Paste a logged-in cookie header from your browser DevTools to raise per-IP rate limits on heavy multi-domain runs. Leave empty for anonymous browsing (works for typical workloads)."
          },
          "proxyConfiguration": {
            "title": "Proxy configuration",
            "type": "object",
            "description": "Apify residential proxy is recommended. Default pins to US residentials, which Trustpilot's Cloudflare edge waves through most reliably. For DACH-locale runs that get edge-challenged, override to apifyProxyCountry='DE' or 'GB'.",
            "default": {
              "useApifyProxy": true,
              "apifyProxyGroups": [
                "RESIDENTIAL"
              ],
              "apifyProxyCountry": "US"
            }
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}