{
  "openapi": "3.0.1",
  "info": {
    "title": "Review Intelligence",
    "description": "Turn normalized customer reviews into one deterministic, evidence-backed product intelligence report.",
    "version": "0.1",
    "x-build-id": "MtEKdSH2dbKYHTHnt"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/agentworkflowlab~review-intelligence/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-agentworkflowlab-review-intelligence",
        "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/agentworkflowlab~review-intelligence/runs": {
      "post": {
        "operationId": "runs-sync-agentworkflowlab-review-intelligence",
        "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/agentworkflowlab~review-intelligence/run-sync": {
      "post": {
        "operationId": "run-sync-agentworkflowlab-review-intelligence",
        "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": "Inline review records or documented upstream shapes. Source-specific aliases include Google Maps text/stars/publishedAtDate/name, Junglee Amazon reviewTitle/reviewDescription/ratingScore/username, and App Store text/score/date/userName. The Console editor uses integer ratings and string IDs; Dataset records also normalize numeric strings and numeric IDs at runtime. Maximum 5,000 records are analyzed.",
            "items": {
              "type": "object",
              "properties": {
                "text": {
                  "title": "Text",
                  "description": "Primary review text.",
                  "type": "string"
                },
                "reviewText": {
                  "title": "Review text",
                  "description": "Alternative review text field.",
                  "type": "string"
                },
                "content": {
                  "title": "Content",
                  "description": "Alternative content field.",
                  "type": "string"
                },
                "review": {
                  "title": "Review",
                  "description": "Alternative generic review text field.",
                  "type": "string"
                },
                "title": {
                  "title": "Review title",
                  "description": "Review headline, optionally combined with body.",
                  "type": "string"
                },
                "body": {
                  "title": "Review body",
                  "description": "Review body, optionally combined with title.",
                  "type": "string"
                },
                "reviewTitle": {
                  "title": "Amazon review title",
                  "description": "Junglee Amazon review headline.",
                  "type": "string"
                },
                "reviewDescription": {
                  "title": "Amazon review description",
                  "description": "Junglee Amazon review body.",
                  "type": "string"
                },
                "rating": {
                  "title": "Rating",
                  "description": "Integer rating from 1 to 5.",
                  "type": "integer",
                  "minimum": 1,
                  "maximum": 5
                },
                "stars": {
                  "title": "Stars",
                  "description": "Alternative integer rating from 1 to 5.",
                  "type": "integer",
                  "minimum": 1,
                  "maximum": 5
                },
                "score": {
                  "title": "Score",
                  "description": "Alternative integer rating from 1 to 5.",
                  "type": "integer",
                  "minimum": 1,
                  "maximum": 5
                },
                "ratingScore": {
                  "title": "Amazon rating score",
                  "description": "Junglee Amazon integer rating from 1 to 5.",
                  "type": "integer",
                  "minimum": 1,
                  "maximum": 5
                },
                "date": {
                  "title": "Date",
                  "description": "Review date or timestamp.",
                  "type": "string"
                },
                "publishedAt": {
                  "title": "Published at",
                  "description": "Alternative publication timestamp.",
                  "type": "string"
                },
                "publishedAtDate": {
                  "title": "Google Maps published date",
                  "description": "Google Maps ISO publication timestamp.",
                  "type": "string"
                },
                "updatedAt": {
                  "title": "Updated at",
                  "description": "Alternative review update timestamp.",
                  "type": "string"
                },
                "author": {
                  "title": "Author",
                  "description": "Review author name.",
                  "type": "string"
                },
                "reviewerName": {
                  "title": "Reviewer name",
                  "description": "Alternative reviewer name.",
                  "type": "string"
                },
                "authorName": {
                  "title": "Author name",
                  "description": "Alternative review author name.",
                  "type": "string"
                },
                "name": {
                  "title": "Google Maps reviewer name",
                  "description": "Google Maps review author.",
                  "type": "string"
                },
                "username": {
                  "title": "Amazon username",
                  "description": "Optional Junglee Amazon review author.",
                  "type": "string"
                },
                "userName": {
                  "title": "App Store username",
                  "description": "Apple App Store review author.",
                  "type": "string"
                },
                "id": {
                  "title": "Review ID",
                  "description": "Source review identifier.",
                  "type": "string"
                },
                "reviewId": {
                  "title": "Alternative review ID",
                  "description": "Alternative source review identifier.",
                  "type": "string"
                },
                "source": {
                  "title": "Source",
                  "description": "Optional source label.",
                  "type": "string"
                }
              }
            }
          },
          "datasetId": {
            "title": "Source Dataset",
            "type": "string",
            "description": "Select an Apify Dataset to analyze. Used only when the reviews property is absent. The Actor receives read-only access to this Dataset and fetches at most maxReviews items."
          },
          "productName": {
            "title": "Product name",
            "type": "string",
            "description": "Optional product or service label included in the report."
          },
          "topics": {
            "title": "Additional topics",
            "maxItems": 20,
            "type": "array",
            "description": "Up to 20 custom topics, each with up to 20 literal keywords.",
            "items": {
              "type": "object",
              "properties": {
                "label": {
                  "title": "Topic label",
                  "description": "Unique custom topic label.",
                  "type": "string"
                },
                "keywords": {
                  "title": "Keywords",
                  "description": "Literal keywords that identify this topic.",
                  "type": "array",
                  "maxItems": 20,
                  "items": {
                    "type": "string"
                  }
                }
              },
              "required": [
                "label",
                "keywords"
              ]
            }
          },
          "negativeRatingThreshold": {
            "title": "Negative rating threshold",
            "minimum": 1,
            "maximum": 5,
            "type": "integer",
            "description": "Ratings at or below this value are treated as negative.",
            "default": 3
          },
          "maxReviews": {
            "title": "Maximum reviews",
            "minimum": 1,
            "maximum": 5000,
            "type": "integer",
            "description": "Maximum records to inspect; hard-capped at 5,000.",
            "default": 1000
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}