initial

references/schemas/AffiliateNetwork.yaml

@@ -0,0 +1,28 @@
+type: object
+properties:
+  id:
+    type: integer
+  name:
+    type: string
+  postback_url:
+    type: string
+  offer_param:
+    type: string
+  state:
+    type: string
+    default: active
+    enum:
+      - active
+      - deleted
+  template_name:
+    type: string
+  notes:
+    type: string
+  pull_api_options:
+    type: string
+  created_at:
+    type: string
+  updated_at:
+    type: string
+  offers:
+    type: integer

references/schemas/AffiliateNetworkObject.yaml

@@ -0,0 +1,16 @@
+type: object
+properties:
+  name:
+    description: Affiliate network name
+    type: string
+  postback_url:
+    description: Postback URL for the Affiliate network
+    type: string
+  offer_param:
+    description: >-
+      These params are appends to offer URLs. Example,
+      "sub1={subid}&sub2={campaign_name}"
+    type: string
+  notes:
+    description: User Notes for the Affiliate network
+    type: string

references/schemas/AffiliateNetworkPut.yaml

@@ -0,0 +1,2 @@
+type: object
+$ref: ../schemas/AffiliateNetworkObject.yaml

references/schemas/AffiliateNetworkRequest.yaml

@@ -0,0 +1,5 @@
+allOf:
+  - $ref: ../schemas/AffiliateNetworkObject.yaml
+  - type: object
+    required:
+      - name

references/schemas/BotListRequest.yaml

@@ -0,0 +1,9 @@
+type: object
+properties:
+  value:
+    description: |-
+      List of IPs. Example, 1.2.3.4
+      2.3.4.5
+    type: string
+required:
+  - value

references/schemas/Campaign.yaml

@@ -0,0 +1,76 @@
+type: object
+properties:
+  id:
+    type: integer
+  alias:
+    type: string
+    description: Leave empty to generate automatically.
+  type:
+    type: string
+    enum:
+      - position
+      - weight
+    default: position
+    description: Set 'weight' to enable split-testing the flows.
+  name:
+    type: string
+  cookies_ttl:
+    type: integer
+    default: 24
+  position:
+    type: integer
+  state:
+    type: string
+    default: active
+    enum:
+      - active
+      - disabled
+      - deleted
+  cost_type:
+    type: string
+    default: CPC
+    enum:
+      - CPM
+      - CPC
+      - CPUC
+      - RevShare
+      - CPA
+      - CPS
+      - CPUV
+      - CPV
+  cost_value:
+    type: number
+    default: 0
+  cost_currency:
+    type: string
+    description: Leave empty to use tracker currency
+  group_id:
+    type: integer
+  bind_visitors:
+    type: string
+    enum:
+      - s
+      - sl
+      - slo
+    description: >-
+      's' for flows. 'sl' for flows and landing pages. 'slo' for flows, landing
+      pages and offers.
+  traffic_source_id:
+    type: integer
+  token:
+    type: string
+  cost_auto:
+    type: boolean
+    default: false
+  parameters:
+    $ref: ../schemas/SourceParameters.yaml
+  postbacks:
+    type: array
+    items:
+      $ref: ../schemas/S2SPostback.yaml
+  notes:
+    type: string
+  created_at:
+    type: string
+  updated_at:
+    type: string

references/schemas/CampaignCostRequest.yaml

@@ -0,0 +1,28 @@
+type: object
+properties:
+  start_date:
+    description: Start date and time. For example, "2017-09-10 20:10"
+    type: string
+  end_date:
+    description: End date and time. For example, "2017-09-10 20:10"
+    type: string
+  timezone:
+    description: Timezone for the time range. For example, "Europe/Madrid".
+    type: string
+  cost:
+    description: Cost for the time range. For example, "19.22".
+    type: string
+  currency:
+    description: Currency of cost. For example "EUR".
+    type: string
+  only_campaign_uniques:
+    description: Apply new costs to unique clicks only.
+    type: boolean
+  filters:
+    $ref: ../schemas/FilterCostRequest.yaml
+required:
+  - start_date
+  - end_date
+  - timezone
+  - cost
+  - currency

references/schemas/CampaignCreateRequired.yaml

@@ -0,0 +1,3 @@
+required:
+  - alias
+  - name

references/schemas/CampaignRequest.yaml

@@ -0,0 +1,74 @@
+type: object
+properties:
+  alias:
+    description: Campaign Alias which is Used in URL http://domain.com/ALIAS
+    type: string
+  type:
+    description: Flow  Rotation Type
+    type: string
+    default: position
+    enum:
+      - position
+      - weight
+  name:
+    description: Campaign Name
+    type: string
+  cookies_ttl:
+    description: When the Click Gets Unique Status Again, in Hours
+    type: integer
+    default: 24
+  state:
+    type: string
+    enum:
+      - active
+      - disabled
+      - deleted
+    description: Campaign State
+    default: active
+  cost_type:
+    description: Cost Type
+    type: string
+    default: CPC
+    enum:
+      - CPC
+      - CPUC
+      - CPM
+  cost_value:
+    description: Cost Value
+    type: number
+  cost_currency:
+    description: >-
+      Currency Value EUR/USD/RUB/UAH/GBP. Default Value is Taken from the
+      Tracker's Settings.
+    type: string
+  cost_auto:
+    description: Enable Automatic Costs (0/1)
+    type: boolean
+    default: false
+  group_id:
+    description: Campaign Group ID
+    type: string
+  bind_visitors:
+    description: >-
+      Bind Visitors Feature (null - disabled/ s - only to streams/ sl - to
+      streams and LPs/ slo — to streams, LPs and offers)
+    type: string
+  traffic_source_id:
+    description: Traffic source ID
+    type: integer
+  parameters:
+    $ref: ../schemas/SourceParameters.yaml
+  token:
+    description: Token to gain access to Click API
+    type: string
+  domain_id:
+    description: Domain ID
+    type: integer
+  postbacks:
+    description: Campaign S2S postback
+    type: array
+    items:
+      $ref: ../schemas/S2SPostback.yaml
+  notes:
+    description: Notes for the campaign
+    type: string

references/schemas/CleanRequest.yaml

@@ -0,0 +1,17 @@
+type: object
+required:
+  - start_date
+  - end_date
+properties:
+  start_date:
+    description: The date and the time for the period to delete, e.g. 2017-04-01 10:10
+    type: string
+  end_date:
+    description: The date and the time for the period to delete, e.g. 2017-04-01 10:10
+    type: string
+  campaign_id:
+    description: Campaign ID
+    type: integer
+  timezone:
+    description: Timezone for the dates, e.g., "UTC" or "Europe/Madrid"
+    type: string

references/schemas/ClickRequest.yaml

@@ -0,0 +1,22 @@
+type: object
+properties:
+  range:
+    $ref: ../schemas/RangeRequest.yaml
+  limit:
+    type: number
+    description: Clicks Request Limit. Either 'limit' or 'range' Parameters are a Must.
+  offset:
+    type: number
+    description: Offset rows
+  columns:
+    type: array
+    items:
+      type: string
+  filters:
+    type: array
+    items:
+      $ref: ../schemas/FilterRequest.yaml
+  sort:
+    type: array
+    items:
+      $ref: ../schemas/SortRequest.yaml

references/schemas/ClicksUpdateCostsPayload.yaml

@@ -0,0 +1,19 @@
+type: object
+properties:
+  start_date:
+    description: Start date and time, e.g., “2017-09-10 20:10”
+    type: string
+  end_date:
+    description: End date and time, e.g., “2017-09-10 20:10”
+    type: string
+  cost:
+    description: Cost value, e.g., 19.22
+    type: number
+  filters:
+    $ref: ../schemas/FilterCostRequest.yaml
+required:
+  - start_date
+  - end_date
+  - timezone
+  - cost
+  - currency

references/schemas/ClicksUpdateCostsRequest.yaml

@@ -0,0 +1,23 @@
+type: object
+properties:
+  campaign_ids:
+    description: Array of campaigns IDs
+    type: array
+    items:
+      type: integer
+  costs:
+    type: array
+    items:
+      $ref: ../schemas/ClicksUpdateCostsPayload.yaml
+  timezone:
+    description: Timezone, e.g., Europe/Madrid
+    type: string
+  currency:
+    description: Currency, e.g., EUR
+    type: string
+  only_campaign_uniques:
+    description: Apply costs only to unique clicks (1 or 0)
+    type: integer
+required:
+  - campaign_ids
+  - costs

references/schemas/ConversionRequest.yaml

@@ -0,0 +1,22 @@
+type: object
+properties:
+  range:
+    $ref: ../schemas/RangeRequest.yaml
+  limit:
+    type: number
+    description: Limit result
+  offset:
+    type: number
+    description: Offset for results
+  columns:
+    type: array
+    items:
+      type: string
+  filters:
+    type: array
+    items:
+      $ref: ../schemas/FilterRequest.yaml
+  sort:
+    type: array
+    items:
+      $ref: ../schemas/SortRequest.yaml

references/schemas/Domain.yaml

@@ -0,0 +1,52 @@
+type: object
+properties:
+  id:
+    type: integer
+    format: int32
+  name:
+    type: string
+  network_status:
+    type: string
+  default_campaign:
+    type: string
+  default_campaign_id:
+    type: integer
+    format: int32
+  state:
+    type: string
+    default: active
+    enum:
+      - active
+      - deleted
+  created_at:
+    type: string
+  updated_at:
+    type: string
+  catch_not_found:
+    type: boolean
+  campaigns_count:
+    type: integer
+    format: int32
+  ssl_redirect:
+    type: boolean
+  allow_indexing:
+    type: boolean
+  admin_dashboard:
+    type: boolean
+  cloudflare_proxy:
+    type: boolean
+  group_id:
+    type: integer
+    format: int32
+  group:
+    type: string
+  is_ssl:
+    type: boolean
+  dns_provider:
+    type: string
+  error_solution:
+    type: string
+  status:
+    type: string
+  notes:
+    type: string

references/schemas/DomainCreateRequired.yaml

@@ -0,0 +1,2 @@
+required:
+  - name

references/schemas/DomainRegister.yaml

@@ -0,0 +1,7 @@
+type: object
+properties:
+  registrar:
+    type: string
+  external_id:
+    type: integer
+    format: int32

references/schemas/DomainRequest.yaml

@@ -0,0 +1,30 @@
+type: object
+properties:
+  name:
+    description: Domain name
+    type: string
+  default_campaign_id:
+    description: Run campaign on the domain
+    type: integer
+  group_id:
+    description: Group ID
+    type: string
+  catch_not_found:
+    description: Catch the traffic of non-existent URLs
+    type: boolean
+    default: false
+  notes:
+    description: Notes for the domain
+    type: string
+  ssl_redirect:
+    description: Force browsers to redirect from HTTP to HTTPS
+    type: boolean
+    default: false
+  allow_indexing:
+    description: Allow robots to index the domain content
+    type: boolean
+    default: true
+  admin_dashboard:
+    description: Allow access to admin dashboard
+    type: boolean
+    default: false

references/schemas/EditorFiles.yaml

@@ -0,0 +1,14 @@
+type: object
+properties:
+  name:
+    type: string
+  type:
+    type: string
+  ext:
+    type: string
+  path:
+    type: string
+  children:
+    type: array
+    items:
+      $ref: ../schemas/EditorFiles.yaml

references/schemas/Error.yaml

@@ -0,0 +1,6 @@
+type: object
+required:
+  - error
+properties:
+  error:
+    type: string

references/schemas/Facebook.yaml

@@ -0,0 +1,48 @@
+type: object
+properties:
+  id:
+    description: Intergration ID
+    type: integer
+  integration:
+    description: The integration name
+    type: string
+  proxy_enabled:
+    description: Use proxy
+    type: boolean
+  name:
+    description: The integration name
+    type: string
+  ad_account_id:
+    description: Facebook account ID
+    type: string
+  token:
+    description: Facebook token
+    type: string
+  last_error:
+    description: Last error
+    type: string
+  last_raw_error:
+    description: Error message from facebook
+    type: string
+  proxy:
+    type: object
+    properties:
+      protocol:
+        description: Protocol
+        type: string
+        enum:
+          - http
+          - https
+          - socks5
+      address:
+        description: Proxy address
+        type: string
+      port:
+        description: Proxy port
+        type: integer
+      login:
+        description: Proxy login
+        type: string
+      password:
+        description: Proxy password
+        type: string

references/schemas/FacebookRequest.yaml

@@ -0,0 +1,36 @@
+type: object
+properties:
+  name:
+    description: The integration name
+    type: string
+  ad_account_id:
+    description: Facebook account ID
+    type: string
+  token:
+    description: Facebook yoken
+    type: string
+  proxy_enabled:
+    description: Use proxy to connect
+    type: boolean
+  proxy:
+    type: object
+    properties:
+      protocol:
+        description: Protocol
+        type: string
+        enum:
+          - http
+          - https
+          - socks5
+      address:
+        description: Proxy address
+        type: string
+      port:
+        description: Proxy port
+        type: integer
+      login:
+        description: Proxy login
+        type: string
+      password:
+        description: Proxy password
+        type: string

references/schemas/Filter.yaml

@@ -0,0 +1,14 @@
+type: object
+properties:
+  id:
+    type: integer
+  stream_id:
+    type: integer
+  name:
+    type: string
+  mode:
+    type: string
+  payload:
+    type: string
+  oid:
+    type: string

references/schemas/FilterCostRequest.yaml

@@ -0,0 +1,75 @@
+type: object
+description: >-
+  Send a key-value object to apply filters to clicks. For example, {"sub_id_1":
+  "1,2,3", "source": "site.ru"}.
+properties:
+  keyword:
+    type: string
+  external_id:
+    type: string
+  creative_id:
+    type: string
+  ad_campaign_id:
+    type: string
+  source:
+    type: string
+  sub_id_1:
+    type: string
+  sub_id_2:
+    type: string
+  sub_id_3:
+    type: string
+  sub_id_4:
+    type: string
+  sub_id_5:
+    type: string
+  sub_id_6:
+    type: string
+  sub_id_7:
+    type: string
+  sub_id_8:
+    type: string
+  sub_id_9:
+    type: string
+  sub_id_10:
+    type: string
+  sub_id_11:
+    type: string
+  sub_id_12:
+    type: string
+  sub_id_13:
+    type: string
+  sub_id_14:
+    type: string
+  sub_id_15:
+    type: string
+  sub_id_16:
+    type: string
+  sub_id_17:
+    type: string
+  sub_id_18:
+    type: string
+  sub_id_19:
+    type: string
+  sub_id_20:
+    type: string
+  sub_id_21:
+    type: string
+  sub_id_22:
+    type: string
+  sub_id_23:
+    type: string
+  sub_id_24:
+    type: string
+  sub_id_25:
+    type: string
+  sub_id_26:
+    type: string
+  sub_id_27:
+    type: string
+  sub_id_28:
+    type: string
+  sub_id_29:
+    type: string
+  sub_id_30:
+    type: string

references/schemas/FilterRequest.yaml

@@ -0,0 +1,17 @@
+type: object
+properties:
+  name:
+    type: string
+    description: Name of the field
+  operator:
+    type: string
+    description: |
+      One of the available operators (<a href="#operators">operators</a>)
+  expression:
+    anyOf:
+      - type: string
+      - type: number
+    description: Expression for the filter
+required:
+  - name
+  - operator

references/schemas/FilterStreamRequest.yaml

@@ -0,0 +1,24 @@
+type: object
+properties:
+  id:
+    type: integer
+    description: Flow filter ID. Provide it if you update the filter.
+  name:
+    type: string
+    description: Flow filter name, see 'retrive-stream-filters' section
+  mode:
+    type: string
+    description: Filter mode
+    enum:
+      - accept
+      - reject
+  payload:
+    type: array
+    items:
+      type: string
+    description: >-
+      Flow payload. This field contains values for filters. For example, for a
+      "keyword" Filter an Array ["value1", "value2"] must be provided
+required:
+  - name
+  - mode

references/schemas/Group.yaml

@@ -0,0 +1,10 @@
+type: object
+properties:
+  id:
+    type: integer
+  name:
+    type: string
+  position:
+    type: integer
+  type:
+    type: string

references/schemas/GroupCreateRequired.yaml

@@ -0,0 +1,3 @@
+required:
+  - name
+  - type

references/schemas/GroupRequest.yaml

@@ -0,0 +1,13 @@
+type: object
+properties:
+  name:
+    description: Group name
+    type: string
+  type:
+    type: string
+    description: Group type
+    enum:
+      - campaigns
+      - offers
+      - landings
+      - domains

references/schemas/LabelRequestPost.yaml

@@ -0,0 +1,45 @@
+type: object
+properties:
+  campaign_id:
+    type: integer
+    description: Campaign ID
+  ref_name:
+    type: string
+    description: |
+      <style>
+        .list-flex {
+          display: flex;
+          list-style: none;
+          flex-wrap: wrap;
+        }
+        .list-flex li {
+          width: 200px;
+        }
+      </style>
+      List of available ref names:
+      <ul class="list-flex">
+      <li class="level1"><div class="li"> ip</div>
+      </li>
+      <li class="level1"><div class="li"> source</div>
+      </li>
+      <li class="level1"><div class="li"> ad_campaign_id</div>
+      </li>
+      <li class="level1"><div class="li"> creative_id</div>
+      </li>
+      <li class="level1"><div class="li"> keyword</div>
+      </li>
+      <li class="level1"><div class="li"> ad_campaign_idn</div>
+      </li>
+      <li class="level1"><div class="li"> sub_id_1..10</div>
+      </li>
+      </ul>
+  items:
+    type: object
+    properties:
+      value:
+        type: string
+        description: An Object like a {"value":"blacklist"}
+required:
+  - campaign_id
+  - ref_name
+  - items

references/schemas/Labels.yaml

@@ -0,0 +1,2 @@
+type: object
+additionalProperties: {}

references/schemas/Landing.yaml

@@ -0,0 +1,34 @@
+type: object
+properties:
+  id:
+    type: integer
+  landing_type:
+    type: string
+  action_type:
+    type: string
+  action_payload:
+    oneOf:
+      - type: string
+      - type: object
+  action_options:
+    type: object
+  name:
+    type: string
+  group_id:
+    type: integer
+  offer_count:
+    type: integer
+  notes:
+    type: string
+  state:
+    type: string
+  created_at:
+    type: string
+  updated_at:
+    type: string
+  archive:
+    type: string
+  local_path:
+    type: string
+  preview_path:
+    type: string

references/schemas/LandingCreateRequired.yaml

@@ -0,0 +1,3 @@
+required:
+  - name
+  - landing_type

references/schemas/LandingRequest.yaml

@@ -0,0 +1,49 @@
+type: object
+properties:
+  name:
+    description: Landing page name
+    type: string
+  action_payload:
+    description: Action payload
+    oneOf:
+      - type: string
+      - type: object
+  group_id:
+    description: Group ID
+    type: string
+  state:
+    type: string
+    enum:
+      - active
+      - disabled
+      - deleted
+    default: active
+  landing_type:
+    description: Landing page type
+    type: string
+    default: local
+    enum:
+      - local
+      - external
+      - preloaded
+      - action
+  action_type:
+    description: Action type
+    type: string
+    default: local_file
+    enum:
+      - local_file
+      - http
+      - curl
+      - status404
+      - show_text
+      - show_html
+  url:
+    description: URL
+    type: string
+  archive:
+    description: ZIP-file encoded to base64.
+    type: string
+  notes:
+    description: Notes
+    type: string

references/schemas/LandingStream.yaml

@@ -0,0 +1,16 @@
+type: object
+properties:
+  id:
+    type: integer
+  stream_id:
+    type: integer
+  landing_id:
+    type: integer
+  state:
+    type: string
+  share:
+    type: integer
+  created_at:
+    type: string
+  updated_at:
+    type: string

references/schemas/LandingStreamRequest.yaml

@@ -0,0 +1,16 @@
+type: object
+properties:
+  landing_id:
+    type: integer
+    description: Landing Page ID
+  share:
+    type: integer
+    description: Share among others
+  state:
+    type: string
+    enum:
+      - active
+      - disabled
+required:
+  - landing_id
+  - share

references/schemas/Logs.yaml

@@ -0,0 +1,8 @@
+type: object
+properties:
+  datetime:
+    type: string
+  jid:
+    type: string
+  message:
+    type: string

references/schemas/Offer.yaml

@@ -0,0 +1,56 @@
+type: object
+properties:
+  id:
+    type: integer
+  name:
+    type: string
+  group_id:
+    type: integer
+  action_type:
+    type: string
+  action_payload:
+    oneOf:
+      - type: string
+      - type: object
+  action_options:
+    type: object
+  affiliate_network_id:
+    type: integer
+  payout_value:
+    type: number
+  payout_currency:
+    type: string
+  payout_type:
+    type: string
+  state:
+    type: string
+  created_at:
+    type: string
+  updated_at:
+    type: string
+  payout_auto:
+    type: boolean
+  payout_upsell:
+    type: boolean
+  country:
+    type: array
+    items:
+      type: string
+  notes:
+    type: string
+  affiliate_network:
+    type: string
+  archive:
+    type: string
+  local_path:
+    type: string
+  preview_path:
+    type: string
+  values:
+    type: array
+    items:
+      type: object
+    example:
+      - exampleKey: exampleValue
+      - price: '100'
+      - currency: EUR

references/schemas/OfferCreateRequired.yaml

@@ -0,0 +1,2 @@
+required:
+  - name

references/schemas/OfferRequest.yaml

@@ -0,0 +1,77 @@
+type: object
+properties:
+  name:
+    description: Offer name
+    type: string
+  group_id:
+    description: Offer group ID
+    type: integer
+  offer_type:
+    description: Offer Type ('local'/'external'/'preloaded'/'action')
+    type: string
+  action_type:
+    description: Action or redirect type
+    type: string
+  action_payload:
+    description: Action payload or URL
+    oneOf:
+      - type: string
+      - type: object
+  affiliate_network_id:
+    description: Affiliate network ID
+    type: integer
+  payout_value:
+    description: Payout value
+    type: number
+  payout_currency:
+    description: Payout currency
+    type: string
+  payout_type:
+    description: Payout type
+    type: string
+    enum:
+      - CPA
+      - CPC
+  state:
+    type: string
+    enum:
+      - active
+      - deleted
+    description: Offer State
+    default: active
+  payout_auto:
+    description: If true, offer receives payout value from postback
+    type: boolean
+    default: false
+  payout_upsell:
+    description: Allow offer to get upsells
+    type: boolean
+    default: false
+  country:
+    description: Country codes (i.g, ["US", "DE", "JP"])
+    type: array
+    items:
+      type: string
+  notes:
+    description: Notes
+    type: string
+  archive:
+    description: ZIP-file encoded to base64
+    type: string
+  conversion_cap_enabled:
+    description: Turn on that feature if the offer limit conversions per day
+    type: boolean
+    default: false
+  daily_cap:
+    description: >-
+      Daily limit of conversions, after which the tracker will send traffic to
+      another offer
+    type: number
+  conversion_timezone:
+    description: >-
+      Which timezone is being used by the Affiliate network for calculating
+      conversions, e.g. UTC or Europe/Madrid
+    type: string
+  alternative_offer_id:
+    description: Offer id, where to send traffic when daily limit is reached
+    type: number

references/schemas/OfferStream.yaml

@@ -0,0 +1,16 @@
+type: object
+properties:
+  id:
+    type: integer
+  stream_id:
+    type: integer
+  offer_id:
+    type: integer
+  state:
+    type: string
+  share:
+    type: integer
+  created_at:
+    type: string
+  updated_at:
+    type: string

references/schemas/OfferStreamRequest.yaml

@@ -0,0 +1,16 @@
+type: object
+properties:
+  offer_id:
+    type: integer
+    description: Offer ID
+  share:
+    type: integer
+    description: Percentage of Traffic Sent to This Offer
+  state:
+    type: string
+    enum:
+      - active
+      - disabled
+required:
+  - offer_id
+  - share

references/schemas/OptionNumber.yaml

@@ -0,0 +1,9 @@
+type: object
+properties:
+  name:
+    type: string
+  value:
+    type: number
+required:
+  - name
+  - value

references/schemas/PlaceholderObject.yaml

@@ -0,0 +1,8 @@
+type: object
+properties:
+  name:
+    type: string
+  placeholder:
+    type: string
+  alias:
+    type: string

references/schemas/RangeRequest.yaml

@@ -0,0 +1,16 @@
+type: object
+properties:
+  from:
+    type: string
+    description: Start Date, e.g., '2017-09-10'
+  to:
+    type: string
+    description: End Date, e.g., '2017-09-10'
+  timezone:
+    type: string
+    description: E.g., Europe/Madrid
+  interval:
+    description: >
+      One of the intervals can be used: today, yesterday, 7_days_ago,
+      first_day_of_this_week, 1_month_ago, first_day_of_this_month, 1_year_ago,
+      first_day_of_this_year, all_time

references/schemas/Report.yaml

@@ -0,0 +1,12 @@
+type: object
+properties:
+  rows:
+    type: array
+    items:
+      type: string
+  total:
+    type: integer
+  meta:
+    type: array
+    items:
+      type: string

references/schemas/ReportsRequest.yaml

@@ -0,0 +1,21 @@
+type: object
+properties:
+  range:
+    $ref: ../schemas/RangeRequest.yaml
+  dimensions:
+    type: array
+    items:
+      type: string
+  measures:
+    type: array
+    items:
+      type: string
+  filters:
+    description: Filters can contain OR and AND logical operators.
+    type: array
+    items:
+      $ref: ../schemas/FilterRequest.yaml
+  sort:
+    type: array
+    items:
+      $ref: ../schemas/SortRequest.yaml

references/schemas/S2SPostback.yaml

@@ -0,0 +1,27 @@
+type: object
+properties:
+  campaign_id:
+    description: Campaign ID
+    type: integer
+  id:
+    description: Postback ID
+    type: integer
+  method:
+    description: Request method
+    type: string
+    enum:
+      - GET
+      - POST
+  statuses:
+    description: Conversion status
+    type: array
+    items:
+      type: string
+      enum:
+        - lead
+        - sale
+        - rejected
+        - rebill
+  url:
+    description: Postback URL
+    type: string

references/schemas/SortRequest.yaml

@@ -0,0 +1,14 @@
+type: object
+properties:
+  name:
+    type: string
+    description: Column or metric name
+  order:
+    type: string
+    description: Order
+    enum:
+      - ASC
+      - DESC
+required:
+  - name
+  - order

references/schemas/Source.yaml

@@ -0,0 +1,30 @@
+type: object
+properties:
+  id:
+    type: integer
+  name:
+    type: string
+  postback_url:
+    type: string
+  postback_statuses:
+    type: array
+    items:
+      type: string
+  template_name:
+    type: string
+  accept_parameters:
+    type: boolean
+  parameters:
+    $ref: ../schemas/SourceParameters.yaml
+  notes:
+    type: string
+  state:
+    type: string
+  created_at:
+    type: string
+  updated_at:
+    type: string
+  traffic_loss:
+    type: number
+  update_in_campaigns:
+    type: string

references/schemas/SourceParameters.yaml

@@ -0,0 +1,46 @@
+type: object
+properties:
+  keyword:
+    $ref: ../schemas/PlaceholderObject.yaml
+  cost:
+    $ref: ../schemas/PlaceholderObject.yaml
+  currency:
+    $ref: ../schemas/PlaceholderObject.yaml
+  external_id:
+    $ref: ../schemas/PlaceholderObject.yaml
+  creative_id:
+    $ref: ../schemas/PlaceholderObject.yaml
+  ad_campaign_id:
+    $ref: ../schemas/PlaceholderObject.yaml
+  source:
+    $ref: ../schemas/PlaceholderObject.yaml
+  sub_id_1:
+    $ref: ../schemas/PlaceholderObject.yaml
+  sub_id_2:
+    $ref: ../schemas/PlaceholderObject.yaml
+  sub_id_3:
+    $ref: ../schemas/PlaceholderObject.yaml
+  sub_id_4:
+    $ref: ../schemas/PlaceholderObject.yaml
+  sub_id_5:
+    $ref: ../schemas/PlaceholderObject.yaml
+  sub_id_6:
+    $ref: ../schemas/PlaceholderObject.yaml
+  sub_id_7:
+    $ref: ../schemas/PlaceholderObject.yaml
+  sub_id_8:
+    $ref: ../schemas/PlaceholderObject.yaml
+  sub_id_9:
+    $ref: ../schemas/PlaceholderObject.yaml
+  sub_id_10:
+    $ref: ../schemas/PlaceholderObject.yaml
+  sub_id_11:
+    $ref: ../schemas/PlaceholderObject.yaml
+  sub_id_12:
+    $ref: ../schemas/PlaceholderObject.yaml
+  sub_id_13:
+    $ref: ../schemas/PlaceholderObject.yaml
+  sub_id_14:
+    $ref: ../schemas/PlaceholderObject.yaml
+  sub_id_15:
+    $ref: ../schemas/PlaceholderObject.yaml

references/schemas/SourceRequest.yaml

@@ -0,0 +1,22 @@
+type: object
+properties:
+  name:
+    type: string
+  postback_url:
+    type: string
+  postback_statuses:
+    type: array
+    items:
+      type: string
+  template_name:
+    type: string
+  accept_parameters:
+    type: boolean
+  parameters:
+    $ref: ../schemas/SourceParameters.yaml
+  notes:
+    type: string
+  state:
+    type: string
+  traffic_loss:
+    type: number

references/schemas/Stream.yaml

@@ -0,0 +1,58 @@
+type: object
+properties:
+  id:
+    type: integer
+  type:
+    type: string
+  name:
+    type: string
+  campaign_id:
+    type: integer
+    format: int32
+  position:
+    type: integer
+    format: int32
+  weight:
+    type: number
+  action_options:
+    type: object
+  comments:
+    type: string
+  state:
+    type: string
+  updated_at:
+    type: string
+  action_type:
+    type: string
+  action_payload:
+    oneOf:
+      - type: string
+      - type: object
+  schema:
+    type: string
+  collect_clicks:
+    type: boolean
+  filter_or:
+    type: boolean
+  filters:
+    type: array
+    items:
+      $ref: ../schemas/Filter.yaml
+  triggers:
+    type: array
+    items:
+      $ref: ../schemas/Trigger.yaml
+  landings:
+    type: array
+    items:
+      $ref: ../schemas/LandingStream.yaml
+  offers:
+    type: array
+    items:
+      $ref: ../schemas/OfferStream.yaml
+  offer_selection:
+    type: string
+    enum:
+      - before_click
+      - after_click
+    default: before_click

references/schemas/StreamAction.yaml

@@ -0,0 +1,12 @@
+type: object
+properties:
+  key:
+    type: string
+  name:
+    type: string
+  field:
+    type: string
+  type:
+    type: string
+  description:
+    type: string

references/schemas/StreamFilter.yaml

@@ -0,0 +1,29 @@
+type: object
+properties:
+  value:
+    type: string
+    description: Filter Name
+  tooltip:
+    type: string
+    description: Filter Description
+  modes:
+    type: object
+    properties:
+      accept:
+        type: string
+        description: Accept mode
+      reject:
+        type: string
+        description: Reject mode
+  group:
+    type: string
+    description: Group ID. It's used to group filters in a filters dropdown menu.
+  template:
+    type: string
+    description: HTML code for rendering filter body view (Not recommended to use)
+  header_template:
+    type: string
+    description: HTML code for rendering filter body view (Not recommended to use)
+  defaults:
+    type: string
+    description: Default values

references/schemas/StreamObject.yaml

@@ -0,0 +1,68 @@
+type: object
+properties:
+  campaign_id:
+    type: integer
+    description: Campaign ID
+  type:
+    type: string
+    description: Flow type
+    enum:
+      - forced
+      - regular
+      - default
+  name:
+    type: string
+    description: Flow name
+  position:
+    type: integer
+    description: Position of a flow among other flows.
+  weight:
+    type: number
+    description: Flow weight.
+  action_options:
+    type: object
+    description: Action options.
+  comments:
+    type: string
+    description: Comments or notes for the flow
+  state:
+    type: string
+    enum:
+      - active
+      - disabled
+      - deleted
+    description: State of the flow
+    default: active
+  action_type:
+    type: string
+    description: Action to perform (see 'Retrieve available flow action types')
+  schema:
+    type: string
+    enum:
+      - landings
+      - redirect
+      - action
+  collect_clicks:
+    type: boolean
+    description: Flow saves clicks (true/false)
+    default: false
+  filter_or:
+    type: boolean
+    description: Use 'OR' operator between filters
+    default: false
+  filters:
+    type: array
+    items:
+      $ref: ../schemas/FilterStreamRequest.yaml
+  triggers:
+    type: array
+    items:
+      $ref: ../schemas/TriggersStreamRequest.yaml
+  landings:
+    type: array
+    items:
+      $ref: ../schemas/LandingStreamRequest.yaml
+  offers:
+    type: array
+    items:
+      $ref: ../schemas/OfferStreamRequest.yaml

references/schemas/StreamRequest.yaml

@@ -0,0 +1,9 @@
+allOf:
+  - $ref: ../schemas/StreamObject.yaml
+  - type: object
+    required:
+      - campaign_id
+      - schema
+      - type
+      - name
+      - action_type

references/schemas/StreamRequestPut.yaml

@@ -0,0 +1,2 @@
+type: object
+$ref: ../schemas/StreamObject.yaml

references/schemas/Success.yaml

@@ -0,0 +1,4 @@
+type: object
+properties:
+  success:
+    type: boolean

references/schemas/Time.yaml

@@ -0,0 +1,9 @@
+type: object
+properties:
+  date:
+    type: string
+  timezone_type:
+    type: integer
+    format: int32
+  timezone:
+    type: string

references/schemas/Trigger.yaml

@@ -0,0 +1,34 @@
+type: object
+properties:
+  id:
+    type: integer
+  oid:
+    type: integer
+  stream_id:
+    type: integer
+  taget:
+    type: string
+  condition:
+    type: string
+  selected_page:
+    type: string
+  pattern:
+    type: string
+  action:
+    type: string
+  interval:
+    type: integer
+  next_run_at:
+    type: integer
+  alternative_urls:
+    type: string
+  grab_from_page:
+    type: string
+  av_settings:
+    type: string
+  reverse:
+    type: boolean
+  enabled:
+    type: boolean
+  scan_page:
+    type: boolean

references/schemas/TriggersStreamRequest.yaml

@@ -0,0 +1,60 @@
+type: object
+properties:
+  id:
+    type: integer
+    description: Trigger ID.
+  stream_id:
+    type: integer
+    description: Flow ID
+  condition:
+    type: string
+    description: Condition
+    enum:
+      - not_respond
+      - always
+      - not_contains
+      - av_detected
+  target:
+    type: string
+    description: Target
+    enum:
+      - stream
+      - landings
+      - offers
+      - selected_page
+  selected_page:
+    type: string
+    description: The URL of the Page to Check
+  pattern:
+    type: string
+    description: Text Pattern to Check
+  action:
+    type: string
+    description: Action
+    enum:
+      - disable
+      - replace_url
+      - grab_from_page
+  interval:
+    type: integer
+    description: Interval between Checks
+  alternative_urls:
+    type: string
+    description: URLs for replacement (split by \n)
+  grab_from_page:
+    type: string
+    description: URL of the page that contains a new URL
+  av_settings:
+    type: string
+    description: Settings for AV Scanners
+  reverse:
+    type: boolean
+    description: Perform also in a reverse mode (true/false)
+  scan_page:
+    type: boolean
+    description: Tell AV scanner to scan the page content
+required:
+  - condition
+  - action
+  - target
+  - stream_id

references/schemas/UnprocessableEntity.yaml

@@ -0,0 +1,6 @@
+type: object
+required:
+  - name
+properties:
+  name:
+    type: string

references/schemas/User.yaml

@@ -0,0 +1,37 @@
+type: object
+properties:
+  id:
+    description: User ID
+    type: integer
+  login:
+    description: User login
+    type: string
+  type:
+    description: User type
+    type: string
+    enum:
+      - USER
+      - ADMIN
+  access_data:
+    allOf:
+      - $ref: ../schemas/UserAccessData.yaml
+      - type: object
+        properties:
+          resources:
+            description: Available resources
+            type: array
+            items:
+              type: string
+          allowed_resources:
+            description: Allowed resources
+            type: array
+            items:
+              type: string
+          reports:
+            description: Allowed reports
+            type: array
+            items:
+              type: string
+  preferences:
+    description: User preferences
+    $ref: ../schemas/UserPreferences.yaml

references/schemas/UserAccessData.yaml

@@ -0,0 +1,150 @@
+type: object
+description: User access data
+properties:
+  resources:
+    type: array
+    items:
+      type: string
+      enum:
+        - offers
+        - landings
+        - groups
+        - affiliate_networks
+        - traffic_sources
+        - streams
+        - groups
+        - domains
+        - archive
+        - geo_profiles
+        - integrations
+        - logs
+        - geo_dbs
+        - campaigns
+        - api_keys
+        - reports
+        - clicks
+        - conversions
+        - trends
+        - cleaner
+        - dashboard
+  offers_access_type:
+    description: Offers access type
+    type: string
+    enum:
+      - full_access
+      - read_only
+      - to_groups_and_selected
+      - created_by_user_groups_and_selected
+  campaigns_access_type:
+    description: Campaigns access type
+    type: string
+    enum:
+      - full_access
+      - read_only
+      - to_groups_and_selected
+      - created_by_user_groups_and_selected
+  landings_access_type:
+    description: Landing pages access type
+    type: string
+    enum:
+      - full_access
+      - read_only
+      - to_groups_and_selected
+      - created_by_user_groups_and_selected
+  traffic_sources_access_type:
+    description: Traffic sources access type
+    type: string
+    enum:
+      - full_access
+      - read_only
+      - to_groups_and_selected
+      - created_by_user_groups_and_selected
+  streams_access_type:
+    description: Flows access type
+    type: string
+    enum:
+      - full_access
+      - read_only
+      - to_groups_and_selected
+      - created_by_user_groups_and_selected
+  affiliate_networks_access_type:
+    description: Affiliate networks access type
+    type: string
+    enum:
+      - full_access
+      - read_only
+      - to_groups_and_selected
+      - created_by_user_groups_and_selected
+  domains_access_type:
+    description: Domains access type
+    type: string
+    enum:
+      - full_access
+      - read_only
+      - to_groups_and_selected
+      - created_by_user_groups_and_selected
+  offers_selected_entities:
+    description: List of available ID offers
+    type: array
+    items:
+      type: number
+  campaigns_selected_entities:
+    description: List of available ID campaigns
+    type: array
+    items:
+      type: number
+  landings_selected_entities:
+    description: List of available ID landings
+    type: array
+    items:
+      type: number
+  traffic_sources_selected_entities:
+    description: List of available ID traffic sources
+    type: array
+    items:
+      type: number
+  affiliate_networks_selected_entities:
+    description: List of available ID affiliate networks
+    type: array
+    items:
+      type: number
+  domains_selected_entities:
+    description: List of available ID domains
+    type: array
+    items:
+      type: number
+  offers_selected_groups:
+    description: List of available group ID
+    type: array
+    items:
+      type: number
+  campaigns_selected_groups:
+    description: List of available groups ID
+    type: array
+    items:
+      type: number
+  landings_selected_groups:
+    description: List of available groups ID
+    type: array
+    items:
+      type: number
+  traffic_sources_selected_groups:
+    description: List of available groups ID
+    type: array
+    items:
+      type: number
+  affiliate_networks_selected_groups:
+    description: List of available groups ID
+    type: array
+    items:
+      type: number
+  domains_selected_groups:
+    description: List of available group ID
+    type: array
+    items:
+      type: number
+  reports:
+    description: List of fields to which access is restricted
+    type: array
+    items:
+      type: string

references/schemas/UserPreferences.yaml

@@ -0,0 +1,11 @@
+type: object
+properties:
+  language:
+    description: User language
+    type: string
+    enum:
+      - ru
+      - en
+  timezone:
+    description: User timezone in UTC, e.g., "Europe/Minsk"
+    type: string

references/schemas/UserRequest.yaml

@@ -0,0 +1,25 @@
+type: object
+properties:
+  login:
+    description: User login
+    type: string
+  new_password:
+    description: User password
+    type: string
+  new_password_confirmation:
+    description: Repeat user password
+    type: string
+  type:
+    description: User type
+    type: string
+    enum:
+      - USER
+      - ADMIN
+  preferences:
+    description: User preferences
+    $ref: ../schemas/UserPreferences.yaml
+required:
+  - login
+  - type
+  - new_password
+  - new_password_confirmation

references/schemas/UserRequestAccess.yaml

@@ -0,0 +1,17 @@
+type: object
+properties:
+  access_data:
+    allOf:
+      - $ref: ../schemas/UserAccessData.yaml
+      - type: object
+        properties:
+          resources:
+            description: Available resources
+            type: array
+            items:
+              type: string
+          reports:
+            description: Allowed reports
+            type: array
+            items:
+              type: string

references/schemas/UserRequestUpdate.yaml

@@ -0,0 +1,23 @@
+type: object
+properties:
+  login:
+    description: User login
+    type: string
+  new_password:
+    description: User password
+    type: string
+  new_password_confirmation:
+    description: User password repeat
+    type: string
+  type:
+    description: User type
+    type: string
+    enum:
+      - USER
+      - ADMIN
+  keyCount:
+    description: API keys count
+    type: integer
+  preferences:
+    description: User preferences
+    $ref: ../schemas/UserPreferences.yaml

references/schemas/_index.yaml

@@ -0,0 +1,138 @@
+AffiliateNetwork:
+  $ref: ./AffiliateNetwork.yaml
+AffiliateNetworkObject:
+  $ref: ./AffiliateNetworkObject.yaml
+AffiliateNetworkPut:
+  $ref: ./AffiliateNetworkPut.yaml
+AffiliateNetworkRequest:
+  $ref: ./AffiliateNetworkRequest.yaml
+BotListRequest:
+  $ref: ./BotListRequest.yaml
+Campaign:
+  $ref: ./Campaign.yaml
+CampaignCostRequest:
+  $ref: ./CampaignCostRequest.yaml
+CampaignCreateRequired:
+  $ref: ./CampaignCreateRequired.yaml
+CampaignRequest:
+  $ref: ./CampaignRequest.yaml
+CleanRequest:
+  $ref: ./CleanRequest.yaml
+ClickRequest:
+  $ref: ./ClickRequest.yaml
+ClicksUpdateCostsPayload:
+  $ref: ./ClicksUpdateCostsPayload.yaml
+ClicksUpdateCostsRequest:
+  $ref: ./ClicksUpdateCostsRequest.yaml
+ConversionRequest:
+  $ref: ./ConversionRequest.yaml
+Domain:
+  $ref: ./Domain.yaml
+DomainCreateRequired:
+  $ref: ./DomainCreateRequired.yaml
+DomainRegister:
+  $ref: ./DomainRegister.yaml
+DomainRequest:
+  $ref: ./DomainRequest.yaml
+EditorFiles:
+  $ref: ./EditorFiles.yaml
+Error:
+  $ref: ./Error.yaml
+Facebook:
+  $ref: ./Facebook.yaml
+FacebookRequest:
+  $ref: ./FacebookRequest.yaml
+Filter:
+  $ref: ./Filter.yaml
+FilterCostRequest:
+  $ref: ./FilterCostRequest.yaml
+FilterRequest:
+  $ref: ./FilterRequest.yaml
+FilterStreamRequest:
+  $ref: ./FilterStreamRequest.yaml
+Group:
+  $ref: ./Group.yaml
+GroupCreateRequired:
+  $ref: ./GroupCreateRequired.yaml
+GroupRequest:
+  $ref: ./GroupRequest.yaml
+LabelRequestPost:
+  $ref: ./LabelRequestPost.yaml
+Labels:
+  $ref: ./Labels.yaml
+Landing:
+  $ref: ./Landing.yaml
+LandingCreateRequired:
+  $ref: ./LandingCreateRequired.yaml
+LandingRequest:
+  $ref: ./LandingRequest.yaml
+LandingStream:
+  $ref: ./LandingStream.yaml
+LandingStreamRequest:
+  $ref: ./LandingStreamRequest.yaml
+Logs:
+  $ref: ./Logs.yaml
+Offer:
+  $ref: ./Offer.yaml
+OfferCreateRequired:
+  $ref: ./OfferCreateRequired.yaml
+OfferRequest:
+  $ref: ./OfferRequest.yaml
+OfferStream:
+  $ref: ./OfferStream.yaml
+OfferStreamRequest:
+  $ref: ./OfferStreamRequest.yaml
+OptionNumber:
+  $ref: ./OptionNumber.yaml
+PlaceholderObject:
+  $ref: ./PlaceholderObject.yaml
+RangeRequest:
+  $ref: ./RangeRequest.yaml
+Report:
+  $ref: ./Report.yaml
+ReportsRequest:
+  $ref: ./ReportsRequest.yaml
+S2SPostback:
+  $ref: ./S2SPostback.yaml
+SortRequest:
+  $ref: ./SortRequest.yaml
+Source:
+  $ref: ./Source.yaml
+SourceParameters:
+  $ref: ./SourceParameters.yaml
+SourceRequest:
+  $ref: ./SourceRequest.yaml
+Stream:
+  $ref: ./Stream.yaml
+StreamAction:
+  $ref: ./StreamAction.yaml
+StreamFilter:
+  $ref: ./StreamFilter.yaml
+StreamObject:
+  $ref: ./StreamObject.yaml
+StreamRequest:
+  $ref: ./StreamRequest.yaml
+StreamRequestPut:
+  $ref: ./StreamRequestPut.yaml
+Success:
+  $ref: ./Success.yaml
+Time:
+  $ref: ./Time.yaml
+Trigger:
+  $ref: ./Trigger.yaml
+TriggersStreamRequest:
+  $ref: ./TriggersStreamRequest.yaml
+UnprocessableEntity:
+  $ref: ./UnprocessableEntity.yaml
+User:
+  $ref: ./User.yaml
+UserAccessData:
+  $ref: ./UserAccessData.yaml
+UserPreferences:
+  $ref: ./UserPreferences.yaml
+UserRequest:
+  $ref: ./UserRequest.yaml
+UserRequestAccess:
+  $ref: ./UserRequestAccess.yaml
+UserRequestUpdate:
+  $ref: ./UserRequestUpdate.yaml