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

# List external creatives.



## OpenAPI

````yaml /openapi/adm.openapi.en-dev.json get /api/manager/external-creatives
openapi: 3.1.0
info:
  description: >
    ## Introduction

    The Data Management APIs comprehensively oversees the **diverse data** used
    by advertising and recommendation systems, ensuring that the Decision API
    runs accurately and efficiently.


    From registering, updating, and deleting campaigns and placements to **log
    and statistics analysis**, it provides the insights necessary for effective
    system operation.


    The resulting data and metrics are used by the Decision API to **optimize ad
    and content decisions**, ultimately boosting the overall performance of the
    advertising and recommendation system.
  title: Data Management APIs
  version: dev
servers: []
security: []
tags:
  - description: >-
      Authentication endpoints. All roles (admin, operator, advertiser) use
      these to log in, refresh tokens, and manage their own credentials.
    name: Auth
  - description: >-
      Advertiser account management. Operators and admins onboard advertisers,
      manage their budgets, and deactivate accounts. Advertisers can only read
      their own profile and balance — they cannot create, delete, or modify
      another advertiser's account.
    name: Advertisers
  - description: >-
      Internal user (operator / admin) account management. Admin only. Covers
      creating operator accounts, changing roles, toggling activation status,
      and hard-deleting accounts. Operators have no access to this resource.
    name: Users
  - description: >-
      The AdUnit Management API provides comprehensive functionalities for
      managing ad units and related resources. AdUnits are organized in a
      hierarchical path structure derived from their code and parent path. Only
      admin and operator roles have access — advertisers cannot access raw
      inventory. References:
      [Placement](https://docs.aiderx.io/guides/about-a2/en/placement)
    name: AdUnit
  - description: >-
      Ad catalog management. CRUD for ad catalogs plus public shared-view access
      via a share link.
    name: Ad Catalogs
  - description: >-
      Ad source (demand partner) management. CRUD for external ad sources that
      supply demand to ad units.
    name: AdSource
  - description: >-
      Allocation management. An allocation binds a line item to a serving target
      such as an ad unit. Covers CRUD, status counts, and single-allocation
      lookup.
    name: Allocations
  - description: >-
      Associated items pool (admin). Bulk upsert/delete and lookup of
      associated-items pools used by the recommendation pipeline.
    name: AssociatedItemsPool
  - description: >-
      Custom targeting segment management. CRUD and bulk operations for custom
      targeting segments.
    name: Custom Targeting Segment
  - description: Audit log access. Read the system audit log of administrative actions.
    name: Audit Logs
  - description: >-
      Creative block list. List, block, and unblock creatives to exclude them
      from serving.
    name: Blocked Creative
  - description: Catalog item management. List and update catalog (product/data) items.
    name: Catalogs
  - description: >-
      Creative asset management. Operators and admins manage creatives;
      advertisers see only their own. Deletion is blocked while any line-item
      association (LICA) still exists.
    name: Creatives
  - description: >-
      Dashboard aggregates. Summary data, inventory, and line-item metric
      rollups for the console dashboard.
    name: Dashboard
  - description: Experiment management. CRUD for A/B and optimization experiments.
    name: Experiment
  - description: >-
      External creative inspection. Read-only access to creatives ingested from
      external demand sources.
    name: External Creative
  - description: >-
      Third-party integration management. Manage integration sources (external
      data/serving connectors), probe connectivity, and read public
      (sensitive-config-redacted) configs.
    name: Integration
  - description: >-
      Line Item–Creative Associations (LICA). Associates creatives with line
      items, including batch create and delete (max 100, partial failure
      allowed) and dashboard counts.
    name: LICAs
  - description: License information. Read available license features and usage metrics.
    name: License
  - description: >-
      Line item management within an order. Covers create, update, delete, batch
      operations (max 100, partial failure allowed), and status transitions. A
      line item defines budget, goal, schedule, and targeting under its parent
      order.
    name: LineItems
  - description: Media library. List, upload, and delete media files used by creatives.
    name: Media Library
  - description: >-
      Metric query endpoints. Retrieve aggregated metrics for ad units,
      creatives, line items, and related entities.
    name: Metric
  - description: >-
      Advertiser order management. Operators and admins create and manage orders
      that group line items under a single budget; advertisers can read their
      own. Includes batch operations (max 100) and draft-only deletion rules.
    name: Orders
  - description: >-
      Placement management. A placement maps ad units to a serving surface.
      Endpoints cover CRUD and replacing the ad units bound to a placement.
    name: Placements
  - description: >-
      System settings. Read and update system configuration, including site
      logo, public URL, TLS, and access-token regeneration.
    name: Settings
  - description: System resources. Public static resources such as the site logo.
    name: System
  - description: >-
      Operational/developer control endpoints. Low-level ext patches and health
      checks intended for internal operation, not general API consumers.
    name: developer
  - description: >-
      Operational allocation control. Update allocation ext or force-update
      status (admin only).
    name: developer/control/allocations
  - description: >-
      Ad-serving monitoring (operational). Read ad-serving status, ad-unit
      monitoring history, and alerts.
    name: developer/monitoring
  - description: Internal health and probe endpoints.
    name: internal
  - description: >-
      Manager-level utility endpoints (e.g. service health) not tied to a
      specific resource.
    name: manager
  - description: Manage mappings between ad units, native formats, and native styles.
    name: Ad Unit Native Style
  - description: Manage custom targeting keys, including lifecycle and bulk operations.
    name: Custom Targeting Key
  - description: >-
      Manage values belonging to custom targeting keys, including lifecycle and
      bulk operations.
    name: Custom Targeting Value
  - description: Manage native formats and the fields that define each format.
    name: Native Format
  - description: List templates available for native styles.
    name: Native Style Template
  - description: Manage native rendering styles.
    name: Native Style
paths:
  /api/manager/external-creatives:
    get:
      tags:
        - External Creative
      summary: List external creatives.
      operationId: handle_list_external_creatives_api_manager_external_creatives_get
      parameters:
        - description: Page number (1-based).
          in: query
          name: page
          required: false
          schema:
            default: 1
            description: Page number (1-based).
            minimum: 1
            title: Page
            type: integer
        - description: Number of items per page.
          in: query
          name: page_size
          required: false
          schema:
            default: 100
            description: Number of items per page.
            maximum: 100
            minimum: 1
            title: Page Size
            type: integer
        - description: Field name to sort by.
          in: query
          name: sort_by
          required: false
          schema:
            default: last_seen
            description: Field name to sort by.
            enum:
              - creative_id
              - campaign_id
              - first_seen
              - last_seen
              - 'no'
            title: Sort By
            type: string
        - description: Sort direction.
          in: query
          name: sort_order
          required: false
          schema:
            $ref: '#/components/schemas/SortOrder'
            default: desc
            description: Sort direction.
        - description: Filter by creative ID.
          in: query
          name: creative_id
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Filter by creative ID.
            title: Creative Id
        - description: Filter by campaign ID.
          in: query
          name: campaign_id
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Filter by campaign ID.
            title: Campaign Id
        - description: Filter by ad source.
          in: query
          name: ad_source
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Filter by ad source.
            title: Ad Source
        - description: Filter by first seen date.
          in: query
          name: first_seen
          required: false
          schema:
            anyOf:
              - format: date-time
                type: string
              - type: 'null'
            description: Filter by first seen date.
            title: First Seen
        - description: Filter by last seen date.
          in: query
          name: last_seen
          required: false
          schema:
            anyOf:
              - format: date-time
                type: string
              - type: 'null'
            description: Filter by last seen date.
            title: Last Seen
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/PaginatedResponse_ExternalCreativeResponse_
          description: Successful Response
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPExceptionResponse'
          description: Forbidden
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      security:
        - HTTPBearer: []
components:
  schemas:
    SortOrder:
      enum:
        - asc
        - desc
      title: SortOrder
      type: string
    PaginatedResponse_ExternalCreativeResponse_:
      properties:
        items:
          items:
            $ref: '#/components/schemas/ExternalCreativeResponse'
          title: Items
          type: array
        pagination:
          $ref: '#/components/schemas/PageInfo'
      required:
        - items
        - pagination
      title: PaginatedResponse[ExternalCreativeResponse]
      type: object
    HTTPExceptionResponse:
      properties:
        detail:
          description: Detailed explanation for the exception
          title: Detail
          type: string
      required:
        - detail
      title: HTTPExceptionResponse
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      type: object
    ExternalCreativeResponse:
      properties:
        ad_source:
          description: Ad source identifier
          title: Ad Source
          type: string
        campaign_id:
          description: Unique identifier for the external campaign
          title: Campaign Id
          type: string
        created_at:
          format: date-time
          title: Created At
          type: string
        creative_id:
          description: Unique identifier for the creative
          title: Creative Id
          type: string
        ext:
          $ref: '#/components/schemas/ExternalCreativeExtRead'
        first_seen:
          description: Timestamp when the creative was first seen
          format: date-time
          title: First Seen
          type: string
        id:
          anyOf:
            - format: uuid
              type: string
            - type: 'null'
          title: Id
        impressions:
          description: Number of impressions
          title: Impressions
          type: integer
        last_seen:
          description: Timestamp when the creative was last seen
          format: date-time
          title: Last Seen
          type: string
        'no':
          description: Auto-incrementing row number (primary key)
          title: 'No'
          type: integer
        source_name:
          anyOf:
            - type: string
            - type: 'null'
          description: Ad source display name
          title: Source Name
        thumbnail_url:
          anyOf:
            - type: string
            - type: 'null'
          description: Optional thumbnail URL for the creative
          title: Thumbnail Url
        updated_at:
          format: date-time
          title: Updated At
          type: string
      required:
        - 'no'
        - created_at
        - updated_at
        - ad_source
        - campaign_id
        - creative_id
        - first_seen
        - impressions
        - last_seen
      title: ExternalCreativeResponse
      type: object
    PageInfo:
      properties:
        page:
          title: Page
          type: integer
        page_size:
          title: Page Size
          type: integer
        total:
          title: Total
          type: integer
        total_pages:
          title: Total Pages
          type: integer
      required:
        - total
        - page
        - page_size
        - total_pages
      title: PageInfo
      type: object
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          title: Location
          type: array
        msg:
          title: Message
          type: string
        type:
          title: Error Type
          type: string
      required:
        - loc
        - msg
        - type
      title: ValidationError
      type: object
    ExternalCreativeExtRead:
      description: |-
        외부 소재 ext 응답 스키마.

        generated `ExternalCreativeExt`(SSoT: a2 a2-http)는 현재 image_info만 가져
        응답에서 cat/cattax/adomain을 떨궈낸다. 이 필드들은 OpenRTB bid에 존재하지만
        적재 파이프라인(a2)에서 채워질 예정이라, 채워지는 즉시 API가 노출하도록
        읽기 전용으로 확장한다. a2-http에 필드가 추가돼 generated 모델이 갱신되면 제거/정리.
      properties:
        adomain:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Adomain
        cat:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Cat
        cattax:
          anyOf:
            - type: integer
            - type: 'null'
          title: Cattax
        image_info:
          anyOf:
            - $ref: '#/components/schemas/CreativeImageInfo'
            - type: 'null'
      title: ExternalCreativeExtRead
      type: object
    CreativeImageInfo:
      properties:
        crop_region:
          anyOf:
            - $ref: '#/components/schemas/CropRegion'
            - type: 'null'
        height:
          minimum: 0
          title: Height
          type: integer
        major_colors:
          items:
            maximum: 255
            minimum: 0
            type: integer
          title: Major Colors
          type: array
        width:
          minimum: 0
          title: Width
          type: integer
      required:
        - height
        - major_colors
        - width
      title: CreativeImageInfo
      type: object
    CropRegion:
      properties:
        height:
          minimum: 0
          title: Height
          type: integer
        width:
          minimum: 0
          title: Width
          type: integer
        x:
          minimum: 0
          title: X
          type: integer
        'y':
          minimum: 0
          title: 'Y'
          type: integer
      required:
        - height
        - width
        - x
        - 'y'
      title: CropRegion
      type: object
  securitySchemes:
    HTTPBearer:
      description: >-
        Bearer authentication. Pass the access token in the `Authorization:
        Bearer <token>` header.
      scheme: bearer
      type: http

````