{
  "openapi": "3.0.1",
  "info": {
    "title": "Shopify App Store Scraper & App Intelligence",
    "description": "Shopify App Store scraper: reviews of any Shopify app at $0.10 per 1,000, plus an optional app report ($0.002 each): review velocity and rating trends, rating by country, new-merchant churn signal, developer reply rate, complaint spikes, category ranks, plan and listing changes with alerts.",
    "version": "0.0",
    "x-build-id": "IeXpWxdq75Hxwc0wD"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/steadywren~shopify-app-store-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-steadywren-shopify-app-store-scraper",
        "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/steadywren~shopify-app-store-scraper/runs": {
      "post": {
        "operationId": "runs-sync-steadywren-shopify-app-store-scraper",
        "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/steadywren~shopify-app-store-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-steadywren-shopify-app-store-scraper",
        "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": {
          "apps": {
            "title": "Apps",
            "type": "array",
            "description": "Shopify App Store URLs or app handles (e.g. klaviyo-email-marketing). Add your competitors to get a side-by-side comparison.",
            "default": [
              "https://apps.shopify.com/klaviyo-email-marketing"
            ],
            "items": {
              "type": "string"
            }
          },
          "maxReviewsPerApp": {
            "title": "Max reviews per app",
            "minimum": 0,
            "maximum": 5000,
            "type": "integer",
            "description": "Reviews to output per app (you pay per review). 0 = reports only.",
            "default": 100
          },
          "sort": {
            "title": "Sort reviews by",
            "enum": [
              "newest",
              "relevant"
            ],
            "type": "string",
            "description": "Order in which Shopify returns reviews.",
            "default": "newest"
          },
          "stars": {
            "title": "Star ratings",
            "type": "array",
            "description": "Only reviews with these ratings. Leave empty for all.",
            "items": {
              "type": "string",
              "enum": [
                "1",
                "2",
                "3",
                "4",
                "5"
              ],
              "enumTitles": [
                "1 star",
                "2 stars",
                "3 stars",
                "4 stars",
                "5 stars"
              ]
            }
          },
          "dateFrom": {
            "title": "From date",
            "type": "string",
            "description": "Only reviews written on or after this day (YYYY-MM-DD)."
          },
          "dateTo": {
            "title": "To date",
            "type": "string",
            "description": "Only reviews written on or before this day (YYYY-MM-DD)."
          },
          "keywords": {
            "title": "Keywords",
            "type": "array",
            "description": "Only reviews that mention any of these words (case-insensitive).",
            "items": {
              "type": "string"
            }
          },
          "countries": {
            "title": "Store countries",
            "type": "array",
            "description": "Only reviews from stores in these countries, as Shopify shows them (e.g. United States, Germany).",
            "items": {
              "type": "string"
            }
          },
          "replyFilter": {
            "title": "Developer reply",
            "enum": [
              "any",
              "withReply",
              "withoutReply"
            ],
            "type": "string",
            "description": "Keep reviews by whether the developer answered.",
            "default": "any"
          },
          "includeReviews": {
            "title": "Output reviews",
            "type": "boolean",
            "description": "One result per review: rating, text, date, store name and country, how long the store has used the app, developer reply. Turn off to get only the app reports.",
            "default": true
          },
          "reviewTrends": {
            "title": "Review trends",
            "type": "boolean",
            "description": "Reviews in the last 7 / 30 days and the change against the 30 days before, rating per week, rating by store country, and new vs established merchants (stores using the app for under 30 days: the onboarding and churn signal).",
            "default": true
          },
          "developerReplies": {
            "title": "Developer replies",
            "type": "boolean",
            "description": "Share of reviews the developer answers (also for 1-2 star reviews), median reply time, and the negative reviews still without a reply.",
            "default": true
          },
          "complaintTopics": {
            "title": "Complaint topics and spikes",
            "type": "boolean",
            "description": "Complaint topics (crashes, bugs, login, billing, ads, performance, design, feature requests) with their share, and complaint spikes in the last 7 days.",
            "default": true
          },
          "categoryRanks": {
            "title": "Category ranks",
            "type": "boolean",
            "description": "Organic position of the app in each of its categories (ads skipped).",
            "default": true
          },
          "categoryPages": {
            "title": "Category pages to read",
            "minimum": 1,
            "maximum": 10,
            "type": "integer",
            "description": "Pages of each category listing (about 24 apps per page) searched for the rank.",
            "default": 3
          },
          "trackChanges": {
            "title": "Track changes between runs",
            "type": "boolean",
            "description": "Remember each app in a key-value store \"shopify-app-store-history\" in your account: new reviews per day, rating change, plan and price changes, Built for Shopify badge, listing changes (name, tagline, description, screenshots, languages, integrations), rank moves and alerts. Run on a schedule.",
            "default": true
          },
          "onlyNew": {
            "title": "Only new reviews",
            "type": "boolean",
            "description": "Output only reviews that earlier runs did not return (turns on change tracking). Good for daily schedules.",
            "default": false
          },
          "compareSimilarApps": {
            "title": "Compare similar apps",
            "type": "boolean",
            "description": "Also make a report for the apps Shopify lists under \"More apps like this\" (no reviews are output for them; each report is charged).",
            "default": false
          },
          "similarAppsCount": {
            "title": "Similar apps per app",
            "minimum": 1,
            "maximum": 10,
            "type": "integer",
            "description": "How many similar apps to add for each app.",
            "default": 3
          },
          "analysisDepth": {
            "title": "Reviews to analyze",
            "minimum": 50,
            "maximum": 3000,
            "type": "integer",
            "description": "Newest reviews read per app for the analytics. They are not output and not charged; more gives longer trends but takes longer (10 reviews per page).",
            "default": 500
          },
          "proxyConfiguration": {
            "title": "Proxy configuration",
            "type": "object",
            "description": "Not needed usually. Use Apify Proxy if Shopify starts blocking requests.",
            "default": {
              "useApifyProxy": false
            }
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}