AdReady (CPXi)

AdReady (CPXi) Flip Dashboard API

APIs related to Flip Dashboard

GitHub OpenAPI

Operations 48

GET /api/advertisers/{advertiserId}/flipPixels/{pixelId} Get details of a FLIP pixel for an advertiser #
PUT /api/advertisers/{advertiserId}/flipPixels/{pixelId} Update an existing FLIP pixel for an advertiser #
PUT /api/advertisers/{advertiserId}/brand_lift/campaigns/{blCampaignId} Update campaign #
DELETE /api/advertisers/{advertiserId}/brand_lift/campaigns/{blCampaignId} Delete campaign #
PUT /api/advertisers/{advertiserId}/brand_lift/campaigns/{blCampaignId}/launch Launch Campaign #
PUT /api/advertisers/{advertiserId}/brand_lift/campaign/{blCampaignId}/spc_groupings_and_mappings Update SPC Groupings and Mappings #
POST /api/advertisers/{advertiserId}/reports/rollup Get rollup report with only last touches for each conversion #
POST /api/advertisers/{advertiserId}/reports/rollup/touches Get all touches (except last touch) for a conversion #
POST /api/advertisers/{advertiserId}/reports/performance Get performance report by creative/publisher/channel/daypart/audience/device/mediatype/state/dma/zip/overall #
POST /api/advertisers/{advertiserId}/reports/eventPerformance Get event-wise performance report by creative/publisher/channel/daypart/audience/device/mediatype/state/dma/zip/overall #
POST /api/advertisers/{advertiserId}/performance Get performance by creative/adgroup/publisher/channel/audience/mediatype #
POST /api/advertisers/{advertiserId}/performance/metrics/reach Get reach and frequency performance metric #
POST /api/advertisers/{advertiserId}/performance/daily Get daily CPM/CPA/ROAS/VCR/CTR performance #
POST /api/advertisers/{advertiserId}/media_types Get media types for an advertiser #
POST /api/advertisers/{advertiserId}/mdsp/performance/daily Get daily CPM/CPA/ROAS/VCR/CTR performance #
POST /api/advertisers/{advertiserId}/mdsp/impressions/summary Get impressions summary (MDSP) #
POST /api/advertisers/{advertiserId}/mdsp/impressions/distribution Get impressions distribution #
POST /api/advertisers/{advertiserId}/mdsp/impressions/daily Get daily impressions details #
POST /api/advertisers/{advertiserId}/lift/summary Get incrementality & brand lift summary #
POST /api/advertisers/{advertiserId}/io_pacing Get overall pacing for selected insertion orders #
POST /api/advertisers/{advertiserId}/impressions/summary Get impressions summary #
POST /api/advertisers/{advertiserId}/impressions/distribution Get impressions distribution #
POST /api/advertisers/{advertiserId}/impressions/daily Get daily impressions details #
GET /api/advertisers/{advertiserId}/flipPixels Get FLIP pixels by advertiser id #
POST /api/advertisers/{advertiserId}/flipPixels Add new FLIP pixel for an advertiser #
POST /api/advertisers/{advertiserId}/creatives Get creatives for an advertiser #
POST /api/advertisers/{advertiserId}/conversions/summary Get conversions summary for a FLIP pixel #
POST /api/advertisers/{advertiserId}/conversions/distribution Get conversions distribution for a FLIP pixel #
POST /api/advertisers/{advertiserId}/conversions/daily Get daily pixel visits details #
GET /api/advertisers/{advertiserId}/brand_lift/campaigns Get campaigns for an Advertiser and selected IO #
POST /api/advertisers/{advertiserId}/brand_lift/campaigns Create campaign for an Advertiser and selected IO #
POST /api/advertisers/{advertiserId}/audiences Get audiences for an advertiser #
GET /api/advertisers/{advertiserId}/publishers Get publishers for an advertiser #
GET /api/advertisers/{advertiserId}/performance/metrics/incrementalreach Get incremental reach metric #
GET /api/advertisers/{advertiserId}/io_names Get unique insertion order names for an advertiser #
GET /api/advertisers/{advertiserId}/flipPixels/{pixelId}/fires Fetch FLIP pixel fires #
GET /api/advertisers/{advertiserId}/flipPixels/{pixelId}/fires/summary Get FLIP pixel fires summary #
GET /api/advertisers/{advertiserId}/flipPixels/{pixelId}/fires/daily Get daily FLIP pixel fires #
GET /api/advertisers/{advertiserId}/flipPixels/{pixelId}/categories Fetch FLIP pixel categories #
GET /api/advertisers/{advertiserId}/events Get conversion events for an advertiser #
GET /api/advertisers/{advertiserId}/brand_lift/types Get lift types for brand lift #
GET /api/advertisers/{advertiserId}/brand_lift/template_questions List Template Questions #
GET /api/advertisers/{advertiserId}/brand_lift/industries List Industries #
GET /api/advertisers/{advertiserId}/brand_lift/groupBy Get group by for brand lift #
GET /api/advertisers/{advertiserId}/brand_lift/distribution Get brand lift distribution #
GET /api/advertisers/{advertiserId}/brand_lift/country_languages List Country Languages #
GET /api/advertisers/{advertiserId}/brand_lift/campaignsStats Get campaigns stats for an Advertiser and selected IO #
GET /api/advertisers/{advertiserId}/brand_lift/campaign/{bl_campaign_id} Retrieve single campaign detail for a given campaign id #

Documentation

📖
APIReference
https://platform.digitalremedy.com/swagger-ui.html
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/adready-cpxi/refs/heads/main/authentication/adready-cpxi-authentication.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/adready-cpxi/refs/heads/main/openapi/adready-cpxi-flip-dashboard-api-openapi.yml

Other Resources

🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/adready-cpxi/refs/heads/main/conventions/adready-cpxi-conventions.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/adready-cpxi/refs/heads/main/data-model/adready-cpxi-data-model.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/adready-cpxi/refs/heads/main/errors/adready-cpxi-problem-types.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/adready-cpxi-flip-dashboard-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

adready-cpxi-flip-dashboard-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Kickstart Flip Dashboard API
  description: API documentation for Kickstart services
  contact:
    name: Your Team
    email: support@example.com
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
  version: '1.0'
servers:
- url: https://platform.digitalremedy.com
  description: Generated server url
tags:
- name: Flip Dashboard
  description: APIs related to Flip Dashboard
paths:
  /api/advertisers/{advertiserId}/flipPixels/{pixelId}:
    get:
      tags:
      - Flip Dashboard
      summary: Get details of a FLIP pixel for an advertiser
      description: Returns metadata for a given FLIP pixel and advertiser
      operationId: fetchFlipPixelDetails
      parameters:
      - name: advertiserId
        in: path
        description: The advertiser ID
        required: true
        schema:
          type: integer
      - name: pixelId
        in: path
        description: The FLIP pixel ID
        required: true
        schema:
          type: string
      responses:
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                type: object
        '200':
          description: Pixel details successfully retrieved
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ApiResponseFlipPixel'
    put:
      tags:
      - Flip Dashboard
      summary: Update an existing FLIP pixel for an advertiser
      description: Updates a FLIP pixel's properties using the provided data
      operationId: updateFlipPixel
      parameters:
      - name: advertiserId
        in: path
        description: The advertiser ID
        required: true
        schema:
          type: integer
      - name: pixelId
        in: path
        description: The pixel ID
        required: true
        schema:
          type: string
      requestBody:
        description: The updated FlipPixel object
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FlipPixel'
        required: true
      responses:
        '400':
          description: Invalid input
        '200':
          description: Pixel updated successfully
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ApiResponseFlipPixel'
        '404':
          description: Pixel not found
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ApiResponseFlipPixel'
  /api/advertisers/{advertiserId}/brand_lift/campaigns/{blCampaignId}:
    put:
      tags:
      - Flip Dashboard
      summary: Update campaign
      operationId: updateCampaign
      parameters:
      - name: advertiserId
        in: path
        description: the advertiser id
        required: true
      - name: blCampaignId
        in: path
        description: Campaign Id
        required: true
      requestBody:
        description: Campaign to be created
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExistingLucidCampaign'
        required: true
      responses:
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                type: object
        '200':
          description: OK
          content:
            application/json: {}
    delete:
      tags:
      - Flip Dashboard
      summary: Delete campaign
      operationId: deleteCampaign
      parameters:
      - name: advertiserId
        in: path
        description: the advertiser id
        required: true
      - name: blCampaignId
        in: path
        description: Campaign Id
        required: true
      responses:
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                type: object
        '200':
          description: OK
          content:
            application/json: {}
  /api/advertisers/{advertiserId}/brand_lift/campaigns/{blCampaignId}/launch:
    put:
      tags:
      - Flip Dashboard
      summary: Launch Campaign
      operationId: launchCampaign
      parameters:
      - name: advertiserId
        in: path
        description: the advertiser id
        required: true
      - name: blCampaignId
        in: path
        description: Campaign Id
        required: true
      responses:
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                type: object
        '200':
          description: OK
          content:
            application/json: {}
  /api/advertisers/{advertiserId}/brand_lift/campaign/{blCampaignId}/spc_groupings_and_mappings:
    put:
      tags:
      - Flip Dashboard
      summary: Update SPC Groupings and Mappings
      operationId: updateSPCGroupings
      parameters:
      - name: advertiserId
        in: path
        description: the advertiser id
        required: true
        schema:
          type: integer
      - name: blCampaignId
        in: path
        description: Brandlift campaign id
        required: true
        schema:
          type: string
      - name: client
        in: query
        description: the account/client name
        required: true
        schema:
          type: string
      - name: advertiser
        in: query
        description: the advertiser name
        required: true
        schema:
          type: string
      - name: type
        in: query
        description: 'SPC Grouping types: placement or publisher'
        required: true
        schema:
          type: string
          enum:
          - placement
          - publisher
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                additionalProperties: {}
        required: true
      responses:
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                type: object
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ApiResponseLucidSPCGroupingsWrapper'
  /api/advertisers/{advertiserId}/reports/rollup:
    post:
      tags:
      - Flip Dashboard
      summary: Get rollup report with only last touches for each conversion
      operationId: getLastTouches
      parameters:
      - name: advertiserId
        in: path
        description: the advertiser id
        required: true
        schema:
          type: integer
      - name: kind
        in: query
        description: the kind of data to be returned, either all_touch or last_touch
        required: true
        schema:
          type: string
          enum:
          - all_touch
          - last_touch
      - name: includeChannel
        in: query
        description: 'true : Include channel false : Dont include channel'
        required: true
        schema:
          type: boolean
      - name: client
        in: query
        description: the account/client name
        required: true
        schema:
          type: string
      - name: advertiser
        in: query
        description: the advertiser name
        required: true
        schema:
          type: string
      - name: xandrId
        in: query
        description: the advertiser's XandrId
        required: true
        schema:
          type: string
      - name: pixel
        in: query
        description: the FLIP universal pixel id
        required: true
        schema:
          type: string
      - name: conversionWindow
        in: query
        description: the conversion window in hours
        schema:
          type: integer
          default: 0
      - name: mediaType
        in: query
        description: the media types to filter (e.g. Display Retargeting, OTT, etc.)
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
      - name: creative
        in: query
        description: the comma-separated creative ids to filter
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
      - name: publisher
        in: query
        description: the comma-separated publisher names to filter
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
      - name: audience
        in: query
        description: the comma-separated audience names to filter
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
      - name: ioIds
        in: query
        description: the comma-separated IO ids to filter
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
      - name: adGroups
        in: query
        description: the comma-separated Adready Id & start date (separated by |) combination to filter
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
      - name: event
        in: query
        description: the event
        required: true
        schema:
          type: string
      - name: category
        in: query
        description: the pixel category
        required: true
        schema:
          type: string
      - name: subCategory
        in: query
        description: the comma-separated pixel sub-categories
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
      - name: startDate
        in: query
        description: the start date
        required: true
        schema:
          type: string
          example: '2022-01-08'
      - name: endDate
        in: query
        description: the end date
        required: true
        schema:
          type: string
          example: '2022-01-14'
      - name: offset
        in: query
        description: the number of records to skip
        schema:
          type: integer
          default: 0
      - name: limit
        in: query
        description: the max number of records to return
        schema:
          type: integer
          default: 100
      - name: onceNow
        in: query
        description: Run this report once?
        schema:
          type: boolean
          default: true
      - name: emailIt
        in: query
        description: Email this report?
        schema:
          type: boolean
          default: false
      - name: emailAddr
        in: query
        description: Email address?
        schema:
          type: string
      - name: Accept
        in: header
        description: '''application/json'' - provides json response. ''text/csv'' or ''application/csv'' provides csv file.'
        schema:
          type: string
          default: application/json
      responses:
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                type: object
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ApiResponseListObject'
  /api/advertisers/{advertiserId}/reports/rollup/touches:
    post:
      tags:
      - Flip Dashboard
      summary: Get all touches (except last touch) for a conversion
      operationId: getAllTouchesForConversion
      parameters:
      - name: advertiserId
        in: path
        description: the advertiser id
        required: true
        schema:
          type: integer
      - name: client
        in: query
        description: the account/client name
        required: true
        schema:
          type: string
      - name: advertiser
        in: query
        description: the advertiser name
        required: true
        schema:
          type: string
      - name: xandrId
        in: query
        description: the advertiser's XandrId
        required: true
        schema:
          type: string
      - name: pixel
        in: query
        description: the FLIP universal pixel id
        required: true
        schema:
          type: string
      - name: conversionWindow
        in: query
        description: the conversion window in hours
        schema:
          type: integer
          default: 0
      - name: mediaType
        in: query
        description: the media types to filter (e.g. Display Retargeting, OTT, etc.)
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
      - name: creative
        in: query
        description: the comma-separated creative ids to filter
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
      - name: publisher
        in: query
        description: the comma-separated publisher names to filter
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
      - name: audience
        in: query
        description: the comma-separated audience names to filter
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
      - name: ioIds
        in: query
        description: the comma-separated IO ids to filter
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
      - name: adGroups
        in: query
        description: the comma-separated Adready Id & start date (separated by |) combination to filter
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
      - name: event
        in: query
        description: the event
        required: true
        schema:
          type: string
      - name: category
        in: query
        description: the pixel category
        required: true
        schema:
          type: string
      - name: subCategory
        in: query
        description: the comma-separated pixel sub-categories
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
      - name: startDate
        in: query
        description: the start date
        required: true
        schema:
          type: string
          example: '2022-01-08'
      - name: endDate
        in: query
        description: the end date
        required: true
        schema:
          type: string
          example: '2022-01-14'
      - name: ip
        in: query
        description: the IP address
        required: true
        schema:
          type: string
      - name: ts
        in: query
        description: the pixel timestamp in micro seconds
        required: true
        schema:
          type: integer
      responses:
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                type: object
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ApiResponseListConversionTouch'
  /api/advertisers/{advertiserId}/reports/performance:
    post:
      tags:
      - Flip Dashboard
      summary: Get performance report by creative/publisher/channel/daypart/audience/device/mediatype/state/dma/zip/overall
      description: Get performance report by creative/publisher/channel/daypart/audience/device/mediatype/state/dma/zip/overall
      operationId: getPerformanceReport
      parameters:
      - name: advertiserId
        in: path
        description: the advertiser id
        required: true
        schema:
          type: integer
      - name: kind
        in: query
        description: the field by which data to be grouped, either creative/adgroup/publisher/channel/daypart/audience/device/mediatype/state/dma/zip/overall
        schema:
          type: string
          enum:
          - creative
          - adgroup
          - publisher
          - channel
          - daypart
          - audience
          - device
          - mediatype
          - state
          - dma
          - zip
          - overall
      - name: client
        in: query
        description: the account/client name
        required: true
        schema:
          type: string
      - name: advertiser
        in: query
        description: the advertiser name
        required: true
        schema:
          type: string
      - name: xandrId
        in: query
        description: the advertiser's XandrId
        required: true
        schema:
          type: string
      - name: pixel
        in: query
        description: the FLIP universal pixel id
        required: true
        schema:
          type: string
      - name: showUniques
        in: query
        description: flag to decide whether to show only uniques or not
        schema:
          type: boolean
          default: false
      - name: conversionWindow
        in: query
        description: the conversion window in hours
        schema:
          type: integer
          default: 0
      - name: mediaType
        in: query
        description: the media types to filter (e.g. Display Retargeting, OTT, etc.)
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
      - name: creative
        in: query
        description: the comma-separated creative ids to filter
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
      - name: publisher
        in: query
        description: the comma-separated publisher names to filter
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
      - name: audience
        in: query
        description: the comma-separated audience names to filter
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
      - name: ioIds
        in: query
        description: the comma-separated IO ids to filter
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
      - name: adGroups
        in: query
        description: the comma-separated Adready Id & start date (separated by |) combination to filter
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
      - name: attribution
        in: query
        description: the conversion attribution to be used, either full or partial
        schema:
          type: string
          default: full
          enum:
          - full
          - partial
      - name: methodology
        in: query
        description: the methodology to be used, either first_touch/last_touch/linear/time_decay
        schema:
          type: string
          default: last_touch
          enum:
          - first_touch
          - last_touch
          - linear
          - time_decay
      - name: event
        in: query
        description: the event
        schema:
          type: string
      - name: category
        in: query
        description: the pixel category
        required: true
        schema:
          type: string
      - name: subCategory
        in: query
        description: the comma-separated pixel sub-categories
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
      - name: startDate
        in: query
        description: the start date
        required: true
        schema:
          type: string
          example: '2022-01-08'
      - name: endDate
        in: query
        description: the end date
        required: true
        schema:
          type: string
          example: '2022-01-14'
      - name: fields
        in: query
        description: the comma-separated fields to return
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
      - name: offset
        in: query
        description: the number of records to skip
        schema:
          type: integer
          default: 0
      - name: limit
        in: query
        description: the max number of records to return
        schema:
          type: integer
          default: 100
      - name: onceNow
        in: query
        description: Run this report once?
        schema:
          type: boolean
          default: true
      - name: emailIt
        in: query
        description: Email this report?
        schema:
          type: boolean
          default: false
      - name: emailAddr
        in: query
        description: Email address?
        schema:
          type: string
      - name: Accept
        in: header
        description: '''application/json'' - provides json response. ''text/csv'' or ''application/csv'' provides csv file.'
        schema:
          type: string
          default: application/json
      responses:
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                type: object
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ApiResponseListMetricsByField'
  /api/advertisers/{advertiserId}/reports/eventPerformance:
    post:
      tags:
      - Flip Dashboard
      summary: Get event-wise performance report by creative/publisher/channel/daypart/audience/device/mediatype/state/dma/zip/overall
      description: Get event-wise performance report by creative/publisher/channel/daypart/audience/device/mediatype/state/dma/zip/overall
      operationId: getEventPerformanceReport
      parameters:
      - name: advertiserId
        in: path
        description: the advertiser id
        required: true
        schema:
          type: integer
      - name: kind
        in: query
        description: the field by which data to be grouped, either creative/adgroup/publisher/channel/daypart/audience/device/mediatype/state/dma/zip/overall
        required: true
        schema:
          type: string
          enum:
          - creative
          - adgroup
          - publisher
          - channel
          - daypart
          - audience
          - device
          - mediatype
          - state
          - dma
          - zip
          - overall
      - name: client
        in: query
        description: the account/client name
        required: true
        schema:
          type: string
      - name: advertiser
        in: query
        description: the advertiser name
        required: true
        schema:
          type: string
      - name: xandrId
        in: query
        description: the advertiser's XandrId
        required: true
        schema:
          type: string
      - name: pixel
        in: query
        description: the FLIP universal pixel id
        required: true
        schema:
          type: string
      - name: showUniques
        in: query
        description: flag to decide whether to show only uniques or not
        schema:
          type: boolean
          default: false
      - name: conversionWindow
        in: query
        description: the conversion window in hours
        schema:
          type: integer
          default: 0
      - name: mediaType
        in: query
        description: the media types to filter (e.g. Display Retargeting, OTT, etc.)
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
      - name: creative
        in: query
        description: the comma-separated creative ids to filter
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
      - name: publisher
        in: query
        description: the comma-separated publisher names to filter
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
      - name: audience
        in: query
        description: the comma-separated audience names to filter
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
      - name: ioIds
        in: query
        description: the comma-separated IO ids to filter
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
      - name: adGroups
        in: query
        description: the comma-separated Adready Id & start date (separated by |) combination to filter
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
      - name: attribution
        in: query
        description: the conversion attribution to be used, either full or partial
        schema:
          type: string
          default: full
          enum:
          - full
          - partial
      - name: methodology
        in: query
        description: the methodology to be used, either first_touch/last_touch/linear/time_decay
        schema:
          type: string
          default: last_touch
          enum:
          - first_touch
          - last_touch
          - linear
          - time_decay
      - name: event
        in: query
        description: the event
        schema:
          type: string
      - name: category
        in: query
        description: the pixel category
        required: true
        schema:
          type: string
      - name: subCategory
        in: query
        description: the comma-separated pixel sub-categories
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
      - name: startDate
        in: query
        description: the start date
        required: true
        schema:
          type: string
          example: '2022-01-08'
      - name: endDate
        in: query
        description: the end date
        required: true
        schema:
          type: string
          example: '2022-01-14'
      - name: fields
        in: query
        description: the comma-separated fields to return
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
      - name: offset
        in: query
        description: the number of records to skip
        schema:
          type: integer
          default: 0
      - name: limit
        in: query
        description: the max number of records to return
        schema:
          type: integer
          default: 100
      - name: onceNow
        in: query
        description: Run this report once?
        schema:
          type: boolean
          default: true
      - name: emailIt
        in: query
        description: Email this report?
        schema:
          type: boolean
          default: false
      - name: emailAddr
        in: query
        description: Email address?
        schema:
          type: string
      - name: Accept
        in: header
        description: '''application/json'' - provides json response. ''text/csv'' or ''application/csv'' provides csv file.'
        schema:
          type: string
          default: application/json
      responses:
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                type: object
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ApiResponsePagedResultEventMetricsByField'
  /api/advertisers/{advertiserId}/performance:
    post:
      tags:
      - Flip Dashboard
      summary: Get performance by creative/adgroup/publisher/channel/audience/mediatype
      description: Returns grouped performance metrics
      operationId: getPerformance
      parameters:
      - name: advertiserId
        in: path
        description: The advertiser ID
        required: true
      - name: groupBy
        in: query
        description: The field to group by
        required: true
        schema:
          type: string
          enum:
          - creative
          - adgroup
          - publisher
          - channel
          - audience
          - mediatype
      - name: client
        in: query
        description: The client name
        required: true
      - name: advertiser
        in: query
        description: The advertiser name
        required: true
      - name: xandrId
        in: query
        description: The advertiser's Xandr ID
        required: true
      - name: pixel
        in: query
        description: The FLIP universal pixel ID
        required: true
      - name: showUniques
        in: query
        description: Whether to show only uniques
        schema:
          type: boolean
          default: false
      - name: conversionWindow
        in: query
        description: Conversion window in hours
        schema:
          type: integer
          default: 0
      - name: mediaType
        in: query
        description: Media types to filter
        schema:
          type: array
          items:
            type: string
      - name: startDate
        in: query
        description: The start date
        required: true
        schema:
          type: string
          example: '2022-01-08'
      - name: endDate
        in: query
        description: The end date
        required: true
        schema:
          type: string
          example: '2022-01-14'
      responses:
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                type: object
        '200':
          description: Successful response
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/MetricsComparisonByField'
  /api/advertisers/{advertiserId}/performance/metrics/reach:
    post:
      tags:
      - Flip Dashboard
      summary: Get reach and frequency performance metric
      description: Returns reach and frequency metrics for a given advertiser and filters
      operationId: getReachFrequencyMetric
      parameters:
      - name: advertiserId
        in: path
        description: The advertiser ID
        required: true
        schema:
          type: integer
      - name: client
        in: query
        description: The account/client name
        required: true
      - name: advertiser
        in: query
        description: The advertiser name
        required: true
      - name: xandrId
        in: query
        description: The advertiser's XandrId
        required: true
      - name: mediaType
        in: query
        description: Media types to filter (e.g., Display Retargeting, OTT, etc.)
        schema:
          type: array
          items:
            type: string
      - name: creative
        in: query
        description: Comma-separated creative IDs to filter
        schema:
          type: array
          items:
            type: string
      - name: publisher
        in: query
        description: Comma-separated publisher names to filter
        schema:
          type: array
          items:
            type: string
      - name: audience
        in: query
        description: Comma-separated audience names to filter
        schema:
          type: array
          items:
            type: string
      - name: ioIds
        in: query
        description: Comma-separated IO IDs to filter
        schema:
          type: array
          items:
            type: string
      - name: adGroups
        in: query
        description: Comma-separated AdReady ID & start date (separated by |) combination to filter
        schema:
          type: array
          items:
            type: string
      - name: startDate
        in: query
        description: Start date
        required: true
        schema:
          type: string
          example: '2021-05-24'
      - name: endDate
        in: query
        description: End date
        required: true
        schema:
          type: string
          example: '2021-05-31'
      - name: compareStartDate
        in: query
        description: Compare start date
        schema:
          type: stri

# --- truncated at 32 KB (120 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/adready-cpxi/refs/heads/main/openapi/adready-cpxi-flip-dashboard-api-openapi.yml