openapi: 3.2.0 info: title: Skai Meta Ads API description: "# Overview\nSkai APIs provide programmatic access to advertising data and campaign management across Search, Social, and Retail Media publishers.\n\n## Choosing the Right API\n\n| What you want to do | API to use | Scale | Notes |\n|---|---|---|---|\n| Pull performance data, metrics, or any reportable field | [Reporting](#tag/Synchronous-Reports) or [Async Reporting](#tag/Asynchronous-Reports) | Unlimited | Primary data access API — the main Skai value-prop |\n| Discover what columns and metrics are available | [Available Columns](#operation/getAvailableColumns) | — | Full list of reportable fields per entity type |\n| Create or update campaigns, keywords, bids, budgets, targeting, and more — at scale | [Bulk Update (One File)](#tag/Bulk-Update) | Millions of rows | Supports Skai's main entity types and hundreds of attributes; all publishers except Meta |\n| Create/update a small number of campaigns or ad groups (common attributes only) | [Campaigns](#tag/Campaigns) / [Ad Groups](#tag/Ad-Groups) / [Ads](#tag/Ads) | Thousands | Limited attribute set — use Bulk Update for full control |\n| Manage Meta (Facebook/Instagram) entities | [Meta Campaigns](#tag/Meta-Campaigns) / [Meta Ad Groups](#tag/Meta-Ad-Groups) / [Meta Ads](#tag/Meta-Ads) | Thousands | Meta-specific tag and attribution management |\n| Use Skai from an AI coding assistant (Claude, Cursor, ChatGPT, Windsurf) | [MCP Integration](#tag/MCP) | — | Full reporting access via natural language |\n\nSkai APIs are RESTful and language agnostic. Authentication uses Bearer tokens over HTTPS.\n\n## What Data Can I Access?\n\nSkai aggregates advertising data across three publisher categories:\n\n| Publisher category | Examples |\n|---|---|\n| **Search** | Google Ads, Microsoft Ads, Yahoo Japan, Baidu, and others |\n| **Social (excl. Meta)** | Pinterest, Snapchat, TikTok, LinkedIn, Reddit, and others |\n| **Social (Meta)** | Facebook, Instagram |\n| **Retail Media** | Amazon Ads, Walmart, Instacart, Kroger, Target, and 100+ others |\n\n**Reportable entity types:**\n\n| Entity | Description | Publishers |\n|---|---|---|\n| `CAMPAIGN` | Campaign-level data | All |\n| `ADGROUP` | Ad group / ad set level | All |\n| `KEYWORD` | Keyword-level performance and settings | Search, Retail Media |\n| `AD` | Individual ad creatives | All |\n| `PRODUCT_ASSET` | Product-level data for shopping and retail media (called \"Products\" in the Skai UI) | Retail Media, Search Shopping |\n| `PRODUCT_TARGETING` | Product targeting entities — ASINs, categories, and product attributes | Retail Media |\n| `PORTFOLIO` | Portfolio-level budget aggregations and pacing | All |\n\n**Available metric categories per entity:**\n\n- **Performance** — Impressions, Clicks, Cost, Conversions, Revenue, ROAS, CTR, CPC, and more\n- **Attributes** — Names, statuses, budgets, bids, targeting settings, and publisher-specific fields\n- **Account-configured** — Dimensions (custom tagging labels), Conversion events (publisher, pixel, and 3rd-party), Custom Metrics (formula-based calculations your team defines)\n\nUse [Available Columns](#operation/getAvailableColumns) to see the complete column list for any entity — including full descriptions and types. A static reference is embedded in that endpoint's documentation.\n\n\n## Authentication\nThe Skai API uses the Bearer authentication scheme.\nThe first step is to generate a *refresh token* (once), which you can then exchange for a temporary *access token*, programmatically, before making an API call.\n\n> Note: The user you use to generate your *refresh token* will determine the token's permissions. API access is allowed for users with Standard role or higher.\nIt is recommended that you create and use a specialized user for your API requests.\n\n\n#### Step 1: Get a Refresh Token\nYou only need to do this once, for each API user you plan to use. \n\nLog into [this page](https://login.kenshoo.com/api/dev/refresh-token) in order to get your *refresh token* and *client ID*. The user you log in with will be the user accessing the API. \nPlease store your refresh token in a secure place. While it is not possible to recover a refresh token, you can generate a new one. The refresh token does not expire.\n\n\n#### Step 2: Generating an Access Token\nBefore making API calls, your code uses the permanent *refresh token* to generate a temporary *access token*.\n\nMake a call to /api/v1/token (as shown below) with your *refresh token* and *client ID* to generate an *access token*:\n\n curl -X POST -d \"refresh_token=&client_id=\" \\\n https://services.kenshoo.com/api/v1/token\n\nNote: the client_id and refresh token should be sent in the POST request body, as the refresh token is confidential and should not be sent as url param.\nthe API will reject refresh tokens sent in url params.\n\nGet token for specific agency context:\nIn case your API user is assigned to multi accounts (agencies), you should explicitly specify in the get access-token request which agency context you would like to receive the token for.\nJust add to the request mentioned above another form param called *agency_id*, and pass the relevant agency ID like this:\n \n curl -X POST -d \"refresh_token=&client_id=&agency_id=\" \\\n https://services.kenshoo.com/api/v1/token\n\nToken expiration:\nPlease check for token expiration before sending another API request , you have 2 options:\n\n1. Call the API and get 401 status code indicating authentication failed.\n2. Consider the *expires_in* field of the token to issue a new access token.\n\nThe response will return a JSON containing the token and time for expiration in seconds.\nIt is recommended to use the token expiration time and reuse tokens while they are still valid, to prevent rate limit issues with generating new tokens too often.\n\n {\"email\":\"my.user@skai.io\",\"expires_in\":21600,\"access_token\":\"eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJzaGxvbWkuY29oZW5Ac2thaS5pbyIsImV4cCI6MTcxNDU2NjgxMSwiaXNzIjoiaHR0cDovL2tlbnNob28uY29tL2xvZ2luLXNlcnZlciIsInVzZXJpZCI6MzU5NDMsImFnZW5jeUlkIjoxNSwibmFtZSI6IlNobG9taSBDb2hlbiIsInJvbGVzIjpbIktlbnNob28gQWRtaW4iLCJTa2FpIERldmVsb3BlciJdLCJhZ2VuY3lfcm9sZXMiOlt7ImFnZW5jeUlkIjoxNSwicm9sZSI6IktlbnNob28gQWRtaW4ifV0sImJpbGxpbmdJZCI6OTIwMzEsImFwaWMiOiI5MjAzMSIsIm9yaSI6ImFwaSIsImFsbG93ZWRfYXBwcyI6W119.R3tHoaecUrMGzijnF5suo9SVsffXWbWxdMv5fdB3Jx8\"}\n\n\n\n\n\n#### Step 3: Making an API call\nWith any API call to all Skai APIs, you must send a valid *access token* in the Authorization header when making requests. For example:\n\n curl -H \"Authorization: Bearer \" -X POST \\\n https://services.kenshoo.com/api/v1/campaigns\n\n\n## Rate Limits\nAPI calls are limited per user, to the following:\n - 60 requests per minute\n - 2,000 requests per hour\n\nWhen you meet the limit, you receive the following 429 HTTP error: “API rate limit exceeded”.\nWhen calling any API endpoint the response headers will show the limits relevant to this user, and the number of remaining calls you can make within the current minute/hour.\n\n\n## Reporting Best Practices\n\n- **Filter for non-zero data:** For performance reports, filter to rows where a key metric (e.g., impressions > 0) to reduce report size and speed up generation.\n- **Scope structure reports:** Apply a filter like \"Last updated > X days ago\" to retrieve only recently changed entities.\n- **Use Async for large datasets:** If your report may return more than a few thousand rows, use [Async Analysis Reports](#tag/Asynchronous-Reports) and poll for results rather than the synchronous endpoint.\n\n\n## Group by and Segmentation\n### Understanding Group by and Segmentation\nWhen querying the /api/v1/reports/async/analysis and /reports endpoints, the breakdown_type parameter\ndetermines how data is structured.\n- FLAT: Returns unsegmented data without any grouping.\n- GROUP: Allows data segmentation based on specified columns (e.g., by date).\n- SEGMENT: Enables segmentation by date and an additional column, such as CampaignId.\n\n### How Group by works\nWhen using \"breakdown_type\": \"GROUP\", the group_bys parameter defines how the data is grouped. For instance:\n\"group_bys\": [ { \"name\": \"Day\", \"group\": \"TimeSegment\" } ]\n This groups data only by date, meaning campaign details won’t be included, similar to what is displayed in the grid export.\n\n| Conv. | Cost | Day |\n|-------|------|------------|\n| 2 | 100 | 09/29/2024 |\n| 3 | 200 | 09/28/2024 |\n\n### Using SEGMENT for Additional Grouping\nTo segment data by both date and another column (e.g., CampaignId), use \"breakdown_type\": \"SEGMENT\", specifying only the date column under group_bys while including the additional column in fields. Example:\n\"breakdown_type\": \"SEGMENT\",\n\"group_bys\": [ { \"name\": \"Day\", \"group\": \"TimeSegment\" } ],\n\"fields\": [ { \"name\": \"CampaignId\", \"group\": \"ATTRIBUTES\" } ]\n\nThis ensures data is segmented by day while preserving campaign details.\n\n| Campaign ID | Conv. | Cost | Day |\n|-------------|-------|------|------------|\n| 25000 | 1 | 50 | 09/29/2024 |\n| 25001 | 1 | 50 | 09/29/2024 |\n| 25000 | 2 | 150 | 09/28/2024 |\n| 25001 | 1 | 50 | 09/28/2024 |\n" version: 1.0.0 x-logo: url: https://grid.kenshoo.com/resources-frontend/latest/kenshoo_logo/skai-logo-devportal.svg backgroundColor: '#FFFFFF' altText: Skai servers: - url: https://services.kenshoo.com security: - BearerAuth: [] tags: - name: Meta Ads description: 'Manage dimension tags on Meta ads. > **Scope:** This section covers applying and removing Skai dimension labels on Meta ads.
Publishers: Meta
' paths: /api/v2/ads: get: tags: - Meta Ads summary: Get Ads description: 'Get ads API call allows you to retrieve ad information. The result is a list of ad objects that can be paged through using the returned next_page/previous_page values. ' parameters: - $ref: '#/components/parameters/ksV2' - $ref: '#/components/parameters/pageId' - $ref: '#/components/parameters/adIds' - $ref: '#/components/parameters/limit' responses: 200: $ref: '#/components/responses/getFacebookAdEntitySuccessResponse' 400: $ref: '#/components/responses/getAdBadRequest' put: tags: - Meta Ads summary: Edit an existing ad parameters: - $ref: '#/components/parameters/ksV2' requestBody: $ref: '#/components/requestBodies/editFacebookAd' responses: 200: $ref: '#/components/responses/EntitySuccessResponse' 400: $ref: '#/components/responses/BadRequest' 500: $ref: '#/components/responses/InternalServerError' post: tags: - Meta Ads summary: Create a new ad parameters: - $ref: '#/components/parameters/ksV2' requestBody: $ref: '#/components/requestBodies/createFacebookAd' responses: 201: $ref: '#/components/responses/EntitySuccessResponse' 400: $ref: '#/components/responses/BadRequest' 500: $ref: '#/components/responses/InternalServerError' /api/v1/ads/tags: get: tags: - Meta Ads summary: Get Ads tags description: 'Get ad tags API call allows you to retrieve a tags assigned to ad. The result is a list of Ad tags assignment objects that can be paged through using the returned next_page/previous_page values. ' operationId: getAdsTags parameters: - $ref: '#/components/parameters/ksV2' - $ref: '#/components/parameters/pageId' - $ref: '#/components/parameters/adGroupIds' - $ref: '#/components/parameters/limit' responses: 200: $ref: '#/components/responses/getEntityTagsSuccessResponse' 400: $ref: '#/components/responses/getEntityTagsBadRequest' put: tags: - Meta Ads summary: Edit Ad tags operationId: updateAdsTags parameters: - $ref: '#/components/parameters/ksV2' requestBody: $ref: '#/components/requestBodies/editEntityTagsRequest' responses: 200: $ref: '#/components/responses/EntitySuccessResponse' 400: $ref: '#/components/responses/BadRequest' 500: $ref: '#/components/responses/InternalServerError' components: schemas: getEntityTagsApiResponse: type: object properties: status: $ref: '#/components/schemas/ApiResponseStatus' entities: type: array readOnly: true items: $ref: '#/components/schemas/getEntityTagsResponse' paging: $ref: '#/components/schemas/Paging' error_message: type: string readOnly: true Paging: type: object properties: previous_page: type: string readOnly: true next_page: type: string readOnly: true createFacebookAd: required: - ad_group_id - bid - creative - name - status type: object properties: ad_group_id: type: integer description: Skai ID of the ad group name: type: string description: Ad name status: type: string description: Status enum: - ACTIVE - PAUSED bid: oneOf: - $ref: '#/components/schemas/facebookAdBid' creative: oneOf: - $ref: '#/components/schemas/facebookAdCreative' tracking: oneOf: - $ref: '#/components/schemas/facebookAdTracking' description: The properties for the newly created ad example: - name: New Ad ad_group_id: 12345 status: ACTIVE bid: bid_amount: 23.05 creative: ad_type: PAGE_POST post_type: LINK post_text: ad body description: ad description headline: ad headline call_to_action: DOWNLOAD link: skai.io caption: skai.io image_name: theBestImage video_name: theBestVideo video_thumbnail_name: theBestThumbnail page_id: 21 instagram_actor_id: 33 tracking: pixel_ids: - 4308 use_kenshoo_tracking: true ApiResponse: type: object properties: status: $ref: '#/components/schemas/ApiResponseStatus' entities: type: array items: $ref: '#/components/schemas/EntityResponse' tag: type: object properties: name: type: string description: Tag name category: type: string description: Category name facebookAdCreativeDTO: type: object properties: ad_type: oneOf: - $ref: '#/components/schemas/facebookAdType' post_type: oneOf: - $ref: '#/components/schemas/facebookAdPostType' post_text: type: string description: Post text description: type: string description: Description headline: type: string description: Headline call_to_action: oneOf: - $ref: '#/components/schemas/facebookAdCallToAction' link: type: string description: Destination URL caption: type: string description: Display link image_name: type: string description: Image name video_name: type: string description: Video name video_thumbnail_name: type: string description: Video thumbnail name page_id: type: integer description: Page id instagram_actor_id: type: integer description: Instagram actor id description: Ad creative facebookAdPostType: type: string description: Ad post type enum: - LINK - VIDEO editEntityTagsRequest: required: - id - operation_type - tags type: object properties: id: type: integer description: Skai ID of the entity tags: type: array description: Tags items: $ref: '#/components/schemas/tag' operation_type: $ref: '#/components/schemas/operationType' description: The properties for editing entity tags example: - id: 100 tags: - name: tag1 category: cat - name: tag2 category: dog operation_type: ATTACH ApiResponseStatus: type: string readOnly: true enum: - SUCCESS - FAILED - PARTIAL_SUCCESS facebookAdTracking: type: object properties: pixel_ids: type: array description: Facebook pixel ids items: type: integer use_kenshoo_tracking: type: boolean description: Use kenshoo tracking description: Tracking editFacebookAd: required: - id type: object properties: id: type: integer description: Skai ID of the ad name: type: string description: Ad name status: type: string description: Status enum: - ACTIVE - PAUSED - ARCHIVED bid: oneOf: - $ref: '#/components/schemas/facebookAdBid' creative: oneOf: - $ref: '#/components/schemas/facebookEditAdCreative' tracking: oneOf: - $ref: '#/components/schemas/facebookAdTracking' description: The properties for edited ad example: - id: 1234 name: New Ad name status: PAUSED bid: bid_amount: 3.14 creative: post_text: new ad body description: new ad description headline: new ad headline call_to_action: CALL_NOW link: kenshoo.com caption: kenshoo.com image_name: betterImage video_name: betterVideo video_thumbnail_name: betterThumbnail page_id: 12 instagram_actor_id: 77 tracking: pixel_ids: - 450 use_kenshoo_tracking: false operationType: type: string description: Operation type enum: - ATTACH - DETACH facebookAdCreative: required: - ad_type - instagram_actor_id - link - page_id - post_type type: object properties: ad_type: oneOf: - $ref: '#/components/schemas/facebookAdType' post_type: oneOf: - $ref: '#/components/schemas/facebookAdPostType' post_text: type: string description: Post text description: type: string description: Description headline: type: string description: Headline call_to_action: description: Required when post_type is VIDEO. oneOf: - $ref: '#/components/schemas/facebookAdCallToAction' link: type: string description: Destination URL caption: type: string description: Display link image_name: type: string description: Image name video_name: type: string description: Video name. Required when post_type is VIDEO. video_thumbnail_name: type: string description: Video thumbnail name. Optional; if omitted no thumbnail is set. page_id: type: integer description: Page id instagram_actor_id: type: integer description: Instagram actor id description: Ad creative ErrorField: type: object properties: fieldName: type: string description: The error field error: type: string description: Error message parameters: type: object additionalProperties: type: string description: Error additional properties facebookAdDTO: type: object properties: id: type: integer description: Skai ID of the ad ad_group_id: type: integer description: Skai ID of the ad group name: type: string description: Ad name status: type: string description: Status enum: - ACTIVE - PAUSED bid: oneOf: - $ref: '#/components/schemas/facebookAdBid' creative: oneOf: - $ref: '#/components/schemas/facebookAdCreativeDTO' tracking: oneOf: - $ref: '#/components/schemas/facebookAdTracking' getAdApiResponse: type: object properties: status: $ref: '#/components/schemas/ApiResponseStatus' entities: type: array readOnly: true items: $ref: '#/components/schemas/adDTO' paging: $ref: '#/components/schemas/Paging' error_message: type: string readOnly: true facebookAdType: type: string description: Ad type enum: - PAGE_POST getFacebookAdApiResponse: type: object properties: status: $ref: '#/components/schemas/ApiResponseStatus' entities: type: array readOnly: true items: $ref: '#/components/schemas/facebookAdDTO' paging: $ref: '#/components/schemas/Paging' error_message: type: string readOnly: true facebookEditAdCreative: type: object properties: post_text: type: string description: Post text description: type: string description: Description headline: type: string description: Headline call_to_action: oneOf: - $ref: '#/components/schemas/facebookAdCallToAction' link: type: string description: Destination URL caption: type: string description: Display link image_name: type: string description: Image name video_name: type: string description: Video name video_thumbnail_name: type: string description: Video thumbnail name page_id: type: integer description: Page id instagram_actor_id: type: integer description: Instagram actor id description: Ad creative facebookAdBid: type: object properties: bid_amount: type: number description: Bid amount description: Bid EntityResponse: type: object properties: id: type: integer format: int64 success: type: boolean errors: type: array items: $ref: '#/components/schemas/ErrorField' facebookAdCallToAction: type: string description: Call to action enum: - BOOK_TRAVEL - LISTEN_MUSIC - OPEN_LINK - PLAY_GAME - SHOP_NOW - USE_APP - WATCH_VIDEO - INSTALL_MOBILE_APP - INSTALL_APP - LEARN_MORE - SIGN_UP - DOWNLOAD - USE_MOBILE_APP - WATCH_MORE - CONTACT_US - GET_QUOTE - SUBSCRIBE - SELL_NOW - APPLY_NOW - DONATE_NOW - VOTE_NOW - LIKE_PAGE - NO_BUTTON - CALL_NOW - BUY_NOW - GET_OFFER - GET_OFFER_VIEW - GET_DIRECTIONS - MESSAGE_PAGE - RECORD_NOW - OPEN_MOVIES - EVENT_RSVP - CALL - SEE_MENU - MESSAGE_USER - REGISTER_NOW - REQUEST_TIME - SAVE - ORDER_NOW - GET_SHOWTIMES - VIEW_INSTAGRAM_PROFILE - LISTEN_NOW - BUY_TICKETS - WHATSAPP_MESSAGE - SEARCH - PAY_TO_ACCESS - INSTAGRAM_MESSAGE - START_ORDER - TRY_IN_CAMERA getEntityTagsResponse: type: object properties: id: type: integer description: Skai ID of the entity tags: type: array readOnly: true items: $ref: '#/components/schemas/tag' adDTO: type: object properties: ad_group_id: type: integer description: Skai ID of the ad group name: type: string description: Ad name status: type: string description: Status enum: - ACTIVE - PAUSED bid: oneOf: - $ref: '#/components/schemas/facebookAdBid' creative: oneOf: - $ref: '#/components/schemas/facebookAdCreativeDTO' tracking: oneOf: - $ref: '#/components/schemas/facebookAdTracking' description: The properties for the newly created ad example: - name: New Ad ad_group_id: 12345 status: ACTIVE bid: bid_amount: 23.05 creative: ad_type: PAGE_POST post_type: LINK post_text: ad body description: ad description headline: ad headline call_to_action: DOWNLOAD link: skai.io caption: skai.io image_name: theBestImage page_id: 21 instagram_actor_id: 33 tracking: pixel_ids: - 4308 use_kenshoo_tracking: true requestBodies: editEntityTagsRequest: description: The entity tags edit request details content: application/json: schema: $ref: '#/components/schemas/editEntityTagsRequest' required: true createFacebookAd: description: The ad details content: application/json: schema: $ref: '#/components/schemas/createFacebookAd' required: true editFacebookAd: description: The ad details content: application/json: schema: $ref: '#/components/schemas/editFacebookAd' required: true responses: getAdBadRequest: description: Bad request (usually indicates validation failure for client input) content: application/json: schema: $ref: '#/components/schemas/getAdApiResponse' example: status: FAILED entities: [] paging: null error_message: The value in page_id is invalid BadRequest: description: Bad request (usually indicates validation failure for client input) content: application/json: schema: $ref: '#/components/responses/ApiResponse' example: status: FAILED entities: - id: null success: false errors: - field_name: name error: ILLEGAL_NAME getFacebookAdEntitySuccessResponse: description: The operation was completed successfully content: application/json: schema: $ref: '#/components/schemas/getFacebookAdApiResponse' example: - status: SUCCESS entities: - id: 1234 name: New Ad ad_group_id: 12345 status: ACTIVE bid: bid_amount: 23.05 creative: ad_type: PAGE_POST post_type: LINK post_text: ad body description: ad description headline: ad headline call_to_action: DOWNLOAD link: skai.io caption: skai.io image_name: theBestImage video_name: theBestVideo page_id: 21 instagram_actor_id: 33 tracking: pixel_ids: - 4308 use_kenshoo_tracking: true paging: previous_page: null next_page: MQ== error_message: null getEntityTagsBadRequest: description: Bad request (usually indicates validation failure for client input) content: application/json: schema: $ref: '#/components/schemas/getEntityTagsApiResponse' example: status: FAILED entities: [] paging: null error_message: The value in page_id is invalid EntitySuccessResponse: description: The entity operations succeeded content: application/json: schema: $ref: '#/components/responses/ApiResponse' example: status: SUCCESS entities: - id: 1234 success: true errors: [] getEntityTagsSuccessResponse: description: The operation was completed successfully content: application/json: schema: $ref: '#/components/schemas/getEntityTagsApiResponse' example: - id: 100 tags: - name: tag1 category: cat - name: tag2 category: dog InternalServerError: description: Server error content: application/json: schema: $ref: '#/components/responses/ApiResponse' example: status: FAILED entities: - id: null success: false errors: - field_name: ServerError error: Unexpected error occurred. parameters: {} ApiResponse: $ref: '#/components/schemas/ApiResponse' parameters: adIds: name: ids in: query description: 'Filter by ad ID. Returns ad whose IDs are included in your list. ' required: false style: form explode: true schema: maxItems: 500 type: array items: type: string pageId: name: page_id in: query description: 'Allows you to traverse pages by using the values for "next_page" and "previous_page" included under "paging" in the response. To return the first page, do not include page_id in the request. ' required: false style: form explode: true schema: type: string example: Mg== limit: name: limit in: query required: false style: form explode: true schema: type: integer format: int32 adGroupIds: name: ids in: query description: 'Filter by ad group ID. Returns ad groups whose IDs are included in your list. ' required: false style: form explode: true schema: maxItems: 500 type: array items: type: string ksV2: name: ks in: query required: true style: form explode: true schema: type: string example: social x-tagGroups: - name: Reporting tags: - Available Columns - Synchronous Reports - Asynchronous Reports - name: Bulk Operations tags: - Jobs - Bulk Update - name: AI & MCP tags: - MCP - name: Objects tags: - Profile - Campaigns - Ad Groups - Ads - Product Groups - Portfolios - Meta Campaigns - Meta Ad Groups - Meta Ads - Columns