Skai (Kenshoo) Available Columns API

openapi: 3.2.0
info:
  title: Skai Available Columns API
  description: '# Overview

    Skai APIs provide programmatic access to advertising data and campaign management across Search, Social, and Retail Media publishers.'
  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: Available Columns
paths:
  /api/v1/reports/{entity}/available_columns:
    get:
      tags:
      - Available Columns
      summary: Get available columns
      description: Get available columns for all Analysis Grid reports.
      operationId: getAvailableColumns
      parameters:
      - name: entity
        in: path
        description: 'Important: For product grids use entity=PRODUCT_ASSET. For product targeting use entity=PRODUCT_TARGETING.'
        required: true
        style: simple
        explode: false
        schema:
          type: string
          enum:
          - CAMPAIGN
          - ADGROUP
          - KEYWORD
          - AD
          - PORTFOLIO
          - PRODUCT_ASSET
          - PRODUCT_TARGETING
      - $ref: '#/components/parameters/ks'
      - name: profile_id
        in: query
        description: "For _Cross-Profile_ columns, use `profile_id=0`. \nFor _Single-Profile_ columns, use the id of a single profile, like `profile_id=412`.\n"
        required: true
        style: form
        explode: true
        example: 412
      responses:
        200:
          description: The operation was completed successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportColumnsResponse'
        400:
          $ref: '#/components/responses/BadRequest'
        500:
          $ref: '#/components/responses/InternalServerError'
components:
  schemas:
    ApiResponseStatus:
      type: string
      readOnly: true
      enum:
      - SUCCESS
      - FAILED
      - PARTIAL_SUCCESS
    ReportColumnsResponse:
      type: object
      example:
        columnsInfo:
          Attributes:
          - name: Status
            id: S3009
            display_name: Status
            value_type: STRING
            report_supported: true
          - name: ChannelType
            id: S3029
            display_name: ChannelType
            value_type: STRING
            report_supported: true
          ConversionTypes:
          - name: Calls
            id: T2105
            value_type: INTEGER
            report_supported: true
          - name: Calls $
            id: R2105
            value_type: MONETARY
            report_supported: true
          - name: Conversions
            id: T2106
            value_type: FLOAT
            report_supported: true
          - column_name: Conversions $
            id: R2106
            value_type: MONETARY
            report_supported: false
          Performance:
          - name: Date
            id: S3035
            display_name: Date
            value_type: DATE
            report_supported: true
          - name: Impressions
            id: S3012
            display_name: Impressions
            value_type: BIG_INTEGER
            report_supported: true
    ApiResponse:
      type: object
      properties:
        status:
          $ref: '#/components/schemas/ApiResponseStatus'
        entities:
          type: array
          items:
            $ref: '#/components/schemas/EntityResponse'
    EntityResponse:
      type: object
      properties:
        id:
          type: integer
          format: int64
        success:
          type: boolean
        errors:
          type: array
          items:
            $ref: '#/components/schemas/ErrorField'
    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
  responses:
    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
    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:
    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