Affise Admin Stats API

openapi: 3.2.0
info:
  title: Documentation Admin Stats 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: admin-stats
  x-displayName: Statistics
  description: Statistics endpoints available to admin (includes admin-only and multi-role)
paths:
  /3.0/stats/custom:
    get:
      tags:
      - admin-stats
      summary: Custom statistics
      description: '`GET /3.0/stats/custom`


        Get custom statistics

        '
      parameters:
      - name: api-key
        in: header
        description: API key
        example: 23df424b0a53b0899f78685966243ee61
        required: true
        schema:
          type: string
      - name: slice[]
        in: query
        description: Custom stats slice
        required: true
        schema:
          type: array
          items:
            type: string
            enum:
            - hour
            - month
            - quarter
            - year
            - day
            - offer
            - country
            - city
            - os
            - os_version
            - device
            - device_model
            - browser
            - goal
            - sub1
            - sub2
            - sub3
            - sub4
            - sub5
            - advertiser
            - affiliate
            - manager
            - smart_id
            - trafficback_reason
      - name: filter[date_from]
        in: query
        description: Date from
        required: true
        schema:
          type: string
          format: date
      - name: filter[date_to]
        in: query
        description: Date to
        required: true
        schema:
          type: string
          format: date
      - name: filter[currency]
        in: query
        description: The list of a currencies code
        schema:
          type: array
          items:
            type: string
      - name: filter[advertiser]
        in: query
        description: Advertiser IDs
        schema:
          oneOf:
          - type: string
          - type: array
            items:
              type: string
      - name: filter[offer]
        in: query
        description: Offers IDs
        schema:
          type: array
          items:
            type: integer
      - name: filter[manager]
        in: query
        description: Managers IDs
        schema:
          oneOf:
          - type: string
          - type: array
            items:
              type: string
      - name: filter[advertiser_manager_id]
        in: query
        description: Advertiser managers IDs
        schema:
          oneOf:
          - type: string
          - type: array
            items:
              type: string
      - name: filter[partner]
        in: query
        description: ONLY FOR ADMIN - Partners IDs
        schema:
          oneOf:
          - type: string
          - type: array
            items:
              type: string
      - name: filter[country]
        in: query
        description: Countries codes. Example US
        schema:
          oneOf:
          - type: string
          - type: array
            items:
              type: string
      - name: filter[os]
        in: query
        description: Os
        schema:
          oneOf:
          - type: string
          - type: array
            items:
              type: string
      - name: filter[goal]
        in: query
        description: Goal
        schema:
          oneOf:
          - type: string
          - type: array
            items:
              type: string
      - name: filter[sub1]
        in: query
        description: Sub number 1
        schema:
          oneOf:
          - type: string
          - type: array
            items:
              type: string
      - name: filter[sub2]
        in: query
        description: Sub number 2
        schema:
          oneOf:
          - type: string
          - type: array
            items:
              type: string
      - name: filter[sub3]
        in: query
        description: Sub number 3
        schema:
          oneOf:
          - type: string
          - type: array
            items:
              type: string
      - name: filter[sub4]
        in: query
        description: Sub number 4
        schema:
          oneOf:
          - type: string
          - type: array
            items:
              type: string
      - name: filter[sub5]
        in: query
        description: Sub number 5
        schema:
          oneOf:
          - type: string
          - type: array
            items:
              type: string
      - name: filter[sub6]
        in: query
        description: Sub number 6
        schema:
          oneOf:
          - type: string
          - type: array
            items:
              type: string
      - name: filter[sub7]
        in: query
        description: Sub number 7
        schema:
          oneOf:
          - type: string
          - type: array
            items:
              type: string
      - name: filter[sub8]
        in: query
        description: Sub number 8
        schema:
          oneOf:
          - type: string
          - type: array
            items:
              type: string
      - name: filter[device]
        in: query
        description: Device
        schema:
          oneOf:
          - type: string
          - type: array
            items:
              type: string
      - name: filter[smart_id]
        in: query
        description: Allowed only when the smart slice selected - SmartLink categories IDs
        schema:
          oneOf:
          - type: string
          - type: array
            items:
              type: string
      - name: filter[nonzero]
        in: query
        description: Non-zero conversions
        schema:
          type: integer
          enum:
          - 0
          - 1
      - name: filter[advertiser_tag]
        in: query
        description: Comma separated array of strings. Example tag1,tag2,tag3
        schema:
          type: string
      - name: filter[affiliate_tag]
        in: query
        description: Comma separated array of strings. Example tag1,tag2,tag3
        schema:
          type: string
      - name: filter[offer_tag]
        in: query
        description: Comma separated array of strings. Example tag1,tag2,tag3
        schema:
          type: string
      - name: not_offer_id
        in: query
        description: ONLY FOR ADMIN — Offer IDs to exclude from results
        schema:
          type: array
          items:
            type: integer
      - name: not_advertiser_id
        in: query
        description: ONLY FOR ADMIN — Advertiser IDs to exclude from results
        schema:
          type: array
          items:
            type: string
      - name: not_affiliate_id
        in: query
        description: ONLY FOR ADMIN — Partner (affiliate) IDs to exclude from results
        schema:
          type: array
          items:
            type: integer
      - name: not_advertiser_manager_id
        in: query
        description: ONLY FOR ADMIN — Advertiser manager IDs to exclude from results
        schema:
          type: array
          items:
            type: string
      - name: not_affiliate_manager_id
        in: query
        description: ONLY FOR ADMIN — Affiliate manager IDs to exclude from results
        schema:
          type: array
          items:
            type: string
      - name: not_smartlink_id
        in: query
        description: ONLY FOR ADMIN — SmartLink category IDs to exclude from results
        schema:
          type: array
          items:
            type: string
      - name: not_country
        in: query
        description: 'ONLY FOR ADMIN — Country codes to exclude from results. Example: US'
        schema:
          type: array
          items:
            type: string
      - name: not_advertiser_tag
        in: query
        description: 'ONLY FOR ADMIN — Comma-separated advertiser tags to exclude. Example: tag1,tag2'
        schema:
          type: string
      - name: not_affiliate_tag
        in: query
        description: 'ONLY FOR ADMIN — Comma-separated affiliate tags to exclude. Example: tag1,tag2'
        schema:
          type: string
      - name: not_offer_tag
        in: query
        description: 'ONLY FOR ADMIN — Comma-separated offer tags to exclude. Example: tag1,tag2'
        schema:
          type: string
      - name: filter[payment_status]
        in: query
        description: Conversion payment status
        schema:
          type: string
          enum:
          - opened
          - closed
          - pending
      - name: locale
        in: query
        description: Locale for output a cities data when you use the city slice
        schema:
          type: string
          enum:
          - ru
          - en
          - es
          default: en
      - name: conversionTypes[]
        in: query
        description: Only this conversion types will be output
        schema:
          type: array
          items:
            type: string
            enum:
            - total
            - confirmed
            - pending
            - declined
            - hold
      - name: page
        in: query
        description: Page of stat entities
        schema:
          type: integer
          default: 1
      - name: limit
        in: query
        description: Limit of stat entities
        schema:
          type: integer
          maximum: 500
          default: 100
      - name: orderType
        in: query
        description: Sorting order
        schema:
          type: string
          enum:
          - asc
          - desc
          default: asc
      - name: order[]
        in: query
        description: Sort by field
        schema:
          type: array
          items:
            type: string
            enum:
            - hour
            - month
            - quarter
            - year
            - day
            - currency
            - offer
            - country
            - city
            - os
            - os_version
            - device
            - device_model
            - browser
            - goal
            - sub1
            - sub2
            - sub3
            - sub4
            - sub5
            - confirmed_earning
            - raw
            - uniq
            - total_count
            - total_revenue
            - total_null
            - pending_count
            - pending_revenue
            - declined_count
            - declined_revenue
            - hold_count
            - hold_revenue
            - confirmed_count
            - confirmed_revenue
            - advertiser
            - affiliate
            - manager
      - name: timezone
        in: query
        description: Timezone name. Example Europe/Berlin
        schema:
          type: string
      - name: fields[]
        in: query
        description: Custom stats fields
        schema:
          type: array
          items:
            type: string
            enum:
            - clicks
            - hosts
            - earnings
            - income
            - noincome
            - payouts
            - conversions
            - cr
            - affiliate_epc
            - ratio
            - epc
            - trafficback
            - ctr
            - views
            - ecpm
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                  stats:
                    type: array
                    items:
                      type: object
                      properties:
                        slice:
                          type: object
                          additionalProperties: true
                        traffic:
                          type: object
                          properties:
                            raw:
                              type: string
                            uniq:
                              type: string
                        actions:
                          type: object
                          additionalProperties:
                            type: object
                            properties:
                              revenue:
                                type: number
                              charge:
                                type: number
                              earning:
                                type: number
                              'null':
                                type: integer
                              count:
                                type: integer
                  pagination:
                    type: object
                    properties:
                      per_page:
                        type: integer
                      total_count:
                        type: integer
                      page:
                        type: integer
              example:
                status: 1
                stats:
                - slice:
                    year: 2017
                    month: 3
                    day: 1
                  traffic:
                    raw: '1607530'
                    uniq: '1468939'
                  actions:
                    total:
                      revenue: 1252
                      charge: 1352.52
                      earning: 100.52
                      'null': 825
                      count: 1092
                    confirmed:
                      revenue: 1252
                      charge: 1352.52
                      earning: 100.52
                      'null': 728
                      count: 995
                    pending:
                      revenue: 0
                      charge: 0
                      earning: 0
                      'null': 0
                      count: 0
                    declined:
                      revenue: 0
                      charge: 0
                      earning: 0
                      'null': 0
                      count: 0
                    hold:
                      revenue: 0
                      charge: 0
                      earning: 0
                      'null': 97
                      count: 97
                pagination:
                  per_page: 100
                  total_count: 1
                  page: 1
        '400':
          $ref: '#/components/responses/BadRequest'
        '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/stats/custom?slice[0]=hour&filter[date_from]=<filter[date_from]>&filter[date_to]=<filter[date_to]>&filter[currency][0]=string&filter[currency][1]=string2&filter[offer][0]=0&filter[offer][1]=1&filter[nonzero]=0&not_offer_id[0]=0&not_offer_id[1]=1&not_advertiser_id[0]=string&not_advertiser_id[1]=string2&not_affiliate_id[0]=0&not_affiliate_id[1]=1&not_advertiser_manager_id[0]=string&not_advertiser_manager_id[1]=string2&not_affiliate_manager_id[0]=string&not_affiliate_manager_id[1]=string2&not_smartlink_id[0]=string&not_smartlink_id[1]=string2&not_country[0]=string&not_country[1]=string2&filter[payment_status]=opened&locale=en&conversionTypes[0]=total&page=1&limit=100&orderType=asc&order[0]=hour&fields[0]=clicks' \\\n  --header 'api-key: 23df424b0a53b0899f78685966243ee61'"
  /3.0/stats/conversionsbyid:
    get:
      tags:
      - admin-stats
      summary: Conversion
      description: '`GET /3.0/stats/conversionsbyid`


        Get conversions

        Available only for admin API-Key

        '
      parameters:
      - name: api-key
        in: header
        description: API key
        example: 23df424b0a53b0899f78685966243ee61
        required: true
        schema:
          type: string
      - name: id
        in: query
        description: Conversion ID
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                  conversion:
                    type: object
                    properties:
                      id:
                        type: string
                      action_id:
                        type: string
                      status:
                        type: integer
                      conversion_id:
                        type: string
                      cbid:
                        type: string
                      currency:
                        type: string
                      offer:
                        type: object
                        properties:
                          id:
                            type: integer
                          title:
                            type: string
                          offer_id:
                            type: string
                          url:
                            type: string
                      offer_id:
                        type: integer
                      goal:
                        type: string
                      hold_date_expire:
                        type: string
                        nullable: true
                      ip:
                        type: string
                      country:
                        type: string
                      country_name:
                        type: string
                      district:
                        type: string
                        nullable: true
                      city:
                        type: string
                      city_id:
                        type: integer
                      isp_code:
                        type: string
                      ua:
                        type: string
                      browser:
                        type: string
                      os:
                        type: string
                      device:
                        type: string
                      device_type:
                        type: string
                      sub1:
                        type: string
                        nullable: true
                      sub2:
                        type: string
                        nullable: true
                      sub3:
                        type: string
                        nullable: true
                      sub4:
                        type: string
                        nullable: true
                      sub5:
                        type: string
                        nullable: true
                      sub6:
                        type: string
                        nullable: true
                      sub7:
                        type: string
                        nullable: true
                      sub8:
                        type: string
                        nullable: true
                      custom_field_1:
                        type: string
                        nullable: true
                      custom_field_2:
                        type: string
                        nullable: true
                      custom_field_3:
                        type: string
                        nullable: true
                      custom_field_4:
                        type: string
                        nullable: true
                      custom_field_5:
                        type: string
                        nullable: true
                      custom_field_6:
                        type: string
                        nullable: true
                      custom_field_7:
                        type: string
                        nullable: true
                      comment:
                        type: string
                        nullable: true
                      created_at:
                        type: string
                        format: date-time
                      click_time:
                        type: string
                        format: date-time
                      updated_at:
                        type: string
                        format: date-time
                      referrer:
                        type: string
                        nullable: true
                      landing_id:
                        type: string
                        nullable: true
                      prelanding_id:
                        type: string
                        nullable: true
                      currency_id:
                        type: string
                        nullable: true
                      price:
                        type: number
                        nullable: true
                      clickid:
                        type: string
                      partner:
                        type: object
                        properties:
                          id:
                            type: integer
                          email:
                            type: string
                          login:
                            type: string
                          name:
                            type: string
                          manager:
                            type: string
                            nullable: true
                      supplier_id:
                        type: string
                      partner_id:
                        type: integer
                      goal_value:
                        type: string
                      sum:
                        type: number
                      revenue:
                        type: number
                      payouts:
                        type: number
                      earnings:
                        type: number
                      advertiser:
                        type: object
                        properties:
                          id:
                            type: string
                          title:
                            type: string
                      payment_type:
                        type: string
                      payment_status:
                        type: string
                      is_paid:
                        type: string
                      charge:
                        type: number
                      earning:
                        type: number
                      click_id:
                        type: string
                      fraud_risk_level:
                        type: string
                      decline_reason:
                        type: string
                      fraud_type:
                        type: array
                        items:
                          type: string
                      createdAt:
                        type: string
                        format: date-time
                      updatedAt:
                        type: string
                        format: date-time
              example:
                conversion:
                  id: 5bd00d73901fcf20008b4574
                  action_id: 5bd00c641d580e000162cf94
                  status: 1
                  conversion_id: 5bd00d73901fcf20008b4574
                  cbid: 5bd00c641d580e000162cf94
                  currency: USD
                  offer:
                    id: 7
                    title: Test Offer
                    offer_id: 5b59b752f44d940011105103
                    url: http://site.com
                  offer_id: 7
                  goal: ''
                  hold_date_expire: null
                  ip: 172.18.0.1
                  country: ''
                  country_name: ''
                  district: null
                  city: Undefined
                  city_id: 0
                  isp_code: ''
                  ua: Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/69.0.3497.100 Safari/537.36
                  browser: Unknown Unknown
                  os: Linux Unknown
                  device: desktop
                  device_type: desktop
                  sub1: null
                  sub2: null
                  sub3: null
                  sub4: null
                  sub5: null
                  sub6: null
                  sub7: null
                  sub8: null
                  custom_field_1: null
                  custom_field_2: null
                  custom_field_3: null
                  custom_field_4: null
                  custom_field_5: null
                  custom_field_6: null
                  custom_field_7: null
                  comment: null
                  created_at: '2018-10-22 09:13:07'
                  click_time: '2018-10-22 09:08:36'
                  updated_at: '2018-10-22 09:13:07'
                  referrer: null
                  landing_id: null
                  prelanding_id: null
                  currency_id: null
                  price: null
                  clickid: 5bd00c641d580e000162cf94
                  partner:
                    id: 2
                    email: emailtest@yahoo.com
                    login: Yvette Michael
                    name: Yvette Michael
                    manager: null
                  supplier_id: 5b5f415035752723008b456a
                  partner_id: 2
                  goal_value: '1'
                  sum: 0
                  revenue: 3
                  payouts: 3
                  earnings: 3
                  advertiser:
                    id: 5b5f415035752723008b456a
                    title: Text supplier 2
                  payment_type: fixed
                  payment_status: opened
                  is_paid: '1'
                  charge: 6
                  earning: 3
                  click_id: 5bd00c641d580e000162cf94
                  fraud_risk_level: not_analyzed
                  decline_reason: by_manager
                  fraud_type: []
                  createdAt: '2021-12-31 11:42:09'
                  updatedAt: '2021-12-31 11:42:39'
                status: 1
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
      x-codeSamples:
      - lang: cURL
        label: cURL
        source: "curl --request GET \\\n  --url 'https://api-demo.affise.com/3.0/stats/conversionsbyid?id=<id>' \\\n  --header 'api-key: 23df424b0a53b0899f78685966243ee61'"
  /3.0/stats/conversions:
    get:
      tags:
      - admin-stats
      summary: Conversions
      description: '`GET /3.0/stats/conversions`


        Get conversions

        '
      parameters:
      - name: api-key
        in: header
        description: API key
        example: 23df424b0a53b0899f78685966243ee61
        required: true
        schema:
          type: string
      - name: date_from
        in: query
        description: Date from
        schema:
          type: string
          format: date
      - name: date_to
        in: query
        description: Date to
        schema:
          type: string
          format: date
      - name: update_from_date
        in: query
        description: ONLY FOR ADMIN - Last update date point
        schema:
          type: string
          format: date
      - name: update_from_hour
        in: query
        description: ONLY FOR ADMIN - Last update hour point. Available only when update_from_date and update_to_date filters are used
        schema:
          type: integer
          minimum: 0
          maximum: 23
      - name: update_to_date
        in: query
        description: ONLY FOR ADMIN - End date of last update
        schema:
          type: string
          format: date
      - name: update_to_hour
        in: query
        description: ONLY FOR ADMIN - End hour of last update. Available only when update_from_date and update_to_date filters are used
        schema:
          type: integer
          minimum: 0
          maximum: 23
      - name: status[]
        in: query
        description: Status conversions. 1 = confirmed, 2 = pending, 3 = declined, 5 = hold
        schema:
          type: array
          items:
            type: integer
            enum:
            - 1
            - 2
            - 3
            - 5
      - name: offer[]
        in: query
        description: Offer ID collection
        schema:
          type: array
          items:
            type: integer
      - name: advertiser[]
        in: query
        description: Advertiser ID collection
        schema:
          type: array
          items:
            type: string
      - name: country[]
        in: query
        description: Countries codes. Example US
        schema:
          type: array
          items:
            type: string
      - name: browser
        in: query
        description: Browser
        schema:
          type: string
      - name: action_id
        in: query
        description: Cbid
        schema:
          type: string
      - name: clickid
        in: query
        description: Click ID
        schema:
          type: string
      - name: os
        in: query
        description: Os
        schema:
          type: string
      - name: goal
        in: query
        description: Goal
        schema:
          type: string
      - name: goal_id
        in: query
        description: Goal ID collection
        schema:
          type: array
          items:
            type: integer
      - name: device
        in: query
        description: Device
        schema:
          type: string
          enum:
          - tablet
          - desktop
          - mobile
      - name: payouts
        in: query
        description: Payout for affiliate
        schema:
          type: number
      - name: payouts_from
        in: query
        description: Payout for affiliate must be greater than this value
        schema:
          type: number
      - name: payouts_to
        in: query
        description: Payout for affiliate must be less than this value
        schema:
          type: number
      - name: currency
        in: query
        description: ID currency
        schema:
          type: integer
      - name: hour
        in: query
        description: Hour point - Allows only for one day period
        schema:
          type: integer
          minimum: 0
          maximum: 23
      - name: timezone
        in: query
        description: Timezone name. Example Europe/Berlin
        schema:
          type: string
      - name: custom_field_1
        in: query
        description: Custom field 1
        schema:
          type: string
      - name: custom_field_2
        in: query
        description: Custom field 2


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