{
  "openapi": "3.0.1",
  "info": {
    "title": "Brand Mentions Monitor - Bluesky, Hacker News & Mastodon",
    "description": "Monitor brand mentions on Bluesky, Hacker News and Mastodon: each run returns only posts and comments new since the last run. Rows: source, keyword, text, author, link, date, likes, replies. $2.50 per 1,000 new mentions + $0.001 per keyword per run; repeats and errors are free.",
    "version": "1.0",
    "x-build-id": "YwAerKCcO8E4GdyZi"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/tenfoldfleet~brand-mentions-monitor/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-tenfoldfleet-brand-mentions-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/tenfoldfleet~brand-mentions-monitor/runs": {
      "post": {
        "operationId": "runs-sync-tenfoldfleet-brand-mentions-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/tenfoldfleet~brand-mentions-monitor/run-sync": {
      "post": {
        "operationId": "run-sync-tenfoldfleet-brand-mentions-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": [
          "keywords"
        ],
        "properties": {
          "keywords": {
            "title": "Keywords to monitor",
            "type": "array",
            "description": "Brand names, product names, competitor names or phrases to watch for, one per line, up to 50 per run. Each keyword is searched on every selected source and every hit is checked in the post text before it is returned.",
            "items": {
              "type": "string"
            }
          },
          "sources": {
            "title": "Sources",
            "type": "array",
            "description": "Where to look. Bluesky and Hacker News are searched in full text. Mastodon has no public full-text search, so the keyword is turned into a hashtag (\"Brand Mentions\" becomes #BrandMentions) and that hashtag's timeline is read on the servers below.",
            "items": {
              "type": "string",
              "enum": [
                "bluesky",
                "hackernews",
                "mastodon"
              ],
              "enumTitles": [
                "Bluesky (full-text search)",
                "Hacker News (stories and comments)",
                "Mastodon (hashtag timelines)"
              ]
            },
            "default": [
              "bluesky",
              "hackernews",
              "mastodon"
            ]
          },
          "timeWindow": {
            "title": "Look back (first run)",
            "enum": [
              "hour",
              "day",
              "week",
              "month"
            ],
            "type": "string",
            "description": "How far back the first run of a monitor searches. Later runs continue from where the previous complete run ended, even when that was longer ago than this window.",
            "default": "week"
          },
          "matchMode": {
            "title": "Match keywords as",
            "enum": [
              "phrase",
              "allWords",
              "anyWord"
            ],
            "type": "string",
            "description": "\"Exact phrase\": the keyword's words appear together in this order (case doesn't matter, whole words only). \"All words\": every word appears somewhere in the post. \"Any word\": at least one word appears. On Mastodon a post carrying the keyword's hashtag always counts.",
            "default": "phrase"
          },
          "excludeWords": {
            "title": "Exclude words",
            "type": "array",
            "description": "Skip a post when its text contains any of these words or phrases (whole words, case doesn't matter). Skipped posts are never charged. Example: for the brand \"Notion\" exclude \"the notion\".",
            "items": {
              "type": "string"
            }
          },
          "languages": {
            "title": "Languages (optional)",
            "type": "array",
            "description": "Keep only posts in these languages, as two-letter codes (\"en\", \"de\"). Hacker News posts and posts without a language tag are always kept. Empty: all languages.",
            "items": {
              "type": "string"
            }
          },
          "maxMentionsPerSource": {
            "title": "Max new mentions per keyword per source",
            "minimum": 1,
            "maximum": 1000,
            "type": "integer",
            "description": "Upper limit of mentions returned for each keyword from each source in one run. Mentions over the limit are skipped for good and not charged. Free Apify plan: at most 50 mentions per run in total.",
            "default": 100
          },
          "mastodonInstances": {
            "title": "Mastodon servers",
            "type": "array",
            "description": "Mastodon servers whose public hashtag timelines are read, up to 5. mastodon.social is the largest and sees posts from across the network; small servers often return nothing.",
            "default": [
              "mastodon.social"
            ],
            "items": {
              "type": "string"
            }
          },
          "monitorName": {
            "title": "Monitor name (optional)",
            "type": "string",
            "description": "Runs with the same monitor name share a memory of the mentions already returned, so each scheduled run returns only what is new. Leave it empty and a saved task keeps its own memory; a run outside a task ties the memory to its exact keyword list. Use a different name for each brand or client."
          },
          "onlyNewMentions": {
            "title": "Only new mentions",
            "type": "boolean",
            "description": "On: skip mentions this monitor returned in earlier runs (the first run returns the backlog in the time window). Off: return every match in the time window on every run; each returned mention is charged.",
            "default": true
          },
          "proxyConfiguration": {
            "title": "Proxy",
            "type": "object",
            "description": "Not needed: all three sources are public APIs. Turn on the Apify datacenter proxy only if a source blocks your runs. Residential proxy groups are ignored.",
            "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}