{
  "openapi": "3.0.1",
  "info": {
    "title": "Competitor Negative Review & Churn Lead Monitor",
    "description": "Monitor competitor 1-to-3 star reviews across Trustpilot, Shopify, WordPress, Atlassian, Apple, Google Play, and Firefox in bulk. Scores churn intent, tags pain points like pricing or support, and deduplicates across 3x/day runs.",
    "version": "1.0",
    "x-build-id": "nHu730ZYbh4e9fvBD"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/obicodes~competitor-review-churn-monitor/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-obicodes-competitor-review-churn-monitor",
        "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/obicodes~competitor-review-churn-monitor/runs": {
      "post": {
        "operationId": "runs-sync-obicodes-competitor-review-churn-monitor",
        "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/obicodes~competitor-review-churn-monitor/run-sync": {
      "post": {
        "operationId": "run-sync-obicodes-competitor-review-churn-monitor",
        "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": [
          "targets"
        ],
        "properties": {
          "targets": {
            "title": "Competitor Apps or Plugins (Bulk Batch)",
            "type": "array",
            "description": "List of competitor URLs to monitor. Supports Trustpilot, Shopify App Store, WordPress Plugins & Themes, Atlassian Marketplace, Apple App Store, Google Play Store, and Firefox Add-ons.",
            "default": [
              "https://www.trustpilot.com/review/hubspot.com",
              "https://apps.shopify.com/klaviyo-email-marketing",
              "https://wordpress.org/plugins/elementor/",
              "https://addons.mozilla.org/en-US/firefox/addon/ublock-origin/",
              "https://apps.apple.com/us/app/slack/id618783545",
              "https://play.google.com/store/apps/details?id=com.Slack",
              "https://marketplace.atlassian.com/apps/6820/scriptrunner-for-jira"
            ],
            "items": {
              "type": "string"
            }
          },
          "maxStars": {
            "title": "Maximum Star Rating to Collect",
            "minimum": 1,
            "maximum": 5,
            "type": "integer",
            "description": "Only keep reviews with this star rating or lower. Set to 3 to capture 1-star, 2-star, and 3-star negative/neutral reviews. Set to 5 to collect all reviews.",
            "default": 3
          },
          "maxReviewsPerTarget": {
            "title": "Max Reviews per Competitor",
            "minimum": 1,
            "maximum": 200,
            "type": "integer",
            "description": "Maximum number of matching reviews to return per competitor target in a single run.",
            "default": 25
          },
          "sinceHours": {
            "title": "Only Reviews from Last N Hours (Optional)",
            "minimum": 0,
            "maximum": 8760,
            "type": "integer",
            "description": "Filter out reviews older than this many hours (e.g., 12 or 24 for 3x/day scheduled runs). Leave 0 to include all recent reviews regardless of age.",
            "default": 0
          },
          "minChurnScore": {
            "title": "Minimum Churn Intent Score (0-100)",
            "minimum": 0,
            "maximum": 100,
            "type": "integer",
            "description": "Only return leads with a churn intent score at or above this threshold. Set to 0 to return all matching reviews.",
            "default": 0
          },
          "onlyUnreplied": {
            "title": "Only Unreplied Reviews",
            "type": "boolean",
            "description": "When enabled, only returns reviews where the competitor has not posted a developer reply yet.",
            "default": false
          },
          "customKeywords": {
            "title": "Extra Pain-Point Keywords (Optional)",
            "type": "array",
            "description": "Additional words or phrases to watch for in reviews (for example: 'migration', 'export', 'slow', 'overcharged').",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "deduplicateAcrossRuns": {
            "title": "Skip Already-Seen Reviews Across Runs",
            "type": "boolean",
            "description": "Saves seen review IDs in a named Key-Value Store so repeated runs (such as 3 times per day) only output brand-new reviews.",
            "default": false
          },
          "dedupeStoreName": {
            "title": "Deduplication Store Name",
            "type": "string",
            "description": "Name of the Key-Value Store used to remember seen review IDs when 'Skip Already-Seen Reviews Across Runs' is enabled.",
            "default": "competitor-review-churn-seen"
          },
          "concurrency": {
            "title": "Concurrent Targets",
            "minimum": 1,
            "maximum": 10,
            "type": "integer",
            "description": "Number of competitor targets to check at the same time. Keep at 2-3 to avoid rate limits on public review pages.",
            "default": 2
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}