openapi: 3.2.0 info: title: Skai Ad Groups 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: Ad Groups description: 'Create, update, and retrieve ad groups. > **Scope:** This API covers common ad group attributes — name, bid, status, and targeting basics. > For the full range of ad group settings use [Bulk Update (One File)](#tag/Bulk-Update).
Publishers: Search Social (excl. Meta) Retail Media
' paths: /api/v1/ad_groups: get: tags: - Ad Groups summary: Get Ad Groups description: 'Get ad groups API call allows you to retrieve ad group information. You can filter by multiple fields, such as the profile ID and channel type, or request specific ad groups by their IDs. The result is a list of ad group objects that can be paged through using the returned next_page/previous_page values. ' operationId: getAdGroups parameters: - $ref: '#/components/parameters/ks' - $ref: '#/components/parameters/pageId' - $ref: '#/components/parameters/adGroupIds' - $ref: '#/components/parameters/channelAdGroupIds' - $ref: '#/components/parameters/adGroupCampaignIds' - $ref: '#/components/parameters/adGroupChannelCampaignIds' - $ref: '#/components/parameters/adGroupProfileId' - $ref: '#/components/parameters/adGroupChannelTypes' - $ref: '#/components/parameters/adGroupStatuses' responses: 200: $ref: '#/components/responses/getAdGroupEntitySuccessResponse' 400: $ref: '#/components/responses/getAdGroupBadRequest' put: tags: - Ad Groups summary: Edit an existing ad group description: 'Update one or more ad groups. Editable attributes are documented in the request body schema below. **Need more attributes?** Use [Bulk Update (One File)](#tag/Bulk-Update) for the full attribute set.' operationId: updateAdGroups parameters: - $ref: '#/components/parameters/ks' requestBody: $ref: '#/components/requestBodies/EditAdgroup' responses: 200: $ref: '#/components/responses/EntitySuccessResponse' 400: $ref: '#/components/responses/BadRequest' 500: $ref: '#/components/responses/InternalServerError' post: tags: - Ad Groups summary: Create a new ad group description: 'Create one or more ad groups. Supported attributes are documented in the request body schema below. **Need more attributes?** Use [Bulk Update (One File)](#tag/Bulk-Update) to create ad groups with the full range of settings.' operationId: createAdGroups parameters: - $ref: '#/components/parameters/ks' requestBody: $ref: '#/components/requestBodies/CreateAdgroup' responses: 201: $ref: '#/components/responses/EntitySuccessResponse' 400: $ref: '#/components/responses/BadRequest' 500: $ref: '#/components/responses/InternalServerError' components: responses: getAdGroupBadRequest: description: Bad request (usually indicates validation failure for client input) content: application/json: schema: $ref: '#/components/schemas/getAdGroupApiResponse' 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 EntitySuccessResponse: description: The entity operations succeeded content: application/json: schema: $ref: '#/components/responses/ApiResponse' example: status: SUCCESS entities: - id: 1234 success: true errors: [] 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' getAdGroupEntitySuccessResponse: description: The operation was completed successfully content: application/json: schema: $ref: '#/components/schemas/getAdGroupApiResponse' example: status: SUCCESS entities: - id: 15324 channel_ad_group_id: '1674257480' name: name campaign_id: 106 channel_campaign_id: '60600800' profile_id: 12 channel_type: Google search_bid: 1.0 bidding_method: NOT_SET status: ACTIVE start_date: '2026-01-01' end_date: '9999-12-30' budget: 100.0 budget_type: DAILY paging: previous_page: null next_page: MQ== error_message: null schemas: AdGroupDTO: type: object properties: id: type: integer description: Skai ID of the ad group channel_ad_group_id: type: string description: Publisher ID of the ad group name: type: string description: Ad group name campaign_id: type: integer description: Skai ID of the campaign channel_campaign_id: type: string description: Publisher ID of the campaign profile_id: type: integer description: Skai ID of the profile channel_type: type: string description: Ad group channel type enum: - Google - Microsoft - Universal - Yandex - Baidu - YahooJapan - YahooGemini - Pinterest - Amazon - Facebook - Walmart search_bid: type: integer description: Default search bid in the profile's currency bidding_method: $ref: '#/components/schemas/AdgroupBiddingMethod' start_date: type: string description: Ad group start date format: yyyy-MM-dd end_date: type: string description: Ad group end date format: yyyy-MM-dd status: $ref: '#/components/schemas/AdgroupStatus' budget: type: integer description: Ad group budget in the profile's currency budget_type: $ref: '#/components/schemas/AdgroupBudgetType' Paging: type: object properties: previous_page: type: string readOnly: true next_page: type: string readOnly: true ApiResponse: type: object properties: status: $ref: '#/components/schemas/ApiResponseStatus' entities: type: array items: $ref: '#/components/schemas/EntityResponse' AdgroupConversionParams: type: object properties: conversion_tag_id: type: string description: The tag ID conversion_event: type: string description: Conversion event enum: - CHECKOUT - SIGNUP - LEAD - APP_INSTALL - ADD_TO_CART conversion_attribute_window: type: string description: Attribution window enum: - WIN_30_30_1 - WIN_7_7_1 - WIN_7_0_0 - WIN_1_1_1 - WIN_1_0_0 conversion_averaget_cpa: type: number description: Average CPA description: Conversion parameters CreateAdgroup: required: - campaign_id - name type: object properties: name: type: string description: New ad group name campaign_id: type: integer description: The ID of the campaign this ad group is created in search_bid: type: integer description: Default search bid in the profile's currency status: $ref: '#/components/schemas/AdgroupStatus' start_date: type: string description: Ad group start date. If not specified, will start immediately. If specified, must be in the future. format: yyyy-MM-dd end_date: type: string description: Ad group end date. If specified, must be in the future and later than the campaign start date. format: yyyy-MM-dd bidding_method: $ref: '#/components/schemas/AdgroupBiddingMethod' budget: type: integer description: Budget, in the profile's currency budget_type: $ref: '#/components/schemas/AdgroupBudgetType' pinterest_ad_group_extensions: $ref: '#/components/schemas/PinterestAdgroupExtensions' description: The properties for the newly created ad group example: - name: adgroup example campaign_id: 1234 search_bid: 12.2 status: ACTIVE start_date: '2026-01-01' end_date: '2026-12-31' bidding_method: ManualCPC budget: 50.1 budget_type: LIFETIME pinterest_ad_group_extensions: delivery_method: STANDARD conversion_parameters: conversion_tag_id: my tag id conversion_event: CHECKOUT conversion_attribution_window: WIN_30_30_1 conversion_avg_cpa: 7.7 targeting_parameters: genders: - FEMALE - MALE - UNSPECIFIED ages: - AGE_50_54 - AGE_18_24 - AGE_25_34 - AGE_21 - AGE_45_49 - AGE_35_44 - AGE_65 - AGE_55_64 devices: - ANDROID_MOBILE - ANDROID_TABLET - IPAD - IPHONE - WEB - WEB_MOBILE placements: ALL countries: - US EditAdgroup: required: - campaign_id - id type: object properties: id: type: integer description: The ad group ID name: type: string description: The new name of the ad group campaign_id: type: integer description: The ID of the campaign of this ad group search_bid: type: integer description: Default search bid in the profile's currency status: $ref: '#/components/schemas/AdgroupStatus' start_date: type: string description: Ad group start date. If not specified, will start immediately. If specified, must be in the future. format: yyyy-MM-dd end_date: type: string description: Ad group end date. If specified, must be in the future and later than the campaign start date. format: yyyy-MM-dd bidding_method: $ref: '#/components/schemas/AdgroupBiddingMethod' budget: type: integer description: Budget, in the profile's currency budget_type: $ref: '#/components/schemas/AdgroupBudgetType' description: The properties for the edited ad group example: - id: 1111 name: adgroup example campaign_id: 1234 search_bid: 12.2 status: ACTIVE start_date: '2026-01-01' end_date: '2026-12-31' bidding_method: ManualCPC budget: 50.1 budget_type: LIFETIME ApiResponseStatus: type: string readOnly: true enum: - SUCCESS - FAILED - PARTIAL_SUCCESS PinterestAdgroupExtensions: type: object properties: delivery_method: type: string description: Delivery method enum: - STANDARD - ACCELERATED conversion_parameters: $ref: '#/components/schemas/AdgroupConversionParams' targeting_parameters: $ref: '#/components/schemas/PinterestTargetingParams' description: For Pinterest Shopping campaigns only getAdGroupApiResponse: type: object properties: status: $ref: '#/components/schemas/ApiResponseStatus' entities: type: array readOnly: true items: $ref: '#/components/schemas/AdGroupDTO' paging: $ref: '#/components/schemas/Paging' error_message: type: string readOnly: true 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 AdgroupBiddingMethod: type: string description: Will inherit from the campaign's bidding method, if not included enum: - ManualCPC - ManualCPM - ENHANCED_CPC - TARGET_CPA - TARGET_SPEND - TARGET_ROAS PinterestTargetingParams: type: object properties: genders: type: string description: Genders enum: - FEMALE - MALE - UNSPECIFIED ages: type: string description: Ages enum: - AGE_18_24 - AGE_21 - AGE_25_34 - AGE_35_44 - AGE_45_49 - AGE_50_54 - AGE_55_64 - AGE_65 devices: type: string description: Devices enum: - ANDROID_MOBILE - ANDROID_TABLET - IPAD - IPHONE - WEB - WEB_MOBILE placements: type: string description: Placements enum: - ALL - SEARCH - BROWSE - OTHER country_names: type: array description: Countries items: type: string description: Pinterest-specific targeting parameters AdgroupStatus: type: string description: Status enum: - ACTIVE - PAUSED - DELETED - REVIEW EntityResponse: type: object properties: id: type: integer format: int64 success: type: boolean errors: type: array items: $ref: '#/components/schemas/ErrorField' AdgroupBudgetType: type: string enum: - DAILY - LIFETIME requestBodies: CreateAdgroup: description: The ad group details content: application/json: schema: $ref: '#/components/schemas/CreateAdgroup' required: true EditAdgroup: description: The ad group details content: application/json: schema: $ref: '#/components/schemas/EditAdgroup' required: true parameters: adGroupChannelTypes: name: channel_types in: query description: 'Filter by channel type. Returns the ad groups whose channel types are included in the list. ' required: false style: form explode: true schema: type: array items: type: string enum: - Google - Microsoft - Universal - Yandex - Baidu - YahooJapan - YahooGemini - Pinterest - Amazon - Facebook - Walmart adGroupCampaignIds: name: campaign_ids in: query description: 'Filter by campaign ID. Returns the ad groups whose campaign IDs are included in your list. ' required: false style: form explode: true schema: maxItems: 200 type: array items: type: string channelAdGroupIds: name: channel_ad_group_ids in: query description: 'Filter by channel ad group ID. Returns the ad groups whose channel ad group 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== adGroupStatuses: name: statuses in: query description: 'Filter by status. Returns the ad groups whose statuses are included in the list. ' required: false style: form explode: true schema: type: array items: type: string enum: - Active - Approved - Paused - Deleted - Failed - Review - ToPause - ToDelete - FailedToPause - FailedToDelete - Unknown - Scheduled - Expired - Pending - Disapproved adGroupChannelCampaignIds: name: channel_campaign_ids in: query description: 'Filter by channel campaign ID. Returns the ad groups whose channel campaign IDs are included in your list. ' required: false style: form explode: true schema: maxItems: 200 type: array items: type: string 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 adGroupProfileId: name: profile_id in: query description: 'Filter by profile ID. Returns the ad groups whose profile ID equals your profile ID. ' required: false style: form explode: true schema: type: string ks: name: ks in: query description: The KS to refer the request to. You can find this ID in the Skai platform under _Administration_ -> _About Skai_ -> _Server ID_ required: true style: form explode: true schema: type: string example: '1234' 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