{ "openapi": "3.0.1", "info": { "title": "LinkedIn Ads Library Scraper", "description": "Collect ads from the public LinkedIn Ad Library by keyword, advertiser or company ID: ad text, format, advertiser, run dates, impressions and targeting.", "version": "0.2", "x-build-id": "7njUtgofyuxCLgzuF" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/datatrilha~linkedin-ads-library/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-datatrilha-linkedin-ads-library", "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/datatrilha~linkedin-ads-library/runs": { "post": { "operationId": "runs-sync-datatrilha-linkedin-ads-library", "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/datatrilha~linkedin-ads-library/run-sync": { "post": { "operationId": "run-sync-datatrilha-linkedin-ads-library", "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": "Search the ad library for these keywords. One search per keyword.", "items": { "type": "string" } }, "advertisers": { "title": "Advertiser names", "type": "array", "description": "Search by advertiser (account owner) name, for example \"microsoft\".", "items": { "type": "string" } }, "payers": { "title": "Payer names", "type": "array", "description": "Search by the entity that paid for the ads (the \"Paid for by\" line).", "items": { "type": "string" } }, "companyIds": { "title": "LinkedIn company IDs", "type": "array", "description": "Numeric LinkedIn company IDs. The most precise way to get every ad from one company.", "items": { "type": "string" } }, "startUrls": { "title": "Ad Library URLs", "type": "array", "description": "Search or ad detail URLs copied from linkedin.com/ad-library. Use this for filters not covered above.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "countries": { "title": "Countries", "type": "array", "description": "Two-letter country codes where the ads ran, for example US, GB, BR. Leave empty for all countries.", "items": { "type": "string" } }, "dateOption": { "title": "Date range", "enum": [ "all", "last-30-days", "current-month", "current-year", "last-year", "custom-date-range" ], "type": "string", "description": "When the ads ran.", "default": "all" }, "startDate": { "title": "Start date (custom range)", "type": "string", "description": "YYYY-MM-DD. Used only with the custom range." }, "endDate": { "title": "End date (custom range)", "type": "string", "description": "YYYY-MM-DD. Used only with the custom range." }, "maxAdsPerSearch": { "title": "Max ads per search", "minimum": 1, "type": "integer", "description": "Stop each search after this many ads. You pay only for ads returned.", "default": 100 }, "includeDetails": { "title": "Include ad details", "type": "boolean", "description": "Open each ad for the full text, \"Paid for by\", headline, call to action and video files, plus run dates, impressions and targeting where LinkedIn shows them. Slower, but much richer.", "default": true }, "delaySecs": { "title": "Delay between requests (seconds)", "minimum": 1, "type": "integer", "description": "LinkedIn rate-limits fast clients. Lower values are faster but get blocked more often.", "default": 2 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "LinkedIn rate-limits datacenter IPs. Residential proxies are recommended.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } } } }, "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 } } } } } } } } } }