Affise Advertiser Offers API

openapi: 3.2.0
info:
  title: Documentation Advertiser Offers API
  version: '3.2'
  x-logo:
    altText: Affise API documentation.
    url: affise_logo.svg
    backgroundColor: '#fafafa'
  description: 'API 3.1 documentation.


    Authorization


    ```shell

    curl --header "API-Key:23df424b0a53b0899f78685966243ee61" http://YOUR_API_DOMAIN/

    or

    curl http://YOUR_API_DOMAIN/some_path?API-Key=23df424b0a53b0899f78685966243ee61

    ```



    For data exchange using authentication public key passed as parameter in the header API-Key. As the key, a hash generated for your site. API key, you can see in your profile.


    Find out more about where you can get your API URL, API-key and personal API-key for Affiliate here - [Getting Started with API](https://help-center.affise.com/en/articles/6463675-start-with-api-networks)


    Postman collection


    A ready-to-use Postman collection covering all endpoints of this documentation is available in the [affise-postman-api-collection](https://github.com/affise/affise-postman-api-collection) repository. Import the collection together with the Demo environment, set your `baseUrl` and API keys in the environment variables, and you are ready to send requests.


    <aside class="warning">

    All API requests must include an API-Key header or API-Key GET parameter for client authentication.

    </aside>

    '
servers:
- url: https://api-demo.affise.com
  description: Demo Server
  variables:
    api-key:
      default: 685168e94e6a96fa7c31895e
      description: Demo Test API Key
tags:
- name: advertiser-offers
  x-displayName: Offers
  description: Advertiser offer listing
paths:
  /3.1/advertiser/offers:
    get:
      tags:
      - advertiser-offers
      summary: Get Advertiser Offers List
      description: '`GET /3.1/advertiser/offers`


        Retrieves a paginated list of offers available to the authenticated advertiser

        '
      parameters:
      - name: Api-Key
        in: header
        description: API key
        required: true
        schema:
          type: string
      - name: search
        in: query
        description: Search by offer name
        schema:
          type: string
      - name: country
        in: query
        description: Targeting countries in ISO 3166-1 format. Values IT, BR, AM, RO, etc
        schema:
          type: string
      - name: offer_id
        in: query
        description: Search by offer ID
        schema:
          type: integer
      - name: page
        in: query
        description: Page of offers
        schema:
          type: integer
          default: 1
      - name: limit
        in: query
        description: Number of offers per page
        schema:
          type: integer
          default: 100
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                  offers:
                    type: array
                    items:
                      $ref: '#/components/schemas/offer'
                  pagination:
                    type: object
                    properties:
                      per_page:
                        type: integer
                      total_count:
                        type: integer
                      page:
                        type: integer
              example:
                status: 1
                offers:
                - id: 2
                  title: crypto_offer
                  created_at: '2025-05-05T12:07:38.833Z'
                  description:
                    cn: ''
                    en: ''
                    zh: ''
                  logo: ''
                  status: active
                  kpi:
                    cn: ''
                    en: ''
                    zh: ''
                  preview_url: ''
                  tracking_url: https://google.com
                  payouts:
                  - id: cf1feb96-07a2-4001-aff8-30b5f8017e8b
                    affiliates: []
                    cities: []
                    countries: []
                    include_regions: false
                    exclude_countries: false
                    currency: USD
                    devices: []
                    goal_title: Default
                    goal_value: '1'
                    goal_id: 1
                    oses: []
                    payment_type: fixed
                    total: 25
                    sub1: []
                    sub2: []
                    sub3: []
                    sub4: []
                    sub5: []
                    sub6: []
                    sub7: []
                    sub8: []
                    cf1: []
                    cf2: []
                    cf3: []
                    cf4: []
                    cf5: []
                    cf6: []
                    cf7: []
                    cf8: []
                    cf9: []
                    cf10: []
                    cf11: []
                    cf12: []
                    cf13: []
                    cf14: []
                    cf15: []
                    baseline_value: 0
                  targetings:
                  - id: d731115e-b24c-41e2-9ed5-fcd5e013ca39
                    country: []
                    region: []
                    city: []
                    os: []
                    os_deny: false
                    browser: []
                    brand: []
                    ip: []
                    zip: []
                    isp: []
                    device_type: []
                    device_type_deny: false
                    connection: []
                    connection_deny: false
                    subs: []
                    sub_regexps: []
                    affiliate_id: []
                    urls: null
                    block_proxy_vpn: false
                    macros_replacement: []
                    macros_replacement_enabled: null
                    browser_version: []
                    device_model: []
                    name: ''
                    condition: and
                    enabled: true
                    isp_organization: []
                    referrer: []
                    ua: []
                  creatives: []
                  landings: []
                  categories:
                  - id: 682f23f0bc83255a7a4d454e
                    title: Cat_01
                  - id: 6842d44b38e9409dbeef2cfe
                    title: Khal Drogo
                  traffic_sources:
                  - id: 51f5325e3b7d9b340e8a2b79
                    title: Traffic Source 1
                  - id: 5432ffe43b7d9b615f4f7f2a
                    title: Traffic Source 2
                  - id: 5432fff93b7d9b615fab559d
                    title: Traffic Source 3
                  cr: 33.33
                  epc: 8.3333
                pagination:
                  per_page: 40
                  total_count: 1
                  page: 1
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
      x-codeSamples:
      - lang: cURL
        label: cURL
        source: "curl --request GET \\\n  --url 'https://api-demo.affise.com/3.1/advertiser/offers?page=1&limit=100' \\\n  --header 'Api-Key: <Api-Key>'"
  /3.1/advertiser/offers/{id}:
    get:
      tags:
      - advertiser-offers
      summary: Get Advertiser Offer
      description: '`GET /3.1/advertiser/offers/{id}`


        Retrieves an offer by ID for the authenticated advertiser

        '
      parameters:
      - name: api-key
        in: header
        description: API key
        required: true
        example: 86cf36ea9f74d822c64ebcccc4ee2c09
        schema:
          type: string
      - name: id
        in: path
        description: Offer ID
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                  offer:
                    $ref: '#/components/schemas/offer'
              example:
                status: 1
                offer:
                  id: 2
                  title: crypto_offer
                  created_at: '2025-05-05T12:07:38.833Z'
                  description:
                    cn: ''
                    en: ''
                    es: ''
                    id: ''
                    it: ''
                    ja: ''
                    ka: ''
                    my: ''
                    pt: ''
                    ru: ''
                    ua: ''
                    vi: ''
                    zh: ''
                  logo: ''
                  status: 1
                  kpi:
                    cn: ''
                    en: ''
                    es: ''
                    id: ''
                    it: ''
                    ja: ''
                    ka: ''
                    my: ''
                    pt: ''
                    ru: ''
                    ua: ''
                    vi: ''
                    zh: ''
                  preview_url: ''
                  tracking_url: https://google.com
                  payouts:
                  - id: cf1feb96-07a2-4001-aff8-30b5f8017e8b
                    affiliates: []
                    cities: []
                    countries: []
                    include_regions: false
                    exclude_countries: false
                    currency: USD
                    devices: []
                    goal_title: Default
                    goal_value: '1'
                    goal_id: 1
                    oses: []
                    payment_type: fixed
                    total: 25
                    sub1: []
                    sub2: []
                    sub3: []
                    sub4: []
                    sub5: []
                    sub6: []
                    sub7: []
                    sub8: []
                    cf1: []
                    cf2: []
                    cf3: []
                    cf4: []
                    cf5: []
                    cf6: []
                    cf7: []
                    cf8: []
                    cf9: []
                    cf10: []
                    cf11: []
                    cf12: []
                    cf13: []
                    cf14: []
                    cf15: []
                    baseline_value: 0
                  targetings:
                  - id: d731115e-b24c-41e2-9ed5-fcd5e013ca39
                    country: []
                    region: []
                    city: []
                    os: []
                    os_deny: false
                    browser: []
                    brand: []
                    ip: []
                    zip: []
                    isp: []
                    device_type: []
                    device_type_deny: false
                    connection: []
                    connection_deny: false
                    subs: []
                    sub_regexps: []
                    affiliate_id: []
                    urls: null
                    block_proxy_vpn: false
                    macros_replacement: []
                    macros_replacement_enabled: null
                    browser_version: []
                    device_model: []
                    name: ''
                    condition: and
                    enabled: true
                    isp_organization: []
                    referrer: []
                    ua: []
                  creatives: []
                  landings: []
                  categories:
                  - id: 682f23f0bc83255a7a4d454e
                    title: Cat_01
                  - id: 682f23f6bc83255a7a4d454f
                    title: Cat_02
                  traffic_sources: null
                  cr: 33.33
                  epc: 8.3333
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
      x-codeSamples:
      - lang: cURL
        label: cURL
        source: "curl --request GET \\\n  --url 'https://api-demo.affise.com/3.1/advertiser/offers/{id}' \\\n  --header 'api-key: 86cf36ea9f74d822c64ebcccc4ee2c09'"
  /3.0/offers:
    get:
      tags:
      - advertiser-offers
      summary: Offers list
      description: '`GET /3.0/offers`


        Get a list of offers

        '
      parameters:
      - name: api-key
        in: header
        description: API key
        example: 23df424b0a53b0899f78685966243ee61
        required: true
        schema:
          type: string
      - name: q
        in: query
        description: Search by title and id
        schema:
          type: string
      - name: int_id
        in: query
        description: Search by one or more offer IDs
        schema:
          type: array
          items:
            type: integer
          example:
            int_id[0]: 234
      - name: countries
        in: query
        description: Array of offers countries (ISO)
        schema:
          type: array
          items:
            type: string
          example:
            countries[0]: US
      - name: os
        in: query
        description: OS
        schema:
          type: array
          items:
            type: string
            enum:
            - Windows
            - webOS
            - macOS
            - iPadOS
            - iOS
            - Android
            example: null
            os[0]: Windows
      - name: categories
        in: query
        description: Array of offers categories
        schema:
          type: array
          items:
            type: string
          example:
            categories[0]: 5368afb23b7d9b4d5d505342
      - name: caps_type
        in: query
        description: Caps type. Values clicks, conversions, budget, impressions. This filter will not show offers for the selected cap type if the cap is full
        schema:
          type: string
          enum:
          - clicks
          - conversions
          - budget
          - impressions
      - name: caps_country
        in: query
        description: Caps country in ISO 3166-1 format
        schema:
          type: string
      - name: sort
        in: query
        description: Sort offers. Sample sort[id]=asc, sort[title]=desc. You can sort offers by one of (id, title, cr, epc, is_top, created, revenue, daily_cap, total_cap)
        schema:
          type: array
          items:
            type: string
          example:
            sort[id]: asc
      - name: page
        in: query
        description: Page of offers
        schema:
          type: integer
      - name: limit
        in: query
        description: Count offers by page
        schema:
          type: integer
          maximum: 500
          default: 100
      - name: status
        in: query
        description: Statuses stopped and suspended ONLY FOR ADMIN. Status active allowed for NON ADMIN
        schema:
          type: array
          items:
            type: string
            enum:
            - active
            - stopped
            - suspended
          example:
            status[0]: active
          default:
          - active
      - name: advertiser
        in: query
        description: ONLY FOR ADMIN - Advertiser ID
        schema:
          type: array
          items:
            type: string
          example:
            advertiser[0]: 55b204663b7d9b460b8b45b2
      - name: privacy
        in: query
        description: ONLY FOR ADMIN - Privacy filter Public(0), Premoderated(1), Private(2)
        schema:
          type: array
          items:
            type: integer
            enum:
            - 0
            - 1
            - 2
      - name: updated_at
        in: query
        description: Get offers that have been updated from this date (format YYYY-MM-DD)
        schema:
          type: string
          format: date
      - name: is_top
        in: query
        description: Get TOP-offers
        schema:
          type: integer
          enum:
          - 0
          - 1
      - name: bundle_id
        in: query
        description: ONLY FOR ADMIN - Search by bundle id
        schema:
          type: string
      - name: smartlink_categories
        in: query
        description: Array of smartlinks IDs
        schema:
          type: array
          items:
            type: string
          example:
            smartlink_categories[0]: 55b204663b7d9b460b8b45b2
      - name: advertiser_manager_id
        in: query
        description: ONLY FOR ADMIN - Array of advertiser managers IDs
        schema:
          type: array
          items:
            type: string
          example:
            advertiser_manager_id[0]: 55b204663b7d9b460b8b45b2
      - name: external_offer_id
        in: query
        description: External offer id
        schema:
          type: string
      - name: additional_fields
        in: query
        description: ONLY FOR ADMIN - Sample additional_fields=enabled_affiliates
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/offer'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
      x-codeSamples:
      - lang: cURL
        label: cURL
        source: "curl --request GET \\\n  --url 'https://api-demo.affise.com/3.0/offers?int_id[0]=234&countries[0]=US&os[0]=&categories[0]=5368afb23b7d9b4d5d505342&caps_type=clicks&sort[id]=asc&limit=100&status[0]=active&advertiser[0]=55b204663b7d9b460b8b45b2&privacy[0]=0&is_top=0&smartlink_categories[0]=55b204663b7d9b460b8b45b2&advertiser_manager_id[0]=55b204663b7d9b460b8b45b2' \\\n  --header 'api-key: 23df424b0a53b0899f78685966243ee61'"
  /3.0/offer/{id}:
    get:
      tags:
      - advertiser-offers
      summary: Offer by id
      description: '`GET /3.0/offer/{id}`


        Get full information of an offer

        '
      parameters:
      - name: api-key
        in: header
        description: API key
        example: 23df424b0a53b0899f78685966243ee61
        required: true
        schema:
          type: string
      - name: id
        in: path
        description: Offer ID
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/offer_affiliate'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
      x-codeSamples:
      - lang: cURL
        label: cURL
        source: "curl --request GET \\\n  --url 'https://api-demo.affise.com/3.0/offer/{id}' \\\n  --header 'api-key: 23df424b0a53b0899f78685966243ee61'"
  /3.0/offer/categories:
    get:
      tags:
      - advertiser-offers
      summary: Categories
      description: '`GET /3.0/offer/categories`


        List of a categories

        '
      parameters:
      - name: api-key
        in: header
        description: API key
        example: 23df424b0a53b0899f78685966243ee61
        required: true
        schema:
          type: string
      - name: ids
        in: query
        description: Search by IDs
        schema:
          type: array
          items:
            type: string
      - name: page
        in: query
        description: Page of entities
        schema:
          type: integer
      - name: limit
        in: query
        description: Limit of entities
        schema:
          type: integer
          maximum: 99999
          default: 99999
      - name: orderType
        in: query
        description: Order type
        schema:
          type: string
          enum:
          - asc
          - desc
          default: asc
      - name: order
        in: query
        description: Order by field
        schema:
          type: string
          enum:
          - id
          - title
          default: id
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                  categories:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        title:
                          type: string
                  pagination:
                    type: object
                    properties:
                      per_page:
                        type: integer
                      total_count:
                        type: integer
                      page:
                        type: integer
                      next_page:
                        type: integer
              example:
                status: 1
                categories:
                - id: 5368a3973b7d9b4d5d59f1ca
                  title: '...'
                pagination:
                  per_page: 1
                  total_count: 11
                  page: 1
                  next_page: 2
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
      x-codeSamples:
      - lang: cURL
        label: cURL
        source: "curl --request GET \\\n  --url 'https://api-demo.affise.com/3.0/offer/categories?ids[0]=string&ids[1]=string2&limit=99999&orderType=asc&order=id' \\\n  --header 'api-key: 23df424b0a53b0899f78685966243ee61'"
components:
  schemas:
    targeting_browser_version_structure:
      type: object
      description: Browser version structure for targeting
      properties:
        name:
          type: string
          description: Browser's name.
        comparison:
          type: string
          enum:
          - LT
          - LTE
          - EQ
          - GT
          - GTE
          description: Comparison operation for browser's version.
        version:
          type: string
          description: Browser's version for comparison.
    targeting_os_structure:
      type: object
      description: OS structure for targeting
      properties:
        name:
          type: string
          description: OS name that could be found at OSes list method.
        comparison:
          type: string
          enum:
          - LT
          - LTE
          - EQ
          - GT
          - GTE
          description: Comparison operation for OS version.
        version:
          type: string
          description: OS version for comparison.
    offer_affiliate:
      type: object
      properties:
        id:
          type: integer
        offer_id:
          type: string
        bundle_id:
          type: string
        title:
          type: string
        preview_url:
          type: string
        description_lang:
          type: object
          additionalProperties:
            type: string
        cr:
          type: number
        epc:
          type: number
        logo:
          type: string
        logo_source:
          type: string
        stop_at:
          type: string
        sources:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              title:
                type: string
              allowed:
                type: integer
        categories:
          type: array
          items:
            type: string
        full_categories:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              title:
                type: string
        payments:
          type: array
          items:
            type: object
            properties:
              countries:
                type: array
                items:
                  type: string
              cities:
                type: array
                items: {}
              devices:
                type: array
                items: {}
              os:
                type: array
                items: {}
              goal:
                type: string
              revenue:
                type: number
              currency:
                type: string
              title:
                type: string
              type:
                type: string
              country_exclude:
                type: boolean
        caps:
          type: array
          items:
            type: object
            properties:
              goals:
                type: object
              period:
                type: string
              type:
                type: string
              value:
                type: integer
              goal_type:
                type: string
              country_type:
                type: string
              country:
                type: array
                items: {}
        caps_status:
          type: array
          items: {}
        required_approval:
          type: boolean
        is_cpi:
          type: boolean
        creatives:
          type: array
          items: {}
        creatives_zip:
          type: string
          nullable: true
        impressions_link:
          type: string
          nullable: true
        landings:
          type: array
          items: {}
        links:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                nullable: true
              title:
                type: string
                nullable: true
              hash:
                type: string
                nullable: true
              url:
                type: string
              postbacks:
                type: array
                items: {}
              created:
                type: string
                nullable: true
        macro_url:
          type: string
          nullable: true
        link:
          type: string
        use_https:
          type: boolean
        use_http:
          type: boolean
        hold_period:
          type: integer
        kpi:
          type: object
          properties:
            en:
              type: string
        click_session:
          type: string
        minimal_click_session:
          type: string
        targeting:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
              condition:
                type: string
              country:
                type: object
                properties:
                  allow:
                    type: array
                    items: {}
                  deny:
                    type: array
                    items: {}
              region:
                type: object
                properties:
                  allow:
                    type: array
                    items: {}
                  deny:
                    type: array
                    items: {}
              city:
                type: object
                properties:
                  allow:
                    type: array
                    items: {}
                  deny:
                    type: array
                    items: {}
              os:
                type: object
                properties:
                  allow:
                    type: array
                    items: {}
                  deny:
                    type: array
                    items: {}
              os_deny:
                type: boolean
              isp:
                type: object
                properties:
                  allow:
                    type: array
                    items: {}
                  deny:
                    type: array
                    items: {}
              isp_organization:
                type: object
                properties:
                  allow:
                    type: array
                    items: {}
                  deny:
                    type: array
                    items: {}
                  deny_empty:
                    type: boolean
              ip:
                type: object
                properties:
                  allow:
                    type: array
                    items: {}
                  deny:
                    type: array
                    items: {}
                  ipv6_deny:
                    type: boolean
              browser:
                type: object
                properties:
                  allow:
                    type: array
                    items: {}
                  deny:
                    type: array
                    items: {}
              browser_version:
                type: object
                properties:
                  allow:
                    type: array
                    items: {}
                  deny:
                    type: array
                    items: {}
              brand:
                type: object
                properties:
                  allow:
                    type: array
                    items: {}
                  deny:
                    type: array
                    items: {}
              device_type:
                type: array
                items: {}
              device_type_deny:
                type: boolean
              device_model:
                type: object
                properties:
                  allow:
                    type: array
                    items: {}
                  deny:
                    type: array
                    items: {}
              connection:
                type: array
                items: {}
              connection_deny:
                type: boolean
              referrer:
                type: object
                properties:
                  allow:
                    type: array
                    items: {}
                  deny:
                    type: array
                    items: {}
                  deny_empty:
                    type: boolean
              ua:
                type: object
                properties:
                  allow:
                    type: array
                    items: {}
                  deny:
                    type: array
                    items: {}
                  deny_crawlers:
                    type: boolean
              id:
                type: string
                format: uuid
              block_proxy:
                type: boolean
        commission_tiers:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                format: uuid
              goals:
                type: array
                items: {}
              timeframe:
                type: string
              type:
                type: string
              value:
                type: integer
              target_goals:
                type: array
                items: {}
              modifier_type:
                type: string
              modifier_value:
                type: number
              countries:
                type: array
                items: {}
              conversion_status:
                type: array
                items:
                  type: string
              modifier_payment_type:
                type: string
        enabled_commission_tiers:
          type: boolean
        consider_personal_targeting_only:
          type: boolean
        hosts_only:
          type: boolean
        uniq_ip_only:
          type: boolean
        reject_not_uniq_ip:
          type: integer
        sign_clicks_integration:
          type: string
          descripti

# --- truncated at 32 KB (57 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/affise/refs/heads/main/openapi/affise-advertiser-offers-api-openapi.yml