MediaMath Strategies API

openapi: 3.2.0
info:
  title: Campaigns Ad Servers Strategies API
  description: 'MediaMath Campaign Management API


    [Postman Collection](https://apidocs.mediamath.com/guides/postman-collections)

    '
  version: 3.0.1807
  contact:
    url: https://support.infillion.com/
servers:
- url: https://api.mediamath.com/api/v3.0
  description: Live Server
security:
- Auth0:
  - offline_access
  - manage:services
tags:
- name: Strategies
  description: Strategies
paths:
  /strategies:
    post:
      tags:
      - Strategies
      operationId: create-strategy
      summary: Create a Strategy
      description: "Create a strategy. \nIf your use case requires more than 100,000 IPs or postal codes, please contact your MediaMath representative to discuss custom solutions or alternative approaches.\n"
      parameters:
      - $ref: '#/components/parameters/extended'
      requestBody:
        $ref: '#/components/requestBodies/strategy_create'
      responses:
        '201':
          description: Strategy created response
          content:
            application/json:
              schema:
                anyOf:
                - $ref: '#/components/schemas/strategy'
                - $ref: '#/components/schemas/strategy_extended'
        '400':
          $ref: '#/components/responses/error'
        '401':
          $ref: '#/components/responses/error'
        '403':
          $ref: '#/components/responses/error'
    get:
      operationId: list-strategies
      summary: List Strategies
      description: Get a list of strategies
      tags:
      - Strategies
      parameters:
      - $ref: '#/components/parameters/strategy_with'
      - $ref: '#/components/parameters/page_limit'
      - $ref: '#/components/parameters/page_offset'
      - $ref: '#/components/parameters/sort_by'
      - $ref: '#/components/parameters/q'
      - $ref: '#/components/parameters/extended'
      - $ref: '#/components/parameters/full'
      - name: live_only
        in: query
        required: false
        description: "If provided and true only strategies with start_date < now and end_date > now will be returned. \nDefault value is false. \nIf use_campaign_start = true campaign.start_date will be used instead of one from strategy.\nIf use_campaign_end = true campaign.end_date will be used instead of one from strategy.\n"
        schema:
          type: boolean
      responses:
        '200':
          description: List strategies response
          content:
            application/json:
              schema:
                anyOf:
                - $ref: '#/components/schemas/strategy_collection'
                - $ref: '#/components/schemas/strategy_collection_full'
                - $ref: '#/components/schemas/strategy_collection_full_extended'
        '400':
          $ref: '#/components/responses/error'
        '401':
          $ref: '#/components/responses/error'
        '403':
          $ref: '#/components/responses/error'
  /strategies/{strategy_id}:
    post:
      operationId: update-strategy
      summary: Update a Strategy
      description: 'Update a strategy by ID.

        If your use case requires more than 100,000 IPs or postal codes, please contact your MediaMath representative to discuss custom solutions or alternative approaches.

        '
      tags:
      - Strategies
      parameters:
      - in: path
        name: strategy_id
        schema:
          type: integer
        required: true
        description: Numeric ID of the strategy to update
      - $ref: '#/components/parameters/extended'
      requestBody:
        $ref: '#/components/requestBodies/strategy_update'
      responses:
        '200':
          description: Strategy updated response
          content:
            application/json:
              schema:
                anyOf:
                - $ref: '#/components/schemas/strategy'
                - $ref: '#/components/schemas/strategy_extended'
        '400':
          $ref: '#/components/responses/error'
        '401':
          $ref: '#/components/responses/error'
        '403':
          $ref: '#/components/responses/error'
        '404':
          $ref: '#/components/responses/error'
        '409':
          $ref: '#/components/responses/error'
    get:
      operationId: get-strategy
      summary: Get a Strategy
      description: Get a strategy by ID
      tags:
      - Strategies
      parameters:
      - in: path
        name: strategy_id
        schema:
          type: integer
        required: true
        description: Numeric ID of the strategy object to get
      - $ref: '#/components/parameters/extended'
      responses:
        '200':
          description: Strategy response
          content:
            application/json:
              schema:
                anyOf:
                - $ref: '#/components/schemas/strategy'
                - $ref: '#/components/schemas/strategy_extended'
        '400':
          $ref: '#/components/responses/error'
        '401':
          $ref: '#/components/responses/error'
        '403':
          $ref: '#/components/responses/error'
        '404':
          $ref: '#/components/responses/error'
  /strategies/{strategy_id}/copy:
    description: Copy a strategy
    post:
      tags:
      - Strategies
      summary: Copy a strategy
      description: Copy a strategy
      parameters:
      - in: path
        name: strategy_id
        schema:
          type: integer
        required: true
        description: Numeric ID of the strategy object
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                status:
                  type: boolean
                  description: Indicates the status.
                name:
                  type: string
                  description: Name of the entity.
                duration:
                  type: object
                  properties:
                    start_date:
                      type: string
                      format: date-time
                      description: Start date of the strategy.
                    copy_use_campaign_start:
                      type: boolean
                      description: Indicates if we copy the 'use_campaign_start' field.
                    end_date:
                      type: string
                      format: date-time
                      description: End date of the strategy.
                    copy_use_campaign_end:
                      type: boolean
                      description: Indicates if we copy the 'use_campaign_end' field.
                targeting:
                  type: object
                  properties:
                    copy_geofence:
                      type: boolean
                      description: Indicates if copy geofencing is enabled.
                    copy_contextual:
                      type: boolean
                      description: Indicates if copy contextual targeting is enabled.
                    copy_audience:
                      type: boolean
                      description: Indicates if copy audience targeting is enabled.
                    copy_technology:
                      type: boolean
                      description: Indicates if copy technology targeting is enabled.
                    copy_my_data:
                      type: boolean
                      description: Indicates if copy "my_data" targeting is enabled.
                    copy_location:
                      type: boolean
                      description: Indicates if copy "location" targeting is enabled.
                    copy_day_parts:
                      type: boolean
                      description: Indicates if copy "day_parts" targeting is enabled.
                    copy_postal_codes:
                      type: boolean
                      description: Indicates if copy "postal_codes" targeting is enabled.
                    copy_audio_video:
                      type: boolean
                      description: Indicates if copy "audio_video" targeting is enabled.
                    copy_ip_addresses:
                      type: boolean
                      description: Indicates if copy 'ip_address" targeting is enabled.
                    copy_fold_position:
                      type: boolean
                      description: Indicates if copy 'fold_position' targeting is enabled.
                inventory:
                  type: object
                  properties:
                    copy_supply:
                      type: boolean
                      description: Indicates if a supply is copied.
                    copy_site_lists:
                      type: boolean
                      description: Indicates if site lists are copied.
                    copy_supply_controls:
                      type: boolean
                      description: Indicates if supply controls are copied
                concepts:
                  type: object
                  properties:
                    copy_creative_groups:
                      type: boolean
                      description: Indicates if creative groups are copied
              required:
              - name
              - status
      responses:
        '200':
          description: Strategy copy
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/strategy'
        '400':
          $ref: '#/components/responses/error'
        '401':
          $ref: '#/components/responses/error'
        '403':
          $ref: '#/components/responses/error'
        '404':
          $ref: '#/components/responses/error'
      operationId: post-copy-strategy
  /strategies/{strategy_id}/healthcheck:
    description: Get strategy health
    get:
      operationId: get-strategy-healthcheck
      summary: Get Strategy Health
      description: Get strategy health
      tags:
      - Strategies
      parameters:
      - in: path
        name: strategy_id
        schema:
          type: integer
        required: true
        description: Numeric ID of the strategy object
      responses:
        '200':
          $ref: '#/components/responses/strategy_healthcheck'
        '400':
          $ref: '#/components/responses/error'
        '401':
          $ref: '#/components/responses/error'
        '403':
          $ref: '#/components/responses/error'
        '404':
          $ref: '#/components/responses/error'
  /strategies/{strategy_id}/friendly_names:
    description: Get targeting friendly names
    get:
      operationId: get-strategy-friendly-names
      summary: Get Targeting Friendly Names
      description: Get targeting friendly names
      tags:
      - Strategies
      parameters:
      - in: path
        name: strategy_id
        schema:
          type: integer
        required: true
        description: Numeric ID of the strategy object
      responses:
        '200':
          $ref: '#/components/responses/strategy_friendly_names'
        '400':
          $ref: '#/components/responses/error'
        '401':
          $ref: '#/components/responses/error'
        '403':
          $ref: '#/components/responses/error'
        '404':
          $ref: '#/components/responses/error'
  /strategies/{strategy_id}/forecast_query:
    description: Get forecast query
    get:
      operationId: get-strategy-forecast-query
      summary: Get Forecast Query
      description: Get forecast query
      tags:
      - Strategies
      parameters:
      - in: path
        name: strategy_id
        schema:
          type: integer
        required: true
        description: Numeric ID of the strategy object
      responses:
        '200':
          $ref: '#/components/responses/strategy_forecast_query'
        '400':
          $ref: '#/components/responses/error'
        '401':
          $ref: '#/components/responses/error'
        '403':
          $ref: '#/components/responses/error'
        '404':
          $ref: '#/components/responses/error'
  /strategies/{strategy_id}/targeting_expression:
    description: Get targeting expression
    get:
      operationId: get-strategy-targeting-expression
      summary: Get Targeting Expression
      description: Get the normalized targeting expression for a strategy.
      tags:
      - Strategies
      parameters:
      - in: path
        name: strategy_id
        schema:
          type: integer
        required: true
        description: Numeric ID of the strategy object
      - in: query
        name: include_inactive
        schema:
          type: boolean
          default: false
        required: false
        description: When true, includes inactive supply sources and strategy targets in the expression. Default behavior filters these out.
      responses:
        '200':
          $ref: '#/components/responses/strategy_targeting_expression'
        '400':
          $ref: '#/components/responses/error'
        '401':
          $ref: '#/components/responses/error'
        '403':
          $ref: '#/components/responses/error'
        '404':
          $ref: '#/components/responses/error'
  /strategies/{strategy_id}/history:
    get:
      operationId: strategy-audit-log
      summary: Strategy Audit Log
      description: Get a list changes to this strategy
      tags:
      - Strategies
      parameters:
      - $ref: '#/components/parameters/page_limit'
      - $ref: '#/components/parameters/page_offset'
      - in: path
        name: strategy_id
        schema:
          type: integer
        required: true
        description: Numeric ID of the strategy
      responses:
        '200':
          $ref: '#/components/responses/audit_log'
        '400':
          $ref: '#/components/responses/error'
        '401':
          $ref: '#/components/responses/error'
        '403':
          $ref: '#/components/responses/error'
        '404':
          $ref: '#/components/responses/error'
  /bulk_update/strategies:
    post:
      operationId: bulk-update-strategies
      summary: Bulk Update Strategies
      description: Update multiple strategies
      tags:
      - Strategies
      responses:
        '200':
          $ref: '#/components/responses/strategy_bulk'
        '207':
          description: Multi-status updated strategy list
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/strategy_full_response'
                  meta:
                    $ref: '#/components/schemas/list_metadata'
        '400':
          $ref: '#/components/responses/error'
        '401':
          $ref: '#/components/responses/error'
        '403':
          $ref: '#/components/responses/error'
      requestBody:
        $ref: '#/components/requestBodies/strategy_bulk_update'
  /strategies/{strategy_id}/permissions:
    get:
      operationId: list-user-permissions-strategy
      summary: List User Permissions for a Strategy
      description: List user permissions for a strategy
      tags:
      - Strategies
      parameters:
      - $ref: '#/components/parameters/page_limit'
      - $ref: '#/components/parameters/page_offset'
      - $ref: '#/components/parameters/sort_by'
      - $ref: '#/components/parameters/q'
      - in: path
        name: strategy_id
        schema:
          type: integer
        required: true
        description: Numeric ID of the strategy
      responses:
        '200':
          description: List user permissions response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/permission_strategy_with_user'
                  meta:
                    $ref: '#/components/schemas/list_metadata'
        '400':
          $ref: '#/components/responses/error'
        '401':
          $ref: '#/components/responses/error'
        '403':
          $ref: '#/components/responses/error'
        '404':
          $ref: '#/components/responses/error'
  /audit_log/strategies:
    post:
      operationId: strategy-audit-log-bulk
      summary: Bulk Strategy Audit Log
      description: Get a list of changes to these strategies
      tags:
      - Strategies
      parameters:
      - $ref: '#/components/parameters/page_limit'
      - $ref: '#/components/parameters/page_offset'
      responses:
        '200':
          $ref: '#/components/responses/audit_log_bulk'
        '400':
          $ref: '#/components/responses/error'
        '401':
          $ref: '#/components/responses/error'
        '403':
          $ref: '#/components/responses/error'
      requestBody:
        $ref: '#/components/requestBodies/id_list'
components:
  schemas:
    single_metadata:
      title: single_metadata
      type: object
      properties:
        status:
          type: string
          example: success
      required:
      - status
    strategy_healthcheck:
      type: object
      properties:
        result:
          type: string
          enum:
          - pass
          - warning
          - fail
        organization:
          type: object
          properties:
            id:
              type: integer
            status:
              type: boolean
            activity_check:
              $ref: '#/components/schemas/healthcheck_result'
        contract:
          type: object
          properties:
            id:
              type:
              - integer
              - 'null'
              description: Null when the organization has no contract on file.
            expiration_date:
              type:
              - string
              - 'null'
              format: date-time
              description: effective_end_date of the contract surfaced by the check; null when no contract was found.
            activity_check:
              $ref: '#/components/schemas/healthcheck_result'
        agency:
          type: object
          properties:
            id:
              type: integer
            status:
              type: boolean
            activity_check:
              $ref: '#/components/schemas/healthcheck_result'
        advertiser:
          type: object
          properties:
            id:
              type: integer
            status:
              type: boolean
            activity_check:
              $ref: '#/components/schemas/healthcheck_result'
        campaign:
          type: object
          properties:
            id:
              type: integer
            status:
              type: boolean
            activity_check:
              $ref: '#/components/schemas/healthcheck_result'
            start_date:
              type: string
              format: date-time
            end_date:
              type: string
              format: date-time
            start_end_date_check:
              $ref: '#/components/schemas/healthcheck_result'
            budget_check:
              $ref: '#/components/schemas/healthcheck_result'
            remaining_budget:
              type:
              - number
              - 'null'
              description: Remaining budget (total_budget − spend_to_date) on the campaign's relevant budget flight; null when no active flight exists.
            currency_code:
              type:
              - string
              - 'null'
              description: Currency of `remaining_budget`, inherited from the relevant budget flight; null when no active flight exists.
        strategy:
          type: object
          properties:
            id:
              type: integer
            status:
              type: boolean
            activity_check:
              $ref: '#/components/schemas/healthcheck_result'
            start_date:
              type: string
              format: date-time
            use_campaign_start:
              type: boolean
            use_campaign_end:
              type: boolean
            end_date:
              type: string
              format: date-time
            start_end_date_check:
              $ref: '#/components/schemas/healthcheck_result'
            budget_check:
              $ref: '#/components/schemas/healthcheck_result'
            remaining_budget:
              type:
              - number
              - 'null'
              description: Strategy budget minus spend-to-date; null when no strategy-level budget cap is set.
            currency_code:
              type:
              - string
              - 'null'
              description: Currency of `remaining_budget`, inherited from the parent campaign; null when no strategy-level cap is set.
            inventory_check:
              $ref: '#/components/schemas/healthcheck_result'
            day_parts_check:
              $ref: '#/components/schemas/healthcheck_result'
            next_active_window_start:
              type:
              - string
              - 'null'
              format: date-time
              description: 'UTC time the next active daypart window will open. Populated only when

                day_parts_check is `warning` (currently outside every active window); null

                otherwise (including when no dayparting is configured).

                '
        creative:
          type: object
          description: 'Collective creative diagnostics. A strategy has many creatives via the

            strategy_concepts → concepts → atomic_creatives path, so there is no single

            creative to point at — only the two pass/fail outcomes.

            '
          properties:
            activity_check:
              description: pass if ≥1 attached creative is active and within its start/end date window.
              allOf:
              - $ref: '#/components/schemas/healthcheck_result'
            approval_check:
              description: pass if ≥1 attached creative has at least one APPROVED row in creative_approvals.
              allOf:
              - $ref: '#/components/schemas/healthcheck_result'
    strategy_goals:
      type: object
      additionalProperties: false
      properties:
        goal_type:
          type: string
          enum:
          - spend
          - reach
          - cpc
          - cpe
          - cpa
          - roi
          - ctr
          - vcr
          - viewability_rate
          - vcpm
          - cpcv
        goal_value:
          type: number
          format: float
          minimum: 0
          maximum: 9999999.9999
        min_bid:
          type: number
          format: float
          minimum: 0
          maximum: 9999999.99
        max_bid:
          type: number
          format: float
          minimum: 0.01
          maximum: 9999999.99
        roi_target:
          type:
          - number
          - 'null'
          format: double
          minimum: 0
          maximum: 9999999.99
        bid_min_devices:
          type:
          - integer
          - 'null'
          format: int16
          example: 1
          minimum: -32768
          maximum: 32767
        bid_aggressiveness:
          type: integer
          minimum: 0
          maximum: 100
        bid_price_is_media_only:
          type: boolean
        max_bid_wm:
          type:
          - number
          - 'null'
          format: float
          minimum: 0
          maximum: 9999999.99
        use_bid_shading:
          type: boolean
        flat_rate_cpm:
          type:
          - number
          - 'null'
          format: float
          minimum: 0.01
          maximum: 9999999.99
    strategy_collection_full_extended:
      type: object
      title: strategy_collection_full_extended
      properties:
        data:
          type: array
          items:
            allOf:
            - $ref: '#/components/schemas/strategy_campaign_info'
            - $ref: '#/components/schemas/strategy_full_extended'
        meta:
          $ref: '#/components/schemas/list_metadata'
    deal:
      title: ''
      type: object
      properties:
        deal_id:
          type: integer
          format: int32
          example: 8
      required:
      - deal_id
    strategy_audience_segment:
      type: object
      title: strategy_audience_segment
      properties:
        audience_segment_id:
          type: integer
          format: int32
          example: 24
        user_cpm:
          type:
          - number
          - 'null'
          format: float
          description: user_cpm is stored in the currency of the campaign and will not fluctuate with daily exchange rates.
      required:
      - audience_segment_id
    strategy_segment_group_extended:
      type: object
      properties:
        operator:
          type: string
          enum:
          - AND
        segment_groups:
          type: array
          items:
            type: object
            properties:
              segment_group_id:
                type: integer
              segment_group_name:
                type: string
      required:
      - segment_groups
    permission_user_output:
      type: object
      properties:
        id:
          type: integer
        entity_type:
          type: string
        username:
          type: string
        active:
          type: boolean
        version:
          type: integer
        title:
          type: string
        first_name:
          type: string
        last_name:
          type: string
        link_ldap:
          type: boolean
        link_saml:
          type: boolean
        phone:
          type: string
        mobile:
          type: string
        fax:
          type: string
        type:
          type: string
        role:
          type: string
        scope:
          type: string
        view_organizations:
          type: boolean
        edit_campaigns:
          type: boolean
        edit_margins_and_performance:
          type: boolean
        labs_enable_rmx:
          type: boolean
        creator_id:
          type: integer
        created_on:
          type: string
          format: date-time
          readOnly: true
        updated_on:
          type: string
          format: date-time
          readOnly: true
        last_login_on:
          type:
          - string
          - 'null'
          format: date-time
          readOnly: true
        access_internal_fees:
          type: boolean
        view_segments:
          type: boolean
        edit_segments:
          type: boolean
        view_data_definition:
          type: boolean
        edit_data_definition:
          type: boolean
        view_dmp_reports:
          type: boolean
        email:
          type: string
        permissions:
          type: object
          properties:
            organizations:
              type: array
              items:
                $ref: '#/components/schemas/permission'
            agencies:
              type: array
              items:
                $ref: '#/components/schemas/permission'
            advertisers:
              type: array
              items:
                $ref: '#/components/schemas/permission'
        roles:
          $ref: '#/components/schemas/roles'
        language:
          type: string
        zone_name:
          type: string
    targeting_recency_element_response:
      type: object
      properties:
        pixel_id:
          type: integer
          format: int32
          example: 55
        from_hour:
          type: integer
          format: int32
          example: 5
        to_hour:
          type: integer
          format: int32
          example: 7
    strategy_technology:
      type: object
      title: ''
      properties:
        operator:
          type: string
          enum:
          - AND
          - OR
          default: OR
        code:
          type: string
          enum:
          - BSER
          - CSPD
          - DVCE
          - ISPX
          - OSXX
          - INVT
          - VPSZ
          - VLIN
          - VCON
          - VAUD
          - VSKP
          - VPLC
          - DVMD
          - BRLG
          - IPTA
          - HYPL
        target_value_id:
          type: integer
          format: int32
          example: 77
      required:
      - code
      - target_value_id
    deal_group:
      title: ''
      type: object
      properties:
        deal_group_id:
          type: integer
          format: int32
          example: 9
      required:
      - deal_group_id
    strategy_geofence_extended:
      type: object
      title: ''
      properties:
        operator:
          type: string
          enum:
          - AND
          - OR
          default: OR
        segments:
          type: array
          items:
            type: object
            required:
            - geofence_segment_id
            - geofence_segment_factual_id
            properties:
              geofence_segment_id:
                type: integer
              geofence_segment_factual_id:
                type: string
              name:
                type: string
                maxLength: 128
                description: available only when extended
              status:
                type: boolean
                description: available only when extended
              updated_on:
                type: string
                format: date-time
                readOnly: true
                description: available only when extended
    strategy_campaign_info:
      type: object
      properties:
        campaign_name:
          type: string
          readOnly: true
        campaign_start_date:
          type: string
          format: date-time
          readOnly: true
        campaign_end_date:
          type: string
          format: date-time
          readOnly: true
        campaign_zone_name:
          type: string
          readOnly: true
        campaign_service_type:
          type: string
          readOnly: true
        campaign_goal_type:
          type: string
          readOnly: true
        campaign_goal_value:
          type: number
          format: float
          readOnly: true
        campaign_merit_pixel_id:
          type:
          - integer
          - 'null'
          readOnly: true
        viewability:
          type: object
          readOnly: true
          properties:
            sample_rate:
              type: number
              format: float
              readOnly: true
            type:
              type: string
              readOnly: true
              example: AUTO_TAG
            vendor_id:
              type: integer
              readOnly: true
    strategy_concepts_extended:
      type: object
      properties:
        weighting:
          type: string
          enum:
          - NONE
          - BUDGET
          - IMPRESSION
        creative_groups:
          type: array
          items:
            type: object
            additionalProperties: false
            properties:
              concept_id:
                type: integer
                format: int32
                example: 24
              percent:
                type: number
                format: float
                description: Sum of all percents provided inside group must be equal to 100
                minimum: 0
                maximum: 100
              name:
                type: string
                maxLength: 128
                description: available only when extended
                readOnly: true
              status:
                type: boolean
                description: available only when extended
                readOnly: true
              created_on:
                type:
                - string
                - 'null'
                format: date-time
                description: available only when extended
                readOnly: true
              start_date:
                type:
                - string
                - 'null'
                format: date-time
                description: available only when extended
                readOnly: true
              assigned_creatives_count:
                type: integer
                minimum: 0
                description: available only when extended
                readOnly: true
            required:
            - concept_id
            - percent
    strategy_details:
      type: object
      properties:
        name:
          type: string
          maxLength: 128
        description:
          type: string
          maxLength: 1024
        status:
          type: boolean
        archived:
  

# --- truncated at 32 KB (84 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/mediamath/refs/heads/main/openapi/mediamath-strategies-api-openapi.yml