{ "openapi": "3.0.1", "info": { "title": "AppKittie Ad Search", "description": "Search and filter mobile app ads through the AppKittie API.", "version": "0.2", "x-build-id": "fiUa9nQV2HVNpFThV" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/appkittie~appkittie-ads/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-appkittie-appkittie-ads", "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/appkittie~appkittie-ads/runs": { "post": { "operationId": "runs-sync-appkittie-appkittie-ads", "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/appkittie~appkittie-ads/run-sync": { "post": { "operationId": "run-sync-appkittie-appkittie-ads", "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": { "operation": { "title": "Operation", "enum": [ "search", "details" ], "type": "string", "description": "Choose which AppKittie ads endpoint to call.", "default": "search" }, "adId": { "title": "Ad ID", "minLength": 1, "type": "string", "description": "Required for details. Use an ad document ID returned by ad search or GET /api/v1/ads." }, "search": { "title": "Search query", "type": "string", "description": "Full-text search across selected ad and app fields." }, "textSearchFields": { "title": "Text search fields", "type": "array", "description": "Fields used for full-text search when a search query is provided. Valid values: creative_text, title, body, caption, description, label, cta_text, page_name, developer, app_title, category.", "items": { "type": "string" } }, "view": { "title": "Response view", "enum": [ "full", "compact" ], "type": "string", "description": "Use compact for lighter responses without media URLs.", "default": "full" }, "appId": { "title": "App identifier", "type": "string", "description": "Optional app filter. Accepts AppKittie slug, numeric App Store ID, Google Play package name, or store URL." }, "adSource": { "title": "Ad source", "enum": [ "all", "meta", "google" ], "type": "string", "description": "Filter by ad library source.", "default": "all" }, "mediaType": { "title": "Media type", "enum": [ "all", "image", "video" ], "type": "string", "description": "Filter by creative media type.", "default": "all" }, "status": { "title": "Status", "enum": [ "all", "active", "inactive" ], "type": "string", "description": "Filter active or inactive ads.", "default": "all" }, "categories": { "title": "Categories", "uniqueItems": true, "type": "array", "description": "App categories to include.", "items": { "type": "string", "enum": [ "Books", "Business", "Education", "Entertainment", "Finance", "Food & Drink", "Games", "Graphics & Design", "Health & Fitness", "Lifestyle", "Magazines & Newspapers", "Medical", "Music", "Navigation", "News", "Photo & Video", "Productivity", "Reference", "Shopping", "Social Networking", "Sports", "Travel", "Utilities", "Weather", "Developer Tools", "Kids", "Safari Extensions", "Auto & Vehicles", "Beauty", "Comics", "Communication", "Dating", "Events", "House & Home", "Libraries & Demo", "Parenting", "Personalization" ] } }, "excludedCategories": { "title": "Excluded categories", "uniqueItems": true, "type": "array", "description": "App categories to exclude.", "items": { "type": "string", "enum": [ "Books", "Business", "Education", "Entertainment", "Finance", "Food & Drink", "Games", "Graphics & Design", "Health & Fitness", "Lifestyle", "Magazines & Newspapers", "Medical", "Music", "Navigation", "News", "Photo & Video", "Productivity", "Reference", "Shopping", "Social Networking", "Sports", "Travel", "Utilities", "Weather", "Developer Tools", "Kids", "Safari Extensions", "Auto & Vehicles", "Beauty", "Comics", "Communication", "Dating", "Events", "House & Home", "Libraries & Demo", "Parenting", "Personalization" ] } }, "adLanguages": { "title": "Ad language countries", "type": "array", "description": "Representative country codes mapped to ad languages, such as US or DE.", "items": { "type": "string", "minLength": 2 } }, "excludedAdLanguages": { "title": "Excluded ad language countries", "type": "array", "description": "Representative country codes whose mapped ad languages should be excluded.", "items": { "type": "string", "minLength": 2 } }, "countries": { "title": "Countries", "type": "array", "description": "Country or region codes where ads were shown.", "items": { "type": "string", "minLength": 2 } }, "excludedCountries": { "title": "Excluded countries", "type": "array", "description": "Country or region codes to exclude.", "items": { "type": "string", "minLength": 2 } }, "surfaces": { "title": "Surfaces", "type": "array", "description": "Publisher surfaces to include.", "items": { "type": "string", "minLength": 1 } }, "excludedSurfaces": { "title": "Excluded surfaces", "type": "array", "description": "Publisher surfaces to exclude.", "items": { "type": "string", "minLength": 1 } }, "developer": { "title": "Developer", "type": "string", "description": "Exact app developer name." }, "startedAfter": { "title": "Started after", "minimum": 0, "type": "integer", "description": "Unix timestamp in seconds. Returns ads that started after this date." }, "startedBefore": { "title": "Started before", "minimum": 0, "type": "integer", "description": "Unix timestamp in seconds. Returns ads that started before this date." }, "endedAfter": { "title": "Ended after", "minimum": 0, "type": "integer", "description": "Unix timestamp in seconds. Returns ads that ended after this date." }, "endedBefore": { "title": "Ended before", "minimum": 0, "type": "integer", "description": "Unix timestamp in seconds. Returns ads that ended before this date." }, "minAppDownloads": { "title": "Minimum app downloads", "minimum": 0, "type": "integer", "description": "Minimum estimated monthly downloads for the advertised app." }, "maxAppDownloads": { "title": "Maximum app downloads", "minimum": 0, "type": "integer", "description": "Maximum estimated monthly downloads for the advertised app." }, "minAppRevenue": { "title": "Minimum app revenue", "minimum": 0, "type": "integer", "description": "Minimum estimated monthly revenue for the advertised app." }, "maxAppRevenue": { "title": "Maximum app revenue", "minimum": 0, "type": "integer", "description": "Maximum estimated monthly revenue for the advertised app." }, "limit": { "title": "Limit", "minimum": 1, "maximum": 10, "type": "integer", "description": "Number of ads to return. Actor runs are capped at 10 returned ads.", "default": 10 }, "cursor": { "title": "Cursor", "minimum": 0, "type": "integer", "description": "Pagination offset. Use nextCursor from a previous response." }, "sortBy": { "title": "Sort by", "enum": [ "start_date", "end_date", "app_downloads", "app_revenue", "app_released_timestamp", "app_updated_timestamp" ], "type": "string", "description": "Field used for sorting.", "default": "start_date" }, "sortOrder": { "title": "Sort order", "enum": [ "asc", "desc" ], "type": "string", "description": "Sort direction.", "default": "desc" } } }, "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 } } } } } } } } } }