{ "openapi": "3.0.1", "info": { "title": "Creator Discovery and Campaign Data API - CreatorIQ", "description": "Search the creators in your CreatorIQ CRM by category, country, language, gender and tags, then pull profiles, social accounts, audience demographics, live Instagram, TikTok and YouTube stats, campaigns, campaign creators and post metrics (reach, views, EMV). Read only. Bring your own API key.", "version": "0.1", "x-build-id": "qdv3BtwgWKpM1FSvp" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nabeelbaghoor~creator-discovery-crm-campaign-data-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nabeelbaghoor-creator-discovery-crm-campaign-data-api", "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/nabeelbaghoor~creator-discovery-crm-campaign-data-api/runs": { "post": { "operationId": "runs-sync-nabeelbaghoor-creator-discovery-crm-campaign-data-api", "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/nabeelbaghoor~creator-discovery-crm-campaign-data-api/run-sync": { "post": { "operationId": "run-sync-nabeelbaghoor-creator-discovery-crm-campaign-data-api", "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": { "service": { "title": "What to read", "enum": [ "creators", "creatorProfiles", "socialAccounts", "audience", "handleLookup", "socialProfiles", "campaigns", "campaignCreators", "campaignPosts", "lists" ], "type": "string", "description": "Creator search lists the creators in your CRM with the filters below and needs no identifiers, so it is the default. Creator profile, social accounts and audience demographics read each publisher id in the identifiers input. Creator lookup by handle checks whether a username or profile link is in your CRM. Social profile data reads live stats for profile links or usernames. Campaigns lists campaigns; campaign creators and campaign posts read each campaign id. Creator lists lists your saved lists.", "default": "creators" }, "identifiers": { "title": "Identifiers", "type": "array", "description": "One per line. Creator profile, social accounts and audience: publisher ids, as the creator search returns them. Creator lookup by handle: usernames or profile links. Social profile data: profile links, or usernames on the social network below. Campaign creators and campaign posts: campaign ids. Creator search, campaigns and lists read none.", "items": { "type": "string" } }, "socialNetwork": { "title": "Social network", "enum": [ "instagram", "tiktok", "youtube", "twitch", "facebook", "twitter", "pinterest" ], "type": "string", "description": "Creator lookup by handle, and social profile data given usernames: the network the handles belong to. Social profile data takes Instagram, TikTok, YouTube, Twitch and Facebook; profile links need no network.", "default": "instagram" }, "publisherIdType": { "title": "Publisher id type", "enum": [ "Id", "PublisherId" ], "type": "string", "description": "Creator profile and social accounts: whether the identifiers are the internal id (the publisherId column of this actor) or the PublisherId (the publisherKey column).", "default": "Id" }, "creatorName": { "title": "Creator name", "type": "string", "description": "Creator search: match this creator name (PublisherName)." }, "categories": { "title": "Categories", "type": "array", "description": "Creator search: categories as your CRM names them, such as Beauty or Gaming. Any of them matches.", "items": { "type": "string" } }, "countries": { "title": "Countries", "type": "array", "description": "Creator search: creator countries as your CRM stores them.", "items": { "type": "string" } }, "languages": { "title": "Languages", "type": "array", "description": "Creator search: creator languages, such as English.", "items": { "type": "string" } }, "genders": { "title": "Genders", "type": "array", "description": "Creator search: creator genders, such as female or male.", "items": { "type": "string" } }, "tags": { "title": "Tags", "type": "array", "description": "Creator search: CRM tags the creator carries.", "items": { "type": "string" } }, "extraFilter": { "title": "Extra filter", "type": "string", "description": "Creator search: more documented filters as Column=Value pairs separated by semicolons, several values separated by commas, such as Status=Active;EyeColor=Blue,Green. Columns: Id, PublisherName, NetworkPublisherId, DateOfBirth, Language, EthnicBackground, Gender, RecruiterName, Category, SubCategories, Description, LastUpdated, Country, Relationship, Children, Pets, EyeColor, HairColor, InternalDescription, Tags, TotalSubscribers, Status." }, "sortBy": { "title": "Sort by", "enum": [ "default", "PublisherName", "TotalSubscribers", "DateRecruitingStarted" ], "type": "string", "description": "Creator search: the order creators come in.", "default": "default" }, "sortOrder": { "title": "Sort order", "enum": [ "asc", "desc" ], "type": "string", "description": "Creator search.", "default": "asc" }, "campaignFilter": { "title": "Campaign filter", "type": "string", "description": "Campaigns: documented filters as Column=Value pairs separated by semicolons, such as StartDate=2024-01-01;DivisionId=1234. Encoded for you." }, "campaignMembers": { "title": "Campaign members", "enum": [ "active", "candidates", "both" ], "type": "string", "description": "Campaign creators: creators active in the campaign, candidates to it, or both.", "default": "active" }, "campaignSections": { "title": "Campaign creator sections", "type": "array", "description": "Campaign creators: extra sections to include with each creator. They appear under raw when the full record is included.", "items": { "type": "string", "enum": [ "ScheduledPosts", "Contract", "InstructionsForPublishers", "CampaignDashboardLink", "FinalPayout", "PublisherCampaignsListLink", "PublishersCustomFields", "FraudSummary", "CampaignFlags", "SocialAccounts" ], "enumTitles": [ "Scheduled posts", "Contract", "Instructions for publishers", "Campaign dashboard link", "Final payout", "Publisher campaigns list link", "Publisher custom fields", "Fraud summary", "Campaign flags", "Social accounts" ] } }, "postsFrom": { "title": "Posts from", "type": "string", "description": "Campaign posts: the first date, as YYYY-MM-DD." }, "postsTo": { "title": "Posts to", "type": "string", "description": "Campaign posts: the last date, as YYYY-MM-DD." }, "postNetwork": { "title": "Post network", "enum": [ "any", "Facebook", "Instagram", "YouTube", "Web", "Twitter", "Twitch", "TikTok", "Snapchat", "Pinterest" ], "type": "string", "description": "Campaign posts: one social network only.", "default": "any" }, "postType": { "title": "Post type", "enum": [ "any", "permalink", "story", "image", "reel", "Photo", "video", "tweet", "TiktokPost", "stream", "other", "article", "status", "blog", "short", "link", "carousel", "clip", "post", "text", "Album", "snap", "YoutubeVideo", "spotlight" ], "type": "string", "description": "Campaign posts: one post type only.", "default": "any" }, "postPublisherId": { "title": "Post publisher id", "minimum": 1, "type": "integer", "description": "Campaign posts: the posts of one creator only, by internal publisher id." }, "includeRaw": { "title": "Include the full record", "type": "boolean", "description": "Keep the provider's whole record under raw, alongside the flattened columns. Creator records carry over a hundred fields, contact details included.", "default": false }, "maxResults": { "title": "Maximum results", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Stop after this many rows. Lists are read 100 records per page, and only as many pages as this needs.", "default": 100 }, "requestsPerMinute": { "title": "Requests per minute", "minimum": 1, "maximum": 300, "type": "integer", "description": "Pacing ceiling for calls to the provider, which allows 5 per second and 100,000 a day per key. Rate limited answers are retried after a pause.", "default": 120 }, "apiKey": { "title": "API key", "type": "string", "description": "Your own CreatorIQ API key (x-api-key), issued by your account manager for your CRM instance. This actor is bring-your-own-key and never ships one. Leave blank to use the DATA_API_KEY environment secret. It is sent only to the API host and is never written to a row or logged." }, "baseUrl": { "title": "API base URL", "type": "string", "description": "Override the host the actor calls. Only useful for testing against a different environment." } } }, "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 } } } } } } } } } }