> ## Documentation Index
> Fetch the complete documentation index at: https://docs.uplifthub.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Display Ad

> Request one or more display ad decisions for the specified zones. Returns sized image assets for banner or rich-media creatives.



## OpenAPI

````yaml /uplift-ads-openapi.json post /display-ad
openapi: 3.0.1
info:
  title: Uplift Ad API
  description: API for the Uplift Ad API
  version: v3
servers:
  - url: https://api.upliftads.io/v3
security:
  - ApiKeyAuth: []
tags:
  - name: Ad Decisions
paths:
  /display-ad:
    post:
      tags:
        - Ad Decisions
      summary: Get Display Ad
      description: >-
        Request one or more display ad decisions for the specified zones.
        Returns sized image assets for banner or rich-media creatives.
      operationId: getdisplayAd
      parameters:
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
        - name: x-site-id
          in: header
          required: true
          schema:
            type: integer
            format: int64
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/displayAdRequest'
        required: true
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/displayAdResponse'
        '400':
          description: Bad request, check the request body
        '404':
          description: Not found
components:
  schemas:
    displayAdRequest:
      type: object
      properties:
        siteId:
          type: number
          format: float
          description: Your site ID. Can be passed here instead of the x-site-id header.
        zoneIds:
          type: array
          items:
            type: number
            format: float
          description: One or more zone IDs to request decisions for.
        adTypes:
          type: array
          items:
            type: number
            format: float
          description: >-
            Ad type IDs specifying the accepted creative formats. Required for
            display ads.
        count:
          type: number
          format: float
          description: Maximum number of ads to return per zone.
        keywords:
          type: array
          items:
            type: string
          description: >-
            Keyword signals used for targeting — e.g. destination names or
            product categories.
        eventIds:
          type: array
          items:
            type: object
            properties:
              id:
                type: number
                format: float
              label:
                type: string
            required:
              - id
              - label
            additionalProperties: false
          description: Contextual event identifiers for the current page or session.
        ip:
          type: string
          description: The end-user's IP address, used for geo-targeting.
        user:
          type: string
          description: A stable user identifier for frequency capping and personalisation.
        consentGDPR:
          type: boolean
          description: Whether the user has given GDPR consent.
        customTargeting:
          type: object
          properties: {}
          additionalProperties:
            anyOf:
              - type: string
              - type: number
                format: float
              - type: array
                items:
                  oneOf:
                    - type: string
                    - type: number
                      format: float
          description: >-
            Freeform key-value targeting parameters. Values can be strings,
            numbers, or arrays of either.
      required:
        - zoneIds
        - adTypes
        - keywords
      additionalProperties: false
    displayAdResponse:
      type: object
      properties:
        user:
          type: object
          properties:
            key:
              type: string
          additionalProperties: false
          description: A stable user identifier for frequency capping and personalisation.
        decisions:
          type: object
          properties: {}
          additionalProperties:
            type: array
            items:
              type: object
              properties:
                adId:
                  type: integer
                creativeId:
                  type: integer
                flightId:
                  type: integer
                campaignId:
                  type: integer
                advertiserId:
                  type: integer
                priorityId:
                  type: integer
                clickUrl:
                  type: string
                impressionUrl:
                  type: string
                viewableImpressionUrl:
                  type: string
                content:
                  type: array
                  items:
                    type: object
                    properties:
                      height:
                        type: integer
                      width:
                        type: integer
                      imageUrl:
                        type: string
                    additionalProperties: false
              additionalProperties: false
      additionalProperties: false
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key

````