{
  "openapi": "3.0.1",
  "info": {
    "title": "Google Trends Keyword Report: Trends, Seasons & Breakouts",
    "description": "Is a keyword rising or falling, when in the year does it peak, where is it searched most and which related searches are breaking out? One report per keyword from Google Trends, with the raw timeline too. No account, no API key.",
    "version": "0.1",
    "x-build-id": "JLl6j9DofeV5uhaLN"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/precious_bathmat~google-trends-keyword-report/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-precious_bathmat-google-trends-keyword-report",
        "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/precious_bathmat~google-trends-keyword-report/runs": {
      "post": {
        "operationId": "runs-sync-precious_bathmat-google-trends-keyword-report",
        "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/precious_bathmat~google-trends-keyword-report/run-sync": {
      "post": {
        "operationId": "run-sync-precious_bathmat-google-trends-keyword-report",
        "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": {
          "keywords": {
            "title": "Keywords",
            "type": "array",
            "description": "One keyword or phrase per line. Each one gets its own report: direction, peak, seasonality, regions and the searches growing around it.",
            "items": {
              "type": "string"
            }
          },
          "country": {
            "title": "Country",
            "enum": [
              "WORLDWIDE",
              "US",
              "GB",
              "CA",
              "AU",
              "NZ",
              "IE",
              "DE",
              "FR",
              "ES",
              "IT",
              "NL",
              "BE",
              "CH",
              "AT",
              "SE",
              "DK",
              "NO",
              "FI",
              "PL",
              "PT",
              "TR",
              "IL",
              "AE",
              "SA",
              "EG",
              "ZA",
              "NG",
              "KE",
              "IN",
              "PK",
              "SG",
              "MY",
              "ID",
              "PH",
              "TH",
              "VN",
              "JP",
              "KR",
              "HK",
              "TW",
              "BR",
              "MX",
              "AR",
              "CL",
              "CO"
            ],
            "type": "string",
            "description": "Where the searches happen. Worldwide compares countries instead of regions.",
            "default": "US"
          },
          "timeframe": {
            "title": "Period",
            "enum": [
              "now 1-d",
              "now 7-d",
              "today 1-m",
              "today 3-m",
              "today 12-m",
              "today 5-y",
              "all"
            ],
            "type": "string",
            "description": "How far back to look. Twelve months and five years are weekly; five years is what shows seasonality and year-on-year change.",
            "default": "today 12-m"
          },
          "searchType": {
            "title": "Where people search",
            "enum": [
              "web",
              "youtube",
              "news",
              "images",
              "shopping"
            ],
            "type": "string",
            "description": "Ordinary Google search, or one of Google's other surfaces.",
            "default": "web"
          },
          "category": {
            "title": "Category",
            "enum": [
              "0",
              "3",
              "5",
              "7",
              "8",
              "11",
              "12",
              "13",
              "14",
              "16",
              "18",
              "19",
              "20",
              "22",
              "29",
              "44",
              "45",
              "47",
              "65",
              "66",
              "67",
              "71",
              "174",
              "299",
              "533",
              "958"
            ],
            "type": "string",
            "description": "Narrows the searches to one Google category, so \"apple\" in Food & Drink is the fruit, not the company.",
            "default": "0"
          },
          "compareKeywords": {
            "title": "Compare the keywords against each other",
            "type": "boolean",
            "description": "Off: every keyword is measured on its own 0-100 scale, which is what you want for trend and seasonality. On: keywords share one scale, in groups of five, and each report gets its share of the interest between them.",
            "default": false
          },
          "includeRelated": {
            "title": "Include related and breakout searches",
            "type": "boolean",
            "description": "The searches people make alongside the keyword, and the ones growing fastest around it. Free.",
            "default": true
          },
          "includeRegions": {
            "title": "Include interest by region",
            "type": "boolean",
            "description": "States, regions or countries ranked by how strongly they search for the keyword. Free.",
            "default": true
          },
          "maxRelated": {
            "title": "Related searches per list",
            "minimum": 1,
            "maximum": 25,
            "type": "integer",
            "description": "How many top and rising searches to keep for each keyword. Google returns at most 25 of each.",
            "default": 25
          },
          "includeTimeline": {
            "title": "Also return every data point as a row",
            "type": "boolean",
            "description": "A second table with one row per keyword per week (or hour, or month), ready to chart in a spreadsheet. Free.",
            "default": true
          },
          "trendingCountries": {
            "title": "Also return today's trending searches",
            "type": "array",
            "description": "Pick countries to get what they are searching right now: the trending searches with Google's traffic estimate and the news story behind each one. Free, and it works on its own if you leave the keywords empty.",
            "items": {
              "type": "string",
              "enum": [
                "US",
                "GB",
                "CA",
                "AU",
                "NZ",
                "IE",
                "DE",
                "FR",
                "ES",
                "IT",
                "NL",
                "BE",
                "CH",
                "AT",
                "SE",
                "DK",
                "NO",
                "FI",
                "PL",
                "PT",
                "TR",
                "IL",
                "AE",
                "SA",
                "EG",
                "ZA",
                "NG",
                "KE",
                "IN",
                "PK",
                "SG",
                "MY",
                "ID",
                "PH",
                "TH",
                "VN",
                "JP",
                "KR",
                "HK",
                "TW",
                "BR",
                "MX",
                "AR",
                "CL",
                "CO"
              ],
              "enumTitles": [
                "United States",
                "United Kingdom",
                "Canada",
                "Australia",
                "New Zealand",
                "Ireland",
                "Germany",
                "France",
                "Spain",
                "Italy",
                "Netherlands",
                "Belgium",
                "Switzerland",
                "Austria",
                "Sweden",
                "Denmark",
                "Norway",
                "Finland",
                "Poland",
                "Portugal",
                "Turkey",
                "Israel",
                "United Arab Emirates",
                "Saudi Arabia",
                "Egypt",
                "South Africa",
                "Nigeria",
                "Kenya",
                "India",
                "Pakistan",
                "Singapore",
                "Malaysia",
                "Indonesia",
                "Philippines",
                "Thailand",
                "Vietnam",
                "Japan",
                "South Korea",
                "Hong Kong",
                "Taiwan",
                "Brazil",
                "Mexico",
                "Argentina",
                "Chile",
                "Colombia"
              ]
            },
            "default": []
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}