openapi: 3.1.1 info: title: API Documentation 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. servers: - url: https://api-demo.affise.com description: Demo Server variables: api-key: default: 685168e94e6a96fa7c31895e description: Demo Test API Key tags: - name: admin-advertisers x-displayName: Advertisers description: Admin operations on advertisers - name: admin-affiliates x-displayName: Affiliates description: Admin operations on affiliates (partners) - name: admin-users x-displayName: Users description: Admin user management - name: admin-offers x-displayName: Offers description: Admin offer management — create, edit, delete, mass-update, categories, sources, creatives - name: admin-conversions x-displayName: Conversions description: Admin conversion editing and import - name: admin-billing x-displayName: Advertiser Billing description: Advertiser invoice management - name: admin-payments x-displayName: Billing description: Affiliate payments API. Available for Expand, Custom and Trial plans. - name: admin-automation x-displayName: Automation description: KPI and block-logs automation - name: admin-presets x-displayName: Presets description: Admin presets management - name: admin-stats x-displayName: Statistics description: Statistics endpoints available to admin (includes admin-only and multi-role) - name: admin-adcosts x-displayName: Ad Costs description: Ad cost reporting - name: admin-tickets x-displayName: Tickets description: Ticket management — list, view, approve/reject affiliate connections to offers and SmartLinks - name: admin-smartlinks x-displayName: Smartlinks description: Admin smartlinks — categories management - name: admin-other x-displayName: Other description: Other admin endpoints — domains, currencies, custom fields, payment systems - name: advertiser-auth x-displayName: Auth & Registration description: Advertiser registration and login - name: advertiser-offers x-displayName: Offers description: Advertiser offer listing - name: advertiser-stats x-displayName: Statistics description: Statistics endpoints available to advertiser (multi-role only) - name: affiliate-profile x-displayName: Profile description: Affiliate profile, API key - name: affiliate-offers x-displayName: Offers description: Affiliate offer listing, live offers, activation - name: affiliate-postbacks x-displayName: Postbacks description: Affiliate postback management - name: affiliate-pixels x-displayName: Pixels description: Affiliate tracking pixels - name: affiliate-stats x-displayName: Statistics description: Statistics endpoints available to affiliate (multi-role + affiliate-only) - name: affiliate-conversions x-displayName: Conversions description: Affiliate conversion import - name: affiliate-news x-displayName: News description: Affiliate news feed - name: affiliate-smartlinks x-displayName: Smartlinks description: Affiliate smartlinks, referrals - name: affiliate-other x-displayName: Other description: Affiliate balance, product feeds - name: resources x-displayName: Lookup description: Public lookup data — countries, regions, ISPs, OSes, goals, browsers, cities, etc. paths: /3.1/adcosts: get: tags: - admin-adcosts summary: Get Ad Costs description: | `GET /3.1/adcosts` Returns ad cost data based on filters. parameters: - name: api-key in: header description: API key required: true schema: type: string - name: offer_id in: query description: Offer ID required: true schema: type: integer - name: page in: query description: page with results schema: type: integer default: 1 - name: limit in: query description: results per page schema: type: integer default: 100 responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer costs: type: array items: type: object properties: offer_id: type: integer affiliate_id: type: integer date: type: string format: date sub8: type: string costs: type: number pagination: type: object properties: page: type: integer limit: type: integer total: type: integer example: status: 1 costs: - offer_id: 2 affiliate_id: 4 date: '2025-02-12' sub8: sub_example_1 costs: 33.1 - offer_id: 2 affiliate_id: 5 date: '2025-02-01' sub8: sub_example_2 costs: 100.4 - offer_id: 2 affiliate_id: 5 date: '2024-01-01' sub8: testS8 costs: 20 pagination: page: 1 limit: 100 total: 3 '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 \ --url 'https://api-demo.affise.com/3.1/adcosts?offer_id=&page=1&limit=100' \ --header 'api-key: ' post: tags: - admin-adcosts summary: Create or Update Ad Costs description: | `POST /3.1/adcosts` This method is used to create or update ad costs. parameters: - name: api-key in: header description: API key required: true schema: type: string requestBody: required: true content: application/x-www-form-urlencoded: schema: type: object properties: offer_id: type: integer description: Offer ID affiliate_id: type: integer description: Affiliate ID date: type: string format: date description: Date (format YYYY-MM-DD) sub8: type: string description: Sub8 costs: type: number format: float description: Costs required: - offer_id - affiliate_id - date - sub8 - costs responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer message: type: string example: status: 1 message: adcost has been added successfully '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 POST \ --url 'https://api-demo.affise.com/3.1/adcosts' \ --header 'api-key: ' \ --form 'offer_id=0' \ --form 'affiliate_id=0' \ --form 'date=string' \ --form 'sub8=string' \ --form 'costs=0' delete: tags: - admin-adcosts summary: Delete Ad Costs description: | `DELETE /3.1/adcosts` Method for deleting ad costs. parameters: - name: api-key in: header description: API key required: true schema: type: string requestBody: required: true content: application/x-www-form-urlencoded: schema: type: object properties: offer_id: type: integer description: Offer ID affiliate_id: type: integer description: Affiliate ID date: type: string format: date description: Date (format YYYY-MM-DD) sub8: type: string description: Sub8 required: - offer_id - affiliate_id - date - sub8 responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer message: type: string example: status: 1 message: adcost has been removed successfully '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 DELETE \ --url 'https://api-demo.affise.com/3.1/adcosts' \ --header 'api-key: ' \ --form 'offer_id=0' \ --form 'affiliate_id=0' \ --form 'date=string' \ --form 'sub8=string' /3.0/admin/advertiser-invoices: get: tags: - admin-billing summary: Invoices list description: | `GET /3.0/admin/advertiser-invoices` Get list of invoices parameters: - name: api-key in: header description: API key required: true schema: type: string - name: page in: query description: Page of entities schema: type: integer - name: limit in: query description: Limit of entities schema: type: integer default: 100 - name: status in: query description: Status of invoice schema: type: string enum: - paid - unpaid - name: start_date in: query description: Start date of period schema: type: string format: date - name: end_date in: query description: End date of period schema: type: string format: date - name: supplier_id in: query description: Advertiser ID schema: type: string - name: sort in: query description: Sort field schema: type: string enum: - number - supplier_id - created_at - start_date - end_date - status - name: sort_type in: query description: Sort direction schema: type: string enum: - asc - desc responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer message: type: array items: type: object properties: number: type: integer supplier_id: type: string created_at: type: string format: date updated_at: type: string format: date start_date: type: string format: date end_date: type: string format: date status: type: string detail: type: array items: type: object properties: offer_id: type: integer payout_type: type: string actions: type: integer amount: type: integer comment: type: string currency: type: string comment: type: string pagination: type: object properties: per_page: type: integer total_count: type: integer page: type: integer example: status: 1 message: - number: 1 supplier_id: 5a37c01cbf0b6b18008b4567 created_at: '2018-01-11' updated_at: '2018-01-11' start_date: '2017-12-05' end_date: '2017-12-07' status: unpaid detail: - offer_id: 1 payout_type: RPA actions: 100 amount: 100 comment: null currency: USD comment: null - number: 2 supplier_id: 5a37c01cbf0b6b18008b4567 created_at: '2018-01-11' updated_at: '2018-01-11' start_date: '2018-01-11' end_date: '2018-01-11' status: unpaid detail: - offer_id: 1 payout_type: RPA actions: 55 amount: 666 comment: null currency: USD comment: some comment pagination: per_page: 100 total_count: 2 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 \ --url 'https://api-demo.affise.com/3.0/admin/advertiser-invoices?limit=100&status=paid&sort=number&sort_type=asc' \ --header 'api-key: ' /3.0/admin/advertiser-invoice: post: tags: - admin-billing summary: Add invoice description: | `POST /3.0/admin/advertiser-invoice` Add new invoice parameters: - name: api-key in: header description: API key required: true schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: type: object properties: supplier_id: type: string description: Advertiser Id start_date: type: string description: Start date of invoice period end_date: type: string description: End date of invoice period status: type: string description: Invoice status enum: - paid - unpaid currency: type: string description: One of the active currencies (RUB, USD, EUR etc) comment: type: string description: Comment detail: type: array items: type: object properties: offer_id: type: integer description: Offer id payout_type: type: string description: Payout type enum: - RPA - RPS - RPA + RPS - RPC - RPM actions: type: integer description: Actions amount: type: integer description: Amount comment: type: string description: Comment for detail required: - supplier_id - currency responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer message: type: string example: status: 1 message: Invoice created. '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 POST \ --url 'https://api-demo.affise.com/3.0/admin/advertiser-invoice' \ --header 'api-key: ' \ --form 'supplier_id=string' \ --form 'start_date=string' \ --form 'end_date=string' \ --form 'status=paid' \ --form 'currency=string' \ --form 'comment=string' \ --form 'detail[0][offer_id]=0' \ --form 'detail[0][payout_type]=RPA' \ --form 'detail[0][actions]=0' \ --form 'detail[0][amount]=0' \ --form 'detail[0][comment]=string' /3.0/admin/advertiser-invoice/{number}: get: tags: - admin-billing summary: Invoices view description: | `GET /3.0/admin/advertiser-invoice/{number}` Get a invoice parameters: - name: api-key in: header description: API key required: true schema: type: string - name: number in: path description: Invoice number required: true schema: type: integer responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer message: type: object properties: number: type: integer supplier_id: type: string created_at: type: string format: date updated_at: type: string format: date start_date: type: string format: date end_date: type: string format: date status: type: string detail: type: array items: type: object properties: offer_id: type: integer payout_type: type: string actions: type: integer amount: type: integer comment: type: string currency: type: string comment: type: string example: status: 1 message: number: 1 supplier_id: 5a37c01cbf0b6b18008b4567 created_at: '2018-01-11' updated_at: '2018-01-11' start_date: '2017-12-05' end_date: '2017-12-07' status: paid detail: - offer_id: 1 payout_type: RPA actions: 100 amount: 100 comment: null currency: USD comment: null '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 \ --url 'https://api-demo.affise.com/3.0/admin/advertiser-invoice/{number}' \ --header 'api-key: ' post: tags: - admin-billing summary: Edit invoice description: | `POST /3.0/admin/advertiser-invoice/{number}` Change an invoice's data parameters: - name: api-key in: header description: API key required: true schema: type: string - name: number in: path description: Invoice number required: true schema: type: integer requestBody: content: application/x-www-form-urlencoded: schema: type: object properties: supplier_id: type: string description: Advertiser Id start_date: type: string description: Start date of invoice period end_date: type: string description: End date of invoice period status: type: string description: Invoice status enum: - paid - unpaid comment: type: string description: Comment detail: type: array items: type: object properties: offer_id: type: integer description: Offer id payout_type: type: string description: Payout type enum: - RPA - RPS - RPA + RPS - RPC - RPM actions: type: integer description: Actions amount: type: integer description: Amount comment: type: string description: Comment for detail currency: type: string description: 'Currency code (one of the currencies active in the network). Example: USD' responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer message: type: string example: status: 1 message: Invoice updated '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 POST \ --url 'https://api-demo.affise.com/3.0/admin/advertiser-invoice/{number}' \ --header 'api-key: ' \ --form 'supplier_id=string' \ --form 'start_date=string' \ --form 'end_date=string' \ --form 'status=paid' \ --form 'comment=string' \ --form 'detail[0][offer_id]=0' \ --form 'detail[0][payout_type]=RPA' \ --form 'detail[0][actions]=0' \ --form 'detail[0][amount]=0' \ --form 'detail[0][comment]=string' \ --form 'currency=string' /3.0/admin/advertiser/{id}: get: tags: - admin-advertisers summary: Get advertiser description: | `GET /3.0/admin/advertiser/{id}` Get advertiser by ID parameters: - name: api-key in: header description: API key required: true example: 23df424b0a53b0899f78685966243ee61 schema: type: string - name: id in: path description: Advertiser ID required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer advertiser: type: object properties: id: type: string title: type: string contact: type: string email: type: string skype: type: string manager: type: string manager_obj: type: object url: type: string address_1: type: string address_2: type: string city: type: string country: type: string zip_code: type: string vat_code: type: string allowed_ip: type: array items: type: string disallowed_ip: type: array items: type: string consider_personal_targeting_only: type: boolean tags: type: array items: type: string hash_password: type: string skad_network_id: type: array items: type: string disabled_choice_postback_status: type: boolean hide_conversion_status: type: boolean hosts_only: type: boolean sign_clicks_integration: type: string sub_accounts: type: object note: type: string created_at: type: string format: date-time updated_at: type: string format: date-time affiliates_enabled: type: array items: type: object properties: id: type: integer name: type: string affiliates_disabled: type: array items: type: object properties: id: type: integer name: type: string example: status: 1 advertiser: address_1: null address_2: null allowed_ip: [] city: Los Angeles consider_personal_targeting_only: false contact: John Doe country: US created_at: '2023-02-22 15:11:09' updated_at: '2023-02-22 15:11:09' disabled_choice_postback_status: false disallowed_ip: [] email: adv@gmail.com hash_password: e6277f0201b26c2c0bb5fcf8bdf25997 hide_conversion_status: false hosts_only: false id: 5b5f415035752723008b456a manager: 63f5ecb90ed3182eb3dba530 manager_obj: api_key: c40469ac42533296ac6c638f392b2ece avatar: null created_at: '2023-04-20 17:21:40' email: new-user@gmail.com facebook: facebook first_name: John id: 64413c649b70ab801d9b9a71 last_login_at: null last_name: Doe roles: - ROLE_ADMIN skype: skype telegram: telegram type: common_manager updated_at: '2023-04-20 17:21:40' username: 64413c649b70ab801d9b9a71 viber: viber wechat: wechat whatsapp: whatsapp work_hours: null note: null sign_clicks_integration: no_sign skad_network_id: [] skype: '456345345' sub_accounts: '1': except: false value: null '2': except: false value: null tags: [] title: Test supplier url: null vat_code: null zip_code: null affiliates_enabled: - id: 1 name: Affiliate affiliates_disabled: [] '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 \ --url 'https://api-demo.affise.com/3.0/admin/advertiser/{id}' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' post: tags: - admin-advertisers summary: Edit advertiser description: | `POST /3.0/admin/advertiser/{id}` Change an advertiser's data parameters: - name: api-key in: header description: API key required: true schema: type: string - name: id in: path description: Advertiser ID required: true schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: type: object properties: title: type: string description: Company name contact: type: string description: Contact person name skype: type: string description: IM/Skype manager: type: string description: Manager ID url: type: string description: Site Url email: type: string description: Email password: type: string description: 'Password: 8 or up to 30 characters with at least one uppercase, at least one lowercase, at least one numeric digit, at least one of the allowed special characters listed: _-!@*.$%?&#/|\~<>^{}[]():;' allowed_ip: type: string description: |- Allowed IP. Example: 127.0.0.1 127.0.1.1-127.0.2.1 note: type: string description: Note address_1: type: string description: Main address string address_2: type: string description: Additional address city: type: string description: City name country: type: string description: Country ISO name zip_code: type: string description: Zip code vat_code: type: string description: Vat code sub_account_1: type: string description: Sub1 list, separated by commas sub_account_2: type: string description: Sub2 list, separated by commas sub_account_1_except: type: integer description: Except Sub1 list enum: - 0 - 1 default: 0 sub_account_2_except: type: integer description: Except Sub2 list enum: - 0 - 1 default: 0 consider_personal_targeting_only: type: string enum: - 'true' - 'false' tags: type: array items: type: string description: An array of tags (All the previous tags will be overwritten by new ones) example: '0': tag1 '1': tag2 sign_clicks_integration: type: string enum: - no_sign - appsflyer - kochava description: Click Signature Service hash_password: type: string description: Secure postback code skad_network_id: type: array description: SkadNetwork ID. For multiple IDs, use `skad_network_id[1]`, `skad_network_id[2]`, etc. (All the IDs will be overwritten by new ones) items: type: string example: '0': string disabled_choice_postback_status: type: boolean description: 'Forbid the affiliates from changing the postback status (for all the offers of this advertiser): true or false' affiliates_enabled: type: array items: type: integer description: An array of Affiliate IDs affiliates_disabled: type: array items: type: integer description: An array of Affiliate IDs disallowed_ip: type: string description: |- Disallowed IP. Example: 127.0.0.1 127.0.1.1-127.0.2.1 logo: type: string description: Advertiser logo URL hide_conversion_status: type: boolean description: 'Hide conversion status from affiliates: true or false' sign_clicks_appsflyer_key: type: boolean description: 'Enable click signing: true or false' status: type: string enum: - active - inactive - moderation description: Advertiser status hosts_only: type: boolean description: 'Count statistics by unique clicks (hosts) only: true or false. Available when the hosts-only feature is enabled' subaccounts_encryption: type: boolean description: 'Enable sub-accounts encryption: true or false. Available when the sub-accounts encryption feature is enabled' host_uniqueness_number_unique_clicks: type: integer minimum: 1 maximum: 100 description: Host uniqueness — number of unique clicks (1-100) host_uniqueness_time_frame: type: integer minimum: 1 maximum: 48 description: Host uniqueness — time frame in hours (1-48) custom_fields: type: object description: 'Custom field values keyed by custom field ID. Send as `custom_fields[1]=value`; checkbox-type fields accept multiple values: `custom_fields[2][0]=value`' responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer advertiser: type: object example: status: 1 advertiser: address_1: address 1 address_2: address 2 allowed_ip: [] city: Lisbon consider_personal_targeting_only: true contact: John Doe country: PT created_at: '2023-04-17 11:32:06' updated_at: '2023-04-17 11:40:18' disallowed_ip: [] email: adv-test6@gmail.com hash_password: b5ecd86502e9bdfba8d1dc16444b4602 hide_conversion_status: false hosts_only: false id: 643cf5f6b49e5edafb231b40 manager: 5cd55442d596c1c7008b4567 manager_obj: api_key: c40469ac42533296ac6c638f392b2ece avatar: null created_at: '2023-04-20 17:21:40' email: new-user@gmail.com facebook: facebook first_name: John id: 64413c649b70ab801d9b9a71 last_login_at: null last_name: Doe roles: - ROLE_ADMIN skype: skype telegram: telegram type: common_manager updated_at: '2023-04-20 17:21:40' username: 64413c649b70ab801d9b9a71 viber: viber wechat: wechat whatsapp: whatsapp work_hours: null note: null sign_clicks_integration: no_sign skad_network_id: [] skype: '123123' sub_accounts: '1': except: false value: null '2': except: false value: null tags: - mobile title: Market Inc url: http://example.com vat_code: null zip_code: null disabled_choice_postback_status: true affiliates_enabled: - 1 - 2 affiliates_disabled: - 3 - 4 '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 POST \ --url 'https://api-demo.affise.com/3.0/admin/advertiser/{id}' \ --header 'api-key: ' \ --form 'title=string' \ --form 'contact=string' \ --form 'skype=string' \ --form 'manager=string' \ --form 'url=string' \ --form 'email=string' \ --form 'password=string' \ --form 'allowed_ip=string' \ --form 'note=string' \ --form 'address_1=string' \ --form 'address_2=string' \ --form 'city=string' \ --form 'country=string' \ --form 'zip_code=string' \ --form 'vat_code=string' \ --form 'sub_account_1=string' \ --form 'sub_account_2=string' \ --form 'sub_account_1_except=0' \ --form 'sub_account_2_except=0' \ --form 'consider_personal_targeting_only=true' \ --form 'tags[0]=tag1' \ --form 'tags[1]=tag2' \ --form 'sign_clicks_integration=no_sign' \ --form 'hash_password=string' \ --form 'skad_network_id[0]=string' \ --form 'disabled_choice_postback_status=false' \ --form 'affiliates_enabled[0]=0' \ --form 'affiliates_enabled[1]=1' \ --form 'affiliates_disabled[0]=0' \ --form 'affiliates_disabled[1]=1' \ --form 'disallowed_ip=string' \ --form 'logo=string' \ --form 'hide_conversion_status=false' \ --form 'sign_clicks_appsflyer_key=false' \ --form 'status=active' \ --form 'hosts_only=false' \ --form 'subaccounts_encryption=false' \ --form 'host_uniqueness_number_unique_clicks=0' \ --form 'host_uniqueness_time_frame=0' /3.0/admin/advertisers: get: tags: - admin-advertisers summary: Advertisers list description: | `GET /3.0/admin/advertisers` Get a list of advertisers parameters: - name: api-key in: header description: API key required: true schema: type: string - name: page in: query description: Page of entities schema: type: integer - name: limit in: query description: Limit of entities (max 500) schema: type: integer default: 100 maximum: 500 - name: order in: query description: Sort by field schema: type: string enum: - id - email - title - created_at - updated_at default: id - name: orderType in: query description: Sorting order schema: type: string enum: - desc - asc default: asc - name: updated_at in: query description: Get advertisers that have been updated from this date (format YYYY-MM-DD) schema: type: string format: date - name: with_offers in: query description: Show advertisers with offers schema: type: integer enum: - 1 - name: id[] in: query description: Filter by advertiser ID schema: type: array items: type: string - name: name in: query description: Filter by advertiser name schema: type: string - name: tags[] in: query description: Filter by tags schema: type: array items: type: string responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer advertisers: type: array items: type: object properties: id: type: string title: type: string contact: type: string email: type: string skype: type: string manager: type: string manager_obj: type: object url: type: string address_1: type: string address_2: type: string city: type: string country: type: string zip_code: type: string vat_code: type: string allowed_ip: type: array items: type: string disallowed_ip: type: array items: type: string consider_personal_targeting_only: type: boolean tags: type: array items: type: string hash_password: type: string skad_network_id: type: array items: type: string hide_conversion_status: type: boolean hosts_only: type: boolean sign_clicks_integration: type: string sub_accounts: type: object note: type: string offers: type: integer has_user: type: boolean created_at: type: string format: date-time updated_at: type: string format: date-time affiliates_enabled: type: array items: type: object properties: id: type: integer name: type: string affiliates_disabled: type: array items: type: object properties: id: type: integer name: type: string pagination: type: object properties: per_page: type: integer total_count: type: integer page: type: integer next_page: type: integer example: status: 1 advertisers: - address_1: Address 1 address_2: null allowed_ip: [] city: Berlin consider_personal_targeting_only: false contact: Samuel country: DE created_at: '2023-02-17 18:29:42' updated_at: '2023-02-17 18:29:42' disallowed_ip: [] email: adv@gmail.com has_user: false hash_password: null hide_conversion_status: false hosts_only: false id: 63ef8f56d05af8acc266ae09 manager: Sales Manager manager_obj: api_key: c40469ac42533296ac6c638f392b2ece avatar: null created_at: '2023-04-20 17:21:40' email: new-user@gmail.com facebook: facebook first_name: John id: 64413c649b70ab801d9b9a71 last_login_at: null last_name: Doe roles: - ROLE_ADMIN skype: skype telegram: telegram type: common_manager updated_at: '2023-04-20 17:21:40' username: 64413c649b70ab801d9b9a71 viber: viber wechat: wechat whatsapp: whatsapp work_hours: null sub_accounts: '1': except: false value: null '2': except: false value: null note: null offers: 0 sign_clicks_integration: no_sign skad_network_id: [] skype: '32543543' tags: [] title: Advertiser url: http://YOUR_API_DOMAIN vat_code: null zip_code: null affiliates_enabled: - id: 1 name: Affiliate affiliates_disabled: [] pagination: per_page: 100 total_count: 183 page: 1 next_page: 2 '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 \ --url 'https://api-demo.affise.com/3.0/admin/advertisers?limit=100&order=id&orderType=asc&with_offers=1&id[0]=string&id[1]=string2&tags[0]=string&tags[1]=string2' \ --header 'api-key: ' /3.0/admin/advertiser: post: tags: - admin-advertisers summary: Add advertiser description: | `POST /3.0/admin/advertiser` Add new advertiser parameters: - name: api-key in: header description: API key required: true schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: type: object properties: title: type: string description: Company name contact: type: string description: Contact person name skype: type: string description: IM/Skype manager: type: string description: Manager ID url: type: string description: Site Url email: type: string description: Email password: type: string description: 'Password: 8 or up to 30 characters with at least one uppercase, at least one lowercase, at least one numeric digit, at least one of the allowed special characters listed: _-!@*.$%?&#/|\~<>^{}[]():;' allowed_ip: type: string description: |- Allowed IP. Example: 127.0.0.1 127.0.1.1-127.0.2.1 address_1: type: string description: Main address string address_2: type: string description: Additional address city: type: string description: City name country: type: string description: Country ISO name zip_code: type: string description: Zip code vat_code: type: string description: Vat code sub_account_1: type: string description: Allowed sub1 values (only letters(a-z), numbers(0-9) and these symbols ,._-{}+=/:~) sub_account_2: type: string description: Allowed sub2 values (only letters(a-z), numbers(0-9) and these symbols ,._-{}+=/:~) sub_account_1_except: type: integer description: Block sub1 values enum: - 0 - 1 default: 0 sub_account_2_except: type: integer description: Block sub2 values enum: - 0 - 1 default: 0 consider_personal_targeting_only: type: string enum: - 'true' - 'false' tags: type: array items: type: string description: An array of advertiser's tags hash_password: type: string description: Secure postback code skad_network_id: type: array description: SkadNetwork ID. For multiple IDs, use `skad_network_id[1]`, `skad_network_id[2]`, etc. (All the IDs will be overwritten by new ones) items: type: string example: '0': string disabled_choice_postback_status: type: boolean description: 'Forbid the affiliates from changing the postback status (for all the offers of this advertiser): true or false' affiliates_enabled: type: array items: type: integer description: An array of Affiliate IDs affiliates_disabled: type: array items: type: integer description: An array of Affiliate IDs note: type: string description: Note disallowed_ip: type: string description: |- Disallowed IP. Example: 127.0.0.1 127.0.1.1-127.0.2.1 logo: type: string description: Advertiser logo URL hide_conversion_status: type: boolean description: 'Hide conversion status from affiliates: true or false' sign_clicks_appsflyer_key: type: boolean description: 'Enable click signing: true or false' sign_clicks_integration: type: string enum: - no_sign - appsflyer - kochava description: Click Signature Service. Besides the listed values, an AppsFlyer multi-account ID can be passed status: type: string enum: - active - inactive - moderation description: Advertiser status hosts_only: type: boolean description: 'Count statistics by unique clicks (hosts) only: true or false. Available when the hosts-only feature is enabled' subaccounts_encryption: type: boolean description: 'Enable sub-accounts encryption: true or false. Available when the sub-accounts encryption feature is enabled' host_uniqueness_number_unique_clicks: type: integer minimum: 1 maximum: 100 description: Host uniqueness — number of unique clicks (1-100) host_uniqueness_time_frame: type: integer minimum: 1 maximum: 48 description: Host uniqueness — time frame in hours (1-48) custom_fields: type: object description: 'Custom field values keyed by custom field ID. Send as `custom_fields[1]=value`; checkbox-type fields accept multiple values: `custom_fields[2][0]=value`' required: - title responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer advertiser: type: object example: status: 1 advertiser: address_1: address 1 address_2: address 2 allowed_ip: [] city: Lisbon consider_personal_targeting_only: true contact: John Doe country: PT created_at: '2023-04-17 11:32:06' updated_at: '2023-04-17 11:32:06' disallowed_ip: [] email: adv-test6@gmail.com hash_password: null hide_conversion_status: false hosts_only: false id: 643cf5f6b49e5edafb231b40 manager: 5cd55442d596c1c7008b4567 manager_obj: api_key: c40469ac42533296ac6c638f392b2ece avatar: null created_at: '2023-04-20 17:21:40' email: new-user@gmail.com facebook: facebook first_name: John id: 64413c649b70ab801d9b9a71 last_login_at: null last_name: Doe roles: - ROLE_ADMIN skype: skype telegram: telegram type: common_manager updated_at: '2023-04-20 17:21:40' username: 64413c649b70ab801d9b9a71 viber: viber wechat: wechat whatsapp: whatsapp work_hours: null note: null sign_clicks_integration: no_sign skad_network_id: [] skype: '456345345' sub_accounts: '1': except: false value: null '2': except: false value: null tags: - mobile title: Market Inc url: http://example.com vat_code: null zip_code: null disabled_choice_postback_status: true affiliates_enabled: - 1 - 2 affiliates_disabled: - 3 - 4 '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 POST \ --url 'https://api-demo.affise.com/3.0/admin/advertiser' \ --header 'api-key: ' \ --form 'title=string' \ --form 'contact=string' \ --form 'skype=string' \ --form 'manager=string' \ --form 'url=string' \ --form 'email=string' \ --form 'password=string' \ --form 'allowed_ip=string' \ --form 'address_1=string' \ --form 'address_2=string' \ --form 'city=string' \ --form 'country=string' \ --form 'zip_code=string' \ --form 'vat_code=string' \ --form 'sub_account_1=string' \ --form 'sub_account_2=string' \ --form 'sub_account_1_except=0' \ --form 'sub_account_2_except=0' \ --form 'consider_personal_targeting_only=true' \ --form 'tags[0]=string' \ --form 'tags[1]=string2' \ --form 'hash_password=string' \ --form 'skad_network_id[0]=string' \ --form 'disabled_choice_postback_status=false' \ --form 'affiliates_enabled[0]=0' \ --form 'affiliates_enabled[1]=1' \ --form 'affiliates_disabled[0]=0' \ --form 'affiliates_disabled[1]=1' \ --form 'note=string' \ --form 'disallowed_ip=string' \ --form 'logo=string' \ --form 'hide_conversion_status=false' \ --form 'sign_clicks_appsflyer_key=false' \ --form 'sign_clicks_integration=no_sign' \ --form 'status=active' \ --form 'hosts_only=false' \ --form 'subaccounts_encryption=false' \ --form 'host_uniqueness_number_unique_clicks=0' \ --form 'host_uniqueness_time_frame=0' /3.0/admin/advertiser/{id}/sendpass: post: tags: - admin-advertisers summary: Send password to advertiser description: | `POST /3.0/admin/advertiser/{id}/sendpass` Change an advertiser password and send it by email parameters: - name: api-key in: header description: API key required: true schema: type: string - name: id in: path description: Advertiser ID required: true schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: type: object properties: password: type: string description: 'Custom password to set and send instead of an auto-generated one. 8 or up to 30 characters with at least one uppercase, at least one lowercase, at least one numeric digit, at least one of the allowed special characters listed: _-!@*.$%?&#/|\~<>^{}[]():;' responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer message: type: string example: status: 1 message: Email send successfully '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 POST \ --url 'https://api-demo.affise.com/3.0/admin/advertiser/{id}/sendpass' \ --header 'api-key: ' \ --form 'password=string' /3.0/admin/advertiser/enable-affiliate: post: tags: - admin-advertisers summary: Advertisers enable affiliate description: | `POST /3.0/admin/advertiser/enable-affiliate` Un-put affiliate from blacklist for specified advertisers parameters: - name: api-key in: header description: API key required: true schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: type: object properties: advertisers_id: type: array items: type: string description: Advertiser ID array example: '0': string pid: type: integer description: affiliate ID required: - advertisers_id - pid responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer message: type: string example: status: 1 message: 'Request is successfully: Partner #610 doesn''t exist in blacklist for advertiser 56fce8ab3b7d9b95588b4568' '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 POST \ --url 'https://api-demo.affise.com/3.0/admin/advertiser/enable-affiliate' \ --header 'api-key: ' \ --form 'advertisers_id[0]=string' \ --form 'pid=0' /3.0/admin/advertiser/disable-affiliate: post: tags: - admin-advertisers summary: Advertisers disable affiliate description: | `POST /3.0/admin/advertiser/disable-affiliate` Put affiliate to blacklist for specified advertisers parameters: - name: api-key in: header description: API key required: true schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: type: object properties: advertisers_id: type: array items: type: string description: Advertiser ID array example: '0': string pid: type: integer description: affiliate ID required: - advertisers_id - pid responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer message: type: string example: status: 1 message: Request is successfully '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 POST \ --url 'https://api-demo.affise.com/3.0/admin/advertiser/disable-affiliate' \ --header 'api-key: ' \ --form 'advertisers_id[0]=string' \ --form 'pid=0' /3.0/admin/partners: get: tags: - admin-affiliates summary: Affiliate list description: | `GET /3.0/admin/partners` Get list of partners parameters: - name: api-key in: header description: API key required: true schema: type: string - name: id in: query description: Search by affiliate IDs schema: type: array items: type: integer example: id[0]: 2 - name: with_balance in: query description: Show partners with balance schema: type: integer enum: - 1 - name: limit in: query description: Limit of entities (max 500) schema: type: integer default: 50 maximum: 500 - name: page in: query description: Page of entities schema: type: integer - name: updated_at in: query description: Get partners that have been updated from this date (format YYYY-MM-DD) schema: type: string format: date - name: status in: query description: Filter by status schema: type: string enum: - active - banned - on moderation - not active - name: search in: query description: Search by affiliate email, login or name schema: type: string - name: manager in: query description: Filter by manager IDs schema: type: array items: type: string example: manager[0]: 5cd5fcced596c1280b3b6477 - name: field in: query description: Filter by custom field values schema: type: array items: type: string example: field[0]: skype_name - name: order in: query description: Sort by field. Prefix the value with "-" for descending order schema: type: string enum: - id - '-id' - _id - '-_id' - created_at - '-created_at' - updated_at - '-updated_at' - name: orderType in: query description: Sorting order for the "order" field schema: type: string enum: - asc - desc responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer partners: type: array items: type: object properties: id: type: integer created_at: type: string format: date-time updated_at: type: string format: date-time email: type: string login: type: string contactPerson: type: string ref_percent: type: string name: type: string notes: type: string manager: type: object status: type: string payment_systems: type: array items: type: object customFields: type: array items: type: object balance: type: object offersCount: type: integer api_key: type: string tags: type: array items: type: string lang: type: string pagination: type: object properties: per_page: type: integer total_count: type: integer page: type: integer next_page: type: integer example: status: 1 partners: - id: 5 created_at: '2019-07-16 16:55:45' updated_at: '2019-07-16 16:55:45' email: login@gmail.com login: treva.jones ref_percent: '2' name: null notes: note status: active payment_systems: - id: 10895 active: 0 system: Webmoney WMR fields: '1': ... customFields: - name: Skype value: '1' label: '1' id: 1 - name: .... value: '2' label: '2' id: 2 - name: ... value: '3' label: '3' id: 3 - name: ... value: '9' label: '9' id: 15 balance: CNY: balance: 0 hold: 0 available: 0 USD: balance: 0 hold: 0 available: 0 EUR: balance: 0 hold: 0 available: 0 BTC: balance: 0 hold: 0 available: 0 offersCount: 0 api_key: eff64a90010faabc92f845a7969a618986478993 address_1: null address_2: null city: null country: null zip_code: null phone: null ref: '2' lang: es sub_accounts: '1': value: sub1 except: 0 '2': value: sub2 except: 1 contactPerson: null pagination: per_page: 1 total_count: 9253 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 \ --url 'https://api-demo.affise.com/3.0/admin/partners?id[0]=2&with_balance=1&limit=50&status=active&manager[0]=5cd5fcced596c1280b3b6477&field[0]=skype_name&order=id&orderType=asc' \ --header 'api-key: ' /3.0/admin/partner: post: tags: - admin-affiliates summary: New affiliate description: | `POST /3.0/admin/partner` Add new partner parameters: - name: api-key in: header description: API key required: true schema: type: string requestBody: content: multipart/form-data: schema: type: object properties: email: type: string description: Partners e-mail password: type: string description: Partners password country: type: string description: Country ISO name login: type: string description: Company name contact_person: type: string description: Contact person ref_percent: type: string description: Percentage of referral program notes: type: string description: Notes status: type: string enum: - not active - active - banned - on moderation description: Partners status manager_id: type: string description: Manager id payment_systems: type: array items: type: object properties: system_id: type: integer description: Integer ID of partners systems currency: type: string description: String the currency code fields: type: object description: Advanced fields where key is ID from /3.0/admin/payment_systems additionalProperties: type: string description: Array[object] - An array of payments (See PaymentSystems structure and /3.0/admin/payment_systems endpoint). Use form-encoded parameters below for actual implementation. custom_fields: type: array items: type: string example: '0': field1 description: An array of custom fields ref: type: integer description: Referral partner sub_account_1: type: string description: Sub1 list, separated by commas sub_account_2: type: string description: Sub2 list, separated by commas sub_account_1_except: type: integer enum: - 0 - 1 default: 0 description: Except Sub1 list sub_account_2_except: type: integer enum: - 0 - 1 default: 0 description: Except Sub2 list notify: type: integer enum: - 0 - 1 default: 0 description: Send welcome email to affiliate (login field should be set) tipalti_payee_id: type: integer description: Tipalti Payee ID tags: type: array items: type: string description: An array of affiliates' tags example: '0': tag1 '1': tag2 enabledOffers: type: array items: type: integer description: An array of offer IDs disabledOffers: type: array items: type: integer description: An array of offer IDs enabledAdvertisers: type: array items: type: string description: An array of advertiser IDs disabledAdvertisers: type: array items: type: string description: An array of advertiser IDs enabledSmartlinks: type: array items: type: string description: An array of smartlink IDs disabledSmartlinks: type: array items: type: string description: An array of smartlink IDs level: type: integer enum: - 0 - 1 - 2 - 3 - 4 - 5 description: Affiliate level default_postback: type: string description: Default postback URL. Available when postback autofill is enabled on the network affiliate_trafficback_url: type: string description: Affiliate trafficback URL. Available when the affiliate trafficback URL feature is enabled on the network subaccount_id: type: integer description: Sub-account ID required: - email - password - country responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer partner: type: object id: type: integer example: status: 1 partner: id: 5 created_at: '2019-07-16 16:55:45' updated_at: '2019-07-16 16:55:45' email: login@gmail.com login: treva.jones ref_percent: '2' name: null notes: note status: active manager: api_key: d6659d76dcce6857a118e2e9890518be avatar: null created_at: '2023-04-20 18:20:29' email: new-user@gmail.com facebook: facebook first_name: John id: 64414a2d9b70ab801d9b9a72 last_login_at: null last_name: Doe roles: - ROLE_MANAGER_AFFILIATE skype: skype telegram: telegram type: affiliate_manager updated_at: '2023-04-20 18:20:29' username: 64414a2d9b70ab801d9b9a72 viber: viber wechat: wechat whatsapp: whatsapp work_hours: null payment_systems: - id: 10895 active: 0 system: Webmoney WMR fields: '1': ... customFields: - name: Skype value: '1' label: '1' id: 1 - name: .... value: '2' label: '2' id: 2 - name: ... value: '3' label: '3' id: 3 - name: ... value: '9' label: '9' id: 15 balance: CNY: balance: 0 hold: 0 available: 0 USD: balance: 0 hold: 0 available: 0 EUR: balance: 0 hold: 0 available: 0 BTC: balance: 0 hold: 0 available: 0 offersCount: 0 api_key: eff64a90010faabc92f845a7969a618986478993 address_1: null address_2: null city: null country: null zip_code: null phone": null ref: '2' lang: es sub_accounts: '1': value: sub1 except: 0 '2': value: sub2 except: 1 contactPerson: null '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '500': $ref: '#/components/responses/InternalServerError' x-codeSamples: - lang: cURL label: cURL source: |- curl --request POST \ --url 'https://api-demo.affise.com/3.0/admin/partner' \ --header 'api-key: ' \ --form 'email=string' \ --form 'password=string' \ --form 'country=string' \ --form 'login=string' \ --form 'contact_person=string' \ --form 'ref_percent=string' \ --form 'notes=string' \ --form 'status=not active' \ --form 'manager_id=string' \ --form 'payment_systems[0][system_id]=0' \ --form 'payment_systems[0][currency]=string' \ --form 'custom_fields[0]=field1' \ --form 'ref=0' \ --form 'sub_account_1=string' \ --form 'sub_account_2=string' \ --form 'sub_account_1_except=0' \ --form 'sub_account_2_except=0' \ --form 'notify=0' \ --form 'tipalti_payee_id=0' \ --form 'tags[0]=tag1' \ --form 'tags[1]=tag2' \ --form 'enabledOffers[0]=0' \ --form 'enabledOffers[1]=1' \ --form 'disabledOffers[0]=0' \ --form 'disabledOffers[1]=1' \ --form 'enabledAdvertisers[0]=string' \ --form 'enabledAdvertisers[1]=string2' \ --form 'disabledAdvertisers[0]=string' \ --form 'disabledAdvertisers[1]=string2' \ --form 'enabledSmartlinks[0]=string' \ --form 'enabledSmartlinks[1]=string2' \ --form 'disabledSmartlinks[0]=string' \ --form 'disabledSmartlinks[1]=string2' \ --form 'level=0' \ --form 'default_postback=string' \ --form 'affiliate_trafficback_url=string' \ --form 'subaccount_id=0' /3.0/admin/partner/{id}: get: tags: - admin-affiliates summary: Get affiliate description: | `GET /3.0/admin/partner/{id}` Get affiliate by ID parameters: - name: api-key in: header description: API key required: true schema: type: string - name: id in: path description: Affiliate ID required: true schema: type: integer responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer partner: type: object properties: id: type: integer created_at: type: string format: date-time updated_at: type: string format: date-time email: type: string login: type: string contactPerson: type: string ref_percent: type: string name: type: string notes: type: string manager: type: object status: type: string enum: - active - banned - on moderation - not active payment_systems: type: array items: type: object properties: id: type: integer active: type: integer system: type: string fields: type: object customFields: type: array items: type: object properties: name: type: string value: type: string label: type: string id: type: integer balance: type: object additionalProperties: type: object properties: balance: type: number hold: type: number available: type: number offersCount: type: integer api_key: type: string address_1: type: string address_2: type: string city: type: string country: type: string zip_code: type: string phone: type: string work_hours: type: string created_by: type: object updated_by: type: object tipalti_payee_id: type: string ref: type: string sub_accounts: type: array items: type: object properties: value: type: string except: type: integer tags: type: array items: type: object properties: id: type: integer name: type: string level: type: integer tipalti_status: type: string lang: type: string example: status: 1 partner: id: 5 created_at: '2021-05-15T04:07:42.834Z' updated_at: '2021-09-08T20:11:15.000Z' email: partner@affise.com login: partner contactPerson: null ref_percent: null name: name notes: notes manager: null status: active payment_systems: - id: 1 active: 1 system: bank fields: banknumber: 555-666888888 - id: 5 active: 0 system: webmoney fields: usd: Z166558469854 customFields: - name: nickname value: Alias label: Nickname id: 1 balance: USD: balance: 13.66 hold: 0 available: 13.66 EUR: balance: 5.74 hold: 1 available: 4.74 offersCount: 1 api_key: 685168e94e6a96fa7c31895e address_1: 123 Main St address_2: '' city: Some City country: US zip_code: '12345' phone: null work_hours: 8-17 created_by: null updated_by: null tipalti_payee_id: 55555-55555-55555 ref: ref sub_accounts: - value: sub except: 1 tags: - id: 4 name: test level: 2 tipalti_status: COMPLETED lang: es '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 \ --url 'https://api-demo.affise.com/3.0/admin/partner/{id}' \ --header 'api-key: ' post: tags: - admin-affiliates summary: Edit affiliate description: | `POST /3.0/admin/partner/{id}` Edit a partner parameters: - name: api-key in: header description: API key required: true schema: type: string - name: id in: path description: Affiliate ID required: true schema: type: integer requestBody: content: multipart/form-data: schema: type: object properties: password: type: string description: Partners password email: type: string description: Partners email login: type: string description: Company name country: type: string description: Country ISO name contact_person: type: string description: Contact person ref_percent: type: string description: Percentage of referral program notes: type: string description: Notes status: type: string enum: - '' - not active - active - banned - on moderation description: Partners status manager_id: type: string description: Manager id payment_systems: type: array items: type: object description: An array of payments (See the add affiliate method and /admin/payment_systems) custom_fields: type: array items: type: string description: An array of custom fields (See /admin/custom_fields) ref: type: integer description: Referral partner sub_account_1: type: string description: Sub1 list, separated by commas sub_account_2: type: string description: Sub2 list, separated by commas sub_account_1_except: type: integer enum: - 0 - 1 default: 0 description: Except Sub1 list sub_account_2_except: type: integer enum: - 0 - 1 default: 0 description: Except Sub2 list tipalti_payee_id: type: integer description: Tipalti Payee ID tags: type: array items: type: string description: An array of tags (Tags will be added to the existing) example: '0': tag1 enabledOffers: type: array items: type: integer description: An array of offer IDs disabledOffers: type: array items: type: integer description: An array of offer IDs enabledAdvertisers: type: array items: type: string description: An array of advertiser IDs example: '0': 64414a2d9b70ab801d9b9a00 disabledAdvertisers: type: array items: type: string description: An array of advertiser IDs example: '0': 64414a2d9b70ab801d9b9a72 enabledSmartlinks: type: array items: type: string description: An array of smartlink IDs example: '0': 64414a2d9b44ab801d9b9a72 disabledSmartlinks: type: array items: type: string description: An array of smartlink IDs example: '0': 64414a2d9b70ab801d9b9a23 level: type: integer enum: - 0 - 1 - 2 - 3 - 4 - 5 description: Affiliate level default_postback: type: string description: Default postback URL. Available when postback autofill is enabled on the network affiliate_trafficback_url: type: string description: Affiliate trafficback URL. Available when the affiliate trafficback URL feature is enabled on the network subaccount_id: type: integer description: Sub-account ID responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer partner: type: object id: type: integer example: status: 1 partner: id: 5 created_at: '2019-07-16 16:55:45' updated_at: '2019-07-16 17:17:05' email: login@gmail.com login: dima.ivanov ref_percent: '2' name: null notes: note manager: api_key: d6659d76dcce6857a118e2e9890518be avatar: null created_at: '2023-04-20 18:20:29' email: new-user@gmail.com facebook: facebook first_name: John id: 64414a2d9b70ab801d9b9a72 last_login_at: null last_name: Doe roles: - ROLE_MANAGER_AFFILIATE skype: skype telegram: telegram type: affiliate_manager updated_at: '2023-04-20 18:20:29' username: 64414a2d9b70ab801d9b9a72 viber: viber wechat: wechat whatsapp: whatsapp work_hours: null status: active payment_systems: - id: 3 active: 0 system: Webmoney fields: '1': BA731035962466786892 '2': PK83DELLCTnbVB5RMU5TL1X4 - id: 4 active: 0 system: Webmoney fields: '1': BA731035962466786892 '2': PK83DELLCTnbVB5RMU5TL1X4 customFields: - name: Skype value: skype label: skype id: 1 balance: USD: balance: 0 hold: 0 available: 0 EUR: balance: 0 hold: 0 available: 0 BTC: balance: 0 hold: 0 available: 0 offersCount: 0 api_key: eff64a90010faabc92f845a7969a618986478993 address_1: null address_2: null city: null country: null zip_code: null phone: null ref: '2' sub_accounts: '1': value: sub1 except: 0 '2': value: sub2 except: 1 lang: es contactPerson: null '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '500': $ref: '#/components/responses/InternalServerError' x-codeSamples: - lang: cURL label: cURL source: |- curl --request POST \ --url 'https://api-demo.affise.com/3.0/admin/partner/{id}' \ --header 'api-key: ' \ --form 'password=string' \ --form 'email=string' \ --form 'login=string' \ --form 'country=string' \ --form 'contact_person=string' \ --form 'ref_percent=string' \ --form 'notes=string' \ --form 'status=' \ --form 'manager_id=string' \ --form 'custom_fields[0]=string' \ --form 'custom_fields[1]=string2' \ --form 'ref=0' \ --form 'sub_account_1=string' \ --form 'sub_account_2=string' \ --form 'sub_account_1_except=0' \ --form 'sub_account_2_except=0' \ --form 'tipalti_payee_id=0' \ --form 'tags[0]=tag1' \ --form 'enabledOffers[0]=0' \ --form 'enabledOffers[1]=1' \ --form 'disabledOffers[0]=0' \ --form 'disabledOffers[1]=1' \ --form 'enabledAdvertisers[0]=64414a2d9b70ab801d9b9a00' \ --form 'disabledAdvertisers[0]=64414a2d9b70ab801d9b9a72' \ --form 'enabledSmartlinks[0]=64414a2d9b44ab801d9b9a72' \ --form 'disabledSmartlinks[0]=64414a2d9b70ab801d9b9a23' \ --form 'level=0' \ --form 'default_postback=string' \ --form 'affiliate_trafficback_url=string' \ --form 'subaccount_id=0' /3.0/admin/partners/mass-update: post: tags: - admin-affiliates summary: Mass update description: | `POST /3.0/admin/partners/mass-update` Update status and manager parameters: - name: api-key in: header description: API key required: true schema: type: string example: 23df424b0a53b0899f78685966243ee61 requestBody: content: multipart/form-data: schema: type: object properties: id: type: array items: type: integer description: Affiliate IDs manager_id: type: string description: Manager ID example: 5ce558efd596c1e4008b4569 status: type: string enum: - not active - active - banned - on moderation description: Status required: - id responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer example: status: 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 POST \ --url 'https://api-demo.affise.com/3.0/admin/partners/mass-update' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' \ --form 'id[0]=0' \ --form 'id[1]=1' \ --form 'manager_id=5ce558efd596c1e4008b4569' \ --form 'status=not active' /3.0/admin/partner/password/{id}: post: tags: - admin-affiliates summary: Change affiliate password description: | `POST /3.0/admin/partner/password/{id}` Change a partner's password parameters: - name: api-key in: header description: API key required: true schema: type: string example: 23df424b0a53b0899f78685966243ee61 - name: id in: path description: Affiliate ID required: true schema: type: integer responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer partner: type: object properties: id: type: integer password: type: string example: status: 1 partner: id: 10117 password: 5947c33371 '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '500': $ref: '#/components/responses/InternalServerError' x-codeSamples: - lang: cURL label: cURL source: |- curl --request POST \ --url 'https://api-demo.affise.com/3.0/admin/partner/password/{id}' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' /3.0/admin/postbacks: get: tags: - affiliate-postbacks summary: Affiliate postbacks list description: | `GET /3.0/admin/postbacks` Get a list of partner postbacks parameters: - name: api-key in: header description: API key required: true schema: type: string - name: partner_id in: query description: Partner ID required: true schema: type: integer - name: limit in: query description: Limit of entities (max 500) schema: type: integer default: 100 maximum: 500 - name: page in: query description: Page of entities schema: type: integer - name: offer_ids in: query description: Filter by offer IDs schema: type: array items: type: integer example: offer_ids[0]: 906 - name: after_id in: query description: Show postbacks with ID greater than the specified one (cursor-style pagination) schema: type: integer - name: only_global in: query description: Show only global postbacks (not bound to a specific offer) schema: type: integer enum: - 0 - 1 - name: verbose in: query description: Return extended postback information schema: type: integer enum: - 0 - 1 responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer postbacks: type: array items: type: object properties: id: type: integer url: type: string offer_id: type: string status: type: string goal: type: string created: type: string format: date-time forced: type: string integration_method: type: string pagination: type: object properties: per_page: type: integer total_count: type: integer page: type: integer example: status: 1 postbacks: - id: 8 url: http://... offer_id: null status: pending goal: '' created: '2018-01-30 18:31:52' forced: '0' integration_method: all - id: 22 url: http://... offer_id: '17' status: null goal: '' created: '2018-05-14 12:39:51' forced: '0' integration_method: all pagination: per_page: 100 total_count: 4 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 \ --url 'https://api-demo.affise.com/3.0/admin/postbacks?partner_id=&limit=100&offer_ids[0]=906&only_global=0&verbose=0' \ --header 'api-key: ' /3.0/admin/partner/{id}/locale: post: tags: - admin-affiliates summary: Update partner locale description: | `POST /3.0/admin/partner/{id}/locale` Update a partner's locale parameters: - name: api-key in: header description: API key required: true schema: type: string - name: id in: path description: Partner ID required: true schema: type: integer requestBody: content: multipart/form-data: schema: type: object properties: lang: type: string description: Language timezone: type: string description: Timezone responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer message: type: string example: status: 1 message: Updated successfully '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '500': $ref: '#/components/responses/InternalServerError' x-codeSamples: - lang: cURL label: cURL source: |- curl --request POST \ --url 'https://api-demo.affise.com/3.0/admin/partner/{id}/locale' \ --header 'api-key: ' \ --form 'lang=string' \ --form 'timezone=string' /3.1/partner/auth: post: tags: - admin-affiliates summary: Check affiliate login credentials description: | `POST /3.1/partner/auth` Check affiliate login credentials (Can be used for build custom affiliate panel) parameters: - name: api-key in: header description: API key required: true schema: type: string requestBody: content: multipart/form-data: schema: type: object properties: email: type: string description: Email affiliate password: type: string description: Password affiliate required: - email - password responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer url: type: string affiliate: type: object properties: id: type: integer email: type: string status: type: string example: status: 1 url: http://YOUR_WEBMASTER_URL/autologin?hash=**** affiliate: id: 999 email: test@test.com status: active '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '500': $ref: '#/components/responses/InternalServerError' x-codeSamples: - lang: cURL label: cURL source: |- curl --request POST \ --url 'https://api-demo.affise.com/3.1/partner/auth' \ --header 'api-key: ' \ --form 'email=string' \ --form 'password=string' /3.0/admin/conversion/edit: post: tags: - admin-conversions summary: Edit conversion description: | `POST /3.0/admin/conversion/edit` Edit a conversion parameters: - name: api-key in: header description: API key required: true example: 23df424b0a53b0899f78685966243ee61 schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: type: object properties: ids: type: array items: type: string example: '0': 59359e1d7e28feb7568b456a description: Conversion IDs status: type: string enum: - confirmed - pending - declined - hold description: Conversion status currency: type: string description: Currency code (example usd) example: USD payouts: type: integer description: Payouts amount revenue: type: integer description: Revenue amount comment: type: string description: Text comment sum: type: number format: float description: Sum amount custom_field_1: type: string description: Custom field 1 custom_field_2: type: string description: Custom field 2 custom_field_3: type: string description: Custom field 3 custom_field_4: type: string description: Custom field 4 custom_field_5: type: string description: Custom field 5 custom_field_6: type: string description: Custom field 6 custom_field_7: type: string description: Custom field 7 custom_field_8: type: string description: Custom field 8 custom_field_9: type: string description: Custom field 9 custom_field_10: type: string description: Custom field 10 custom_field_11: type: string description: Custom field 11 custom_field_12: type: string description: Custom field 12 custom_field_13: type: string description: Custom field 13 custom_field_14: type: string description: Custom field 14 custom_field_15: type: string description: Custom field 15 all: type: integer enum: - 0 - 1 description: If set to 1, the edit is applied to all conversions matching the filters passed in `params` (batch edit by filter) instead of the conversions listed in `ids`. Requires non-empty `params` with `params[date_from]` and `params[date_to]` set. params: type: object description: 'Filters that select the conversions to edit when `all=1` (passed in bracket notation, e.g. `params[date_from]=2026-06-01`). `params[date_from]` and `params[date_to]` are required when `all=1`. Supports the same filters as the conversions list: `date_from`, `date_to`, `timezone`, `status`, `offer[]`, `advertiser[]`, `partner[]`, `country`, `goal[]`, `currency`, `payment_status[]`, `action_id`, `clickid`, `decline_reason`, `fraud_risk_level`, `fraud_type[]`, `browser`, `os[]`, `device[]`, `payouts_from`, `payouts_to`, `revenue_from`, `revenue_to`, `update_from_date`, `update_from_hour`, `update_to_date`, `update_to_hour`, `user_id[]`, `affiliate_manager_id[]`, `advertiser_manager_id[]`, `invoice_id[]`.' example: date_from: '2026-06-01' date_to: '2026-06-10' status: pending required: - ids responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer data: type: object properties: ids: type: array items: type: string status: type: string currency: type: string payouts: type: integer revenue: type: integer message: type: string example: status: 1 data: ids: - 59359e1d7e28feb7568b456a status: confirmed currency: USD payouts: null revenue: null message: Conversion changes will take a few minutes '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '500': $ref: '#/components/responses/InternalServerError' x-codeSamples: - lang: cURL label: cURL source: |- curl --request POST \ --url 'https://api-demo.affise.com/3.0/admin/conversion/edit' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' \ --form 'ids[0]=59359e1d7e28feb7568b456a' \ --form 'status=confirmed' \ --form 'currency=USD' \ --form 'payouts=0' \ --form 'revenue=0' \ --form 'comment=string' \ --form 'sum=0' \ --form 'custom_field_1=string' \ --form 'custom_field_2=string' \ --form 'custom_field_3=string' \ --form 'custom_field_4=string' \ --form 'custom_field_5=string' \ --form 'custom_field_6=string' \ --form 'custom_field_7=string' \ --form 'custom_field_8=string' \ --form 'custom_field_9=string' \ --form 'custom_field_10=string' \ --form 'custom_field_11=string' \ --form 'custom_field_12=string' \ --form 'custom_field_13=string' \ --form 'custom_field_14=string' \ --form 'custom_field_15=string' \ --form 'all=0' \ --form 'params[date_from]=2026-06-01' \ --form 'params[date_to]=2026-06-10' \ --form 'params[status]=pending' /3.0/admin/conversion/edit-by-advertiser: post: tags: - admin-conversions summary: Edit conversions by advertiser description: | `POST /3.0/admin/conversion/edit-by-advertiser` Edit multiple conversions with advertiser ownership validation. All specified conversions must belong to the given advertiser. parameters: - name: api-key in: header description: API key required: true example: 23df424b0a53b0899f78685966243ee61 schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: type: object properties: ids: type: array items: type: string maxItems: 2000 example: '0': 59359e1d7e28feb7568b456a description: Conversion IDs (max 2000) advertiser_id: type: string description: Advertiser ID. All specified conversions must belong to this advertiser. example: 56cc49dc3b7d9b89058b45f0 status: type: string enum: - confirmed - pending - declined - hold description: Conversion status currency: type: string description: Currency code (example usd) example: USD payouts: type: integer description: Payouts amount revenue: type: integer description: Revenue amount comment: type: string description: Text comment sum: type: number format: float description: Sum amount custom_field_1: type: string description: Custom field 1 custom_field_2: type: string description: Custom field 2 custom_field_3: type: string description: Custom field 3 custom_field_4: type: string description: Custom field 4 custom_field_5: type: string description: Custom field 5 custom_field_6: type: string description: Custom field 6 custom_field_7: type: string description: Custom field 7 custom_field_8: type: string description: Custom field 8 custom_field_9: type: string description: Custom field 9 custom_field_10: type: string description: Custom field 10 custom_field_11: type: string description: Custom field 11 custom_field_12: type: string description: Custom field 12 custom_field_13: type: string description: Custom field 13 custom_field_14: type: string description: Custom field 14 custom_field_15: type: string description: Custom field 15 required: - ids - advertiser_id responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer data: type: object properties: ids: type: array items: type: string status: type: string currency: type: string payouts: type: integer revenue: type: integer message: type: string example: status: 1 data: ids: - 59359e1d7e28feb7568b456a status: confirmed currency: USD payouts: null revenue: null message: Conversion changes will take a few minutes '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '500': $ref: '#/components/responses/InternalServerError' x-codeSamples: - lang: cURL label: cURL source: |- curl --request POST \ --url 'https://api-demo.affise.com/3.0/admin/conversion/edit-by-advertiser' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' \ --form 'ids[0]=59359e1d7e28feb7568b456a' \ --form 'advertiser_id=56cc49dc3b7d9b89058b45f0' \ --form 'status=confirmed' \ --form 'currency=USD' \ --form 'payouts=0' \ --form 'revenue=0' \ --form 'comment=string' \ --form 'sum=0' \ --form 'custom_field_1=string' \ --form 'custom_field_2=string' \ --form 'custom_field_3=string' \ --form 'custom_field_4=string' \ --form 'custom_field_5=string' \ --form 'custom_field_6=string' \ --form 'custom_field_7=string' \ --form 'custom_field_8=string' \ --form 'custom_field_9=string' \ --form 'custom_field_10=string' \ --form 'custom_field_11=string' \ --form 'custom_field_12=string' \ --form 'custom_field_13=string' \ --form 'custom_field_14=string' \ --form 'custom_field_15=string' /3.0/admin/conversion/import: post: tags: - admin-conversions summary: Import single conversion description: | `POST /3.0/admin/conversion/import` Import a single conversion parameters: - name: api-key in: header description: API key required: true example: 23df424b0a53b0899f78685966243ee61 schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: type: object properties: offer: type: integer description: Offer id pid: type: integer description: Partner id action_id: type: string description: Advertiser conversion id click_id: type: string description: Click ID goal: type: integer description: Goal number ip: type: string description: Visitor IP ua: type: string description: Visitor user-agent comment: type: string description: Comment sum: type: integer description: Payouts amount for conversion (for percent payment type only) status: type: string enum: - confirmed - pending - declined - hold description: Conversion status custom_field_1: type: string description: Custom field 1 custom_field_2: type: string description: Custom field 2 custom_field_3: type: string description: Custom field 3 custom_field_4: type: string description: Custom field 4 custom_field_5: type: string description: Custom field 5 custom_field_6: type: string description: Custom field 6 custom_field_7: type: string description: Custom field 7 created_at: type: string format: date description: Created at (YYYY-MM-DD not later than 2 month from now, default now) send_affiliate_postbacks: type: integer emum: - 0 - 1 default: 0 description: If true conversion affiliate postback will be sent required: - offer - pid responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer data: type: object properties: offer: type: integer pid: type: integer action_id: type: string goal: type: integer ip: type: string ua: type: string sum: type: integer comment: type: string message: type: string example: status: 1 data: offer: 1000 pid: 500 action_id: null goal: null ip: null ua: null sum: null comment: null message: Conversion import will take a few minutes '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '500': $ref: '#/components/responses/InternalServerError' x-codeSamples: - lang: cURL label: cURL source: |- curl --request POST \ --url 'https://api-demo.affise.com/3.0/admin/conversion/import' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' \ --form 'offer=0' \ --form 'pid=0' \ --form 'action_id=string' \ --form 'click_id=string' \ --form 'goal=0' \ --form 'ip=string' \ --form 'ua=string' \ --form 'comment=string' \ --form 'sum=0' \ --form 'status=confirmed' \ --form 'custom_field_1=string' \ --form 'custom_field_2=string' \ --form 'custom_field_3=string' \ --form 'custom_field_4=string' \ --form 'custom_field_5=string' \ --form 'custom_field_6=string' \ --form 'custom_field_7=string' \ --form 'created_at=string' \ --form 'send_affiliate_postbacks=0' /3.0/admin/conversions/import: post: tags: - admin-conversions summary: Import multiple conversions description: | `POST /3.0/admin/conversions/import` Import multiple conversions parameters: - name: api-key in: header description: API key required: true example: 23df424b0a53b0899f78685966243ee61 schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: type: object properties: list: type: array items: type: object properties: offer: type: integer description: Offer id pid: type: integer description: Partner id action_id: type: string description: Advertiser conversion id click_id: type: string description: Click ID goal: type: integer description: Goal number ip: type: string description: Visitor IP ua: type: string description: Visitor user-agent comment: type: string description: Comment sum: type: integer description: Payouts amount for conversion (for percent payment type only) status: type: string enum: - confirmed - pending - declined - hold - pending_cap description: Conversion status custom_field_1: type: string description: Custom field 1 custom_field_2: type: string description: Custom field 2 custom_field_3: type: string description: Custom field 3 custom_field_4: type: string description: Custom field 4 custom_field_5: type: string description: Custom field 5 custom_field_6: type: string description: Custom field 6 custom_field_7: type: string description: Custom field 7 created_at: type: string format: date description: Created at (YYYY-MM-DD not later than 2 month from now, default now) required: - offer - pid description: List of conversions to import send_affiliate_postbacks: type: integer enum: - 0 - 1 default: 0 description: If 1 conversion affiliate postback will be sent required: - list responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer data: type: object properties: list: type: array items: type: object properties: offer: type: integer pid: type: integer action_id: type: string goal: type: integer ip: type: string ua: type: string sum: type: integer comment: type: string message: type: string example: status: 1 data: list: - offer: 1000 pid: 500 action_id: null goal: null ip: null ua: null sum: null comment: null message: Conversion import will take a few minutes '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '500': $ref: '#/components/responses/InternalServerError' x-codeSamples: - lang: cURL label: cURL source: |- curl --request POST \ --url 'https://api-demo.affise.com/3.0/admin/conversions/import' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' \ --form 'list[0][offer]=0' \ --form 'list[0][pid]=0' \ --form 'list[0][action_id]=string' \ --form 'list[0][click_id]=string' \ --form 'list[0][goal]=0' \ --form 'list[0][ip]=string' \ --form 'list[0][ua]=string' \ --form 'list[0][comment]=string' \ --form 'list[0][sum]=0' \ --form 'list[0][status]=confirmed' \ --form 'list[0][custom_field_1]=string' \ --form 'list[0][custom_field_2]=string' \ --form 'list[0][custom_field_3]=string' \ --form 'list[0][custom_field_4]=string' \ --form 'list[0][custom_field_5]=string' \ --form 'list[0][custom_field_6]=string' \ --form 'list[0][custom_field_7]=string' \ --form 'list[0][created_at]=string' \ --form 'send_affiliate_postbacks=0' /3.0/admin/users: get: tags: - admin-users summary: Users list description: | `GET /3.0/admin/users` Get a list of users parameters: - name: api-key in: header description: API key example: 23df424b0a53b0899f78685966243ee61 required: true schema: type: string - name: page in: query description: Page of entities schema: type: integer - name: limit in: query description: Limit of entities (max 500) schema: type: integer default: 100 maximum: 500 - name: updated_at in: query description: Get users that have been updated from this date (format YYYY-MM-DD) schema: type: string format: date - name: q in: query description: Search query schema: type: string responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer users: type: array items: type: object properties: id: type: string api_key: type: string avatar: type: string created_at: type: string format: date-time email: type: string facebook: type: string viber: type: string wechat: type: string whatsapp: type: string skype: type: string telegram: type: string first_name: type: string last_name: type: string last_login_at: type: string format: date-time roles: type: array items: type: string type: type: string enum: - common_manager - affiliate_manager - account_manager updated_at: type: string format: date-time username: type: string work_hours: type: string pagination: type: object properties: per_page: type: integer total_count: type: integer page: type: integer example: status: 1 users: - id: 64413c649b70ab801d9b9a71 api_key: c40469ac42533296ac6c638f392b2ece avatar: null created_at: '2023-04-20 17:21:40' email: new-user@gmail.com facebook: facebook viber: viber wechat: wechat whatsapp: whatsapp skype: skype telegram: telegram first_name: John last_name: Doe last_login_at: null roles: - ROLE_ADMIN type: common_manager updated_at: '2023-04-20 17:21:40' username: 64413c649b70ab801d9b9a71 work_hours: null pagination: per_page: 100 total_count: 18 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 \ --url 'https://api-demo.affise.com/3.0/admin/users?limit=100' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' /3.0/admin/user: post: tags: - admin-users summary: Add user description: | `POST /3.0/admin/user` Add a new user parameters: - name: api-key in: header description: API key required: true example: 23df424b0a53b0899f78685966243ee61 schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: type: object properties: email: type: string description: Email password: type: string description: Password (8 or up to 30 characters with at least one uppercase, at least one lowercase, at least one numeric digit, at least one of the allowed special characters listed _-!@*.$%?&#/|\\~<>^{}[]():;) first_name: type: string description: Name last_name: type: string description: Last name roles: type: array items: type: string enum: - ROLE_ADMIN - ROLE_MANAGER_AFFILIATE - ROLE_MANAGER_SALES - ROLE_SECTION_OFFER - ROLE_SECTION_SUPPLIER - ROLE_SECTION_DASHBOARD - ROLE_SECTION_NEWS - ROLE_SECTION_CATEGORY - ROLE_SECTION_PARTNER - ROLE_SECTION_TICKET - ROLE_SECTION_AUTOMATION example: - ROLE_ADMIN description: Array of allowed roles type: type: string enum: - common_manager - affiliate_manager - account_manager description: User type skype: type: string description: Skype whatsapp: type: string description: Whatsapp telegram: type: string description: Telegram viber: type: string description: Viber facebook: type: string description: Facebook wechat: type: string description: Wechat work_hours: type: string description: Working time avatar: type: string format: base64 description: Base64 encoded image. Allowed formats jpg, jpeg internal_telegram_username: type: string description: Internal Telegram username (available only when the Telegram intercom integration is enabled) required: - email - password - first_name - last_name - roles responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer user: type: object properties: id: type: string api_key: type: string avatar: type: string created_at: type: string format: date-time email: type: string facebook: type: string viber: type: string wechat: type: string whatsapp: type: string skype: type: string telegram: type: string first_name: type: string last_name: type: string last_login_at: type: string format: date-time roles: type: array items: type: string type: type: string updated_at: type: string format: date-time username: type: string work_hours: type: string example: status: 1 user: id: 64413c649b70ab801d9b9a71 api_key: c40469ac42533296ac6c638f392b2ece avatar: null created_at: '2023-04-20 17:21:40' email: new-user@gmail.com facebook: facebook viber: viber wechat: wechat whatsapp: whatsapp skype: skype telegram: telegram first_name: John last_name: Doe last_login_at: null roles: - ROLE_ADMIN type: common_manager updated_at: '2023-04-20 17:21:40' username: 64413c649b70ab801d9b9a71 work_hours: null '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '500': $ref: '#/components/responses/InternalServerError' x-codeSamples: - lang: cURL label: cURL source: |- curl --request POST \ --url 'https://api-demo.affise.com/3.0/admin/user' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' \ --form 'email=string' \ --form 'password=string' \ --form 'first_name=string' \ --form 'last_name=string' \ --form 'roles[0][0]=ROLE_ADMIN' \ --form 'type=common_manager' \ --form 'skype=string' \ --form 'whatsapp=string' \ --form 'telegram=string' \ --form 'viber=string' \ --form 'facebook=string' \ --form 'wechat=string' \ --form 'work_hours=string' \ --form 'avatar=string' \ --form 'internal_telegram_username=string' /3.0/admin/user/{id}: get: tags: - admin-users summary: Read user description: | `GET /3.0/admin/user/{id}` Read single user parameters: - name: api-key in: header description: API key required: true example: 23df424b0a53b0899f78685966243ee61 schema: type: string - name: id in: path description: User ID required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer user: type: object properties: id: type: string first_name: type: string last_name: type: string work_hours: type: string email: type: string skype: type: string api_key: type: string roles: type: array items: type: string updated_at: type: string format: date-time created_at: type: string format: date-time last_login_at: type: string format: date-time type: type: string avatar: type: string info: type: string permissions: type: object description: User permissions object with nested structure example: status: 1 user: id: 5f515aefa1ceda82eed06518 first_name: test1 last_name: test1 work_hours: '' email: test1@example.com skype: test1 api_key: c03d492dc29faa4028610aaca57f00d1 roles: - ROLE_MANAGER_AFFILIATE updated_at: '2020-09-03T23:30:34Z' created_at: '2020-09-03T21:06:55Z' last_login_at: null type: affiliate_manager avatar: null info: null permissions: automation: affise-checker: level: deny general: marketplace: level: read settings: level: deny billing: level: deny notificator: client-subscription: level: write transport-configuration: level: write user-subscription: level: write stats: affiliate-postback: level: read clicks-list: level: read comparison-report: level: read conversions-export: level: read conversions-import: level: write conversions-list: level: read entity-account-manager: level: read default_level: read exceptions: strings: [] entity-affiliate-manager: level: deny exceptions: strings: [] referral: level: deny server-postback: level: read slice-account_manager_id: level: deny slice-advertiser_id: level: deny slice-affiliate_id: level: read slice-affiliate_manager_id: level: deny slice-browser: level: deny slice-city: level: read slice-connection-type: level: deny slice-country: level: read slice-day: level: read slice-device: level: read slice-goal: level: read slice-landing: level: deny slice-mobile-carrier: level: deny slice-offer_id: level: read slice-os: level: read slice-prelanding: level: deny slice-smart_id: level: deny slice-sub1: level: deny slice-sub2: level: deny slice-trafficback_reason: level: read stats-export: level: read view-custom: level: read view-kpi: level: deny view-retention-rate: level: deny slice-events: level: read users: entity-account-manager: level: deny exceptions: strings: [] entity-advertiser: level: deny exceptions: strings: [] entity-affiliate: level: deny exceptions: ints: [] entity-affiliate-manager: level: write exceptions: strings: [] entity-common-manager: level: deny exceptions: strings: [] entity-preset: level: deny view-users: level: deny '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 \ --url 'https://api-demo.affise.com/3.0/admin/user/{id}' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' post: tags: - admin-users summary: Edit user description: | `POST /3.0/admin/user/{id}` Change the user parameters: - name: api-key in: header description: API key example: 23df424b0a53b0899f78685966243ee61 required: true schema: type: string - name: id in: path description: User ID required: true schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: type: object properties: email: type: string description: Email password: type: string description: Password (8 or up to 30 characters with at least one uppercase, at least one lowercase, at least one numeric digit, at least one of the allowed special characters listed _-!@*.$%?&#/|\\~<>^{}[]():;) first_name: type: string description: Name last_name: type: string description: Last name roles: type: array items: type: string enum: - ROLE_ADMIN - ROLE_MANAGER_AFFILIATE - ROLE_MANAGER_SALES - ROLE_SECTION_OFFER - ROLE_SECTION_SUPPLIER - ROLE_SECTION_DASHBOARD - ROLE_SECTION_NEWS - ROLE_SECTION_CATEGORY - ROLE_SECTION_PARTNER - ROLE_SECTION_TICKET - ROLE_SECTION_AUTOMATION example: - ROLE_MANAGER_AFFILIATE description: Array of allowed roles skype: type: string description: Skype whatsapp: type: string description: Whatsapp telegram: type: string description: Telegram viber: type: string description: Viber facebook: type: string description: Facebook wechat: type: string description: Wechat work_hours: type: string description: Working time type: type: string enum: - common_manager - affiliate_manager - account_manager description: User type avatar: type: string format: base64 description: Base64 encoded image. Allowed formats jpg, jpeg internal_telegram_username: type: string description: Internal Telegram username (available only when the Telegram intercom integration is enabled) responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer user: type: object example: status: 1 user: id: 64413c649b70ab801d9b9a71 api_key: c40469ac42533296ac6c638f392b2ece avatar: null created_at: '2023-04-20 17:21:40' email: new-user@gmail.com facebook: facebook viber: viber wechat: wechat whatsapp: whatsapp skype: skype telegram: telegram first_name: John last_name: Doe last_login_at: null roles: - ROLE_ADMIN type: common_manager updated_at: '2023-04-20 17:21:40' username: 64413c649b70ab801d9b9a71 work_hours: null '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '500': $ref: '#/components/responses/InternalServerError' x-codeSamples: - lang: cURL label: cURL source: |- curl --request POST \ --url 'https://api-demo.affise.com/3.0/admin/user/{id}' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' \ --form 'email=string' \ --form 'password=string' \ --form 'first_name=string' \ --form 'last_name=string' \ --form 'roles[0][0]=ROLE_MANAGER_AFFILIATE' \ --form 'skype=string' \ --form 'whatsapp=string' \ --form 'telegram=string' \ --form 'viber=string' \ --form 'facebook=string' \ --form 'wechat=string' \ --form 'work_hours=string' \ --form 'type=common_manager' \ --form 'avatar=string' \ --form 'internal_telegram_username=string' /3.0/admin/user/api_key/{id}: post: tags: - admin-users summary: Change user api key description: | `POST /3.0/admin/user/api_key/{id}` Change user api key parameters: - name: api-key in: header description: API key required: true schema: type: string - name: id in: path description: User ID required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer user: type: object properties: id: type: string api_key: type: string example: status: 1 user: id: 594927bd7e28fe1c4a8b4569 api_key: c740955e768795098c8b91ef40ec008526f3f884 '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '500': $ref: '#/components/responses/InternalServerError' x-codeSamples: - lang: cURL label: cURL source: |- curl --request POST \ --url 'https://api-demo.affise.com/3.0/admin/user/api_key/{id}' \ --header 'api-key: ' /3.0/admin/user/{id}/password: post: tags: - admin-users summary: Change user password description: | `POST /3.0/admin/user/{id}/password` Change user password parameters: - name: api-key in: header description: API key example: 23df424b0a53b0899f78685966243ee61 required: true schema: type: string - name: id in: path description: User ID required: true schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: type: object properties: password: type: string description: Password (8 or up to 30 characters with at least one uppercase, at least one lowercase, at least one numeric digit, at least one of the allowed special characters listed _-!@*.$%?&#/|\\~<>^{}[]():;) required: - password responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer user: type: object properties: id: type: string password: type: string example: status: 1 user: id: 594927bd7e28fe1c4a8b4569 password: c740955e768795098c8b91ef40ec008526f3f884 '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '500': $ref: '#/components/responses/InternalServerError' x-codeSamples: - lang: cURL label: cURL source: |- curl --request POST \ --url 'https://api-demo.affise.com/3.0/admin/user/{id}/password' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' \ --form 'password=string' /3.1/user/{id}/permissions: post: tags: - admin-users summary: Update user permissions description: | `POST /3.1/user/{id}/permissions` Update user permissions parameters: - name: api-key in: header description: API key example: 23df424b0a53b0899f78685966243ee61 required: true schema: type: string - name: id in: path description: User ID required: true schema: type: string requestBody: content: application/json: schema: type: object properties: permissions: type: object description: Complex permissions object with nested structure properties: automation: type: object properties: affise-checker: type: object properties: level: type: string enum: - deny - read - write general: type: object properties: marketplace: type: object properties: level: type: string enum: - deny - read - write settings: type: object properties: level: type: string enum: - deny - read - write billing: type: object properties: level: type: string enum: - deny - read - write notificator: type: object properties: client-subscription: type: object properties: level: type: string enum: - deny - read - write transport-configuration: type: object properties: level: type: string enum: - deny - read - write user-subscription: type: object properties: level: type: string enum: - deny - read - write stats: type: object properties: affiliate-postback: type: object properties: level: type: string enum: - deny - read - write clicks-list: type: object properties: level: type: string enum: - deny - read - write comparison-report: type: object properties: level: type: string enum: - deny - read - write conversions-export: type: object properties: level: type: string enum: - deny - read - write conversions-import: type: object properties: level: type: string enum: - deny - read - write conversions-list: type: object properties: level: type: string enum: - deny - read - write entity-account-manager: type: object properties: level: type: string enum: - deny - read - write default_level: type: string enum: - deny - read - write exceptions: type: object properties: strings: type: object ints: type: object entity-affiliate-manager: type: object properties: level: type: string enum: - deny - read - write exceptions: type: object properties: strings: type: object ints: type: object referral: type: object properties: level: type: string enum: - deny - read - write server-postback: type: object properties: level: type: string enum: - deny - read - write slice-account_manager_id: type: object properties: level: type: string enum: - deny - read - write slice-advertiser_id: type: object properties: level: type: string enum: - deny - read - write slice-affiliate_id: type: object properties: level: type: string enum: - deny - read - write slice-affiliate_manager_id: type: object properties: level: type: string enum: - deny - read - write slice-browser: type: object properties: level: type: string enum: - deny - read - write slice-city: type: object properties: level: type: string enum: - deny - read - write slice-connection-type: type: object properties: level: type: string enum: - deny - read - write slice-country: type: object properties: level: type: string enum: - deny - read - write slice-day: type: object properties: level: type: string enum: - deny - read - write slice-device: type: object properties: level: type: string enum: - deny - read - write slice-goal: type: object properties: level: type: string enum: - deny - read - write slice-landing: type: object properties: level: type: string enum: - deny - read - write slice-mobile-carrier: type: object properties: level: type: string enum: - deny - read - write slice-offer_id: type: object properties: level: type: string enum: - deny - read - write slice-os: type: object properties: level: type: string enum: - deny - read - write slice-prelanding: type: object properties: level: type: string enum: - deny - read - write slice-smart_id: type: object properties: level: type: string enum: - deny - read - write slice-sub1: type: object properties: level: type: string enum: - deny - read - write slice-sub2: type: object properties: level: type: string enum: - deny - read - write slice-trafficback_reason: type: object properties: level: type: string enum: - deny - read - write stats-export: type: object properties: level: type: string enum: - deny - read - write view-custom: type: object properties: level: type: string enum: - deny - read - write view-kpi: type: object properties: level: type: string enum: - deny - read - write view-retention-rate: type: object properties: level: type: string enum: - deny - read - write slice-events: type: object properties: level: type: string enum: - deny - read - write users: type: object properties: entity-account-manager: type: object properties: level: type: string enum: - deny - read - write exceptions: type: object properties: strings: type: object ints: type: object entity-advertiser: type: object properties: level: type: string enum: - deny - read - write exceptions: type: object properties: strings: type: object ints: type: object entity-affiliate: type: object properties: level: type: string enum: - deny - read - write exceptions: type: object properties: strings: type: object ints: type: object entity-affiliate-manager: type: object properties: level: type: string enum: - deny - read - write exceptions: type: object properties: strings: type: object ints: type: object entity-common-manager: type: object properties: level: type: string enum: - deny - read - write exceptions: type: object properties: strings: type: object ints: type: object entity-preset: type: object properties: level: type: string enum: - deny - read - write view-users: type: object properties: level: type: string enum: - deny - read - write required: - permissions example: permissions: automation: affise-checker: level: deny general: marketplace: level: read settings: level: deny billing: level: write notificator: client-subscription: level: write transport-configuration: level: write user-subscription: level: write stats: affiliate-postback: level: read clicks-list: level: read comparison-report: level: read conversions-export: level: read conversions-import: level: write conversions-list: level: read entity-account-manager: level: read default_level: read exceptions: strings: {} entity-affiliate-manager: level: deny exceptions: strings: {} referral: level: deny server-postback: level: read slice-account_manager_id: level: deny slice-advertiser_id: level: deny slice-affiliate_id: level: read slice-affiliate_manager_id: level: deny slice-browser: level: deny slice-city: level: read slice-connection-type: level: deny slice-country: level: read slice-day: level: read slice-device: level: read slice-goal: level: read slice-landing: level: deny slice-mobile-carrier: level: deny slice-offer_id: level: read slice-os: level: read slice-prelanding: level: deny slice-smart_id: level: deny slice-sub1: level: deny slice-sub2: level: deny slice-trafficback_reason: level: read stats-export: level: read view-custom: level: read view-kpi: level: deny view-retention-rate: level: deny slice-events: level: read users: entity-account-manager: level: deny exceptions: strings: {} entity-advertiser: level: deny exceptions: strings: {} entity-affiliate: level: deny exceptions: ints: {} entity-affiliate-manager: level: write exceptions: strings: {} entity-common-manager: level: deny exceptions: strings: {} entity-preset: level: deny view-users: level: deny responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer user: type: object properties: id: type: string email: type: string type: type: string first_name: type: string last_name: type: string permissions: type: object description: Complex permissions object with nested structure properties: automation: type: object properties: affise-checker: type: object properties: level: type: string enum: - deny - read - write general: type: object properties: marketplace: type: object properties: level: type: string enum: - deny - read - write settings: type: object properties: level: type: string enum: - deny - read - write billing: type: object properties: level: type: string enum: - deny - read - write notificator: type: object properties: client-subscription: type: object properties: level: type: string enum: - deny - read - write transport-configuration: type: object properties: level: type: string enum: - deny - read - write user-subscription: type: object properties: level: type: string enum: - deny - read - write stats: type: object properties: affiliate-postback: type: object properties: level: type: string enum: - deny - read - write clicks-list: type: object properties: level: type: string enum: - deny - read - write comparison-report: type: object properties: level: type: string enum: - deny - read - write conversions-export: type: object properties: level: type: string enum: - deny - read - write conversions-import: type: object properties: level: type: string enum: - deny - read - write conversions-list: type: object properties: level: type: string enum: - deny - read - write entity-account-manager: type: object properties: level: type: string enum: - deny - read - write default_level: type: string enum: - deny - read - write exceptions: type: object properties: strings: type: object ints: type: object entity-affiliate-manager: type: object properties: level: type: string enum: - deny - read - write exceptions: type: object properties: strings: type: object ints: type: object referral: type: object properties: level: type: string enum: - deny - read - write server-postback: type: object properties: level: type: string enum: - deny - read - write slice-account_manager_id: type: object properties: level: type: string enum: - deny - read - write slice-advertiser_id: type: object properties: level: type: string enum: - deny - read - write slice-affiliate_id: type: object properties: level: type: string enum: - deny - read - write slice-affiliate_manager_id: type: object properties: level: type: string enum: - deny - read - write slice-browser: type: object properties: level: type: string enum: - deny - read - write slice-city: type: object properties: level: type: string enum: - deny - read - write slice-connection-type: type: object properties: level: type: string enum: - deny - read - write slice-country: type: object properties: level: type: string enum: - deny - read - write slice-day: type: object properties: level: type: string enum: - deny - read - write slice-device: type: object properties: level: type: string enum: - deny - read - write slice-goal: type: object properties: level: type: string enum: - deny - read - write slice-landing: type: object properties: level: type: string enum: - deny - read - write slice-mobile-carrier: type: object properties: level: type: string enum: - deny - read - write slice-offer_id: type: object properties: level: type: string enum: - deny - read - write slice-os: type: object properties: level: type: string enum: - deny - read - write slice-prelanding: type: object properties: level: type: string enum: - deny - read - write slice-smart_id: type: object properties: level: type: string enum: - deny - read - write slice-sub1: type: object properties: level: type: string enum: - deny - read - write slice-sub2: type: object properties: level: type: string enum: - deny - read - write slice-trafficback_reason: type: object properties: level: type: string enum: - deny - read - write stats-export: type: object properties: level: type: string enum: - deny - read - write view-custom: type: object properties: level: type: string enum: - deny - read - write view-kpi: type: object properties: level: type: string enum: - deny - read - write view-retention-rate: type: object properties: level: type: string enum: - deny - read - write slice-events: type: object properties: level: type: string enum: - deny - read - write users: type: object properties: entity-account-manager: type: object properties: level: type: string enum: - deny - read - write exceptions: type: object properties: strings: type: object ints: type: object entity-advertiser: type: object properties: level: type: string enum: - deny - read - write exceptions: type: object properties: strings: type: object ints: type: object entity-affiliate: type: object properties: level: type: string enum: - deny - read - write exceptions: type: object properties: strings: type: object ints: type: object entity-affiliate-manager: type: object properties: level: type: string enum: - deny - read - write exceptions: type: object properties: strings: type: object ints: type: object entity-common-manager: type: object properties: level: type: string enum: - deny - read - write exceptions: type: object properties: strings: type: object ints: type: object entity-preset: type: object properties: level: type: string enum: - deny - read - write view-users: type: object properties: level: type: string enum: - deny - read - write work_hours: type: string api_key: type: string created_at: type: string format: date-time updated_at: type: string format: date-time example: status: 1 user: id: 5f515aefa1ceda82eed06518 email: test1@example.com type: affiliate_manager first_name: test1 last_name: test1 work_hours: '' api_key: c03d492dc29faa4028610aaca57f00d1 created_at: '2020-09-03T21:06:55Z' updated_at: '2020-09-03T23:30:34Z' permissions: automation: affise-checker: level: deny general: marketplace: level: read settings: level: deny billing: level: write notificator: client-subscription: level: write transport-configuration: level: write user-subscription: level: write stats: affiliate-postback: level: read clicks-list: level: read comparison-report: level: read conversions-export: level: read conversions-import: level: write conversions-list: level: read entity-account-manager: level: read default_level: read exceptions: strings: {} entity-affiliate-manager: level: deny exceptions: strings: {} referral: level: deny server-postback: level: read slice-account_manager_id: level: deny slice-advertiser_id: level: deny slice-affiliate_id: level: read slice-affiliate_manager_id: level: deny slice-browser: level: deny slice-city: level: read slice-connection-type: level: deny slice-country: level: read slice-day: level: read slice-device: level: read slice-goal: level: read slice-landing: level: deny slice-mobile-carrier: level: deny slice-offer_id: level: read slice-os: level: read slice-prelanding: level: deny slice-smart_id: level: deny slice-sub1: level: deny slice-sub2: level: deny slice-trafficback_reason: level: read stats-export: level: read view-custom: level: read view-kpi: level: deny view-retention-rate: level: deny slice-events: level: read users: entity-account-manager: level: deny exceptions: strings: {} entity-advertiser: level: deny exceptions: strings: {} entity-affiliate: level: deny exceptions: ints: {} entity-affiliate-manager: level: write exceptions: strings: {} entity-common-manager: level: deny exceptions: strings: {} entity-preset: level: deny view-users: level: deny '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '500': $ref: '#/components/responses/InternalServerError' x-codeSamples: - lang: cURL label: cURL source: |- curl --request POST \ --url 'https://api-demo.affise.com/3.1/user/{id}/permissions' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' \ --header 'Content-Type: application/json' \ --data '{ "permissions": { "automation": { "affise-checker": { "level": "deny" } }, "general": { "marketplace": { "level": "read" }, "settings": { "level": "deny" }, "billing": { "level": "write" } }, "notificator": { "client-subscription": { "level": "write" }, "transport-configuration": { "level": "write" }, "user-subscription": { "level": "write" } }, "stats": { "affiliate-postback": { "level": "read" }, "clicks-list": { "level": "read" }, "comparison-report": { "level": "read" }, "conversions-export": { "level": "read" }, "conversions-import": { "level": "write" }, "conversions-list": { "level": "read" }, "entity-account-manager": { "level": "read", "default_level": "read", "exceptions": { "strings": {} } }, "entity-affiliate-manager": { "level": "deny", "exceptions": { "strings": {} } }, "referral": { "level": "deny" }, "server-postback": { "level": "read" }, "slice-account_manager_id": { "level": "deny" }, "slice-advertiser_id": { "level": "deny" }, "slice-affiliate_id": { "level": "read" }, "slice-affiliate_manager_id": { "level": "deny" }, "slice-browser": { "level": "deny" }, "slice-city": { "level": "read" }, "slice-connection-type": { "level": "deny" }, "slice-country": { "level": "read" }, "slice-day": { "level": "read" }, "slice-device": { "level": "read" }, "slice-goal": { "level": "read" }, "slice-landing": { "level": "deny" }, "slice-mobile-carrier": { "level": "deny" }, "slice-offer_id": { "level": "read" }, "slice-os": { "level": "read" }, "slice-prelanding": { "level": "deny" }, "slice-smart_id": { "level": "deny" }, "slice-sub1": { "level": "deny" }, "slice-sub2": { "level": "deny" }, "slice-trafficback_reason": { "level": "read" }, "stats-export": { "level": "read" }, "view-custom": { "level": "read" }, "view-kpi": { "level": "deny" }, "view-retention-rate": { "level": "deny" }, "slice-events": { "level": "read" } }, "users": { "entity-account-manager": { "level": "deny", "exceptions": { "strings": {} } }, "entity-advertiser": { "level": "deny", "exceptions": { "strings": {} } }, "entity-affiliate": { "level": "deny", "exceptions": { "ints": {} } }, "entity-affiliate-manager": { "level": "write", "exceptions": { "strings": {} } }, "entity-common-manager": { "level": "deny", "exceptions": { "strings": {} } }, "entity-preset": { "level": "deny" }, "view-users": { "level": "deny" } } } }' /3.1/pub-auth: post: tags: - admin-users summary: Public auth description: | `POST /3.1/pub-auth` Get user api key by login and password requestBody: content: application/x-www-form-urlencoded: schema: type: object properties: email: type: string format: email description: A valid email password: type: string description: Password (8 or up to 30 characters with at least one uppercase, at least one lowercase, at least one numeric digit, at least one of the allowed special characters listed _-!@*.$%?&#/|\\~<>^{}[]():;) required: - email - password responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer api_key: type: string example: status: 1 api_key: c740955e768795098c8b91ef40ec008526f3f884 '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '500': $ref: '#/components/responses/InternalServerError' x-codeSamples: - lang: cURL label: cURL source: |- curl --request POST \ --url 'https://api-demo.affise.com/3.1/pub-auth' \ --form 'email=string' \ --form 'password=string' /3.1/advertiser/registration: post: tags: - advertiser-auth summary: Advertiser Registration description: | `POST /3.1/advertiser/registration` Registers a new advertiser account requestBody: required: true content: application/x-www-form-urlencoded: schema: type: object properties: title: type: string description: Name of the advertiser email: type: string format: email description: Advertiser's email address password: type: string description: Account password captcha: type: string description: Code from the captcha image. Required when captcha is enabled for the advertiser registration form; validated together with the `captcha_token` request parameter issued when the captcha image was generated required: - title - email - password responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer message: type: string example: status: 1 message: Advertiser created successfully '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '500': $ref: '#/components/responses/InternalServerError' x-codeSamples: - lang: cURL label: cURL source: |- curl --request POST \ --url 'https://api-demo.affise.com/3.1/advertiser/registration' \ --form 'title=string' \ --form 'email=string' \ --form 'password=string' \ --form 'captcha=string' /3.1/advertiser/login: post: tags: - advertiser-auth summary: Advertiser Login description: | `POST /3.1/advertiser/login` Authenticates an advertiser and returns access tokens requestBody: required: true content: application/x-www-form-urlencoded: schema: type: object properties: email: type: string format: email description: Advertiser's email address password: type: string description: Account password required: - email - password responses: '200': description: Successful response content: application/json: schema: type: object properties: user: type: object properties: id: type: string email: type: string type: type: string created_at: type: string format: date-time api_key: type: string access_token: type: string refresh_token: type: string expires_in: type: integer example: user: id: 6848050f08e2615692933935 email: test@advertiser.com type: advertiser created_at: '2025-06-10T10:12:31.052Z' api_key: 86cf36ea9f74d822c64ebcccc4ee2c09 access_token: IOBDJ2v42z8Vev3gy_zBrrd7ShzrVh3sdgi-vzK6M9o.Q6n5LMbkePzcYG3jeAE6cU9SOk9pdf6QSQqZPDbxBPA refresh_token: FStbN5FROfnTcWw9nJx1gkDwGjuB3DXXc1ApyRrcuCM.CDCxmJTibIkHB9kga1gwZqj9ldtsU9A10WlXtPlAQJ0 expires_in: 259200 '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '500': $ref: '#/components/responses/InternalServerError' x-codeSamples: - lang: cURL label: cURL source: |- curl --request POST \ --url 'https://api-demo.affise.com/3.1/advertiser/login' \ --form 'email=string' \ --form 'password=string' /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 \ --url 'https://api-demo.affise.com/3.1/advertiser/offers?page=1&limit=100' \ --header '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 \ --url 'https://api-demo.affise.com/3.1/advertiser/offers/{id}' \ --header 'api-key: 86cf36ea9f74d822c64ebcccc4ee2c09' /3.1/partner/me: get: tags: - affiliate-profile summary: Get partner own data description: | `GET /3.1/partner/me` Get partner own data parameters: - name: api-key in: header description: API key required: true schema: type: string example: 23df424b0a53b0899f78685966243ee61 responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer user: type: object properties: partner_id: type: integer needAcceptTerms: type: boolean manager: type: object properties: name: type: string email: type: string skype: type: string work_hours: type: string id: type: string api_key: type: string info: type: string nullable: true created_at: type: string format: date-time settings: type: string nullable: true email: type: string login: type: string name: type: string nullable: true company: type: string nullable: true status: type: string updated_at: type: string format: date-time confirm_code: type: string nullable: true ref: type: string nullable: true lang: type: string timezone: type: string nullable: true level: type: integer nullable: true manager_id: type: string notes: type: string ref_percent: type: number nullable: true pay_sys: type: string nullable: true pay_acc: type: string pay_acc_wmz: type: string balance_ru: type: string hold_ru: type: string available_ru: type: string balance_usd: type: string hold_usd: type: string available_usd: type: string address_1: type: string nullable: true address_2: type: string nullable: true city: type: string nullable: true country: type: string zip_code: type: string nullable: true phone: type: string nullable: true sub_accounts: type: object additionalProperties: type: object properties: value: type: string except: type: integer type: type: string permissions: type: object additionalProperties: true work_hours: type: string last_login_at: type: string format: date-time example: status: 1 user: partner_id: 2 needAcceptTerms: false manager: name: firstName lastName email: manager@manager.com skype: manager work_hours: '24' id: 5d91e81acbe5a8fd53e7215d api_key: cd21e0d96fdfcd181403531854bba48f info: null created_at: '2019-09-30T11:33:46Z' settings: null email: test1.users-stage-v1@cud.partner login: test11.users-stage-v1@cud.partner name: null company: null status: '1' updated_at: '2019-10-02T07:28:01Z' confirm_code: null ref: null lang: en timezone: null level: null manager_id: '' notes: '' ref_percent: null pay_sys: null pay_acc: '' pay_acc_wmz: '' balance_ru: '0.00' hold_ru: '0.00' available_ru: '0.00' balance_usd: '0.00' hold_usd: '0.00' available_usd: '0.00' address_1: null address_2: null city: null country: GH zip_code: null phone: null sub_accounts: '1': value: '' except: 0 '2': value: '' except: 0 type: affiliate permissions: automation: affise-checker: level: deny general: marketplace: level: read settings: level: deny notificator: client-subscription: level: write transport-configuration: level: write user-subscription: level: write stats: affiliate-postback: level: read clicks-list: level: read comparison-report: level: read conversions-export: level: read conversions-import: level: write conversions-list: level: read entity-account-manager: level: read default_level: read exceptions: strings: [] entity-affiliate-manager: level: deny exceptions: strings: [] referral: level: deny server-postback: level: read slice-account_manager_id: level: deny slice-advertiser_id: level: deny slice-affiliate_id: level: read slice-affiliate_manager_id: level: deny slice-browser: level: deny slice-city: level: read slice-connection-type: level: deny slice-country: level: read slice-day: level: read slice-device: level: read slice-goal: level: read slice-landing: level: deny slice-mobile-carrier: level: deny slice-offer_id: level: read slice-os: level: read slice-prelanding: level: deny slice-smart_id: level: deny slice-sub1: level: deny slice-sub2: level: deny slice-trafficback_reason: level: read stats-export: level: read view-custom: level: read view-kpi: level: deny view-retention-rate: level: deny users: entity-account-manager: level: deny exceptions: strings: [] entity-advertiser: level: deny exceptions: strings: [] entity-affiliate: level: deny exceptions: ints: [] entity-affiliate-manager: level: write exceptions: strings: [] entity-common-manager: level: deny exceptions: strings: [] entity-preset: level: deny view-users: level: deny work_hours: '' last_login_at: '2019-10-02T07:29:22Z' '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 \ --url 'https://api-demo.affise.com/3.1/partner/me' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' /3.0/partner/offers: get: tags: - affiliate-offers summary: Offer list description: | `GET /3.0/partner/offers` Get list of available partner offers parameters: - name: api-key in: header description: API key required: true schema: type: string example: 23df424b0a53b0899f78685966243ee61 - name: q in: query description: Search by title and id schema: type: string - name: int_id in: query description: Search by int offer ID schema: type: array items: type: integer example: int_id[0]: 1 - name: countries in: query description: Array of offers countries(ISO) schema: type: array items: type: string example: countries[0]: USA - name: categories in: query description: Array of offers categories schema: type: array items: type: string example: categories[0]: 46cc97dc3b7d9b10758b45f0 - name: caps_country in: query description: Comma separated array of strings. Example US,DE. If one or more cap filters are set (caps_country, caps_type), other filters are ignored schema: type: string - name: caps_type in: query description: Comma separated array of strings. Example clicks,conversions,budget,impressions. If one or more cap filters are set (caps_country, caps_type), other filters are ignored. This filter will not show offers for the selected cap type if the cap is full 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) schema: type: array items: type: string example: sort[title]: desc - name: page in: query description: Page of offers schema: type: integer - name: limit in: query description: Count offers by page schema: type: integer default: 100 maximum: 500 responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer offers: type: array items: $ref: '#/components/schemas/offer_affiliate' pagination: type: object properties: per_page: type: integer total_count: type: integer page: type: integer next_page: type: integer example: status: 1 offers: - id: 902 offer_id: 5718dac83b7d9bf8588b4579 bundle_id: 46cc97dc3b7d9b10758b45f0 title: ... preview_url: .... description_lang: cn: '' en: '' es: '' ka: '' my: '' pt: '' ru: '' vi: '' cr: 199850 epc: 298988.33 logo: http://YOUR_API_DOMAIN/images/cpa/logos/2602108452.png logo_source: ... sources: - id: 51f531f53b7d9b1e0382f6d9 title: Web sites allowed: 1 categories: - ... full_categories: - id: 5368afb23b7d9b4d5d505342 title: ... payments: - countries: - US cities: [] devices: [] os: [] goal: '1' revenue: 0 currency: usd title: '' type: fixed country_exclude: true caps: - goals: {} period: day type: conversions value: 10 goal_type: all country_type: all country: [] caps_status: [] stop_at: '' required_approval: true is_cpi: false creatives: [] creatives_zip: null impressions_link: null landings: [] macro_url: null links: - id: null title: null hash: null url: http://YOUR_API_DOMAIN/click?pid=610&offer_id=902 postbacks: [] created: null link: http://YOUR_API_DOMAIN/click?pid=610&offer_id=902 use_https: false use_http: true hold_period: 0 kpi: en: '' click_session: 1y targeting: - name: default targeting condition: and country: allow: [] deny: [] region: allow: [] deny: [] city: allow: [] deny: [] os: allow: [] deny: [] os_deny: false isp: allow: [] deny: [] isp_organization: allow: [] deny: [] deny_empty: false ip: allow: [] deny: [] ipv6_deny: false browser: allow: [] deny: [] browser_version: allow: [] deny: [] brand: allow: [] deny: [] device_type: [] device_type_deny: false device_model: allow: [] deny: [] connection: [] connection_deny: false referrer: allow: [] deny: [] deny_empty: false ua: allow: [] deny: [] deny_crawlers: false id: 991f9eb4-0f12-4e6a-805a-1ed7aab01ef4 block_proxy: false commission_tiers: - id: e09f260e-8461-4b7d-aa30-3c164a70c1bc goals: [] timeframe: all type: conversions value: 1 target_goals: [] modifier_type: by_fix modifier_value: 0.0002 countries: [] conversion_status: - confirmed - declined - pending - hold modifier_payment_type: payout minimal_click_session: 0s enabled_commission_tiers: true consider_personal_targeting_only: false hosts_only: false uniq_ip_only: false reject_not_uniq_ip: 0 pagination: per_page: 1 total_count: 127 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 \ --url 'https://api-demo.affise.com/3.0/partner/offers?int_id[0]=1&countries[0]=USA&categories[0]=46cc97dc3b7d9b10758b45f0&sort[title]=desc&limit=100' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' /3.0/partner/live-offers: get: tags: - affiliate-offers summary: Live offer list description: | `GET /3.0/partner/live-offers` Get list of a live offers parameters: - name: api-key in: header description: API key required: true schema: type: string example: 23df424b0a53b0899f78685966243ee61 - name: q in: query description: Search by title and id schema: type: string - name: int_id in: query description: Search by int offer ID schema: type: array items: type: integer example: int_id[0]: 235 - name: countries in: query description: Array of offers countries(ISO) schema: type: array items: type: string example: countries[0]: DE - name: categories in: query description: Array of offers categories schema: type: array items: type: string example: categories[0]: 46cc97dc3b7d9b10758b45f0 - name: caps_country in: query description: Comma separated array of strings. Example US,DE. If one or more cap filters are set (caps_country, caps_type), other filters are ignored schema: type: string - name: caps_type in: query description: Comma separated array of strings. Example clicks,conversions,budget,impressions. If one or more cap filters are set (caps_country, caps_type), other filters are ignored 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) 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 default: 100 maximum: 500 - name: ids in: query description: Array of offer IDs schema: type: array items: type: string example: ids[0]: 5718dac83b7d9bf8588b4579 - name: os in: query description: Array of OS names schema: type: array items: type: string example: os[0]: Android - name: is_top in: query description: Filter top offers schema: type: integer enum: - 0 - 1 - name: updated_at in: query description: Show offers updated starting from this date (YYYY-MM-DD) schema: type: string format: date - name: smartlink_categories in: query description: Array of smartlink category IDs schema: type: array items: type: string example: smartlink_categories[0]: 595e3b447e28feb7568b456a - name: status in: query description: Array of offer statuses. Non-manager API keys may request only the active status schema: type: array items: type: string enum: - stopped - active - suspended example: status[0]: active - name: advertiser in: query description: Array of advertiser IDs. ONLY FOR ADMIN schema: type: array items: type: string example: advertiser[0]: 5b5f415035752723008b456a - name: external_offer_id in: query description: Search by external offer ID. ONLY FOR ADMIN schema: type: string - name: bundle_id in: query description: Search by bundle ID. ONLY FOR ADMIN schema: type: string - name: privacy in: query description: 'Array of offer privacy levels: 0 - public, 1 - protected, 2 - private. ONLY FOR ADMIN' schema: type: array items: type: integer enum: - 0 - 1 - 2 example: privacy[0]: 0 - name: advertiser_manager_id in: query description: Array of advertiser manager IDs. ONLY FOR ADMIN schema: type: array items: type: string example: advertiser_manager_id[0]: 5f4dfa3a2ed3070ba0464c8f - name: additional_fields in: query description: Additional fields to include in the response. ONLY FOR ADMIN schema: type: string enum: - enabled_affiliates responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer offers: type: array items: $ref: '#/components/schemas/offer_affiliate' pagination: type: object properties: per_page: type: integer total_count: type: integer page: type: integer next_page: type: integer example: status: 1 offers: - id: 902 offer_id: 5718dac83b7d9bf8588b4579 bundle_id: 46cc97dc3b7d9b10758b45f0 title: ... preview_url: .... description_lang: cn: '' en: '' es: '' ka: '' my: '' pt: '' ru: '' vi: '' cr: 199850 epc: 298988.33 logo: http://YOUR_API_DOMAIN/images/cpa/logos/2602108452.png logo_source: ... sources: - id: 51f531f53b7d9b1e0382f6d9 title: Web sites allowed: 1 categories: - ... full_categories: - id: 5368afb23b7d9b4d5d505342 title: ... payments: - countries: - US cities: [] devices: [] os: [] goal: '1' revenue: 0 currency: usd title: '' type: fixed country_exclude: true caps: - goals: {} period: day type: conversions value: 10 goal_type: all country_type: all country: [] caps_status: [] stop_at: '' required_approval: true is_cpi: false creatives: [] creatives_zip: null impressions_link: null landings: [] macro_url: null links: - id: null title: null hash: null url: http://YOUR_API_DOMAIN/click?pid=610&offer_id=902 postbacks: [] created: null link: http://YOUR_API_DOMAIN/click?pid=610&offer_id=902 use_https: false use_http: true hold_period: 0 kpi: en: '' click_session: 1y targeting: - name: default targeting condition: and country: allow: [] deny: [] region: allow: [] deny: [] city: allow: [] deny: [] os: allow: [] deny: [] os_deny: false isp: allow: [] deny: [] isp_organization: allow: [] deny: [] deny_empty: false ip: allow: [] deny: [] ipv6_deny: false browser: allow: [] deny: [] browser_version: allow: [] deny: [] brand: allow: [] deny: [] device_type: [] device_type_deny: false device_model: allow: [] deny: [] connection: [] connection_deny: false referrer: allow: [] deny: [] deny_empty: false ua: allow: [] deny: [] deny_crawlers: false id: 991f9eb4-0f12-4e6a-805a-1ed7aab01ef4 block_proxy: false commission_tiers: - id: e09f260e-8461-4b7d-aa30-3c164a70c1bc goals: [] timeframe: all type: conversions value: 1 target_goals: [] modifier_type: by_fix modifier_value: 0.0002 countries: [] conversion_status: - confirmed - declined - pending - hold modifier_payment_type: payout minimal_click_session: 0s enabled_commission_tiers: true consider_personal_targeting_only: false hosts_only: false uniq_ip_only: false reject_not_uniq_ip: 0 pagination: per_page: 1 total_count: 127 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 \ --url 'https://api-demo.affise.com/3.0/partner/live-offers?int_id[0]=235&countries[0]=DE&categories[0]=46cc97dc3b7d9b10758b45f0&sort[id]=asc&limit=100&ids[0]=5718dac83b7d9bf8588b4579&os[0]=Android&is_top=0&smartlink_categories[0]=595e3b447e28feb7568b456a&status[0]=active&advertiser[0]=5b5f415035752723008b456a&privacy[0]=0&advertiser_manager_id[0]=5f4dfa3a2ed3070ba0464c8f&additional_fields=enabled_affiliates' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' /3.0/partner/activation/offer: post: tags: - affiliate-offers summary: Activation offer description: | `POST /3.0/partner/activation/offer` Connect to an offer parameters: - name: api-key in: header description: API key required: true schema: type: string example: 23df424b0a53b0899f78685966243ee61 requestBody: content: application/x-www-form-urlencoded: schema: type: object properties: offer_id: type: integer description: Offer ID comment: type: string description: Comment required: - offer_id - comment responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer message: type: string example: status: 1 message: Request is successfully '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '500': $ref: '#/components/responses/InternalServerError' x-codeSamples: - lang: cURL label: cURL source: |- curl --request POST \ --url 'https://api-demo.affise.com/3.0/partner/activation/offer' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' \ --form 'offer_id=0' \ --form 'comment=string' /3.0/partner/postback: post: tags: - affiliate-postbacks summary: Add partner postback description: | `POST /3.0/partner/postback` Add a partner's postback parameters: - name: api-key in: header description: API key required: true schema: type: string example: 23df424b0a53b0899f78685966243ee61 requestBody: content: application/x-www-form-urlencoded: schema: type: object properties: offer_id: type: integer description: Offer ID (missed parameter means creation of global postback) url: type: string description: Example http://YOUR_API_DOMAIN status: type: string enum: - by_creating - confirmed - pending - declined - hold description: Postback status. Status "not_found" is deprecated and will be transformed to "declined". goal: type: string description: Postback goal (value) pid: type: integer description: Partner ID integration_method: type: string enum: - all - default - skad - probabilistic_attribution default: all description: Postback integration method forced: type: integer enum: - 0 - 1 default: 0 description: Forced postback flag meta: type: object description: Postback meta settings — conversion fields mapping for the Meta (Facebook) Conversions API integration. All values are strings. The fields meta_access_token, meta_pixel_id and event_name are required together when any of them is provided additionalProperties: false properties: action_source: type: string city: type: string click_date: type: string comment: type: string currency: type: string custom_event_currency: type: string custom_event_value: type: string custom_field1: type: string custom_field2: type: string custom_field3: type: string custom_field4: type: string custom_field5: type: string custom_field6: type: string custom_field7: type: string date: type: string date_only: type: string device_type: type: string event_name: type: string event_url: type: string ext1: type: string ext2: type: string ext3: type: string fbclid: type: string geo: type: string ip: type: string meta_access_token: type: string meta_pixel_id: type: string order_currency: type: string order_sum: type: string os: type: string os_id: type: string promo_code: type: string rand: type: string ref_id: type: string referrer: type: string sub1: type: string sub2: type: string sub3: type: string sub4: type: string sub5: type: string sub6: type: string sub7: type: string sub8: type: string sum: type: string time: type: string timestamp: type: string transaction_id: type: string user_agent: type: string user_id: type: string status: type: string offer_id: type: string offer_name: type: string goal: type: string custom_filter_field: type: string description: Custom filter — conversion field name to check before sending the postback custom_filter_text: type: string description: Custom filter — value the field set in custom_filter_field must match for the postback to be sent required: - url - pid responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer postback: type: object properties: id: type: integer url: type: string status: type: string goal: type: string created: type: string format: date-time updated_at: type: string format: date-time forced: type: string pid: type: string integration_method: type: string example: status: 1 postback: id: 960 url: http://YOUR_API_DOMAIN status: by_creating goal: null created: '2017-06-20 02:17:58' updated_at: '2017-06-20 02:17:58' forced: '0' pid: '1' integration_method: all '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '500': $ref: '#/components/responses/InternalServerError' x-codeSamples: - lang: cURL label: cURL source: |- curl --request POST \ --url 'https://api-demo.affise.com/3.0/partner/postback' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' \ --form 'offer_id=0' \ --form 'url=string' \ --form 'status=by_creating' \ --form 'goal=string' \ --form 'pid=0' \ --form 'integration_method=all' \ --form 'forced=0' \ --form 'meta[action_source]=string' \ --form 'meta[city]=string' \ --form 'meta[click_date]=string' \ --form 'meta[comment]=string' \ --form 'meta[currency]=string' \ --form 'meta[custom_event_currency]=string' \ --form 'meta[custom_event_value]=string' \ --form 'meta[custom_field1]=string' \ --form 'meta[custom_field2]=string' \ --form 'meta[custom_field3]=string' \ --form 'meta[custom_field4]=string' \ --form 'meta[custom_field5]=string' \ --form 'meta[custom_field6]=string' \ --form 'meta[custom_field7]=string' \ --form 'meta[date]=string' \ --form 'meta[date_only]=string' \ --form 'meta[device_type]=string' \ --form 'meta[event_name]=string' \ --form 'meta[event_url]=string' \ --form 'meta[ext1]=string' \ --form 'meta[ext2]=string' \ --form 'meta[ext3]=string' \ --form 'meta[fbclid]=string' \ --form 'meta[geo]=string' \ --form 'meta[ip]=string' \ --form 'meta[meta_access_token]=string' \ --form 'meta[meta_pixel_id]=string' \ --form 'meta[order_currency]=string' \ --form 'meta[order_sum]=string' \ --form 'meta[os]=string' \ --form 'meta[os_id]=string' \ --form 'meta[promo_code]=string' \ --form 'meta[rand]=string' \ --form 'meta[ref_id]=string' \ --form 'meta[referrer]=string' \ --form 'meta[sub1]=string' \ --form 'meta[sub2]=string' \ --form 'meta[sub3]=string' \ --form 'meta[sub4]=string' \ --form 'meta[sub5]=string' \ --form 'meta[sub6]=string' \ --form 'meta[sub7]=string' \ --form 'meta[sub8]=string' \ --form 'meta[sum]=string' \ --form 'meta[time]=string' \ --form 'meta[timestamp]=string' \ --form 'meta[transaction_id]=string' \ --form 'meta[user_agent]=string' \ --form 'meta[user_id]=string' \ --form 'meta[status]=string' \ --form 'meta[offer_id]=string' \ --form 'meta[offer_name]=string' \ --form 'meta[goal]=string' \ --form 'custom_filter_field=string' \ --form 'custom_filter_text=string' /3.0/partner/postback/{id}: post: tags: - affiliate-postbacks summary: Edit partner postback description: | `POST /3.0/partner/postback/{id}` Edit a partner's postback parameters: - name: api-key in: header description: API key required: true schema: type: string example: 23df424b0a53b0899f78685966243ee61 - name: id in: path description: Postback ID required: true schema: type: integer requestBody: content: application/x-www-form-urlencoded: schema: type: object properties: url: type: string description: Example http://YOUR_API_DOMAIN status: type: string enum: - by_creating - confirmed - pending - declined - hold description: Postback status. Status "not_found" is deprecated and will be transformed to "declined". goal: type: string description: Postback goal (value) integration_method: type: string enum: - all - default - skad - probabilistic_attribution description: Postback integration method forced: type: integer enum: - 0 - 1 default: 0 description: Forced postback flag meta: type: object description: Postback meta settings — conversion fields mapping for the Meta (Facebook) Conversions API integration. All values are strings. The fields meta_access_token, meta_pixel_id and event_name are required together when any of them is provided additionalProperties: false properties: action_source: type: string city: type: string click_date: type: string comment: type: string currency: type: string custom_event_currency: type: string custom_event_value: type: string custom_field1: type: string custom_field2: type: string custom_field3: type: string custom_field4: type: string custom_field5: type: string custom_field6: type: string custom_field7: type: string date: type: string date_only: type: string device_type: type: string event_name: type: string event_url: type: string ext1: type: string ext2: type: string ext3: type: string fbclid: type: string geo: type: string ip: type: string meta_access_token: type: string meta_pixel_id: type: string order_currency: type: string order_sum: type: string os: type: string os_id: type: string promo_code: type: string rand: type: string ref_id: type: string referrer: type: string sub1: type: string sub2: type: string sub3: type: string sub4: type: string sub5: type: string sub6: type: string sub7: type: string sub8: type: string sum: type: string time: type: string timestamp: type: string transaction_id: type: string user_agent: type: string user_id: type: string status: type: string offer_id: type: string offer_name: type: string goal: type: string custom_filter_field: type: string description: Custom filter — conversion field name to check before sending the postback custom_filter_text: type: string description: Custom filter — value the field set in custom_filter_field must match for the postback to be sent offer_id: type: integer description: Offer ID (missed parameter means creation of global postback) pid: type: integer description: Partner ID required: - url responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer postback: type: object example: status: 1 postback: id: 960 url: http://YOUR_API_DOMAIN status: confirmed goal: null created: '2017-06-20 02:17:58' updated_at: '2017-06-20 02:17:58' forced: '0' pid: '1' integration_method: all '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '500': $ref: '#/components/responses/InternalServerError' x-codeSamples: - lang: cURL label: cURL source: |- curl --request POST \ --url 'https://api-demo.affise.com/3.0/partner/postback/{id}' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' \ --form 'url=string' \ --form 'status=by_creating' \ --form 'goal=string' \ --form 'integration_method=all' \ --form 'forced=0' \ --form 'meta[action_source]=string' \ --form 'meta[city]=string' \ --form 'meta[click_date]=string' \ --form 'meta[comment]=string' \ --form 'meta[currency]=string' \ --form 'meta[custom_event_currency]=string' \ --form 'meta[custom_event_value]=string' \ --form 'meta[custom_field1]=string' \ --form 'meta[custom_field2]=string' \ --form 'meta[custom_field3]=string' \ --form 'meta[custom_field4]=string' \ --form 'meta[custom_field5]=string' \ --form 'meta[custom_field6]=string' \ --form 'meta[custom_field7]=string' \ --form 'meta[date]=string' \ --form 'meta[date_only]=string' \ --form 'meta[device_type]=string' \ --form 'meta[event_name]=string' \ --form 'meta[event_url]=string' \ --form 'meta[ext1]=string' \ --form 'meta[ext2]=string' \ --form 'meta[ext3]=string' \ --form 'meta[fbclid]=string' \ --form 'meta[geo]=string' \ --form 'meta[ip]=string' \ --form 'meta[meta_access_token]=string' \ --form 'meta[meta_pixel_id]=string' \ --form 'meta[order_currency]=string' \ --form 'meta[order_sum]=string' \ --form 'meta[os]=string' \ --form 'meta[os_id]=string' \ --form 'meta[promo_code]=string' \ --form 'meta[rand]=string' \ --form 'meta[ref_id]=string' \ --form 'meta[referrer]=string' \ --form 'meta[sub1]=string' \ --form 'meta[sub2]=string' \ --form 'meta[sub3]=string' \ --form 'meta[sub4]=string' \ --form 'meta[sub5]=string' \ --form 'meta[sub6]=string' \ --form 'meta[sub7]=string' \ --form 'meta[sub8]=string' \ --form 'meta[sum]=string' \ --form 'meta[time]=string' \ --form 'meta[timestamp]=string' \ --form 'meta[transaction_id]=string' \ --form 'meta[user_agent]=string' \ --form 'meta[user_id]=string' \ --form 'meta[status]=string' \ --form 'meta[offer_id]=string' \ --form 'meta[offer_name]=string' \ --form 'meta[goal]=string' \ --form 'custom_filter_field=string' \ --form 'custom_filter_text=string' \ --form 'offer_id=0' \ --form 'pid=0' /3.0/partner/postback/{id}/remove: delete: tags: - affiliate-postbacks summary: Delete partner postback description: | `DELETE /3.0/partner/postback/{id}/remove` Delete a partner's postback parameters: - name: api-key in: header description: API key required: true schema: type: string - name: id in: path description: Postback ID required: true schema: type: integer responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer postback: type: object example: status: 1 postback: id: 960 url: http://YOUR_API_DOMAIN offer_id: '4' status: confirmed goal: null created: '2017-06-20 02:17:58' updated_at: '2017-06-20 02:17:58' forced: '0' pid: '1' integration_method: all '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '500': $ref: '#/components/responses/InternalServerError' x-codeSamples: - lang: cURL label: cURL source: |- curl --request DELETE \ --url 'https://api-demo.affise.com/3.0/partner/postback/{id}/remove' \ --header 'api-key: ' /3.0/partner/postbacks/by-offers: delete: tags: - affiliate-postbacks summary: Delete partners postbacks by offers ids description: | `DELETE /3.0/partner/postbacks/by-offers` Delete partners postbacks by offers ids parameters: - name: api-key in: header description: API key required: true schema: type: string - name: ids in: query description: Comma separated array of offer IDs required: true schema: type: string responses: '200': description: Successful response '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '500': $ref: '#/components/responses/InternalServerError' x-codeSamples: - lang: cURL label: cURL source: |- curl --request DELETE \ --url 'https://api-demo.affise.com/3.0/partner/postbacks/by-offers?ids=' \ --header 'api-key: ' /3.0/partner/postbacks/by-affiliates: delete: tags: - affiliate-postbacks summary: Delete partners postbacks by affiliates ids description: | `DELETE /3.0/partner/postbacks/by-affiliates` Delete partners postbacks by affiliates ids parameters: - name: api-key in: header description: API key required: true schema: type: string - name: ids in: query description: Comma separated array of affiliate IDs required: true schema: type: string responses: '200': description: Successful response '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '500': $ref: '#/components/responses/InternalServerError' x-codeSamples: - lang: cURL label: cURL source: |- curl --request DELETE \ --url 'https://api-demo.affise.com/3.0/partner/postbacks/by-affiliates?ids=' \ --header 'api-key: ' /3.0/news: get: tags: - affiliate-news summary: News list description: | `GET /3.0/news` News list parameters: - name: api-key in: header description: API key required: true example: 23df424b0a53b0899f78685966243ee61 schema: type: string - name: limit in: query description: Number of items to return schema: type: integer default: 10 maximum: 100 - name: skip in: query description: Offset schema: type: integer default: 0 - name: fixed in: query description: 1 - pinned, 0 - not pinned schema: type: integer enum: - 0 - 1 responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer items: type: array items: type: object properties: _id: type: object properties: $id: type: string title: type: string small_desc: type: string desc: type: string status: type: integer created_at: type: object properties: sec: type: integer usec: type: integer all_items: type: integer example: status: 1 items: - _id: $id: 57a4914f3b7d9bbd358b45b6 title: Title news small_desc: .... desc: .... status: 1 created_at: sec: 1470402895 usec: 891000 all_items: 334 '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 \ --url 'https://api-demo.affise.com/3.0/news?limit=10&skip=0&fixed=0' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' /3.0/news/{id}: get: tags: - affiliate-news summary: News get by ID description: | `GET /3.0/news/{id}` Get news by ID parameters: - name: api-key in: header description: API key required: true example: 23df424b0a53b0899f78685966243ee61 schema: type: string - name: id in: path description: News ID required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer news: type: object properties: _id: type: object properties: $id: type: string title: type: string small_desc: type: string desc: type: string status: type: integer created_at: type: object properties: sec: type: integer usec: type: integer example: status: 1 news: _id: $id: 57a4914f3b7d9bbd358b45b6 title: ... small_desc: .... desc: .... status: 1 created_at: sec: 1470402895 usec: 891000 '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 \ --url 'https://api-demo.affise.com/3.0/news/{id}' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' /3.0/balance: get: tags: - affiliate-other summary: Affiliate balance description: | `GET /3.0/balance` Get current affiliate balance parameters: - name: api-key in: header description: API key required: true example: 23df424b0a53b0899f78685966243ee61 schema: type: string responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer balance: type: object properties: balance: type: object additionalProperties: type: number hold: type: object additionalProperties: type: number available: type: object additionalProperties: type: number example: status: 1 balance: balance: USD: 0 EUR: 0 RUB: 16968 hold: USD: 0 EUR: 0 RUB: 1234 available: USD: 0 EUR: 0 RUB: 15734 '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 \ --url 'https://api-demo.affise.com/3.0/balance' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' /3.0/partner/smartlink/categories: get: tags: - affiliate-smartlinks summary: SmartLink categories description: | `GET /3.0/partner/smartlink/categories` SmartLink categories list parameters: - name: api-key in: header description: API key required: true schema: type: string example: 23df424b0a53b0899f78685966243ee61 - name: id in: query description: SmartLink categories ID collections schema: type: array items: type: string example: id[0]: 5718dac83b7d9bf8588b4579 - name: name in: query description: Search by category name schema: type: string responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer data: type: array items: type: object properties: _id: type: string name: type: string domain: type: string use_https: type: boolean description: type: string nullable: true created_at: type: string example: status: 1 data: - _id: 595e3b547e28fede7b8b456c name: test1 domain: myDomen.com use_https: false description: null created_at: '2017-07-06 13:29:56' '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 \ --url 'https://api-demo.affise.com/3.0/partner/smartlink/categories?id[0]=5718dac83b7d9bf8588b4579' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' /3.0/partner/smartlink/category/{id}/offers-count: get: tags: - affiliate-smartlinks summary: SmartLink offer count description: | `GET /3.0/partner/smartlink/category/{id}/offers-count` Add new SmartLink category parameters: - name: api-key in: header description: API key required: true example: 23df424b0a53b0899f78685966243ee61 schema: type: string - name: id in: path description: Category ID required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer data: type: object properties: count: type: integer example: status: 1 data: count: 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 \ --url 'https://api-demo.affise.com/3.0/partner/smartlink/category/{id}/offers-count' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' /3.0/admin/partner/{id}/referrals: get: tags: - admin-affiliates summary: Get partner referrals description: | `GET /3.0/admin/partner/{id}/referrals` Get a list of referrals for a specific partner. parameters: - name: api-key in: header description: API key required: true example: 23df424b0a53b0899f78685966243ee61 schema: type: string - name: id in: path description: Partner ID required: true schema: type: integer responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer referrals: type: array items: type: object properties: id: type: integer created_at: type: string format: date-time updated_at: type: string format: date-time email: type: string login: type: string ref_percent: type: number nullable: true name: type: string nullable: true notes: type: string manager: type: object nullable: true status: type: string level: type: integer payment_systems: type: array items: type: object properties: id: type: integer active: type: integer system: type: string fields: type: object additionalProperties: type: string customFields: type: array items: type: object properties: name: type: string value: type: string label: type: string id: type: integer balance: type: object additionalProperties: type: object properties: balance: type: number hold: type: number available: type: number offersCount: type: integer api_key: type: string address_1: type: string address_2: type: string city: type: string country: type: string zip_code: type: string phone: type: string ref: type: string sub_accounts: type: object additionalProperties: type: object properties: value: type: string except: type: integer pagination: type: object properties: per_page: type: integer total_count: type: integer page: type: integer example: status: 1 referrals: - id: 2 created_at: '2019-05-04 16:55:58' updated_at: '2019-05-04 16:57:32' email: email@domain.aff login: login ref_percent: null name: null notes: Notes manager: null status: active level: 0 payment_systems: - id: 1 active: 0 system: Webmoney fields: '1': '11111' '2': '22222' customFields: - name: Skype value: skype label: skype id: 1 balance: RUB: balance: 0 hold: 0 available: 0 USD: balance: 0 hold: 0 available: 0 EUR: balance: 0 hold: 0 available: 0 BTC: balance: 0 hold: 0 available: 0 offersCount: 1 api_key: api_key address_1: adress 1 address_2: adress 2 city: New York country: US zip_code: '220089' phone: '375291111111' ref: '1' sub_accounts: '1': value: '' except: 0 '2': value: '' except: 0 pagination: per_page: 100 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 \ --url 'https://api-demo.affise.com/3.0/admin/partner/{id}/referrals' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' /3.1/partner/api-key: post: tags: - affiliate-profile summary: Change partner api key description: | `POST /3.1/partner/api-key` Change partner api key parameters: - name: api-key in: header description: API key example: 97366c88ad626fdf4c73687d2cae5394 required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer user: type: object properties: id: type: integer api_key: type: string example: status: 1 user: id: 1 api_key: 97366c88ad626fdf4c73687d2cae5394 '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '500': $ref: '#/components/responses/InternalServerError' x-codeSamples: - lang: cURL label: cURL source: |- curl --request POST \ --url 'https://api-demo.affise.com/3.1/partner/api-key' \ --header 'api-key: 97366c88ad626fdf4c73687d2cae5394' /4.0/affiliate/conversion/import: post: tags: - affiliate-conversions summary: Import single conversion (affiliate) description: | `POST /4.0/affiliate/conversion/import` Import a single conversion for affiliate parameters: - name: api-key in: header description: API key required: true example: 5718dac83b7d9bf8588b4579 schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: type: object properties: offer: type: integer description: Offer id action_id: type: string description: Advertiser conversion id click_id: type: string description: Click ID goal: type: integer description: Goal number ip: type: string description: Visitor IP ua: type: string description: Visitor user-agent comment: type: string description: Comment sum: type: integer description: Payouts amount for conversion status: type: string enum: - confirmed - pending - declined - hold description: Conversion status created_at: type: string format: date description: Created at (YYYY-MM-DD) send_advertiser_postbacks: type: boolean default: false description: If true conversion advertiser postback will be sent custom_field_1: type: string description: custom field 1 custom_field_2: type: string description: custom field 2 custom_field_3: type: string description: custom field 3 custom_field_4: type: string description: custom field 4 custom_field_5: type: string description: custom field 5 custom_field_6: type: string description: custom field 6 custom_field_7: type: string description: custom field 7 required: - offer responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer data: type: object properties: offer: type: integer action_id: type: string goal: type: integer ip: type: string ua: type: string sum: type: integer comment: type: string message: type: string example: status: 1 data: offer: 1000 action_id: null goal: null ip: null ua: null sum: null comment: null message: Conversion import will take a few minutes '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '500': $ref: '#/components/responses/InternalServerError' x-codeSamples: - lang: cURL label: cURL source: |- curl --request POST \ --url 'https://api-demo.affise.com/4.0/affiliate/conversion/import' \ --header 'api-key: 5718dac83b7d9bf8588b4579' \ --form 'offer=0' \ --form 'action_id=string' \ --form 'click_id=string' \ --form 'goal=0' \ --form 'ip=string' \ --form 'ua=string' \ --form 'comment=string' \ --form 'sum=0' \ --form 'status=confirmed' \ --form 'created_at=string' \ --form 'send_advertiser_postbacks=false' \ --form 'custom_field_1=string' \ --form 'custom_field_2=string' \ --form 'custom_field_3=string' \ --form 'custom_field_4=string' \ --form 'custom_field_5=string' \ --form 'custom_field_6=string' \ --form 'custom_field_7=string' /4.0/affiliate/conversions/import: post: tags: - affiliate-conversions summary: Import multiple conversions (affiliate) description: | `POST /4.0/affiliate/conversions/import` Import multiple conversions for affiliate parameters: - name: api-key in: header description: API key required: true example: 23df424b0a53b0899f78685966243ee61 schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: type: object properties: list: type: array items: type: object properties: offer: type: integer description: Offer id action_id: type: string description: Advertiser conversion id click_id: type: string description: Click ID goal: type: integer description: Goal number ip: type: string description: Visitor IP ua: type: string description: Visitor user-agent comment: type: string description: Comment sum: type: integer description: Payouts amount for conversion status: type: string enum: - confirmed - pending - declined - hold - pending_cap description: Conversion status created_at: type: string format: date description: Created at (YYYY-MM-DD) custom_field_1: type: string description: custom field 1 custom_field_2: type: string description: custom field 2 custom_field_3: type: string description: custom field 3 custom_field_4: type: string description: custom field 4 custom_field_5: type: string description: custom field 5 custom_field_6: type: string description: custom field 6 custom_field_7: type: string description: custom field 7 required: - offer description: List of conversions to import send_advertiser_postbacks: type: integer enum: - 0 - 1 default: 0 description: If 1 conversion advertiser postback will be sent required: - list responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer data: type: object properties: list: type: array items: type: object properties: offer: type: integer action_id: type: string goal: type: integer ip: type: string ua: type: string sum: type: integer comment: type: string message: type: string example: status: 1 data: list: - offer: 1000 action_id: null goal: null ip: null ua: null sum: null comment: null message: Conversion import will take a few minutes '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '500': $ref: '#/components/responses/InternalServerError' x-codeSamples: - lang: cURL label: cURL source: |- curl --request POST \ --url 'https://api-demo.affise.com/4.0/affiliate/conversions/import' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' \ --form 'list[0][offer]=0' \ --form 'list[0][action_id]=string' \ --form 'list[0][click_id]=string' \ --form 'list[0][goal]=0' \ --form 'list[0][ip]=string' \ --form 'list[0][ua]=string' \ --form 'list[0][comment]=string' \ --form 'list[0][sum]=0' \ --form 'list[0][status]=confirmed' \ --form 'list[0][created_at]=string' \ --form 'list[0][custom_field_1]=string' \ --form 'list[0][custom_field_2]=string' \ --form 'list[0][custom_field_3]=string' \ --form 'list[0][custom_field_4]=string' \ --form 'list[0][custom_field_5]=string' \ --form 'list[0][custom_field_6]=string' \ --form 'list[0][custom_field_7]=string' \ --form 'send_advertiser_postbacks=0' /3.0/admin/offer: post: tags: - admin-offers summary: Add offer description: | `POST /3.0/admin/offer` Add new offer parameters: - name: API-Key in: header description: API key required: true schema: type: string requestBody: content: multipart/form-data: schema: type: object properties: title: type: string description: Title advertiser: type: string description: Advertiser ID url: type: string description: Tracking URL parallel_tracking_url: type: string description: Parallel tracking URL cross_postback_url: type: string description: Cross-postback URL cross_postback_method: type: string enum: - get - post description: Cross-postback method cross_postback_body: type: string description: Cross-postback body (required for cross_postback_method=post) macro_url: type: string description: Additional macro url_preview: type: string description: View URL trafficback_url: type: string description: Trafficback URL description_lang[en]: type: string description: Offer description in English description_lang[ru]: type: string description: Offer description in Russian stopDate: type: string format: date description: Stop date (YYYY-MM-DD) creativeFiles: type: array items: type: string format: binary description: Array of creative files to upload creativeUrls: type: array items: type: string description: Array of URLs to external creative resources creativeDownloads: type: array items: type: string description: Array of URLs to external creative resources for download creativesHtml: type: array items: $ref: '#/components/schemas/offer_creative_html_structure' description: HTML creative creativeAssets: type: array items: type: string format: binary description: Assets for html creative sources: type: array items: type: string description: Array of traffic sources logo: type: string format: binary description: Logo file status: type: string enum: - stopped - active - suspended default: stopped description: Offer status tags: type: array items: type: string description: Offer tags privacy: type: string enum: - public - protected - private description: Privacy level is_top: type: integer enum: - 0 - 1 description: The top offer is_cpi: type: integer enum: - 0 - 1 description: CPI payments: type: array items: $ref: '#/components/schemas/offer_payment_structure' description: Payments array partner_payments: type: array items: allOf: - type: object properties: partners: type: array items: type: integer required: true description: Array of partner ID, which include payments (It's available only for personal payments) - $ref: '#/components/schemas/offer_payment_structure' description: Array of personal payments notice_percent_overcap: type: integer description: The percentage conversions to achieve the daily limit at which messages will be sent landings: type: array items: $ref: '#/components/schemas/offer_landing_structure' description: Array of landings strictly_country: type: integer enum: - 0 - 1 description: Strictly identify the country strictly_connection_type: type: string enum: - '' - wi-fi - cellular description: Strictly identify the connection type restriction_os: type: array items: type: object description: Strictly identify the operating system strictly_devices: type: array items: type: string description: Strictly identify the device caps: type: array items: $ref: '#/components/schemas/offer_caps_structure' description: Caps strictly_brands: type: array items: type: string description: Vendors caps_status: type: array items: type: string enum: - confirmed - pending - hold - declined description: Array of conversion statuses for caps calculation caps_timezone: type: string description: Select timezone of conversions calculating for caps with periods day/month commission_tiers: type: array items: $ref: '#/components/schemas/offer_tier_structure' description: Commission tiers enabled_commission_tiers: type: integer enum: - 0 - 1 default: 0 description: Enable commission tiers hold_period: type: integer minimum: 0 maximum: 60 description: 'Hold period duration (0-60). The unit is defined by hold_type (default: days)' hold_type: type: string enum: - days - hours default: days description: Hold type categories: type: array items: type: string description: Array of categories notes: type: string description: Offer notes allowed_ip: type: string description: Allowed IP hash_password: type: string description: Secure postback code allow_deeplink: type: integer enum: - 0 - 1 description: Allow deeplinks hide_referer: type: integer enum: - 0 - 1 description: Hide referrer redirect_type: type: string enum: - http302 - http302hidden - js - meta description: Redirect types schedule[date_start]: type: string format: date description: Date time of launch (YYYY-MM-DD) is_redirect_overcap: type: integer enum: - 0 - 1 default: 0 description: Send traffic to trafficback by daily overcaps hide_payments: type: integer enum: - 0 - 1 default: 0 description: Hide the percentage of contributions to offer for partners click_session: type: string default: 1y description: Click Session Lifespan minimal_click_session: type: string default: 0s description: Minimal click session lifespan sub_account_1: type: string description: Allowed sub1 values sub_account_2: type: string description: Allowed sub2 values sub_account_1_except: type: integer enum: - 0 - 1 default: 0 description: Block sub1 values sub_account_2_except: type: integer enum: - 0 - 1 default: 0 description: Block sub2 values smartlink_categories: type: array items: type: string description: Smartlink category ID kpi[en]: type: string description: KPI description in English kpi[ru]: type: string description: KPI description in Russian sub_restrictions: type: array items: type: object description: Sub restriction pair uniqIpOnly: type: integer enum: - 0 - 1 default: 0 description: Unique IP only flag rejectNotUniqIp: type: integer enum: - 0 - 1 default: 0 description: Reject not unique IP flag restriction_isp: type: array items: type: object description: Strictly ISP external_offer_id: type: string description: External offer id bundle_id: type: string description: Bundle id note_aff: type: string description: Note for affiliate note_sales: type: string description: Note for sales disallowed_ip: type: string description: Disallowed IP hide_caps: type: integer enum: - 0 - 1 description: Hide caps in partner interface search_empty_sub: type: integer minimum: 1 maximum: 8 description: Search for an empty sub with this number caps_goal_overcap: type: string description: When cap for chosen default goal is reached, clicks would be redirected to Trafficback url targeting: type: array items: $ref: '#/components/schemas/targeting_group_structure' description: Array of targeting groups allow_impressions: type: integer enum: - 0 - 1 description: Allow impressions for offer impressions_url: type: string description: Impressions destination URL additional_impression_destination_urls: type: string description: Additional impression destination URL consider_personal_targeting_only: type: string enum: - 'true' - 'false' description: Consider personal targeting only schedule: $ref: '#/components/schemas/offer_schedule_structure' sign_clicks_integration: type: string enum: - no_sign - appsflyer - kochava description: Click Signature Service tracking_domain: type: string description: The domain name (FQDN) for the tracking URL duplicate_clicks_threshold: type: integer minimum: 0 maximum: 100 default: 0 description: The number of clicks after which a user will be redirected to Trafficback macros_replacement: type: array items: type: object description: Macros replacement macros_replacement_enabled: type: array items: type: string enum: - sub1 - sub2 - sub3 - sub4 - sub5 - sub6 - sub7 - sub8 - sub9 - sub10 description: Macros replacement enabled auto_offer_connect: type: integer enum: - 0 - 1 description: Automatically connect affiliates to the offer creatives: type: array items: type: object properties: file_name: type: string description: Creative file name width: type: number description: Creative width height: type: number description: Creative height description: Array of existing creatives (used to update dimensions or delete creatives) creativeFileTitles: type: array items: type: string description: Titles for creative files uploaded via creativeFiles (in the same order) creativeUrlTitles: type: array items: type: string description: Titles for creative URLs passed via creativeUrls (in the same order) creativeDownloadTitles: type: array items: type: string description: Titles for creative download URLs passed via creativeDownloads (in the same order) freshness: type: string enum: - default - old - fresh - exclusive description: Offer freshness privacy_level: type: integer minimum: 0 maximum: 6 description: Offer privacy level (0-6) start_at: type: string description: Offer start date, YYYY-MM-DD or YYYY-MM-DD HH:MM:SS (only current or future date) send_emails: type: integer enum: - 0 - 1 description: Send email notifications about the offer overcap: type: integer enum: - 0 - 1 description: Enable overcap is_impression_overcap: type: integer enum: - 0 - 1 description: Enable overcap for impressions skad_app_id: type: string description: SKAdNetwork application ID redirect_param: type: string description: Redirect parameter for the tracking link managers: type: array items: type: string maxItems: 10 description: Array of manager (user) IDs assigned to the offer (max 10) hosts_only: type: integer enum: - 0 - 1 description: Count statistics by unique hosts only host_uniqueness_type: type: string enum: - cookie - sub3 description: Host uniqueness detection type product_feed_id: type: string description: Product feed ID required: - title - advertiser - url - payments 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: 936 offer_id: 5943f7307e28fe9a1f8b456d advertiser: 573c69a33b7d9b0e638b4576 hide_payments: false title: test macro_url: null url: http://YOUR_API_DOMAIN cross_postback_url: http://test-url.com cross_postback_method: post cross_postback_body: test data url_preview: http://preview.YOUR_API_DOMAIN preview_url: http://preview.YOUR_API_DOMAIN domain_url: YOUR_API_DOMAIN use_https: false use_http: true description_lang: ru: Описание en: Description sources: [] logo: /images/cpa/logos/ status: stopped tags: - default privacy: public is_top: 0 payments: [] partner_payments: [] landings: [] strictly_country: 0 strictly_os: {} strictly_connection_type: wi-fi is_redirect_overcap: false notice_percent_overcap: null hold_period: 0 hold_type: days categories: [] full_categories: [] cr: 0 epc: 0 notes: null allowed_ip: '' hash_password: null allow_deeplink: 0 hide_referer: 0 start_at: '2017-06-17 12:35:00' stop_at: null auto_offer_connect: null required_approval: false is_cpi: false creatives: [] creatives_zip: null smartlink_categories: - 595e3b5b7e28fede7b8b456d click_session: 1y minimal_click_session: 0s external_offer_id: 5a97f4af94b814997c8b456a bundle_id: 5jfj7jjs0amcslsaaah sub_restrictions: - sub1: sub_value1 sub2: sub_value2 caps_timezone: Europe/Moscow strictly_isp: - 595e3b5b7e28fede7b8b456d note_aff: '' note_sales: '' disallowed_ip: '' hide_caps: 0 caps_status: - confirmed caps_goal_overcap: install commission_tiers: - affiliate_type: exact affiliates: - 1 goals: [] timeframe: month type: budget value: 55.6 target_goals: [] modifier_type: to_percent modifier_value: 10.02 modifier_payment_type: payout countries: [] consider_personal_targeting_only: false schedule: enabled: true date_start: '2022-01-09' date_to: '2022-08-01' timezone: Europe/Monaco intervals: - day_of_week: 1 from: 2 to: 4 - day_of_week: 1 from: 8 to: 10 targeting: - country: allow: - BR - US deny: [] region: allow: {} deny: {} city: allow: {} deny: {} os: allow: [] deny: [] isp: allow: {} deny: {} ip: allow: [] deny: [] browser: allow: [] deny: [] brand: allow: [] deny: [] device_type: [] connection: [] affiliate_id: [] sub: allow: {} deny: {} deny_groups: [] id: cc4fe1f5-3425-42ae-9874-a10fe29a2974 os_deny: false zip: [] device_type_deny: false connection_deny: false macros_replacement: [] macros_replacement_enabled: [] browser_version: [] device_model: [] name: My Targeting condition: and enabled: true isp_organization: [] referrer: allow: [] deny: [] deny_empty: 0 is_regexp: false ua: [] block_proxy: false block_known_bots: false duplicate_clicks_threshold: 0 '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '500': $ref: '#/components/responses/InternalServerError' x-codeSamples: - lang: cURL label: cURL source: |- curl --request POST \ --url 'https://api-demo.affise.com/3.0/admin/offer' \ --header 'API-Key: ' \ --form 'title=string' \ --form 'advertiser=string' \ --form 'url=string' \ --form 'parallel_tracking_url=string' \ --form 'cross_postback_url=string' \ --form 'cross_postback_method=get' \ --form 'cross_postback_body=string' \ --form 'macro_url=string' \ --form 'url_preview=string' \ --form 'trafficback_url=string' \ --form 'description_lang[en]=string' \ --form 'description_lang[ru]=string' \ --form 'stopDate=string' \ --form 'creativeFiles[0]=string' \ --form 'creativeFiles[1]=string2' \ --form 'creativeUrls[0]=string' \ --form 'creativeUrls[1]=string2' \ --form 'creativeDownloads[0]=string' \ --form 'creativeDownloads[1]=string2' \ --form 'creativeAssets[0]=string' \ --form 'creativeAssets[1]=string2' \ --form 'sources[0]=string' \ --form 'sources[1]=string2' \ --form 'logo=string' \ --form 'status=stopped' \ --form 'tags[0]=string' \ --form 'tags[1]=string2' \ --form 'privacy=public' \ --form 'is_top=0' \ --form 'is_cpi=0' \ --form 'partner_payments[0][partners][0]=0' \ --form 'partner_payments[0][partners][1]=1' \ --form 'notice_percent_overcap=0' \ --form 'strictly_country=0' \ --form 'strictly_connection_type=' \ --form 'strictly_devices[0]=string' \ --form 'strictly_devices[1]=string2' \ --form 'strictly_brands[0]=string' \ --form 'strictly_brands[1]=string2' \ --form 'caps_status[0]=confirmed' \ --form 'caps_timezone=string' \ --form 'enabled_commission_tiers=0' \ --form 'hold_period=0' \ --form 'hold_type=days' \ --form 'categories[0]=string' \ --form 'categories[1]=string2' \ --form 'notes=string' \ --form 'allowed_ip=string' \ --form 'hash_password=string' \ --form 'allow_deeplink=0' \ --form 'hide_referer=0' \ --form 'redirect_type=http302' \ --form 'schedule[date_start]=string' \ --form 'is_redirect_overcap=0' \ --form 'hide_payments=0' \ --form 'click_session=1y' \ --form 'minimal_click_session=0s' \ --form 'sub_account_1=string' \ --form 'sub_account_2=string' \ --form 'sub_account_1_except=0' \ --form 'sub_account_2_except=0' \ --form 'smartlink_categories[0]=string' \ --form 'smartlink_categories[1]=string2' \ --form 'kpi[en]=string' \ --form 'kpi[ru]=string' \ --form 'uniqIpOnly=0' \ --form 'rejectNotUniqIp=0' \ --form 'external_offer_id=string' \ --form 'bundle_id=string' \ --form 'note_aff=string' \ --form 'note_sales=string' \ --form 'disallowed_ip=string' \ --form 'hide_caps=0' \ --form 'search_empty_sub=0' \ --form 'caps_goal_overcap=string' \ --form 'allow_impressions=0' \ --form 'impressions_url=string' \ --form 'additional_impression_destination_urls=string' \ --form 'consider_personal_targeting_only=true' \ --form 'sign_clicks_integration=no_sign' \ --form 'tracking_domain=string' \ --form 'duplicate_clicks_threshold=0' \ --form 'macros_replacement_enabled[0]=sub1' \ --form 'auto_offer_connect=0' \ --form 'creatives[0][file_name]=string' \ --form 'creatives[0][width]=0' \ --form 'creatives[0][height]=0' \ --form 'creativeFileTitles[0]=string' \ --form 'creativeFileTitles[1]=string2' \ --form 'creativeUrlTitles[0]=string' \ --form 'creativeUrlTitles[1]=string2' \ --form 'creativeDownloadTitles[0]=string' \ --form 'creativeDownloadTitles[1]=string2' \ --form 'freshness=default' \ --form 'privacy_level=0' \ --form 'start_at=string' \ --form 'send_emails=0' \ --form 'overcap=0' \ --form 'is_impression_overcap=0' \ --form 'skad_app_id=string' \ --form 'redirect_param=string' \ --form 'managers[0]=string' \ --form 'managers[1]=string2' \ --form 'hosts_only=0' \ --form 'host_uniqueness_type=cookie' \ --form 'product_feed_id=string' /3.0/admin/offer/{id}: post: tags: - admin-offers summary: Edit offer description: | `POST /3.0/admin/offer/{id}` Change an offer settings 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 requestBody: content: multipart/form-data: schema: type: object properties: title: type: string description: Title advertiser: type: string description: Advertiser ID url: type: string description: Tracking URL parallel_tracking_url: type: string description: Parallel tracking URL cross_postback_url: type: string description: Cross-postback URL cross_postback_method: type: string enum: - get - post description: Cross-postback method cross_postback_body: type: string description: Cross-postback body (required for cross_postback_method=post) macro_url: type: string description: Additional macro url_preview: type: string description: View URL trafficback_url: type: string description: Trafficback URL description_lang[en]: type: string description: Offer description in English description_lang[ru]: type: string description: Offer description in Russian kpi[en]: type: string description: KPI description in English kpi[ru]: type: string description: KPI description in Russian stopDate: type: string format: date description: Stop date (YYYY-MM-DD) creativeFiles: type: array items: type: string format: binary description: An array of creative FILES to upload creativeUrls: type: array items: type: string description: An array of URLs to external creative resources creativeDownloads: type: array items: type: string description: An array of URLs to external creative resources for download creativesHtml: type: array items: $ref: '#/components/schemas/offer_creative_html_structure' description: HTML creative creativeAssets: type: array items: type: string format: binary description: Assets for html creative creativeFileTitles: type: array items: type: string description: Array of titles for file creatives creativeUrlTitles: type: array items: type: string description: Array of titles for url creatives creativeDownloadTitles: type: array items: type: string description: Array of titles for download creatives sources: type: array items: type: string description: An array of traffic sources logo: type: string format: binary description: logo File status: type: string enum: - stopped - active - suspended default: stopped description: Offer status tags: type: array items: type: string description: Offer tags privacy: type: string enum: - public - protected - private description: Privacy level is_top: type: integer enum: - 0 - 1 description: The top offer is_cpi: type: integer enum: - 0 - 1 description: CPI payments: type: array items: $ref: '#/components/schemas/offer_payment_structure' description: Payments array partner_payments: type: array items: allOf: - $ref: '#/components/schemas/offer_payment_structure' - type: object properties: partners: type: array items: type: integer description: Array of partner ID, which include payments (It's available only for personal payments) description: Array of personal payments notice_percent_overcap: type: integer description: The percentage conversions to achieve the daily limit at which the messages will be sent landings: type: array items: $ref: '#/components/schemas/offer_landing_structure' description: An array of landings. This replaces the entire landings collection — any existing landing not included here is deleted. Pass an existing landing's id to update it in place; omit id to add a new landing. Pass an empty string (instead of an array) to clear all landings. strictly_country: type: integer enum: - 0 - 1 description: Strictly identify the country strictly_connection_type: type: string enum: - '' - wi-fi - cellular description: Strictly identify the connection type restriction_os: type: array items: type: object description: Strictly identify the operating system strictly_devices: type: array items: type: string description: Strictly identify the device caps: type: array items: $ref: '#/components/schemas/offer_caps_structure' description: Caps caps_status: type: array items: type: string enum: - confirmed - pending - hold - declined description: Array of conversion statuses for caps calculation caps_timezone: type: string description: Select timezone of conversions calculating for caps with periods day/month commission_tiers: type: array items: $ref: '#/components/schemas/offer_tier_structure' description: Commission tiers enabled_commission_tiers: type: integer enum: - 0 - 1 description: Enable commission tiers hold_period: type: integer minimum: 0 maximum: 60 description: Hold time hold_type: type: string enum: - days - hours default: days description: Hold type categories: type: array items: type: string description: An array of categories notes: type: string description: Offer notes allowed_ip: type: string description: Allowed IP hash_password: type: string description: Secure postback code allow_deeplink: type: integer enum: - 0 - 1 description: Allow deeplinks hide_referer: type: integer enum: - 0 - 1 description: Hide referrer (deprecated, use redirect_type) redirect_type: type: string enum: - http302 - http302hidden - js - meta description: Redirect types schedule: $ref: '#/components/schemas/offer_schedule_structure' is_redirect_overcap: type: integer enum: - 0 - 1 default: 0 description: Send traffic to trafficback by daily overcaps hide_payments: type: integer enum: - 0 - 1 default: 0 description: Hide the percentage of contributions to offer for partners click_session: type: string default: 1y description: Click Session Lifespan minimal_click_session: type: string default: 0s description: Minimal click session lifespan sub_account_1: type: string description: Sub1 list, separated by commas sub_account_2: type: string description: Sub2 list, separated by commas sub_account_1_except: type: integer enum: - 0 - 1 default: 0 description: Except Sub1 list sub_account_2_except: type: integer enum: - 0 - 1 default: 0 description: Except Sub2 list smartlink_categories: type: array items: type: string description: Smartlink category ID sub_restrictions: type: array items: type: object description: Sub restriction pair uniqIpOnly: type: integer enum: - 0 - 1 default: 0 description: Unique IP only flag rejectNotUniqIp: type: integer enum: - 0 - 1 default: 0 description: Reject not unique IP flag restriction_isp: type: array items: type: object description: Stricly ISP external_offer_id: type: string description: External offer id bundle_id: type: string description: Bundle id hide_caps: type: integer enum: - 0 - 1 description: Hide caps in partner interface search_empty_sub: type: integer minimum: 1 maximum: 8 description: Search for an empty sub with this number caps_goal_overcap: type: string description: When cap for chosen default goal is reached, clicks would be redirected to Trafficback url targeting: type: array items: $ref: '#/components/schemas/targeting_group_structure' description: Array of targeting groups allow_impressions: type: integer enum: - 0 - 1 description: Allow impressions for offer impressions_url: type: string description: Impressions destination URL additional_impression_destination_urls: type: string description: Additional impression destination URL consider_personal_targeting_only: type: string enum: - 'true' - 'false' description: Consider personal targeting only sign_clicks_integration: type: string enum: - no_sign - appsflyer - kochava description: Click Signature Service tracking_domain: type: string description: The domain name (FQDN) for the tracking URL duplicate_clicks_threshold: type: integer minimum: 0 maximum: 100 default: 0 description: The number of clicks after which a user will be redirected to Trafficback macros_replacement: type: array items: type: object description: Macros replacement macros_replacement_enabled: type: array items: type: string enum: - sub1 - sub2 - sub3 - sub4 - sub5 - sub6 - sub7 - sub8 - sub9 - sub10 description: Macros replacement enabled auto_offer_connect: type: integer enum: - 0 - 1 description: Automatically connect affiliates to the offer creatives: type: array items: type: object properties: file_name: type: string description: Creative file name width: type: number description: Creative width height: type: number description: Creative height description: Array of existing creatives (used to update dimensions or delete creatives) freshness: type: string enum: - default - old - fresh - exclusive description: Offer freshness privacy_level: type: integer minimum: 0 maximum: 6 description: Offer privacy level (0-6) note_aff: type: string description: Note for affiliate note_sales: type: string description: Note for sales disallowed_ip: type: string description: Disallowed IP addresses or ranges of IP addresses start_at: type: string description: Offer start date, YYYY-MM-DD or YYYY-MM-DD HH:MM:SS (only current or future date) send_emails: type: integer enum: - 0 - 1 description: Send email notifications about the offer overcap: type: integer enum: - 0 - 1 description: Enable overcap is_impression_overcap: type: integer enum: - 0 - 1 description: Enable overcap for impressions skad_app_id: type: string description: SKAdNetwork application ID redirect_param: type: string description: Redirect parameter for the tracking link managers: type: array items: type: string maxItems: 10 description: Array of manager (user) IDs assigned to the offer (max 10) hosts_only: type: integer enum: - 0 - 1 description: Count statistics by unique hosts only host_uniqueness_type: type: string enum: - cookie - sub3 description: Host uniqueness detection type product_feed_id: type: string description: Product feed ID 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: 936 offer_id: 5943f7307e28fe9a1f8b456d advertiser: 573c69a33b7d9b0e638b4576 hide_payments: false title: test_edit macro_url: null url: http://YOUR_API_DOMAIN cross_postback_url: http://test-url.com cross_postback_method: post cross_postback_body: test data url_preview: http://preview.YOUR_API_DOMAIN preview_url: http://preview.YOUR_API_DOMAIN domain_url: YOUR_API_DOMAIN use_https: false use_http: true description_lang: ru: Описание en: Description sources: [] logo: /images/cpa/logos/ status: stopped tags: - default privacy: public is_top: 0 payments: [] partner_payments: [] landings: [] strictly_country: 0 strictly_os: {} strictly_connection_type: wi-fi is_redirect_overcap: false notice_percent_overcap: null hold_period: 0 hold_type: days categories: [] full_categories: [] cr: 0 epc: 0 notes: null allowed_ip: '' hash_password: null allow_deeplink: 0 hide_referer: 0 start_at: '2017-06-17 12:35:00' stop_at: null auto_offer_connect: null required_approval: false is_cpi: false creatives: [] creatives_zip: null smartlink_categories: - 595e3b5b7e28fede7b8b456d click_session: 1y minimal_click_session: 0s external_offer_id: 5a97f4af94b814997c8b456a bundle_id: 5jfj7jjs0amcslsaaah sub_restrictions: - sub1: sub_value1 sub2: sub_value2 caps_timezone: Europe/Moscow strictly_isp: - 595e3b5b7e28fede7b8b456d note_aff: '' note_sales: '' disallowed_ip: '' hide_caps: 0 caps_status: - confirmed caps_goal_overcap: install commission_tiers: - affiliate_type: exact affiliates: - 1 goals: [] timeframe: month type: budget value: 55.6 target_goals: [] modifier_type: to_percent modifier_value: 10.02 modifier_payment_type: payout countries: [] consider_personal_targeting_only: false schedule: enabled: true date_start: '2022-01-09' date_to: '2022-08-01' timezone: Europe/Monaco intervals: - day_of_week: 1 from: 2 to: 4 - day_of_week: 1 from: 8 to: 10 targeting: - country: allow: - BR - US deny: [] region: allow: {} deny: {} city: allow: {} deny: {} os: allow: [] deny: [] isp: allow: {} deny: {} ip: allow: [] deny: [] browser: allow: [] deny: [] brand: allow: [] deny: [] device_type: [] connection: [] affiliate_id: [] sub: allow: {} deny: {} deny_groups: [] id: cc4fe1f5-3425-42ae-9874-a10fe29a2974 os_deny: false zip: [] device_type_deny: false connection_deny: false macros_replacement: [] macros_replacement_enabled: [] browser_version: [] device_model: [] name: My Targeting condition: and enabled: true isp_organization: [] referrer: allow: [] deny: [] deny_empty: 0 is_regexp: false ua: [] block_proxy: false block_known_bots: false duplicate_clicks_threshold: 0 '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '500': $ref: '#/components/responses/InternalServerError' x-codeSamples: - lang: cURL label: cURL source: |- curl --request POST \ --url 'https://api-demo.affise.com/3.0/admin/offer/{id}' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' \ --form 'title=string' \ --form 'advertiser=string' \ --form 'url=string' \ --form 'parallel_tracking_url=string' \ --form 'cross_postback_url=string' \ --form 'cross_postback_method=get' \ --form 'cross_postback_body=string' \ --form 'macro_url=string' \ --form 'url_preview=string' \ --form 'trafficback_url=string' \ --form 'description_lang[en]=string' \ --form 'description_lang[ru]=string' \ --form 'kpi[en]=string' \ --form 'kpi[ru]=string' \ --form 'stopDate=string' \ --form 'creativeFiles[0]=string' \ --form 'creativeFiles[1]=string2' \ --form 'creativeUrls[0]=string' \ --form 'creativeUrls[1]=string2' \ --form 'creativeDownloads[0]=string' \ --form 'creativeDownloads[1]=string2' \ --form 'creativeAssets[0]=string' \ --form 'creativeAssets[1]=string2' \ --form 'creativeFileTitles[0]=string' \ --form 'creativeFileTitles[1]=string2' \ --form 'creativeUrlTitles[0]=string' \ --form 'creativeUrlTitles[1]=string2' \ --form 'creativeDownloadTitles[0]=string' \ --form 'creativeDownloadTitles[1]=string2' \ --form 'sources[0]=string' \ --form 'sources[1]=string2' \ --form 'logo=string' \ --form 'status=stopped' \ --form 'tags[0]=string' \ --form 'tags[1]=string2' \ --form 'privacy=public' \ --form 'is_top=0' \ --form 'is_cpi=0' \ --form 'partner_payments[0][partners][0]=0' \ --form 'partner_payments[0][partners][1]=1' \ --form 'notice_percent_overcap=0' \ --form 'strictly_country=0' \ --form 'strictly_connection_type=' \ --form 'strictly_devices[0]=string' \ --form 'strictly_devices[1]=string2' \ --form 'caps_status[0]=confirmed' \ --form 'caps_timezone=string' \ --form 'enabled_commission_tiers=0' \ --form 'hold_period=0' \ --form 'hold_type=days' \ --form 'categories[0]=string' \ --form 'categories[1]=string2' \ --form 'notes=string' \ --form 'allowed_ip=string' \ --form 'hash_password=string' \ --form 'allow_deeplink=0' \ --form 'hide_referer=0' \ --form 'redirect_type=http302' \ --form 'is_redirect_overcap=0' \ --form 'hide_payments=0' \ --form 'click_session=1y' \ --form 'minimal_click_session=0s' \ --form 'sub_account_1=string' \ --form 'sub_account_2=string' \ --form 'sub_account_1_except=0' \ --form 'sub_account_2_except=0' \ --form 'smartlink_categories[0]=string' \ --form 'smartlink_categories[1]=string2' \ --form 'uniqIpOnly=0' \ --form 'rejectNotUniqIp=0' \ --form 'external_offer_id=string' \ --form 'bundle_id=string' \ --form 'hide_caps=0' \ --form 'search_empty_sub=0' \ --form 'caps_goal_overcap=string' \ --form 'allow_impressions=0' \ --form 'impressions_url=string' \ --form 'additional_impression_destination_urls=string' \ --form 'consider_personal_targeting_only=true' \ --form 'sign_clicks_integration=no_sign' \ --form 'tracking_domain=string' \ --form 'duplicate_clicks_threshold=0' \ --form 'macros_replacement_enabled[0]=sub1' \ --form 'auto_offer_connect=0' \ --form 'creatives[0][file_name]=string' \ --form 'creatives[0][width]=0' \ --form 'creatives[0][height]=0' \ --form 'freshness=default' \ --form 'privacy_level=0' \ --form 'note_aff=string' \ --form 'note_sales=string' \ --form 'disallowed_ip=string' \ --form 'start_at=string' \ --form 'send_emails=0' \ --form 'overcap=0' \ --form 'is_impression_overcap=0' \ --form 'skad_app_id=string' \ --form 'redirect_param=string' \ --form 'managers[0]=string' \ --form 'managers[1]=string2' \ --form 'hosts_only=0' \ --form 'host_uniqueness_type=cookie' \ --form 'product_feed_id=string' /3.0/offers/count: get: tags: - admin-offers summary: Count of active offers description: | `GET /3.0/offers/count` Get count of offers in status 'active' parameters: - name: api-key in: header description: API key example: 23df424b0a53b0899f78685966243ee61 required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer count: type: integer example: status: 1 count: 8 '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 \ --url 'https://api-demo.affise.com/3.0/offers/count' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' /ui/offers/available-for/{affiliate_id}: get: tags: - admin-offers summary: Offers available for affiliate description: | `GET /ui/offers/available-for/{affiliate_id}` Returns the offers available for the given affiliate — the same list the affiliate would see on the partner panel with their own API key, but requested with an admin API key. Available only for an admin (common-manager) or root API key that has read access to the offers section. parameters: - name: api-key in: header description: API key required: true schema: type: string example: 23df424b0a53b0899f78685966243ee61 - name: affiliate_id in: path description: Affiliate to list available offers for required: true schema: type: integer example: 1 - name: page in: query description: Page of offers schema: type: integer - name: limit in: query description: Count offers by page schema: type: integer default: 100 maximum: 500 responses: '200': description: Successful response content: application/json: schema: type: object properties: offers: type: array items: $ref: '#/components/schemas/offer' pagination: type: object properties: total_count: type: integer per_page: type: integer page: type: integer next_page: type: integer example: offers: [] pagination: total_count: 127 per_page: 20 page: 1 next_page: 2 '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 \ --url 'https://api-demo.affise.com/ui/offers/available-for/{affiliate_id}?limit=100' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' /3.0/admin/offer/delete: post: tags: - admin-offers summary: Delete offer description: | `POST /3.0/admin/offer/delete` Delete the offer parameters: - name: api-key in: header description: API key example: 23df424b0a53b0899f78685966243ee61 required: true schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: type: object properties: offer_id: type: array items: type: integer description: Offer IDs example: '0': 1 required: - offer_id responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer message: type: string example: status: 1 message: Offer 936 is removed successfully. '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '500': $ref: '#/components/responses/InternalServerError' x-codeSamples: - lang: cURL label: cURL source: |- curl --request POST \ --url 'https://api-demo.affise.com/3.0/admin/offer/delete' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' \ --form 'offer_id[0]=1' /3.1/offers/{id}/privacy: get: tags: - admin-offers summary: Enabled/disabled affiliates list description: | `GET /3.1/offers/{id}/privacy` Get list of enabled/disabled affiliates and offer's privacy parameters: - name: API-Key in: header description: API key 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: type: object properties: affiliates_disabled: type: array items: type: integer affiliates_enabled: type: array items: type: integer privacy_level: type: string example: affiliates_disabled: [] affiliates_enabled: - 9 privacy_level: private '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 \ --url 'https://api-demo.affise.com/3.1/offers/{id}/privacy' \ --header 'API-Key: ' /3.0/admin/offer/sources: get: tags: - admin-offers summary: Sources description: | `GET /3.0/admin/offer/sources` Get list of sources parameters: - name: api-key in: header description: API key example: 23df424b0a53b0899f78685966243ee61 required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer sources: type: array items: type: object properties: id: type: string title: type: string title_lang: type: object additionalProperties: type: string allowed: type: integer example: status: 1 sources: - id: 51f531f53b7d9b1e0382f6d9 title: Web sites title_lang: ru: веб сайты en: web sites es: '' allowed: 0 '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 \ --url 'https://api-demo.affise.com/3.0/admin/offer/sources' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' /3.0/admin/offer/source: post: tags: - admin-offers summary: Source add description: | `POST /3.0/admin/offer/source` Add new source parameters: - name: api-key in: header description: API key example: 23df424b0a53b0899f78685966243ee61 required: true schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: type: object properties: title_lang[en]: type: string description: Title in English title_lang[ru]: type: string description: Title in Russian title_lang[es]: type: string description: Title in Spanish title_lang[ka]: type: string description: Title in Georgian title_lang[vi]: type: string description: Title in Vietnamese required: - title_lang[en] responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer source: type: object properties: id: type: string title: type: string title_lang: type: object additionalProperties: type: string example: status: 1 source: title: api-test-en-3 title_lang: en: api-test-en-3 ru: api-test-ru-3 es: api-test-es-2 ka: api-test-ka-2 vi: api-test-vi-3 id: 5b7e6d350f0e5a001c7bb4d5 '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '500': $ref: '#/components/responses/InternalServerError' x-codeSamples: - lang: cURL label: cURL source: |- curl --request POST \ --url 'https://api-demo.affise.com/3.0/admin/offer/source' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' \ --form 'title_lang[en]=string' \ --form 'title_lang[ru]=string' \ --form 'title_lang[es]=string' \ --form 'title_lang[ka]=string' \ --form 'title_lang[vi]=string' /3.0/admin/offer/source/{id}: post: tags: - admin-offers summary: Source edit description: | `POST /3.0/admin/offer/source/{id}` Edit source parameters: - name: api-key in: header description: API key example: 23df424b0a53b0899f78685966243ee61 required: true schema: type: string - name: id in: path description: Source ID required: true schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: type: object properties: title_lang[en]: type: string description: Title in English title_lang[ru]: type: string description: Title in Russian title_lang[es]: type: string description: Title in Spanish title_lang[ka]: type: string description: Title in Georgian title_lang[vi]: type: string description: Title in Vietnamese required: - title_lang[en] responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer source: type: object properties: id: type: string title: type: string title_lang: type: object additionalProperties: type: string example: status: 1 source: title: api-test-en-3 title_lang: en: api-test-en-3 ru: api-test-ru-3 es: api-test-es-2 ka: api-test-ka-2 vi: api-test-vi-3 id: 5b7e6d350f0e5a001c7bb4d5 '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '500': $ref: '#/components/responses/InternalServerError' x-codeSamples: - lang: cURL label: cURL source: |- curl --request POST \ --url 'https://api-demo.affise.com/3.0/admin/offer/source/{id}' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' \ --form 'title_lang[en]=string' \ --form 'title_lang[ru]=string' \ --form 'title_lang[es]=string' \ --form 'title_lang[ka]=string' \ --form 'title_lang[vi]=string' delete: tags: - admin-offers summary: Source remove description: | `DELETE /3.0/admin/offer/source/{id}` Remove source parameters: - name: api-key in: header description: API key example: 23df424b0a53b0899f78685966243ee61 required: true schema: type: string - name: id in: path description: Source ID required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer source: type: object properties: id: type: string title: type: string title_lang: type: object additionalProperties: type: string example: status: 1 source: title: api-test-en-3 title_lang: en: api-test-en-3 ru: api-test-ru-3 es: api-test-es-2 ka: api-test-ka-2 vi: api-test-vi-3 id: 5b7e6d350f0e5a001c7bb4d5 '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '500': $ref: '#/components/responses/InternalServerError' x-codeSamples: - lang: cURL label: cURL source: |- curl --request DELETE \ --url 'https://api-demo.affise.com/3.0/admin/offer/source/{id}' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' /3.0/admin/category: post: tags: - admin-offers summary: Category add description: | `POST /3.0/admin/category` Add new category parameters: - name: api-key in: header description: API key example: 23df424b0a53b0899f78685966243ee61 required: true schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: type: object properties: title: type: string description: Category title required: - title responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer category: type: object properties: id: type: string title: type: string example: status: 1 category: id: 59440f427e28feff5c8b4567 title: test_category '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '500': $ref: '#/components/responses/InternalServerError' x-codeSamples: - lang: cURL label: cURL source: |- curl --request POST \ --url 'https://api-demo.affise.com/3.0/admin/category' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' \ --form 'title=string' /3.0/admin/category/{id}: post: tags: - admin-offers summary: Category edit description: | `POST /3.0/admin/category/{id}` Change a category parameters: - name: api-key in: header description: API key required: true example: 23df424b0a53b0899f78685966243ee61 schema: type: string - name: id in: path description: Category ID required: true schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: type: object properties: title: type: string description: Category title required: - title responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer category: type: object properties: id: type: string title: type: string example: status: 1 category: id: 59440f427e28feff5c8b4567 title: test_category2 '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '500': $ref: '#/components/responses/InternalServerError' x-codeSamples: - lang: cURL label: cURL source: |- curl --request POST \ --url 'https://api-demo.affise.com/3.0/admin/category/{id}' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' \ --form 'title=string' /3.0/offer/enable-affiliate: post: tags: - admin-offers summary: Enable affiliate description: | `POST /3.0/offer/enable-affiliate` Connection an affiliate to offer parameters: - name: api-key in: header description: API key example: 23df424b0a53b0899f78685966243ee61 required: true schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: type: object properties: offer_id: oneOf: - type: integer - type: array items: type: integer example: '0': 2 description: Offer ID or array of offer IDs pid: type: integer description: Affiliate ID notice: type: integer enum: - 0 - 1 default: 1 description: Send notice to affiliate required: - offer_id - pid responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer message: type: string example: status: 1 message: Request for offer 935 is successfully '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '500': $ref: '#/components/responses/InternalServerError' x-codeSamples: - lang: cURL label: cURL source: |- curl --request POST \ --url 'https://api-demo.affise.com/3.0/offer/enable-affiliate' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' \ --form 'offer_id[0]=2' \ --form 'pid=0' \ --form 'notice=1' /3.0/offer/disable-affiliate: post: tags: - admin-offers summary: Disable affiliate description: | `POST /3.0/offer/disable-affiliate` Disconnect an affiliate from offer parameters: - name: api-key in: header description: API key example: 23df424b0a53b0899f78685966243ee61 required: true schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: type: object properties: offer_id: oneOf: - type: integer - type: array items: type: integer example: '0': 2 description: Offer ID or array of offer IDs pid: type: integer description: Affiliate ID notice: type: integer enum: - 0 - 1 default: 1 description: Send notice to affiliate required: - offer_id - pid responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer message: type: string example: status: 1 message: Request for offer 935 is successfully '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '500': $ref: '#/components/responses/InternalServerError' x-codeSamples: - lang: cURL label: cURL source: |- curl --request POST \ --url 'https://api-demo.affise.com/3.0/offer/disable-affiliate' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' \ --form 'offer_id[0]=2' \ --form 'pid=0' \ --form 'notice=1' /3.0/admin/offer/mass-update: post: tags: - admin-offers summary: Update offer's status description: | `POST /3.0/admin/offer/mass-update` Update offers status parameters: - name: api-key in: header description: API key example: 23df424b0a53b0899f78685966243ee61 required: true schema: type: string requestBody: content: multipart/form-data: schema: type: object properties: offer_id: type: array items: type: integer description: Offer IDs status: type: string enum: - active - stopped - suspended description: Status privacy: type: string enum: - public - protected - private description: Privacy level required: - offer_id responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer message: type: string example: status: 1 message: status updated '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '500': $ref: '#/components/responses/InternalServerError' x-codeSamples: - lang: cURL label: cURL source: |- curl --request POST \ --url 'https://api-demo.affise.com/3.0/admin/offer/mass-update' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' \ --form 'offer_id[0]=0' \ --form 'offer_id[1]=1' \ --form 'status=active' \ --form 'privacy=public' /3.0/admin/offer/{id}/disable-affiliates: post: tags: - admin-offers summary: Disable affiliates description: | `POST /3.0/admin/offer/{id}/disable-affiliates` Disconnect all affiliates from private or protected offer parameters: - name: api-key in: header description: API key required: true example: 23df424b0a53b0899f78685966243ee61 schema: type: string - name: id in: path description: Private or protected offer ID required: true schema: type: integer responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer message: type: string example: status: 1 message: Affiliates disabled successfully '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '500': $ref: '#/components/responses/InternalServerError' x-codeSamples: - lang: cURL label: cURL source: |- curl --request POST \ --url 'https://api-demo.affise.com/3.0/admin/offer/{id}/disable-affiliates' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' /3.0/admin/affiliate/{id}/disable-offers: post: tags: - admin-offers summary: Disable offers description: | `POST /3.0/admin/affiliate/{id}/disable-offers` Disconnect all private or protected offers from affiliate parameters: - name: api-key in: header description: API key required: true example: 23df424b0a53b0899f78685966243ee61 schema: type: string - name: id in: path description: Affiliate ID required: true schema: type: integer responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer message: type: string example: status: 1 message: Offers disabled successfully '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '500': $ref: '#/components/responses/InternalServerError' x-codeSamples: - lang: cURL label: cURL source: |- curl --request POST \ --url 'https://api-demo.affise.com/3.0/admin/affiliate/{id}/disable-offers' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' /3.0/admin/offer/{offerId}/tracking-link: post: tags: - admin-offers summary: Generate tracking link description: | `POST /3.0/admin/offer/{offerId}/tracking-link` Generate a tracking link for a specific offer and affiliate. Only available for admin and manager roles. Validates that the affiliate has access to the offer based on its privacy settings. parameters: - name: api-key in: header description: API key example: 23df424b0a53b0899f78685966243ee61 required: true schema: type: string - name: offerId in: path description: Offer ID required: true schema: type: integer requestBody: content: application/x-www-form-urlencoded: schema: type: object properties: affiliate_id: type: integer description: Affiliate ID sub1: type: string description: Sub parameter 1 sub2: type: string description: Sub parameter 2 sub3: type: string description: Sub parameter 3 sub4: type: string description: Sub parameter 4 sub5: type: string description: Sub parameter 5 sub6: type: string description: Sub parameter 6 sub7: type: string description: Sub parameter 7 sub8: type: string description: Sub parameter 8 required: - affiliate_id responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer tracking_link: type: string example: status: 1 tracking_link: https://your-tracking-domain.com/click?pid=610&offer_id=935&sub1=value1&sub2=value2 '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '500': $ref: '#/components/responses/InternalServerError' x-codeSamples: - lang: cURL label: cURL source: |- curl --request POST \ --url 'https://api-demo.affise.com/3.0/admin/offer/{offerId}/tracking-link' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' \ --form 'affiliate_id=0' \ --form 'sub1=string' \ --form 'sub2=string' \ --form 'sub3=string' \ --form 'sub4=string' \ --form 'sub5=string' \ --form 'sub6=string' \ --form 'sub7=string' \ --form 'sub8=string' /3.0/admin/offer/{id}/remove-creative: delete: tags: - admin-offers summary: Remove creative from offer description: | `DELETE /3.0/admin/offer/{id}/remove-creative` Remove creative from offer by creative id 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 requestBody: content: application/x-www-form-urlencoded: schema: type: object properties: creatives: type: array items: type: integer example: '0': 12345 description: Creative IDs required: - creatives responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer removed: type: array items: type: integer example: status: 1 removed: - 1 - 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 DELETE \ --url 'https://api-demo.affise.com/3.0/admin/offer/{id}/remove-creative' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' \ --form 'creatives[0]=12345' /3.0/admin/offer/{offer_id}/creative/html/{creative_id}: post: tags: - admin-offers summary: Change HTML creatives description: | `POST /3.0/admin/offer/{offer_id}/creative/html/{creative_id}` Change html creative from offer by creative id parameters: - name: api-key in: header description: API key example: 23df424b0a53b0899f78685966243ee61 required: true schema: type: string - name: offer_id in: path description: Offer ID required: true schema: type: integer - name: creative_id in: path description: Creative ID required: true schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: type: object properties: code: type: string description: HTML code name: type: string description: Creative name width: type: integer description: Creative width height: type: integer description: Creative height required: - code - name - width - height responses: '200': description: Successful response content: application/json: schema: type: object properties: creatives: type: array items: type: object properties: id: type: string type: type: string url: type: string title: type: string width: type: integer height: type: integer size: type: integer overwritten: type: boolean assets: type: array items: type: object example: creatives: - id: 7caf7245-be89-4845-bf47-31bfada8e3f9 type: image/jpeg url: http://s3host/bucket/offers/99999/104/x-files.jpeg title: x-files width: 1024 height: 768 size: 79685 overwritten: false - id: a899dae2-a9c0-4c11-a5d3-76a131a9ed0e type: text/html url: http://s3host/bucket/offers/99999/104/23249c03-a9b3-11ec-a56e-0242ac10ee4d.html title: html creative width: 100 height: 100 size: 132 assets: - url: http://s3host/bucket/99999/104/opt/app/web/creatives/ab/66/ab661c7ca92142727035b33a72a209d7.jpeg title: ab661c7ca92142727035b33a72a209d7.jpeg size: 112836 overwritten: false '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '500': $ref: '#/components/responses/InternalServerError' x-codeSamples: - lang: cURL label: cURL source: |- curl --request POST \ --url 'https://api-demo.affise.com/3.0/admin/offer/{offer_id}/creative/html/{creative_id}' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' \ --form 'code=string' \ --form 'name=string' \ --form 'width=0' \ --form 'height=0' delete: tags: - admin-offers summary: Delete HTML creatives description: | `DELETE /3.0/admin/offer/{offer_id}/creative/html/{creative_id}` Delete html creative from offer by creative id parameters: - name: api-key in: header description: API key example: 23df424b0a53b0899f78685966243ee61 required: true schema: type: string - name: offer_id in: path description: Offer ID required: true schema: type: integer - name: creative_id in: path description: Creative ID required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer example: status: 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 DELETE \ --url 'https://api-demo.affise.com/3.0/admin/offer/{offer_id}/creative/html/{creative_id}' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' /3.1/offers/promocodes: get: tags: - admin-offers - affiliate-offers summary: List of promocodes description: | `GET /3.1/offers/promocodes` List of promocodes parameters: - name: api-key in: header description: API key example: 23df424b0a53b0899f78685966243ee61 required: true schema: type: string - name: offer_id in: query description: Comma separated list of identifiers schema: type: integer - name: search in: query description: Search promocodes by part of string schema: type: string - name: code in: query description: Search promocode by exact match schema: type: string - name: page in: query description: Page number schema: type: integer default: 1 - name: limit in: query description: Number of items per page schema: type: integer default: 100 responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer data: type: object properties: promocodes: type: array items: type: object properties: id: type: string type: type: string code: type: string code_template: type: string description: type: string offer_id: type: integer affiliate_id: type: integer usage_limit: type: integer usage_value: type: integer date_from: type: string format: date-time date_to: type: string format: date-time created_at: type: string format: date-time updated_at: type: string format: date-time total_count: type: integer per_page: type: integer page: type: integer example: status: 1 data: promocodes: - id: 63bbf54e8098683662ea61b5 type: manual code: Black-1 code_template: '' description: Some description offer_id: 13 affiliate_id: 4 usage_limit: 100 usage_value: 0 date_from: '2023-01-09T00:00:00Z' date_to: '2023-01-29T00:00:00Z' created_at: '2023-01-09T11:06:54.189Z' updated_at: '2023-01-09T11:06:54.189Z' total_count: 2 per_page: 100 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 \ --url 'https://api-demo.affise.com/3.1/offers/promocodes?page=1&limit=100' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' /3.1/offers/promocodes/bulk: post: tags: - admin-offers summary: Promocodes bulk creation description: | `POST /3.1/offers/promocodes/bulk` Promocodes bulk creation (Available if the Promocode feature is enabled) parameters: - name: api-key in: header description: API key example: 23df424b0a53b0899f78685966243ee61 required: true schema: type: string requestBody: content: multipart/form-data: schema: type: object properties: promocodes[0][type]: type: string enum: - manual description: Promocode type promocodes[0][code]: type: string description: Promocode promocodes[0][offer_id]: type: integer description: Offer ID promocodes[0][affiliate_id]: type: integer description: Affiliate ID promocodes[0][description]: type: string maxLength: 130 description: Description promocodes[0][usage_limit]: type: integer description: Usage limit promocodes[0][date_from]: type: string format: date-time description: Date from (RFC3339 format) promocodes[0][date_to]: type: string format: date-time description: Date to (RFC3339 format) required: - promocodes[0][type] - promocodes[0][code] - promocodes[0][offer_id] - promocodes[0][affiliate_id] - promocodes[0][date_from] - promocodes[0][date_to] responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer data: type: object properties: promocodes: type: array items: type: object properties: id: type: string type: type: string code: type: string code_template: type: string description: type: string offer_id: type: integer affiliate_id: type: integer usage_limit: type: integer usage_value: type: integer date_from: type: string format: date-time date_to: type: string format: date-time created_at: type: string format: date-time updated_at: type: string format: date-time example: status: 1 data: promocodes: - id: 624ad87ac9c43aed7a32ef06 type: manual code: qwerty code_template: '' description: some text offer_id: 3 affiliate_id: 1 usage_limit: 1 usage_value: 0 date_from: '2022-03-31T00:00:00Z' date_to: '2032-04-30T00:00:00Z' created_at: '2022-04-04T11:37:30.137Z' updated_at: '2022-04-04T11:37:30.137Z' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '500': $ref: '#/components/responses/InternalServerError' x-codeSamples: - lang: cURL label: cURL source: |- curl --request POST \ --url 'https://api-demo.affise.com/3.1/offers/promocodes/bulk' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' \ --form 'promocodes[0][type]=manual' \ --form 'promocodes[0][code]=string' \ --form 'promocodes[0][offer_id]=0' \ --form 'promocodes[0][affiliate_id]=0' \ --form 'promocodes[0][description]=string' \ --form 'promocodes[0][usage_limit]=0' \ --form 'promocodes[0][date_from]=string' \ --form 'promocodes[0][date_to]=string' /3.0/offers: get: tags: - admin-offers - advertiser-offers - affiliate-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 \ --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' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' /3.0/offer/{id}: get: tags: - admin-offers - advertiser-offers - affiliate-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 \ --url 'https://api-demo.affise.com/3.0/offer/{id}' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' /3.0/offer/categories: get: tags: - admin-offers - advertiser-offers - affiliate-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 \ --url 'https://api-demo.affise.com/3.0/offer/categories?ids[0]=string&ids[1]=string2&limit=99999&orderType=asc&order=id' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' /3.0/stats/custom: get: tags: - admin-stats - advertiser-stats - affiliate-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 \ --url 'https://api-demo.affise.com/3.0/stats/custom?slice[0]=hour&filter[date_from]=&filter[date_to]=&filter[currency][0]=string&filter[currency][1]=string2&filter[offer][0]=0&filter[offer][1]=1&filter[nonzero]=0¬_offer_id[0]=0¬_offer_id[1]=1¬_advertiser_id[0]=string¬_advertiser_id[1]=string2¬_affiliate_id[0]=0¬_affiliate_id[1]=1¬_advertiser_manager_id[0]=string¬_advertiser_manager_id[1]=string2¬_affiliate_manager_id[0]=string¬_affiliate_manager_id[1]=string2¬_smartlink_id[0]=string¬_smartlink_id[1]=string2¬_country[0]=string¬_country[1]=string2&filter[payment_status]=opened&locale=en&conversionTypes[0]=total&page=1&limit=100&orderType=asc&order[0]=hour&fields[0]=clicks' \ --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 \ --url 'https://api-demo.affise.com/3.0/stats/conversionsbyid?id=' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' /3.0/stats/conversions: get: tags: - admin-stats - advertiser-stats - affiliate-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 schema: type: string - name: custom_field_3 in: query description: Custom field 3 schema: type: string - name: custom_field_4 in: query description: Custom field 4 schema: type: string - name: custom_field_5 in: query description: Custom field 5 schema: type: string - name: custom_field_6 in: query description: Custom field 6 schema: type: string - name: custom_field_7 in: query description: Custom field 7 schema: type: string - name: subid1 in: query description: Sub 1 schema: type: string - name: subid2 in: query description: Sub 2 schema: type: string - name: subid3 in: query description: Sub 3 schema: type: string - name: subid4 in: query description: Sub 4 schema: type: string - name: subid5 in: query description: Sub 5 schema: type: string - name: smart_id in: query description: Smartlink Id schema: type: string - name: promocode in: query description: Promocode schema: type: string - name: imp_id in: query description: Impression Id schema: type: string - name: payment_status in: query description: Payment status schema: type: string enum: - opened - pending - closed - name: partner[] in: query description: ONLY FOR ADMIN - Affiliates schema: type: array items: type: integer - name: revenue in: query description: ONLY FOR ADMIN - Revenue schema: type: number - name: revenue_from in: query description: ONLY FOR ADMIN - Revenue must be greater than this value schema: type: number - name: revenue_to in: query description: ONLY FOR ADMIN - Revenue must be less than this value schema: type: number - 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: raw_export in: query description: Without mapping related entities (For huge exports) schema: type: integer default: 0 - name: decline_reason[] in: query description: Filter by decline reason schema: type: array items: type: string enum: - anti_fraud - cap_reached - by_manager - payment_not_found - ip_duplicate - by_server_postback - partner_banned - partner_disabled - min_click_time_not_reached - click_time_expire - by_import - promocode_expired - promocode_not_available - name: fraud_risk_level[] in: query description: Filter by fraud risk level schema: type: array items: type: string enum: - not_analyzed - low - medium - high - no_risk - name: fraud_type[] in: query description: Filter by fraud type schema: type: array items: type: string - name: comment in: query description: Comment schema: type: string responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer conversions: type: array items: type: object properties: id: type: string action_id: type: string status: type: string currency: type: string goal: type: string nullable: true country: type: string district: type: string city: type: string ip: type: string browser: type: string os: type: string device: type: string offer: type: object nullable: true properties: id: type: integer offer_id: type: string title: type: string url: type: string offer_id: type: string ios_idfa: type: string android_id: type: string sub1: type: string sub2: type: string sub3: type: string sub4: type: string sub5: type: string custom_field_1: type: string custom_field_2: type: string custom_field_3: type: string custom_field_4: type: string custom_field_5: type: string custom_field_6: type: string custom_field_7: type: string ua: type: string comment: type: string created_at: type: string format: date-time updated_at: type: string format: date-time click_time: type: string format: date-time referrer: type: string payouts: type: number clickid: type: string partner: type: object properties: id: type: integer email: type: string login: type: string name: type: string goal_value: type: string sum: type: number revenue: type: number earnings: type: number advertiser: type: object properties: id: type: string title: type: string payment_status: type: string is_paid: type: string forensiq: type: string nullable: true payment_type: type: string nullable: true hold_date_expire: type: string nullable: true fraud_risk_level: type: string decline_reason: type: string fraud_type: type: array items: type: string pagination: type: object properties: per_page: type: integer total_count: type: integer page: type: integer next_page: type: integer example: status: 1 conversions: - id: 59359e1d7e28feb7568b456a action_id: 59359dcb7e28fee0558b4567 status: confirmed currency: USD goal: null country: US district: '' city: New York ip: 127.0.0.1 browser: Chrome 58.0.3029 os: Mac OS X 10.12.5 device: Other offer: id: 934 offer_id: 59313e097960ad2774b4f274 title: HD-smart [Web] url: http://YOUR_API_DOMAIN/1/ offer_id: '934' ios_idfa: '' android_id: '' sub1: '' sub2: '' sub3: '' sub4: '' sub5: '' custom_field_1: '' custom_field_2: '' custom_field_3: '' custom_field_4: '' custom_field_5: '' custom_field_6: '' custom_field_7: '' ua: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/58.0.3029.110 Safari/537.36 comment: '' created_at: '2017-06-06 03:08:29' updated_at: '2017-06-06 03:08:30' click_time: '2017-06-06 03:07:07' referrer: http://YOUR_API_DOMAIN payouts: 1234 clickid: 59359dcb7e28fee0558b4567 partner: id: 610 email: example@gmail.com login: example name: '' goal_value: '1' sum: 0 revenue: 12345 earnings: 11111 advertiser: id: 56cc49dc3b7d9b89058b45f0 title: Example payment_status: opened is_paid: '1' forensiq: null payment_type: null hold_date_expire: null fraud_risk_level: not_analyzed decline_reason: by_manager fraud_type: [] pagination: per_page: 1 total_count: 17 page: 1 next_page: 2 '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 \ --url 'https://api-demo.affise.com/3.0/stats/conversions?status[0]=1&offer[0]=0&offer[1]=1&advertiser[0]=string&advertiser[1]=string2&country[0]=string&country[1]=string2&goal_id[0]=0&goal_id[1]=1&device=tablet&payment_status=opened&partner[0]=0&partner[1]=1&page=1&limit=100&raw_export=0&decline_reason[0]=anti_fraud&fraud_risk_level[0]=not_analyzed&fraud_type[0]=string&fraud_type[1]=string2' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' /3.0/stats/getbydate: get: tags: - admin-stats - advertiser-stats - affiliate-stats summary: By date description: | `GET /3.0/stats/getbydate` Get statistics by date parameters: - name: api-key in: header description: API key example: 23df424b0a53b0899f78685966243ee61 required: true schema: type: string - 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: orderType in: query description: Order type schema: type: string enum: - asc - desc default: asc - name: locale in: query description: Locale schema: type: string enum: - ru - en - es default: en - name: limit in: query description: Limit of stat entities schema: type: integer default: 100 - name: filter[currency] in: query description: The list of a currencies code schema: type: array items: type: string - name: page in: query description: Page of stat entities schema: type: integer default: 1 - name: timezone in: query description: Timezone name. Example Europe/Berlin schema: type: string - name: filter[advertiser] in: query description: Advertiser ID's schema: oneOf: - type: string - type: array items: type: string - name: filter[offer] in: query description: Offers ID's schema: type: array items: type: integer - name: filter[manager] in: query description: Managers ID's schema: oneOf: - type: string - type: array items: type: string - name: filter[advertiser_manager_id] in: query description: Advertiser managers ID's schema: oneOf: - type: string - type: array items: type: string - name: filter[partner] in: query description: Partners ID's 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 1 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub2] in: query description: Sub 2 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub3] in: query description: Sub 3 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub4] in: query description: Sub 4 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub5] in: query description: Sub 5 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub6] in: query description: Sub 6 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub7] in: query description: Sub 7 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub8] in: query description: Sub 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[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 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 properties: year: type: integer month: type: integer day: type: integer 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: 5 day: 31 traffic: raw: '0' uniq: '0' actions: total: revenue: 191190.40796039 charge: 339894.05859619 earning: 148703.65063587 'null': 0 count: 12600 confirmed: revenue: 15.173841901617 charge: 26.975718936208 earning: 11.801877034591 'null': 0 count: 1 pending: revenue: 0 charge: 0 earning: 0 'null': 0 count: 0 declined: revenue: 0 charge: 0 earning: 0 'null': 0 count: 0 hold: revenue: 191175.23411849 charge: 339867.08287725 earning: 148691.84875883 'null': 0 count: 12599 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 \ --url 'https://api-demo.affise.com/3.0/stats/getbydate?filter[date_from]=&filter[date_to]=&orderType=asc&locale=en&limit=100&filter[currency][0]=string&filter[currency][1]=string2&page=1&filter[offer][0]=0&filter[offer][1]=1¬_offer_id[0]=0¬_offer_id[1]=1¬_advertiser_id[0]=string¬_advertiser_id[1]=string2¬_affiliate_id[0]=0¬_affiliate_id[1]=1¬_advertiser_manager_id[0]=string¬_advertiser_manager_id[1]=string2¬_affiliate_manager_id[0]=string¬_affiliate_manager_id[1]=string2¬_smartlink_id[0]=string¬_smartlink_id[1]=string2¬_country[0]=string¬_country[1]=string2' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' /3.0/stats/getbyhour: get: tags: - admin-stats - advertiser-stats - affiliate-stats summary: Hourly description: | `GET /3.0/stats/getbyhour` Get hourly statistics parameters: - name: api-key in: header description: API key example: 23df424b0a53b0899f78685966243ee61 required: true schema: type: string - 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: 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: timezone in: query description: Timezone name. Example Europe/Berlin schema: type: string - 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: 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 1 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub2] in: query description: Sub 2 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub3] in: query description: Sub 3 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub4] in: query description: Sub 4 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub5] in: query description: Sub 5 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub6] in: query description: Sub 6 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub7] in: query description: Sub 7 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub8] in: query description: Sub 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[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 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 properties: year: type: integer month: type: integer day: type: integer hour: type: integer 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: 5 day: 31 hour: 0 traffic: raw: '0' uniq: '0' actions: total: revenue: 0 charge: 0 earning: 0 'null': 0 count: 0 confirmed: revenue: 0 charge: 0 earning: 0 'null': 0 count: 0 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': 0 count: 0 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 \ --url 'https://api-demo.affise.com/3.0/stats/getbyhour?filter[date_from]=&filter[date_to]=&locale=en&page=1&limit=100&orderType=asc&filter[currency][0]=string&filter[currency][1]=string2&filter[offer][0]=0&filter[offer][1]=1¬_offer_id[0]=0¬_offer_id[1]=1¬_advertiser_id[0]=string¬_advertiser_id[1]=string2¬_affiliate_id[0]=0¬_affiliate_id[1]=1¬_advertiser_manager_id[0]=string¬_advertiser_manager_id[1]=string2¬_affiliate_manager_id[0]=string¬_affiliate_manager_id[1]=string2¬_smartlink_id[0]=string¬_smartlink_id[1]=string2¬_country[0]=string¬_country[1]=string2' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' /3.0/stats/getbysub: get: tags: - affiliate-stats summary: By sub description: | `GET /3.0/stats/getbysub` Get statistics by sub (Available only for partner API-Key) parameters: - name: api-key in: header description: API key example: 23df424b0a53b0899f78685966243ee61 required: true schema: type: string - 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[offer] in: query description: Offers IDs required: true schema: type: array items: type: integer - 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: timezone in: query description: Timezone name. Example Europe/Berlin schema: type: string - 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: 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[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[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 1 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub2] in: query description: Sub 2 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub3] in: query description: Sub 3 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub4] in: query description: Sub 4 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub5] in: query description: Sub 5 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub6] in: query description: Sub 6 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub7] in: query description: Sub 7 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub8] in: query description: Sub 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[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 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 properties: sub1: type: string 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: sub1: '' traffic: raw: '0' uniq: '0' actions: total: revenue: 191190.40796039 charge: 339894.05859619 earning: 148703.65063587 'null': 0 count: 12600 confirmed: revenue: 15.173841901617 charge: 26.975718936208 earning: 11.801877034591 'null': 0 count: 1 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': 0 count: 0 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 \ --url 'https://api-demo.affise.com/3.0/stats/getbysub?filter[date_from]=&filter[date_to]=&filter[offer][0]=0&filter[offer][1]=1&locale=en&page=1&limit=100&orderType=asc&filter[currency][0]=string&filter[currency][1]=string2' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' /3.0/stats/getbyprogram: get: tags: - admin-stats - advertiser-stats - affiliate-stats summary: By offer description: | `GET /3.0/stats/getbyprogram` Get statistics by offer parameters: - name: api-key in: header description: API key example: 23df424b0a53b0899f78685966243ee61 required: true schema: type: string - 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: 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: timezone in: query description: Timezone name. Example Europe/Berlin schema: type: string - 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: 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 1 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub2] in: query description: Sub 2 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub3] in: query description: Sub 3 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub4] in: query description: Sub 4 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub5] in: query description: Sub 5 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub6] in: query description: Sub 6 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub7] in: query description: Sub 7 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub8] in: query description: Sub 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[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 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 properties: offer: type: object properties: id: type: integer offer_id: type: string title: type: string 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: offer: id: 906 offer_id: 59313e127960ad2774b4f2b9 title: HD-smart [Web] traffic: raw: '0' uniq: '0' actions: total: revenue: 191190.40796039 charge: 339894.05859619 earning: 148703.65063587 'null': 0 count: 12600 confirmed: revenue: 15.173841901617 charge: 26.975718936208 earning: 11.801877034591 'null': 0 count: 1 pending: revenue: 0 charge: 0 earning: 0 'null': 0 count: 0 declined: revenue: 0 charge: 0 earning: 0 'null': 0 count: 0 hold: revenue: 191175.23411849 charge: 339867.08287725 earning: 148691.84875883 'null': 0 count: 12599 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 \ --url 'https://api-demo.affise.com/3.0/stats/getbyprogram?filter[date_from]=&filter[date_to]=&locale=en&page=1&limit=100&orderType=asc&filter[currency][0]=string&filter[currency][1]=string2&filter[offer][0]=0&filter[offer][1]=1¬_offer_id[0]=0¬_offer_id[1]=1¬_advertiser_id[0]=string¬_advertiser_id[1]=string2¬_affiliate_id[0]=0¬_affiliate_id[1]=1¬_advertiser_manager_id[0]=string¬_advertiser_manager_id[1]=string2¬_affiliate_manager_id[0]=string¬_affiliate_manager_id[1]=string2¬_smartlink_id[0]=string¬_smartlink_id[1]=string2¬_country[0]=string¬_country[1]=string2' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' /3.0/stats/getbyadvertiser: get: tags: - admin-stats summary: By advertiser description: | `GET /3.0/stats/getbyadvertiser` Get statistics by advertiser (Available only for admin API-Key) parameters: - name: api-key in: header description: API key required: true schema: type: string - 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: 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: timezone in: query description: Timezone name. Example Europe/Berlin schema: type: string - 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: filter[currency] in: query description: The list of a currencies code schema: type: array items: type: string - name: filter[advertiser] in: query description: Advertiser ID's schema: oneOf: - type: string - type: array items: type: string - name: filter[offer] in: query description: Offers ID's schema: type: array items: type: integer - name: filter[manager] in: query description: Managers ID's schema: oneOf: - type: string - type: array items: type: string - name: filter[advertiser_manager_id] in: query description: Advertiser managers ID's schema: oneOf: - type: string - type: array items: type: string - name: filter[partner] in: query description: Partners ID's 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 1 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub2] in: query description: Sub 2 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub3] in: query description: Sub 3 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub4] in: query description: Sub 4 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub5] in: query description: Sub 5 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub6] in: query description: Sub 6 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub7] in: query description: Sub 7 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub8] in: query description: Sub 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[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 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 properties: advertiser: type: object properties: id: type: string title: type: string 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: advertiser: id: 56cc49dc3b7d9b89058b45f0 title: advertiser traffic: raw: '0' uniq: '0' actions: total: revenue: 191190.40796039 charge: 339894.05859619 earning: 148703.65063587 'null': 0 count: 12600 confirmed: revenue: 15.173841901617 charge: 26.975718936208 earning: 11.801877034591 'null': 0 count: 1 pending: revenue: 0 charge: 0 earning: 0 'null': 0 count: 0 declined: revenue: 0 charge: 0 earning: 0 'null': 0 count: 0 hold: revenue: 191175.23411849 charge: 339867.08287725 earning: 148691.84875883 'null': 0 count: 12599 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 \ --url 'https://api-demo.affise.com/3.0/stats/getbyadvertiser?filter[date_from]=&filter[date_to]=&locale=en&page=1&limit=100&orderType=asc&filter[currency][0]=string&filter[currency][1]=string2&filter[offer][0]=0&filter[offer][1]=1¬_offer_id[0]=0¬_offer_id[1]=1¬_advertiser_id[0]=string¬_advertiser_id[1]=string2¬_affiliate_id[0]=0¬_affiliate_id[1]=1¬_advertiser_manager_id[0]=string¬_advertiser_manager_id[1]=string2¬_affiliate_manager_id[0]=string¬_affiliate_manager_id[1]=string2¬_smartlink_id[0]=string¬_smartlink_id[1]=string2¬_country[0]=string¬_country[1]=string2' \ --header 'api-key: ' /3.0/stats/getbyaccountmanager: get: tags: - admin-stats summary: By accounts managers description: | `GET /3.0/stats/getbyaccountmanager` Get statistics by accounts managers (Available only for admin API-Key) parameters: - name: api-key in: header description: API key example: 23df424b0a53b0899f78685966243ee61 required: true schema: type: string - 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: 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: timezone in: query description: Timezone name. Example Europe/Berlin schema: type: string - 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: filter[currency] in: query description: The list of a currencies code schema: type: array items: type: string - name: filter[advertiser] in: query description: Advertiser ID's schema: oneOf: - type: string - type: array items: type: string - name: filter[offer] in: query description: Offers ID's schema: type: array items: type: integer - name: filter[manager] in: query description: Managers ID's schema: oneOf: - type: string - type: array items: type: string - name: filter[advertiser_manager_id] in: query description: Advertiser managers ID's schema: oneOf: - type: string - type: array items: type: string - name: filter[partner] in: query description: Partners ID's 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 1 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub2] in: query description: Sub 2 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub3] in: query description: Sub 3 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub4] in: query description: Sub 4 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub5] in: query description: Sub 5 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub6] in: query description: Sub 6 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub7] in: query description: Sub 7 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub8] in: query description: Sub 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[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 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 properties: advertiser_manager_id: type: object properties: id: type: integer first_name: type: string last_name: type: string 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: advertiser_manager_id: id: 0 first_name: Undefined last_name: Undefined traffic: raw: '9' uniq: '1' actions: total: revenue: 191190.40796039 charge: 339894.05859619 earning: 148703.65063587 'null': 0 count: 12600 confirmed: charge: 0 earning: 0 'null': 0 revenue: 0 count: 0 declined: charge: 0 earning: 0 'null': 0 revenue: 0 count: 0 hold: charge: 0 earning: 0 'null': 0 revenue: 0 count: 0 pending: charge: 0 earning: 0 'null': 0 revenue: 0 count: 0 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 \ --url 'https://api-demo.affise.com/3.0/stats/getbyaccountmanager?filter[date_from]=&filter[date_to]=&locale=en&page=1&limit=100&orderType=asc&filter[currency][0]=string&filter[currency][1]=string2&filter[offer][0]=0&filter[offer][1]=1¬_offer_id[0]=0¬_offer_id[1]=1¬_advertiser_id[0]=string¬_advertiser_id[1]=string2¬_affiliate_id[0]=0¬_affiliate_id[1]=1¬_advertiser_manager_id[0]=string¬_advertiser_manager_id[1]=string2¬_affiliate_manager_id[0]=string¬_affiliate_manager_id[1]=string2¬_smartlink_id[0]=string¬_smartlink_id[1]=string2¬_country[0]=string¬_country[1]=string2' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' /3.0/stats/getbyaffiliatemanager: get: tags: - admin-stats summary: By affiliates managers description: | `GET /3.0/stats/getbyaffiliatemanager` Get statistics by affiliates managers (Available only for admin API-Key) parameters: - name: api-key in: header description: API key example: 23df424b0a53b0899f78685966243ee61 required: true schema: type: string - 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: 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: timezone in: query description: Timezone name. Example Europe/Berlin schema: type: string - 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: filter[currency] in: query description: The list of a currencies code schema: type: array items: type: string - name: filter[advertiser] in: query description: Advertiser ID's schema: oneOf: - type: string - type: array items: type: string - name: filter[offer] in: query description: Offers ID's schema: type: array items: type: integer - name: filter[manager] in: query description: Managers ID's schema: oneOf: - type: string - type: array items: type: string - name: filter[advertiser_manager_id] in: query description: Advertiser managers ID's schema: oneOf: - type: string - type: array items: type: string - name: filter[partner] in: query description: Partners ID's 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 1 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub2] in: query description: Sub 2 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub3] in: query description: Sub 3 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub4] in: query description: Sub 4 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub5] in: query description: Sub 5 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub6] in: query description: Sub 6 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub7] in: query description: Sub 7 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub8] in: query description: Sub 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[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 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 properties: affiliate_manager_id: type: object properties: id: type: string first_name: type: string last_name: type: string 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: affiliate_manager_id: id: '0' first_name: Undefined last_name: Undefined traffic: raw: '9' uniq: '1' actions: total: revenue: 191190.40796039 charge: 339894.05859619 earning: 148703.65063587 'null': 0 count: 12600 confirmed: charge: 0 earning: 0 'null': 0 revenue: 0 count: 0 declined: charge: 0 earning: 0 'null': 0 revenue: 0 count: 0 hold: charge: 0 earning: 0 'null': 0 revenue: 0 count: 0 pending: charge: 0 earning: 0 'null': 0 revenue: 0 count: 0 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 \ --url 'https://api-demo.affise.com/3.0/stats/getbyaffiliatemanager?filter[date_from]=&filter[date_to]=&locale=en&page=1&limit=100&orderType=asc&filter[currency][0]=string&filter[currency][1]=string2&filter[offer][0]=0&filter[offer][1]=1¬_offer_id[0]=0¬_offer_id[1]=1¬_advertiser_id[0]=string¬_advertiser_id[1]=string2¬_affiliate_id[0]=0¬_affiliate_id[1]=1¬_advertiser_manager_id[0]=string¬_advertiser_manager_id[1]=string2¬_affiliate_manager_id[0]=string¬_affiliate_manager_id[1]=string2¬_smartlink_id[0]=string¬_smartlink_id[1]=string2¬_country[0]=string¬_country[1]=string2' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' /3.0/stats/getbypartner: get: tags: - admin-stats summary: By affiliate description: | `GET /3.0/stats/getbypartner` Get statistics by affiliate (Available only for admin API-Key) parameters: - name: api-key in: header description: API key example: 23df424b0a53b0899f78685966243ee61 required: true schema: type: string - 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: 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: timezone in: query description: Timezone name. Example Europe/Berlin schema: type: string - 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: filter[currency] in: query description: The list of a currencies code schema: type: array items: type: string - name: filter[advertiser] in: query description: Advertiser ID's schema: oneOf: - type: string - type: array items: type: string - name: filter[offer] in: query description: Offers ID's schema: type: array items: type: integer - name: filter[manager] in: query description: Managers ID's schema: oneOf: - type: string - type: array items: type: string - name: filter[advertiser_manager_id] in: query description: Advertiser managers ID's schema: oneOf: - type: string - type: array items: type: string - name: filter[partner] in: query description: Partners ID's 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 1 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub2] in: query description: Sub 2 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub3] in: query description: Sub 3 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub4] in: query description: Sub 4 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub5] in: query description: Sub 5 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub6] in: query description: Sub 6 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub7] in: query description: Sub 7 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub8] in: query description: Sub 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[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 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 properties: affiliate: type: object properties: id: type: integer email: type: string login: type: string name: type: string 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: affiliate: id: 610 email: aff@iliate.com login: affiliate name: '' traffic: raw: '0' uniq: '0' actions: total: revenue: 191190.40796039 charge: 339894.05859619 earning: 148703.65063587 'null': 0 count: 12600 confirmed: revenue: 15.173841901617 charge: 26.975718936208 earning: 11.801877034591 'null': 0 count: 1 pending: revenue: 0 charge: 0 earning: 0 'null': 0 count: 0 declined: revenue: 0 charge: 0 earning: 0 'null': 0 count: 0 hold: revenue: 191175.23411849 charge: 339867.08287725 earning: 148691.84875883 'null': 0 count: 12599 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 \ --url 'https://api-demo.affise.com/3.0/stats/getbypartner?filter[date_from]=&filter[date_to]=&locale=en&page=1&limit=100&orderType=asc&filter[currency][0]=string&filter[currency][1]=string2&filter[offer][0]=0&filter[offer][1]=1¬_offer_id[0]=0¬_offer_id[1]=1¬_advertiser_id[0]=string¬_advertiser_id[1]=string2¬_affiliate_id[0]=0¬_affiliate_id[1]=1¬_advertiser_manager_id[0]=string¬_advertiser_manager_id[1]=string2¬_affiliate_manager_id[0]=string¬_affiliate_manager_id[1]=string2¬_smartlink_id[0]=string¬_smartlink_id[1]=string2¬_country[0]=string¬_country[1]=string2' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' /3.0/stats/getbypartnerbydate: get: tags: - admin-stats summary: By affiliate and date description: | `GET /3.0/stats/getbypartnerbydate` Get statistics by affiliate and date (Available only for admin API-Key) parameters: - name: api-key in: header description: API key example: 23df424b0a53b0899f78685966243ee61 required: true schema: type: string - 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: 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: timezone in: query description: Timezone name. Example Europe/Berlin schema: type: string - 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: filter[currency] in: query description: The list of a currencies code schema: type: array items: type: string - name: filter[advertiser] in: query description: Advertiser ID's schema: oneOf: - type: string - type: array items: type: string - name: filter[offer] in: query description: Offers ID's schema: type: array items: type: integer - name: filter[manager] in: query description: Managers ID's schema: oneOf: - type: string - type: array items: type: string - name: filter[advertiser_manager_id] in: query description: Advertiser managers ID's schema: oneOf: - type: string - type: array items: type: string - name: filter[partner] in: query description: Partners ID's 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 1 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub2] in: query description: Sub 2 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub3] in: query description: Sub 3 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub4] in: query description: Sub 4 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub5] in: query description: Sub 5 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub6] in: query description: Sub 6 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub7] in: query description: Sub 7 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub8] in: query description: Sub 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[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 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 properties: year: type: integer month: type: integer day: type: integer affiliate: type: object properties: id: type: integer email: type: string login: type: string name: type: string 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: 5 day: 31 affiliate: id: 610 email: affiliate@affiliate.com login: affiliate name: '' traffic: raw: '0' uniq: '0' actions: total: revenue: 191190.40796039 charge: 339894.05859619 earning: 148703.65063587 'null': 0 count: 12600 confirmed: revenue: 15.173841901617 charge: 26.975718936208 earning: 11.801877034591 'null': 0 count: 1 pending: revenue: 0 charge: 0 earning: 0 'null': 0 count: 0 declined: revenue: 0 charge: 0 earning: 0 'null': 0 count: 0 hold: revenue: 191175.23411849 charge: 339867.08287725 earning: 148691.84875883 'null': 0 count: 12599 pagination: per_page: 1 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 \ --url 'https://api-demo.affise.com/3.0/stats/getbypartnerbydate?filter[date_from]=&filter[date_to]=&locale=en&page=1&limit=100&orderType=asc&filter[currency][0]=string&filter[currency][1]=string2&filter[offer][0]=0&filter[offer][1]=1' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' /3.0/stats/getbycountries: get: tags: - admin-stats - advertiser-stats - affiliate-stats summary: By country description: | `GET /3.0/stats/getbycountries` Get statistics by country parameters: - name: api-key in: header description: API key example: 23df424b0a53b0899f78685966243ee61 required: true schema: type: string - 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: 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: timezone in: query description: Timezone name. Example Europe/Berlin schema: type: string - 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: filter[currency] in: query description: The list of a currencies code schema: type: array items: type: string - name: filter[advertiser] in: query description: Advertiser ID's schema: oneOf: - type: string - type: array items: type: string - name: filter[offer] in: query description: Offers ID's schema: type: array items: type: integer - name: filter[manager] in: query description: Managers ID's schema: oneOf: - type: string - type: array items: type: string - name: filter[advertiser_manager_id] in: query description: Advertiser managers ID's schema: oneOf: - type: string - type: array items: type: string - name: filter[partner] in: query description: Partners ID's 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 1 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub2] in: query description: Sub 2 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub3] in: query description: Sub 3 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub4] in: query description: Sub 4 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub5] in: query description: Sub 5 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub6] in: query description: Sub 6 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub7] in: query description: Sub 7 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub8] in: query description: Sub 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[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 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 properties: country: type: string 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: country: USA traffic: raw: '0' uniq: '0' actions: total: revenue: 191190.40796039 charge: 339894.05859619 earning: 148703.65063587 'null': 0 count: 12600 confirmed: revenue: 15.173841901617 charge: 26.975718936208 earning: 11.801877034591 'null': 0 count: 1 pending: revenue: 0 charge: 0 earning: 0 'null': 0 count: 0 declined: revenue: 0 charge: 0 earning: 0 'null': 0 count: 0 hold: revenue: 191175.23411849 charge: 339867.08287725 earning: 148691.84875883 'null': 0 count: 12599 pagination: per_page: 1 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 \ --url 'https://api-demo.affise.com/3.0/stats/getbycountries?filter[date_from]=&filter[date_to]=&locale=en&page=1&limit=100&orderType=asc&filter[currency][0]=string&filter[currency][1]=string2&filter[offer][0]=0&filter[offer][1]=1¬_offer_id[0]=0¬_offer_id[1]=1¬_advertiser_id[0]=string¬_advertiser_id[1]=string2¬_affiliate_id[0]=0¬_affiliate_id[1]=1¬_advertiser_manager_id[0]=string¬_advertiser_manager_id[1]=string2¬_affiliate_manager_id[0]=string¬_affiliate_manager_id[1]=string2¬_smartlink_id[0]=string¬_smartlink_id[1]=string2¬_country[0]=string¬_country[1]=string2' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' /3.0/stats/getbybrowsers: get: tags: - admin-stats - advertiser-stats - affiliate-stats summary: By browser description: | `GET /3.0/stats/getbybrowsers` Get statistics by browser parameters: - name: api-key in: header description: API key example: 23df424b0a53b0899f78685966243ee61 required: true schema: type: string - 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: 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: timezone in: query description: Timezone name. Example Europe/Berlin schema: type: string - 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: filter[currency] in: query description: The list of a currencies code schema: type: array items: type: string - name: filter[advertiser] in: query description: Advertiser ID's schema: oneOf: - type: string - type: array items: type: string - name: filter[offer] in: query description: Offers ID's schema: type: array items: type: integer - name: filter[manager] in: query description: Managers ID's schema: oneOf: - type: string - type: array items: type: string - name: filter[advertiser_manager_id] in: query description: Advertiser managers ID's schema: oneOf: - type: string - type: array items: type: string - name: filter[partner] in: query description: Partners ID's 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 1 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub2] in: query description: Sub 2 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub3] in: query description: Sub 3 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub4] in: query description: Sub 4 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub5] in: query description: Sub 5 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub6] in: query description: Sub 6 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub7] in: query description: Sub 7 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub8] in: query description: Sub 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[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 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 properties: browser: type: string 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: browser: '' traffic: raw: '0' uniq: '0' actions: total: revenue: 191190.40796039 charge: 339894.05859619 earning: 148703.65063587 'null': 0 count: 12600 confirmed: revenue: 15.173841901617 charge: 26.975718936208 earning: 11.801877034591 'null': 0 count: 1 pending: revenue: 0 charge: 0 earning: 0 'null': 0 count: 0 declined: revenue: 0 charge: 0 earning: 0 'null': 0 count: 0 hold: revenue: 191175.23411849 charge: 339867.08287725 earning: 148691.84875883 'null': 0 count: 12599 pagination: per_page: 1 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 \ --url 'https://api-demo.affise.com/3.0/stats/getbybrowsers?filter[date_from]=&filter[date_to]=&locale=en&page=1&limit=100&orderType=asc&filter[currency][0]=string&filter[currency][1]=string2&filter[offer][0]=0&filter[offer][1]=1' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' /3.0/stats/getbybrowsersversion: get: tags: - admin-stats - advertiser-stats - affiliate-stats summary: By browser version description: | `GET /3.0/stats/getbybrowsersversion` Get statistics by browser version parameters: - name: api-key in: header description: API key example: 23df424b0a53b0899f78685966243ee61 required: true schema: type: string - 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: 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: timezone in: query description: Timezone name. Example Europe/Berlin schema: type: string - 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: filter[currency] in: query description: The list of a currencies code schema: type: array items: type: string - name: filter[advertiser] in: query description: Advertiser ID's schema: oneOf: - type: string - type: array items: type: string - name: filter[offer] in: query description: Offers ID's schema: type: array items: type: integer - name: filter[manager] in: query description: Managers ID's schema: oneOf: - type: string - type: array items: type: string - name: filter[advertiser_manager_id] in: query description: Advertiser managers ID's schema: oneOf: - type: string - type: array items: type: string - name: filter[partner] in: query description: Partners ID's 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 1 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub2] in: query description: Sub 2 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub3] in: query description: Sub 3 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub4] in: query description: Sub 4 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub5] in: query description: Sub 5 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub6] in: query description: Sub 6 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub7] in: query description: Sub 7 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub8] in: query description: Sub 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[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 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 properties: browser_version: type: string 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: browser_version: '70' traffic: raw: '0' uniq: '0' actions: total: revenue: 191190.40796039 charge: 339894.05859619 earning: 148703.65063587 'null': 0 count: 12600 confirmed: revenue: 15.173841901617 charge: 26.975718936208 earning: 11.801877034591 'null': 0 count: 1 pending: revenue: 0 charge: 0 earning: 0 'null': 0 count: 0 declined: revenue: 0 charge: 0 earning: 0 'null': 0 count: 0 hold: revenue: 191175.23411849 charge: 339867.08287725 earning: 148691.84875883 'null': 0 count: 12599 pagination: per_page: 1 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 \ --url 'https://api-demo.affise.com/3.0/stats/getbybrowsersversion?filter[date_from]=&filter[date_to]=&locale=en&page=1&limit=100&orderType=asc&filter[currency][0]=string&filter[currency][1]=string2&filter[offer][0]=0&filter[offer][1]=1' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' /3.0/stats/getbylanding: get: tags: - admin-stats - advertiser-stats - affiliate-stats summary: By landing description: | `GET /3.0/stats/getbylanding` Get statistics by landing parameters: - name: api-key in: header description: API key example: 23df424b0a53b0899f78685966243ee61 required: true schema: type: string - 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[offer] in: query description: Offer ID required: true schema: type: integer - 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: timezone in: query description: Timezone name. Example Europe/Berlin schema: type: string - 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: filter[currency] in: query description: The list of a currencies code schema: type: array items: type: string - name: filter[advertiser] in: query description: Advertiser ID's schema: oneOf: - type: string - type: array items: type: string - name: filter[manager] in: query description: Managers ID's schema: oneOf: - type: string - type: array items: type: string - name: filter[advertiser_manager_id] in: query description: Advertiser managers ID's schema: oneOf: - type: string - type: array items: type: string - name: filter[partner] in: query description: Partners ID's 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 1 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub2] in: query description: Sub 2 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub3] in: query description: Sub 3 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub4] in: query description: Sub 4 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub5] in: query description: Sub 5 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub6] in: query description: Sub 6 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub7] in: query description: Sub 7 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub8] in: query description: Sub 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[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 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 properties: landing: type: string 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 ratio: type: string epc: type: number landings_info: type: object additionalProperties: type: object properties: url: type: string preview_url: type: string title: type: string pagination: type: object properties: per_page: type: integer total_count: type: integer page: type: integer example: status: 1 stats: - slice: landing: '1543238303' traffic: raw: '0' uniq: '0' actions: total: revenue: 191190.40796039 charge: 339894.05859619 earning: 148703.65063587 'null': 0 count: 12600 confirmed: revenue: 15.173841901617 charge: 26.975718936208 earning: 11.801877034591 'null': 0 count: 1 pending: revenue: 0 charge: 0 earning: 0 'null': 0 count: 0 declined: revenue: 0 charge: 0 earning: 0 'null': 0 count: 0 hold: revenue: 191175.23411849 charge: 339867.08287725 earning: 148691.84875883 'null': 0 count: 12599 ratio: '' epc: 0 landings_info: '1543238303': url: http://test-url.com preview_url: http://test-preview-url.com title: '333' pagination: per_page: 1 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 \ --url 'https://api-demo.affise.com/3.0/stats/getbylanding?filter[date_from]=&filter[date_to]=&filter[offer]=&locale=en&page=1&limit=100&orderType=asc&filter[currency][0]=string&filter[currency][1]=string2¬_offer_id[0]=0¬_offer_id[1]=1¬_advertiser_id[0]=string¬_advertiser_id[1]=string2¬_affiliate_id[0]=0¬_affiliate_id[1]=1¬_advertiser_manager_id[0]=string¬_advertiser_manager_id[1]=string2¬_affiliate_manager_id[0]=string¬_affiliate_manager_id[1]=string2¬_smartlink_id[0]=string¬_smartlink_id[1]=string2¬_country[0]=string¬_country[1]=string2' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' /3.0/stats/getbyprelanding: get: tags: - admin-stats - advertiser-stats - affiliate-stats summary: By prelanding description: | `GET /3.0/stats/getbyprelanding` Get statistics by prelanding parameters: - name: api-key in: header description: API key example: 23df424b0a53b0899f78685966243ee61 required: true schema: type: string - 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[offer] in: query description: Offer ID required: true schema: type: integer - 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: timezone in: query description: Timezone name. Example Europe/Berlin schema: type: string - 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: filter[currency] in: query description: The list of a currencies code schema: type: array items: type: string - name: filter[advertiser] in: query description: Advertiser ID's schema: oneOf: - type: string - type: array items: type: string - name: filter[manager] in: query description: Managers ID's schema: oneOf: - type: string - type: array items: type: string - name: filter[advertiser_manager_id] in: query description: Advertiser managers ID's schema: oneOf: - type: string - type: array items: type: string - name: filter[partner] in: query description: Partners ID's 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 1 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub2] in: query description: Sub 2 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub3] in: query description: Sub 3 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub4] in: query description: Sub 4 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub5] in: query description: Sub 5 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub6] in: query description: Sub 6 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub7] in: query description: Sub 7 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub8] in: query description: Sub 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[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 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 properties: prelanding: type: integer 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 ratio: type: string epc: type: number landings_info: type: object additionalProperties: type: object properties: url: type: string preview_url: type: string title: type: string pagination: type: object properties: per_page: type: integer total_count: type: integer page: type: integer example: status: 1 stats: - slice: prelanding: 1543243821 traffic: raw: '0' uniq: '0' actions: total: revenue: 191190.40796039 charge: 339894.05859619 earning: 148703.65063587 'null': 0 count: 12600 confirmed: revenue: 15.173841901617 charge: 26.975718936208 earning: 11.801877034591 'null': 0 count: 1 pending: revenue: 0 charge: 0 earning: 0 'null': 0 count: 0 declined: revenue: 0 charge: 0 earning: 0 'null': 0 count: 0 hold: revenue: 191175.23411849 charge: 339867.08287725 earning: 148691.84875883 'null': 0 count: 12599 ratio: '' epc: 0 landings_info: '1543243821': url: http://test-url.com preview_url: http://test-preview-url.com title: '333' pagination: per_page: 1 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 \ --url 'https://api-demo.affise.com/3.0/stats/getbyprelanding?filter[date_from]=&filter[date_to]=&filter[offer]=&locale=en&page=1&limit=100&orderType=asc&filter[currency][0]=string&filter[currency][1]=string2' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' /3.0/stats/getbymobilecarrier: get: tags: - admin-stats - advertiser-stats - affiliate-stats summary: By mobile carrier description: | `GET /3.0/stats/getbymobilecarrier` Get statistics by mobile carrier parameters: - name: api-key in: header description: API key example: 23df424b0a53b0899f78685966243ee61 required: true schema: type: string - 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: 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: timezone in: query description: Timezone name. Example Europe/Berlin schema: type: string - 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: filter[currency] in: query description: The list of a currencies code schema: type: array items: type: string - name: filter[advertiser] in: query description: Advertiser ID's schema: oneOf: - type: string - type: array items: type: string - name: filter[offer] in: query description: Offers ID's schema: type: array items: type: integer - name: filter[manager] in: query description: Managers ID's schema: oneOf: - type: string - type: array items: type: string - name: filter[advertiser_manager_id] in: query description: Advertiser managers ID's schema: oneOf: - type: string - type: array items: type: string - name: filter[partner] in: query description: Partners ID's 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 1 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub2] in: query description: Sub 2 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub3] in: query description: Sub 3 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub4] in: query description: Sub 4 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub5] in: query description: Sub 5 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub6] in: query description: Sub 6 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub7] in: query description: Sub 7 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub8] in: query description: Sub 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[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 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 properties: isp: type: string 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 ratio: type: string epc: type: number pagination: type: object properties: per_page: type: integer total_count: type: integer page: type: integer example: status: 1 stats: - slice: isp: '' traffic: raw: '0' uniq: '0' actions: total: revenue: 191190.40796039 charge: 339894.05859619 earning: 148703.65063587 'null': 0 count: 12600 confirmed: revenue: 15.173841901617 charge: 26.975718936208 earning: 11.801877034591 'null': 0 count: 1 pending: revenue: 0 charge: 0 earning: 0 'null': 0 count: 0 declined: revenue: 0 charge: 0 earning: 0 'null': 0 count: 0 hold: revenue: 191175.23411849 charge: 339867.08287725 earning: 148691.84875883 'null': 0 count: 12599 ratio: '' epc: 0 pagination: per_page: 1 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 \ --url 'https://api-demo.affise.com/3.0/stats/getbymobilecarrier?filter[date_from]=&filter[date_to]=&locale=en&page=1&limit=100&orderType=asc&filter[currency][0]=string&filter[currency][1]=string2&filter[offer][0]=0&filter[offer][1]=1¬_offer_id[0]=0¬_offer_id[1]=1¬_advertiser_id[0]=string¬_advertiser_id[1]=string2¬_affiliate_id[0]=0¬_affiliate_id[1]=1¬_advertiser_manager_id[0]=string¬_advertiser_manager_id[1]=string2¬_affiliate_manager_id[0]=string¬_affiliate_manager_id[1]=string2¬_smartlink_id[0]=string¬_smartlink_id[1]=string2¬_country[0]=string¬_country[1]=string2' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' /3.0/stats/getbyconnectiontype: get: tags: - admin-stats - advertiser-stats - affiliate-stats summary: By connection type description: | `GET /3.0/stats/getbyconnectiontype` Get statistics by connection type parameters: - name: api-key in: header description: API key example: 23df424b0a53b0899f78685966243ee61 required: true schema: type: string - 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: 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: timezone in: query description: Timezone name. Example Europe/Berlin schema: type: string - 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: filter[currency] in: query description: The list of a currencies code schema: type: array items: type: string - name: filter[advertiser] in: query description: Advertiser ID's schema: oneOf: - type: string - type: array items: type: string - name: filter[offer] in: query description: Offers ID's schema: type: array items: type: integer - name: filter[manager] in: query description: Managers ID's schema: oneOf: - type: string - type: array items: type: string - name: filter[advertiser_manager_id] in: query description: Advertiser managers ID's schema: oneOf: - type: string - type: array items: type: string - name: filter[partner] in: query description: Partners ID's 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 1 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub2] in: query description: Sub 2 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub3] in: query description: Sub 3 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub4] in: query description: Sub 4 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub5] in: query description: Sub 5 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub6] in: query description: Sub 6 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub7] in: query description: Sub 7 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub8] in: query description: Sub 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[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 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 properties: conn_type: type: string 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 ratio: type: string epc: type: number pagination: type: object properties: per_page: type: integer total_count: type: integer page: type: integer example: status: 1 stats: - slice: conn_type: '' traffic: raw: '0' uniq: '0' actions: total: revenue: 191190.40796039 charge: 339894.05859619 earning: 148703.65063587 'null': 0 count: 12600 confirmed: revenue: 15.173841901617 charge: 26.975718936208 earning: 11.801877034591 'null': 0 count: 1 pending: revenue: 0 charge: 0 earning: 0 'null': 0 count: 0 declined: revenue: 0 charge: 0 earning: 0 'null': 0 count: 0 hold: revenue: 191175.23411849 charge: 339867.08287725 earning: 148691.84875883 'null': 0 count: 12599 ratio: '' epc: 0 pagination: per_page: 1 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 \ --url 'https://api-demo.affise.com/3.0/stats/getbyconnectiontype?filter[date_from]=&filter[date_to]=&locale=en&page=1&limit=100&orderType=asc&filter[currency][0]=string&filter[currency][1]=string2&filter[offer][0]=0&filter[offer][1]=1¬_offer_id[0]=0¬_offer_id[1]=1¬_advertiser_id[0]=string¬_advertiser_id[1]=string2¬_affiliate_id[0]=0¬_affiliate_id[1]=1¬_advertiser_manager_id[0]=string¬_advertiser_manager_id[1]=string2¬_affiliate_manager_id[0]=string¬_affiliate_manager_id[1]=string2¬_smartlink_id[0]=string¬_smartlink_id[1]=string2¬_country[0]=string¬_country[1]=string2' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' /3.0/stats/getbyos: get: tags: - admin-stats - advertiser-stats - affiliate-stats summary: By OS description: | `GET /3.0/stats/getbyos` Get statistics by OS parameters: - name: api-key in: header description: API key example: 23df424b0a53b0899f78685966243ee61 required: true schema: type: string - 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: 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: timezone in: query description: Timezone name. Example Europe/Berlin schema: type: string - 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: filter[currency] in: query description: The list of a currencies code schema: type: array items: type: string - name: filter[advertiser] in: query description: Advertiser ID's schema: oneOf: - type: string - type: array items: type: string - name: filter[offer] in: query description: Offers ID's schema: type: array items: type: integer - name: filter[manager] in: query description: Managers ID's schema: oneOf: - type: string - type: array items: type: string - name: filter[advertiser_manager_id] in: query description: Advertiser managers ID's schema: oneOf: - type: string - type: array items: type: string - name: filter[partner] in: query description: Partners ID's 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 1 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub2] in: query description: Sub 2 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub3] in: query description: Sub 3 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub4] in: query description: Sub 4 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub5] in: query description: Sub 5 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub6] in: query description: Sub 6 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub7] in: query description: Sub 7 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub8] in: query description: Sub 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[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 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 properties: os: type: string 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: os: '' traffic: raw: '0' uniq: '0' actions: total: revenue: 191190.40796039 charge: 339894.05859619 earning: 148703.65063587 'null': 0 count: 12600 confirmed: revenue: 15.173841901617 charge: 26.975718936208 earning: 11.801877034591 'null': 0 count: 1 pending: revenue: 0 charge: 0 earning: 0 'null': 0 count: 0 declined: revenue: 0 charge: 0 earning: 0 'null': 0 count: 0 hold: revenue: 191175.23411849 charge: 339867.08287725 earning: 148691.84875883 'null': 0 count: 12599 pagination: per_page: 1 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 \ --url 'https://api-demo.affise.com/3.0/stats/getbyos?filter[date_from]=&filter[date_to]=&locale=en&page=1&limit=100&orderType=asc&filter[currency][0]=string&filter[currency][1]=string2&filter[offer][0]=0&filter[offer][1]=1¬_offer_id[0]=0¬_offer_id[1]=1¬_advertiser_id[0]=string¬_advertiser_id[1]=string2¬_affiliate_id[0]=0¬_affiliate_id[1]=1¬_advertiser_manager_id[0]=string¬_advertiser_manager_id[1]=string2¬_affiliate_manager_id[0]=string¬_affiliate_manager_id[1]=string2¬_smartlink_id[0]=string¬_smartlink_id[1]=string2¬_country[0]=string¬_country[1]=string2' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' /3.0/stats/getbyversions: get: tags: - admin-stats - advertiser-stats - affiliate-stats summary: By OS version description: | `GET /3.0/stats/getbyversions` Get statistics by OS version parameters: - name: api-key in: header description: API key example: 23df424b0a53b0899f78685966243ee61 required: true schema: type: string - 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: 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: timezone in: query description: Timezone name. Example Europe/Berlin schema: type: string - 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: filter[currency] in: query description: The list of a currencies code schema: type: array items: type: string - name: filter[advertiser] in: query description: Advertiser ID's schema: oneOf: - type: string - type: array items: type: string - name: filter[offer] in: query description: Offers ID's schema: type: array items: type: integer - name: filter[manager] in: query description: Managers ID's schema: oneOf: - type: string - type: array items: type: string - name: filter[advertiser_manager_id] in: query description: Advertiser managers ID's schema: oneOf: - type: string - type: array items: type: string - name: filter[partner] in: query description: Partners ID's 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 1 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub2] in: query description: Sub 2 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub3] in: query description: Sub 3 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub4] in: query description: Sub 4 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub5] in: query description: Sub 5 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub6] in: query description: Sub 6 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub7] in: query description: Sub 7 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub8] in: query description: Sub 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[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 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 properties: os: type: string os_version: type: string 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: os: '' os_version: '' traffic: raw: '0' uniq: '0' actions: total: revenue: 191190.40796039 charge: 339894.05859619 earning: 148703.65063587 'null': 0 count: 12600 confirmed: revenue: 15.173841901617 charge: 26.975718936208 earning: 11.801877034591 'null': 0 count: 1 pending: revenue: 0 charge: 0 earning: 0 'null': 0 count: 0 declined: revenue: 0 charge: 0 earning: 0 'null': 0 count: 0 hold: revenue: 191175.23411849 charge: 339867.08287725 earning: 148691.84875883 'null': 0 count: 12599 pagination: per_page: 1 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 \ --url 'https://api-demo.affise.com/3.0/stats/getbyversions?filter[date_from]=&filter[date_to]=&locale=en&page=1&limit=100&orderType=asc&filter[currency][0]=string&filter[currency][1]=string2&filter[offer][0]=0&filter[offer][1]=1' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' /3.0/stats/getbygoal: get: tags: - admin-stats - advertiser-stats - affiliate-stats summary: By goal description: | `GET /3.0/stats/getbygoal` Get statistics by goal parameters: - name: api-key in: header description: API key example: 23df424b0a53b0899f78685966243ee61 required: true schema: type: string - 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: 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: timezone in: query description: Timezone name. Example Europe/Berlin schema: type: string - 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: filter[currency] in: query description: The list of a currencies code schema: type: array items: type: string - name: filter[advertiser] in: query description: Advertiser ID's schema: oneOf: - type: string - type: array items: type: string - name: filter[offer] in: query description: Offers ID's schema: type: array items: type: integer - name: filter[manager] in: query description: Managers ID's schema: oneOf: - type: string - type: array items: type: string - name: filter[advertiser_manager_id] in: query description: Advertiser managers ID's schema: oneOf: - type: string - type: array items: type: string - name: filter[partner] in: query description: Partners ID's 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 1 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub2] in: query description: Sub 2 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub3] in: query description: Sub 3 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub4] in: query description: Sub 4 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub5] in: query description: Sub 5 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub6] in: query description: Sub 6 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub7] in: query description: Sub 7 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub8] in: query description: Sub 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[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 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 properties: goal: type: string 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: goal: '1' traffic: raw: '0' uniq: '0' actions: total: revenue: 191190.40796039 charge: 339894.05859619 earning: 148703.65063587 'null': 0 count: 12600 confirmed: revenue: 15.173841901617 charge: 26.975718936208 earning: 11.801877034591 'null': 0 count: 1 pending: revenue: 0 charge: 0 earning: 0 'null': 0 count: 0 declined: revenue: 0 charge: 0 earning: 0 'null': 0 count: 0 hold: revenue: 191175.23411849 charge: 339867.08287725 earning: 148691.84875883 'null': 0 count: 12599 pagination: per_page: 1 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 \ --url 'https://api-demo.affise.com/3.0/stats/getbygoal?filter[date_from]=&filter[date_to]=&locale=en&page=1&limit=100&orderType=asc&filter[currency][0]=string&filter[currency][1]=string2&filter[offer][0]=0&filter[offer][1]=1' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' /3.0/stats/getbycities: get: tags: - admin-stats - advertiser-stats - affiliate-stats summary: By city description: | `GET /3.0/stats/getbycities` Get statistics by city parameters: - name: api-key in: header description: API key example: 23df424b0a53b0899f78685966243ee61 required: true schema: type: string - 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: 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: timezone in: query description: Timezone name. Example Europe/Berlin schema: type: string - 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: filter[currency] in: query description: The list of a currencies code schema: type: array items: type: string - name: filter[advertiser] in: query description: Advertiser ID's schema: oneOf: - type: string - type: array items: type: string - name: filter[offer] in: query description: Offers ID's schema: type: array items: type: integer - name: filter[manager] in: query description: Managers ID's schema: oneOf: - type: string - type: array items: type: string - name: filter[advertiser_manager_id] in: query description: Advertiser managers ID's schema: oneOf: - type: string - type: array items: type: string - name: filter[partner] in: query description: Partners ID's 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 1 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub2] in: query description: Sub 2 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub3] in: query description: Sub 3 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub4] in: query description: Sub 4 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub5] in: query description: Sub 5 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub6] in: query description: Sub 6 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub7] in: query description: Sub 7 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub8] in: query description: Sub 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[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 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 properties: city: type: integer 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: city: 0 traffic: raw: '0' uniq: '0' actions: total: revenue: 191190.40796039 charge: 339894.05859619 earning: 148703.65063587 'null': 0 count: 12600 confirmed: revenue: 15.173841901617 charge: 26.975718936208 earning: 11.801877034591 'null': 0 count: 1 pending: revenue: 0 charge: 0 earning: 0 'null': 0 count: 0 declined: revenue: 0 charge: 0 earning: 0 'null': 0 count: 0 hold: revenue: 191175.23411849 charge: 339867.08287725 earning: 148691.84875883 'null': 0 count: 12599 pagination: per_page: 1 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 \ --url 'https://api-demo.affise.com/3.0/stats/getbycities?filter[date_from]=&filter[date_to]=&locale=en&page=1&limit=100&orderType=asc&filter[currency][0]=string&filter[currency][1]=string2&filter[offer][0]=0&filter[offer][1]=1¬_offer_id[0]=0¬_offer_id[1]=1¬_advertiser_id[0]=string¬_advertiser_id[1]=string2¬_affiliate_id[0]=0¬_affiliate_id[1]=1¬_advertiser_manager_id[0]=string¬_advertiser_manager_id[1]=string2¬_affiliate_manager_id[0]=string¬_affiliate_manager_id[1]=string2¬_smartlink_id[0]=string¬_smartlink_id[1]=string2¬_country[0]=string¬_country[1]=string2' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' /3.0/stats/getbydevices: get: tags: - admin-stats - advertiser-stats - affiliate-stats summary: By device description: | `GET /3.0/stats/getbydevices` Get statistics by device parameters: - name: api-key in: header description: API key example: 23df424b0a53b0899f78685966243ee61 required: true schema: type: string - 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: 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: timezone in: query description: Timezone name. Example Europe/Berlin schema: type: string - 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: filter[currency] in: query description: The list of a currencies code schema: type: array items: type: string - name: filter[advertiser] in: query description: Advertiser ID's schema: oneOf: - type: string - type: array items: type: string - name: filter[offer] in: query description: Offers ID's schema: type: array items: type: integer - name: filter[manager] in: query description: Managers ID's schema: oneOf: - type: string - type: array items: type: string - name: filter[advertiser_manager_id] in: query description: Advertiser managers ID's schema: oneOf: - type: string - type: array items: type: string - name: filter[partner] in: query description: Partners ID's 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 1 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub2] in: query description: Sub 2 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub3] in: query description: Sub 3 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub4] in: query description: Sub 4 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub5] in: query description: Sub 5 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub6] in: query description: Sub 6 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub7] in: query description: Sub 7 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub8] in: query description: Sub 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[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 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 properties: device: type: string 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: device: '' traffic: raw: '0' uniq: '0' actions: total: revenue: 191190.40796039 charge: 339894.05859619 earning: 148703.65063587 'null': 0 count: 12600 confirmed: revenue: 15.173841901617 charge: 26.975718936208 earning: 11.801877034591 'null': 0 count: 1 pending: revenue: 0 charge: 0 earning: 0 'null': 0 count: 0 declined: revenue: 0 charge: 0 earning: 0 'null': 0 count: 0 hold: revenue: 191175.23411849 charge: 339867.08287725 earning: 148691.84875883 'null': 0 count: 12599 pagination: per_page: 1 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 \ --url 'https://api-demo.affise.com/3.0/stats/getbydevices?filter[date_from]=&filter[date_to]=&locale=en&page=1&limit=100&orderType=asc&filter[currency][0]=string&filter[currency][1]=string2&filter[offer][0]=0&filter[offer][1]=1¬_offer_id[0]=0¬_offer_id[1]=1¬_advertiser_id[0]=string¬_advertiser_id[1]=string2¬_affiliate_id[0]=0¬_affiliate_id[1]=1¬_advertiser_manager_id[0]=string¬_advertiser_manager_id[1]=string2¬_affiliate_manager_id[0]=string¬_affiliate_manager_id[1]=string2¬_smartlink_id[0]=string¬_smartlink_id[1]=string2¬_country[0]=string¬_country[1]=string2' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' /3.0/stats/getbydevicemodels: get: tags: - admin-stats - advertiser-stats - affiliate-stats summary: By device model description: | `GET /3.0/stats/getbydevicemodels` Get statistics by device model parameters: - name: api-key in: header description: API key example: 23df424b0a53b0899f78685966243ee61 required: true schema: type: string - 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: 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: timezone in: query description: Timezone name. Example Europe/Berlin schema: type: string - 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: filter[currency] in: query description: The list of a currencies code schema: type: array items: type: string - name: filter[advertiser] in: query description: Advertiser ID's schema: oneOf: - type: string - type: array items: type: string - name: filter[offer] in: query description: Offers ID's schema: type: array items: type: integer - name: filter[manager] in: query description: Managers ID's schema: oneOf: - type: string - type: array items: type: string - name: filter[advertiser_manager_id] in: query description: Advertiser managers ID's schema: oneOf: - type: string - type: array items: type: string - name: filter[partner] in: query description: Partners ID's 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 1 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub2] in: query description: Sub 2 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub3] in: query description: Sub 3 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub4] in: query description: Sub 4 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub5] in: query description: Sub 5 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub6] in: query description: Sub 6 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub7] in: query description: Sub 7 schema: oneOf: - type: string - type: array items: type: string - name: filter[sub8] in: query description: Sub 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[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 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 properties: device_model: type: string 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: device_model: '' traffic: raw: '0' uniq: '0' actions: total: revenue: 191190.40796039 charge: 339894.05859619 earning: 148703.65063587 'null': 0 count: 12600 confirmed: revenue: 15.173841901617 charge: 26.975718936208 earning: 11.801877034591 'null': 0 count: 1 pending: revenue: 0 charge: 0 earning: 0 'null': 0 count: 0 declined: revenue: 0 charge: 0 earning: 0 'null': 0 count: 0 hold: revenue: 191175.23411849 charge: 339867.08287725 earning: 148691.84875883 'null': 0 count: 12599 pagination: per_page: 1 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 \ --url 'https://api-demo.affise.com/3.0/stats/getbydevicemodels?filter[date_from]=&filter[date_to]=&locale=en&page=1&limit=100&orderType=asc&filter[currency][0]=string&filter[currency][1]=string2&filter[offer][0]=0&filter[offer][1]=1' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' /3.0/stats/getreferralpayments: get: tags: - admin-stats - advertiser-stats - affiliate-stats summary: By referral payments description: | `GET /3.0/stats/getreferralpayments` Get statistics by referral payments parameters: - name: api-key in: header description: API key example: 23df424b0a53b0899f78685966243ee61 required: true schema: type: string - name: date_from in: query description: Date from required: true schema: type: string pattern: ^\d{2}-\d{2}-\d{4}$ example: 31-05-2017 - name: date_to in: query description: Date to required: true schema: type: string pattern: ^\d{2}-\d{2}-\d{4}$ example: 31-05-2017 - name: timezone in: query description: Timezone name. Example Europe/Berlin schema: type: string - name: pid in: query description: Partner ID schema: type: integer - name: pids in: query description: List of partner IDs schema: type: array items: type: integer - name: ref in: query description: Referral partner ID schema: type: integer - name: refs in: query description: List of referral partner IDs schema: type: array items: type: integer - name: is_paid in: query description: Status (0 => payouts, 1 => paid, 2 => pending) schema: type: integer enum: - 0 - 1 - 2 - name: payment_statuses in: query description: List of is_paid values schema: type: array items: type: integer enum: - 0 - 1 - 2 - name: status in: query description: Active (0 => no, 1 => yes) schema: type: integer enum: - 0 - 1 - 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: currency in: query description: ID currency schema: type: integer - name: currencies in: query description: List of currency IDs schema: type: array items: type: integer responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer ref_payments: type: array items: type: object properties: pid: type: string ref: type: string status: type: string is_paid: type: string currency: type: string count: type: string max_created_at: type: string format: date-time date_registration_partner: type: string format: date-time sum_revenue: type: string pagination: type: object properties: per_page: type: integer total_count: type: integer page: type: integer example: status: 1 ref_payments: - pid: '2' ref: '3' status: '0' is_paid: '0' currency: USD count: '4' max_created_at: '2016-03-19 16:25:22' date_registration_partner: '2016-10-30 10:22:12' sum_revenue: '0.20000' 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 \ --url 'https://api-demo.affise.com/3.0/stats/getreferralpayments?date_from=31-05-2017&date_to=31-05-2017&pids[0]=0&pids[1]=1&refs[0]=0&refs[1]=1&is_paid=0&payment_statuses[0]=0&status=0&page=1&limit=100¤cies[0]=0¤cies[1]=1' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' /3.0/stats/find-subs: get: tags: - affiliate-stats summary: Find subs description: | `GET /3.0/stats/find-subs` Get sub accounts (Available only for partner API-Key) parameters: - name: api-key in: header description: API key example: 23df424b0a53b0899f78685966243ee61 required: true schema: type: string - name: sub1 in: query description: Sub1 parameter schema: type: string - name: sub2 in: query description: Sub2 parameter schema: type: string - name: sub3 in: query description: Sub3 parameter schema: type: string - name: sub4 in: query description: Sub4 parameter schema: type: string - name: sub5 in: query description: Sub5 parameter schema: type: string - name: sub6 in: query description: Sub6 parameter schema: type: string - name: sub7 in: query description: Sub7 parameter schema: type: string - name: sub8 in: query description: Sub8 parameter schema: type: string - 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 responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer subs: type: array items: type: object properties: sub1: type: string sub2: type: string sub3: type: string sub4: type: string sub5: type: string sub6: type: string sub7: type: string sub8: type: string pagination: type: object properties: per_page: type: integer total_count: type: integer page: type: integer example: status: 1 subs: - sub1: test1 pagination: per_page: 100 total_count: 0 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 \ --url 'https://api-demo.affise.com/3.0/stats/find-subs?page=1&limit=100' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' /3.0/stats/serverpostbacks: get: tags: - admin-stats summary: By server postback description: | `GET /3.0/stats/serverpostbacks` Get server postbacks parameters: - name: api-key in: header description: API key example: 23df424b0a53b0899f78685966243ee61 required: true schema: type: string - name: date_from in: query description: Date from required: true schema: type: string pattern: ^\d{2}-\d{2}-\d{4}$ example: 01-04-2017 - name: date_to in: query description: Date to required: true schema: type: string pattern: ^\d{2}-\d{2}-\d{4}$ example: 01-07-2017 - name: offer in: query description: Offer IDs schema: type: array items: type: string - name: partner in: query description: Partner IDs schema: type: array items: type: integer - name: search in: query description: Search parameter schema: type: string - name: click_id in: query description: Click ID schema: type: string - name: goal in: query description: Goal schema: type: string - 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 responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer postbacks: type: array items: type: object properties: _id: type: object properties: $id: type: string _get: type: object additionalProperties: true _post: type: array items: {} date: type: object properties: sec: type: integer usec: type: integer get: type: string post: type: string server: type: string response: type: string track: type: object properties: id: type: string ip: type: string ua: type: string country: type: string city: type: string device: type: string os: type: string browser: type: string offer: type: object properties: id: type: integer offer_id: type: string title: type: string preview_url: type: string referrer: type: string click_id: type: string sub1: type: string sub2: type: string sub3: type: string sub4: type: string sub5: type: string offer_id: type: string conversion_id: nullable: true ios_idfa: nullable: true android_id: nullable: true created_at: type: string format: date-time uniq: type: integer cbid: nullable: true partner: type: object properties: id: type: string login: type: string email: type: string pagination: type: object properties: per_page: type: integer total_count: type: integer page: type: integer example: status: 1 postbacks: - _id: $id: 59359e1d7e28feb7568b4569 _get: clickid: 59359dcb7e28fee0558b4567 _post: [] date: sec: 1496686109 usec: 35000 get: '{"clickid":"59359dcb7e28fee0558b4567"}' post: '[]' server: 127.0.0.1 response: |- { "status": 1 } track: id: 59359dcb7e28fee0558b4567 ip: 127.0.0.1 ua: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/58.0.3029.110 Safari/537.36 country: US city: New York device: Other os: Mac OS X 10.12.5 browser: Chrome 58.0.3029 offer: id: 934 offer_id: 59313e097960ad2774b4f274 title: HD-smart [Web] preview_url: http://YOUR_API_DOMAIN/desktop/1/ referrer: '' click_id: 59359dcb7e28fee0558b4567 sub1: '' sub2: '' sub3: '' sub4: '' sub5: '' offer_id: '934' conversion_id: null ios_idfa: null android_id: null created_at: '2017-06-06 03:07:07' uniq: 1 cbid: null partner: id: '610' login: affiliate email: affi@lia.te 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 \ --url 'https://api-demo.affise.com/3.0/stats/serverpostbacks?date_from=01-04-2017&date_to=01-07-2017&offer[0]=string&offer[1]=string2&partner[0]=0&partner[1]=1&page=1&limit=100' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' /3.0/stats/affiliatepostbacks: get: tags: - admin-stats summary: By partner postback description: | `GET /3.0/stats/affiliatepostbacks` Get partner postbacks (Available only for admin API-Key) parameters: - name: api-key in: header description: API key required: true example: 23df424b0a53b0899f78685966243ee61 schema: type: string - name: date_from in: query description: Date from required: true schema: type: string format: date example: '2017-11-25' - name: date_to in: query description: Date to required: true schema: type: string format: date example: '2017-11-28' - name: offer in: query description: Offers ID's schema: type: array items: type: integer - name: partner in: query description: Partners ID's schema: type: array items: type: integer - name: goal in: query description: Goal schema: type: string - name: status in: query description: Status schema: type: integer - name: http_code in: query description: Http code schema: type: integer - name: timezone in: query description: Timezone name. Example Europe/Berlin schema: type: string - 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 responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer postbacks: type: array items: type: object properties: _id: type: object properties: $id: type: string _get: nullable: true _post: nullable: true date: type: object properties: sec: type: integer usec: type: integer pid: type: integer lead_id: type: string http_code: type: integer postback_url: type: string offer_id: type: integer job_id: type: string goal: type: string status: type: integer pagination: type: object properties: per_page: type: integer total_count: type: integer page: type: integer example: status: 1 postbacks: - _id: $id: 5a1d248f1bfa2441008b4567 _get: null _post: null date: sec: 1511859343 usec: 662000 pid: 2 lead_id: 5a1d247cbbf68e0001972d26 http_code: 200 postback_url: http://dsda.com offer_id: 1 job_id: 5a1d248a1bfa2418008b456b goal: '1' status: 1 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 \ --url 'https://api-demo.affise.com/3.0/stats/affiliatepostbacks?date_from=2017-11-25&date_to=2017-11-28&offer[0]=0&offer[1]=1&partner[0]=0&partner[1]=1&page=1&limit=100' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' /3.0/stats/caps: get: tags: - admin-stats summary: By cap description: | `GET /3.0/stats/caps` Get stats by cap parameters: - name: api-key in: header description: API key example: 23df424b0a53b0899f78685966243ee61 required: true schema: type: string - name: offer_id in: query description: Offers ID's required: true schema: type: array items: type: integer responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer stats: type: array items: type: object properties: offer_id: type: integer stats: type: array items: type: object properties: affiliate_type: type: string affiliates: type: array items: {} countries: type: array items: type: string country_type: type: string current_value: type: integer goal_stats: type: object goal_type: type: string goals: type: array items: {} id: type: string is_remaining: type: boolean reset_to_value: type: integer timeframe: type: string type: type: string value: type: integer example: status: 1 stats: - offer_id: 10 stats: - affiliate_type: string affiliates: [] countries: - string country_type: string current_value: 0 goal_stats: {} goal_type: string goals: [] id: string is_remaining: true reset_to_value: 0 timeframe: string type: string value: 0 '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 \ --url 'https://api-demo.affise.com/3.0/stats/caps?offer_id[0]=0&offer_id[1]=1' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' /3.0/stats/getbytrafficback: get: tags: - admin-stats - advertiser-stats - affiliate-stats summary: By trafficback description: | `GET /3.0/stats/getbytrafficback` Get statistics by trafficback parameters: - name: api-key in: header description: API key example: 23df424b0a53b0899f78685966243ee61 required: true schema: type: string - 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: 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: timezone in: query description: Timezone name. Example Europe/Berlin schema: type: string - 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: filter[advertiser] in: query description: Advertiser ID's schema: oneOf: - type: string - type: array items: type: string - name: filter[offer] in: query description: Offers ID's schema: type: array items: type: integer - name: filter[partner] in: query description: Partners ID's (ONLY FOR ADMIN - If the request from not an admin then default a ID partner) 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[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 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 properties: trafficback_reason: type: string traffic: type: object properties: raw: type: string uniq: type: string actions: type: array items: {} views: type: integer ctr: type: integer trafficback: type: integer pagination: type: object properties: per_page: type: integer total_count: type: integer page: type: integer example: status: 1 stats: - slice: trafficback_reason: unknown-affiliate traffic: raw: '0' uniq: '0' actions: [] views: 0 ctr: 0 trafficback: 1 - slice: trafficback_reason: invalid-affiliate traffic: raw: '0' uniq: '0' actions: [] views: 0 ctr: 0 trafficback: 47 pagination: per_page: 100 total_count: 2 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 \ --url 'https://api-demo.affise.com/3.0/stats/getbytrafficback?filter[date_from]=&filter[date_to]=&locale=en&page=1&limit=100&orderType=asc&filter[offer][0]=0&filter[offer][1]=1' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' /3.0/stats/retentionrate: get: tags: - admin-stats summary: Retention rate description: | `GET /3.0/stats/retentionrate` Get stats retentionrate parameters: - name: api-key in: header description: API key example: 23df424b0a53b0899f78685966243ee61 required: true schema: type: string - name: date_from in: query description: Date from required: true schema: type: string format: date example: '2018-10-16' - name: date_to in: query description: Date to required: true schema: type: string format: date example: '2018-10-19' - name: offer_id in: query description: Offer ID required: true schema: type: integer - name: base_event in: query description: Name based goal required: true schema: type: string pattern: ^[a-zA-Z] - name: events in: query description: Events (comma separated) required: true schema: type: array items: type: string pattern: ^[a-zA-Z] - name: affiliate_id in: query description: Affiliates filter schema: type: integer - name: timezone in: query description: Timezone name. Example Europe/Berlin schema: type: string responses: '200': description: Successful response content: application/json: schema: type: array items: type: object properties: affiliate_id: type: integer date: type: string format: date rr_install: type: number rr_other1: type: number rr_other2: type: number install_count: type: integer example: - affiliate_id: 1 date: '2018-10-18' rr_install: 66.66 rr_other1: 100 rr_other2: 33.33 install_count: 3 - affiliate_id: 1 date: '2018-10-19' rr_install: 0 rr_other1: 100 rr_other2: 0 install_count: 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 \ --url 'https://api-demo.affise.com/3.0/stats/retentionrate?date_from=2018-10-16&date_to=2018-10-19&offer_id=&base_event=&events[0]=string&events[1]=string2' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' /3.0/stats/time-to-action: get: tags: - admin-stats summary: Time to action description: | `GET /3.0/stats/time-to-action` Get Time to action report parameters: - name: api-key in: header description: API key required: true example: 23df424b0a53b0899f78685966243ee61 schema: type: string - name: date_from in: query description: Date from required: true schema: type: string format: date example: '2019-11-16' - name: date_to in: query description: Date to required: true schema: type: string format: date example: '2019-11-18' - name: offer_id in: query description: An offer id required: true schema: type: integer - name: timezone in: query description: Timezone name. Example Europe/Berlin required: true schema: type: string - name: goal in: query description: Name based goal schema: type: string - name: affiliate_ids in: query description: Affiliates filter. Comma separated int values schema: type: string example: 70,71 - 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 responses: '200': description: Successful response content: application/json: schema: type: object properties: data: type: array items: type: object properties: affiliate_id: type: integer affiliate_name: type: string affiliate_email: type: string clicks: type: integer total_conversions: type: integer tta_30: type: integer tta_600: type: integer tta_inf: type: integer status: type: integer pagination: type: object properties: total_count: type: integer per_page: type: integer page: type: integer statusCode: type: integer example: data: - affiliate_id: 70 affiliate_name: Yve affiliate_email: affi@lia.te clicks: 90 total_conversions: 4 tta_30: 3 tta_600: 1 tta_inf: 0 status: 1 pagination: total_count: 1 per_page: 100 page: 1 statusCode: 200 '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 \ --url 'https://api-demo.affise.com/3.0/stats/time-to-action?date_from=2019-11-16&date_to=2019-11-18&offer_id=&timezone=&affiliate_ids=70%2C71&page=1&limit=100' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' /3.0/appsflyer_stats/getbyslice: get: tags: - admin-stats - advertiser-stats - affiliate-stats summary: Stats description: | `GET /3.0/appsflyer_stats/getbyslice` Get Appsflyer stats by slice parameters: - name: API-Key in: header description: API key required: true schema: type: string - name: slice in: query description: Search by slices required: true schema: type: array items: type: string enum: - date - app_id - event_name - city - country - sub1 - sub2 - sub3 - sub4 - sub5 - isp - os - device - name: filter[date_from] in: query description: Filter by date from required: true schema: type: string format: date - name: filter[date_to] in: query description: Filter by date to required: true schema: type: string format: date - name: filter[app_id] in: query description: Filter by app_id schema: type: array items: type: string - name: filter[event_name] in: query description: Filter by event_name schema: type: array items: type: string - name: filter[country_code] in: query description: Filter by country_code schema: type: array items: type: string - name: filter[city_id] in: query description: Filter by city_id schema: type: array items: type: integer - name: filter[os] in: query description: Filter by os schema: type: array items: type: string - name: filter[device_type] in: query description: Filter by device_type schema: type: array items: type: string - name: filter[isp] in: query description: Filter by isp schema: type: array items: type: string - name: filter[campaign_id] in: query description: Filter by campaign_id from Appsflyer schema: type: array items: type: string - name: filter[language] in: query description: Filter by language schema: type: array items: type: string - name: filter[sub1] in: query description: Filter by sub1 schema: type: array items: type: string - name: filter[sub2] in: query description: Filter by sub2 schema: type: array items: type: string - name: filter[sub3] in: query description: Filter by sub3 schema: type: array items: type: string - name: filter[sub4] in: query description: Filter by sub4 schema: type: array items: type: string - name: filter[sub5] in: query description: Filter by sub5 schema: type: array items: type: string - name: sort in: query description: Sort field schema: type: string - name: order in: query description: Sort order schema: type: string enum: - asc - desc - name: page in: query description: Page of results schema: type: integer - name: limit in: query description: Count results per page schema: type: integer 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: type: string clicks: type: integer impressions: type: integer preinstalls: type: integer revenue: type: number format: float pagination: type: object properties: per_page: type: integer total_count: type: integer page: type: integer example: status: 1 stats: - slice: country: US clicks: 10 impressions: 100 preinstalls: 20 revenue: 12.5 pagination: per_page: 100 total_count: 0 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 \ --url 'https://api-demo.affise.com/3.0/appsflyer_stats/getbyslice?slice[0]=date&filter[date_from]=&filter[date_to]=&filter[app_id][0]=string&filter[app_id][1]=string2&filter[event_name][0]=string&filter[event_name][1]=string2&filter[country_code][0]=string&filter[country_code][1]=string2&filter[city_id][0]=0&filter[city_id][1]=1&filter[os][0]=string&filter[os][1]=string2&filter[device_type][0]=string&filter[device_type][1]=string2&filter[isp][0]=string&filter[isp][1]=string2&filter[campaign_id][0]=string&filter[campaign_id][1]=string2&filter[language][0]=string&filter[language][1]=string2&filter[sub1][0]=string&filter[sub1][1]=string2&filter[sub2][0]=string&filter[sub2][1]=string2&filter[sub3][0]=string&filter[sub3][1]=string2&filter[sub4][0]=string&filter[sub4][1]=string2&filter[sub5][0]=string&filter[sub5][1]=string2&order=asc' \ --header 'API-Key: ' /3.1/automation/kpi: get: tags: - admin-automation summary: Kpi automation list description: | `GET /3.1/automation/kpi` Get list of kpi automation parameters: - name: api-key in: header description: API key required: true example: 23df424b0a53b0899f78685966243ee61 schema: type: string - name: page in: query description: Page of entities schema: type: integer default: 1 - name: limit in: query description: Limit of entities schema: type: integer default: 100 maximum: 500 responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer items: type: array items: type: object pagination: type: object properties: page: type: integer per_page: type: integer total_count: type: integer example: status: 1 items: [] pagination: page: 1 per_page: 10 total_count: 0 '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 \ --url 'https://api-demo.affise.com/3.1/automation/kpi?page=1&limit=100' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' post: tags: - admin-automation summary: Create new kpi automation description: | `POST /3.1/automation/kpi` Create new kpi automation parameters: - name: api-key in: header description: API key required: true example: 23df424b0a53b0899f78685966243ee61 schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: type: object properties: offers: type: array items: type: integer description: Offer ID (only one offer id is available) action_type: type: string enum: - block - conversion description: Action type period: type: string enum: - hour - day - week - month description: Period sub: type: string enum: - sub1 - sub2 - sub3 - sub4 - sub5 description: Sub (required only for action_type == block) change_to: type: string enum: - confirmed - pending - declined - hold description: Change to (required only for action_type == conversion) affiliates: type: array items: type: integer description: Affiliate IDs (required only for action_type == block) goal1: type: string description: Goal 1 goal2: type: string description: Goal 2 kpi: type: number format: float description: KPI value notify_manager: type: integer enum: - 0 - 1 description: Notify manager required: - offers - action_type - period - goal1 - goal2 - kpi - notify_manager responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer message: type: object properties: id: type: string offers: type: array items: type: string period: type: string action_type: type: string change_to: type: string nullable: true affiliates: type: array items: type: integer sub: type: string goal1: type: string goal2: type: string kpi: type: number format: float notify_manager: type: integer example: status: 1 message: id: 5fcf6e20f28f89004e187664 offers: - '3' period: hour action_type: block change_to: null affiliates: - 1 sub: sub1 goal1: '1' goal2: '2' kpi: 0.1 notify_manager: 0 '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '500': $ref: '#/components/responses/InternalServerError' x-codeSamples: - lang: cURL label: cURL source: |- curl --request POST \ --url 'https://api-demo.affise.com/3.1/automation/kpi' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' \ --form 'offers[0]=0' \ --form 'offers[1]=1' \ --form 'action_type=block' \ --form 'period=hour' \ --form 'sub=sub1' \ --form 'change_to=confirmed' \ --form 'affiliates[0]=0' \ --form 'affiliates[1]=1' \ --form 'goal1=string' \ --form 'goal2=string' \ --form 'kpi=0' \ --form 'notify_manager=0' /3.1/automation/kpi/{id}: post: tags: - admin-automation summary: Edit kpi automation description: | `POST /3.1/automation/kpi/{id}` Edit kpi automation parameters: - name: api-key in: header description: API key example: 23df424b0a53b0899f78685966243ee61 required: true schema: type: string - name: id in: path description: Automation ID required: true schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: type: object properties: offers: type: array items: type: integer description: Offer ID (only one offer id is available) action_type: type: string enum: - block - conversion description: Action type period: type: string enum: - hour - day - week - month description: Period sub: type: string enum: - sub1 - sub2 - sub3 - sub4 - sub5 description: Sub (required only for action_type == block) change_to: type: string enum: - confirmed - pending - declined - hold description: Change to (required only for action_type == conversion) affiliates: type: array items: type: integer description: Affiliate IDs (required only for action_type == block) goal1: type: string description: Goal 1 goal2: type: string description: Goal 2 kpi: type: number format: float description: KPI value notify_manager: type: integer enum: - 0 - 1 description: Notify manager required: - offers - action_type - period - goal1 - goal2 - kpi - notify_manager responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer message: type: object properties: id: type: string offers: type: array items: type: string period: type: string action_type: type: string change_to: type: string nullable: true affiliates: type: array items: type: integer sub: type: string goal1: type: string goal2: type: string kpi: type: number format: float notify_manager: type: integer example: status: 1 message: id: 5fce42c5f28f8900143f3463 offers: - '3' period: hour action_type: block change_to: null affiliates: - 1 sub: sub1 goal1: '1' goal2: '2' kpi: 0.1 notify_manager: 0 '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '500': $ref: '#/components/responses/InternalServerError' x-codeSamples: - lang: cURL label: cURL source: |- curl --request POST \ --url 'https://api-demo.affise.com/3.1/automation/kpi/{id}' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' \ --form 'offers[0]=0' \ --form 'offers[1]=1' \ --form 'action_type=block' \ --form 'period=hour' \ --form 'sub=sub1' \ --form 'change_to=confirmed' \ --form 'affiliates[0]=0' \ --form 'affiliates[1]=1' \ --form 'goal1=string' \ --form 'goal2=string' \ --form 'kpi=0' \ --form 'notify_manager=0' delete: tags: - admin-automation summary: Remove kpi automation description: | `DELETE /3.1/automation/kpi/{id}` Remove kpi automation parameters: - name: Api-key in: header description: API key required: true schema: type: string - name: id in: path description: Automation ID required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer message: type: object properties: message: type: string example: status: 1 message: message: success deleted '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '500': $ref: '#/components/responses/InternalServerError' x-codeSamples: - lang: cURL label: cURL source: |- curl --request DELETE \ --url 'https://api-demo.affise.com/3.1/automation/kpi/{id}' \ --header 'Api-key: ' /3.1/automation/kpi/change-logs: get: tags: - admin-automation summary: Kpi automation changes description: | `GET /3.1/automation/kpi/change-logs` Get list of kpi automation changes parameters: - name: api-key in: header example: 23df424b0a53b0899f78685966243ee61 description: API key required: true schema: type: string - name: filter[date_from] in: query description: Filter by date from (YYYY-MM-DD) required: true schema: type: string format: date - name: filter[date_to] in: query description: Filter by date to (YYYY-MM-DD) required: true schema: type: string format: date - name: page in: query description: Page of entities schema: type: integer default: 1 - name: limit in: query description: Limit of entities schema: type: integer default: 10 - name: offers in: query description: Offers IDs schema: type: array items: type: integer - name: affiliates in: query description: Affiliates IDs schema: type: array items: type: integer - name: type in: query description: Array of kpi automation types (add, update, delete) schema: type: array items: type: string enum: - add - update - delete responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer items: type: array items: type: object pagination: type: object properties: page: type: integer per_page: type: integer total_count: type: integer example: status: 1 items: [] pagination: page: 1 per_page: 10 total_count: 0 '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 \ --url 'https://api-demo.affise.com/3.1/automation/kpi/change-logs?filter[date_from]=&filter[date_to]=&page=1&limit=10&offers[0]=0&offers[1]=1&affiliates[0]=0&affiliates[1]=1&type[0]=add' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' /3.1/automation/kpi/block-logs: get: tags: - admin-automation summary: Kpi automation block log description: | `GET /3.1/automation/kpi/block-logs` Get list of kpi automation block logs parameters: - name: api-key in: header example: 23df424b0a53b0899f78685966243ee61 description: API key required: true schema: type: string - name: page in: query description: Page of entities schema: type: integer default: 1 - name: limit in: query description: Limit of entities schema: type: integer default: 100 maximum: 500 - name: filter[date_from] in: query description: Filter by date from (YYYY-MM-DD) required: true schema: type: string format: date - name: filter[date_to] in: query description: Filter by date to (YYYY-MM-DD) required: true schema: type: string format: date - name: filter[sub_index] in: query description: Sub index schema: type: string - name: filter[sub_value] in: query description: Sub value schema: type: string - name: filter[action] in: query description: Action schema: type: string - name: filter[offers] in: query description: Offers IDs schema: type: array items: type: integer - name: filter[affiliates] in: query description: Affiliates IDs schema: type: array items: type: integer responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer items: type: array items: type: object properties: created_at: type: string format: date-time offer_id: type: integer affiliate_id: type: integer sub_index: type: string sub_value: type: string action: type: string additional_data: type: string nullable: true pagination: type: object properties: per_page: type: integer total_count: type: integer page: type: integer example: status: 1 items: - created_at: '2020-10-05 19:59:22' offer_id: 2 affiliate_id: 2 sub_index: data sub_value: data action: data additional_data: null pagination: per_page: 5 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 \ --url 'https://api-demo.affise.com/3.1/automation/kpi/block-logs?page=1&limit=100&filter[date_from]=&filter[date_to]=&filter[offers][0]=0&filter[offers][1]=1&filter[affiliates][0]=0&filter[affiliates][1]=1' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' /3.1/automation/cr-and-sub/block-logs: get: tags: - admin-automation summary: CR and SUB automation block log description: | `GET /3.1/automation/cr-and-sub/block-logs` Get list of cr and sub automation block logs parameters: - name: api-key in: header example: 23df424b0a53b0899f78685966243ee61 description: API key required: true schema: type: string - name: page in: query description: Page of entities schema: type: integer default: 1 - name: limit in: query description: Limit of entities schema: type: integer default: 100 maximum: 500 - name: filter[date_from] in: query description: Filter by date from (YYYY-MM-DD) required: true schema: type: string format: date - name: filter[date_to] in: query description: Filter by date to (YYYY-MM-DD) required: true schema: type: string format: date - name: filter[advertisers] in: query description: Advertisers IDs schema: type: array items: type: string - name: filter[offers] in: query description: Offers IDs schema: type: array items: type: integer - name: filter[affiliates] in: query description: Affiliates IDs schema: type: array items: type: integer responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer rules: type: array items: type: object properties: advertiser: type: object properties: id: type: string title: type: string offer: type: object properties: id: type: string title: type: string affiliate: type: object properties: id: type: string title: type: string rule_id: type: string sub1: type: string sub2: type: string created_at: type: string format: date-time current_cr: type: number cr_thresholds_min: type: string cr_thresholds_max: type: string type: type: string pagination: type: object properties: per_page: type: integer total_count: type: integer page: type: integer example: status: 1 rules: - advertiser: id: 5bc9d7c16d73e41c008b4567 title: Test advertiser offer: id: '4' title: test offer 4 affiliate: id: '3' title: test1234 rule_id: 5fe0abb38e36eb001a2efb82 sub1: '' sub2: '' created_at: '2020-12-21 17:15:15' current_cr: 0 cr_thresholds_min: '10.000000' cr_thresholds_max: '50.000000' type: disabled affiliate pagination: per_page: 10 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 \ --url 'https://api-demo.affise.com/3.1/automation/cr-and-sub/block-logs?page=1&limit=100&filter[date_from]=&filter[date_to]=&filter[advertisers][0]=string&filter[advertisers][1]=string2&filter[offers][0]=0&filter[offers][1]=1&filter[affiliates][0]=0&filter[affiliates][1]=1' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' /3.1/payments: get: tags: - admin-payments summary: Get payments list description: | `GET /3.1/payments` Get payments list parameters: - name: api-key in: header description: API key example: 23df424b0a53b0899f78685966243ee61 required: true schema: type: string - name: date_from in: query description: The date from (format YYYY-MM-DD) required: true schema: type: string format: date - name: date_to in: query description: The date to (format YYYY-MM-DD) required: true schema: type: string format: date - name: id in: query description: Filter by payment invoice ids schema: type: array items: type: integer example: id[0]: 3 - name: status in: query description: Filter by payment invoice status. Possible values (1 - waiting, 2 - completed, 3 - paid partly, 4 - waiting, -1 - declined) schema: type: array items: type: integer enum: - -1 - 1 - 2 - 3 - 4 example: status[0]: 1 - name: aid in: query description: Filter by affiliate ids schema: type: array items: type: integer example: aid[0]: 2 - name: manager_id in: query description: Filter by affiliate manager ids schema: type: array items: type: string example: manager_id[0]: 62164a9a5a8b7e788f752f13 - name: payment_system in: query description: Filter by payment systems schema: type: array items: type: string example: payment_system[0]: 62164a9a5a8b7e788f752f13 - name: payment_account in: query description: Filter by payment accounts schema: type: array items: type: string example: payment_account[0]: 62164a9a5a8b7e788f752f13 - name: update_from_date in: query description: The updated date from (format YYYY-MM-DD) schema: type: string format: date - name: update_to_date in: query description: The updated date to (format YYYY-MM-DD) schema: type: string format: date - name: update_from_hour in: query description: The updated from hour (between 0 to 23) schema: type: integer minimum: 0 maximum: 23 - name: update_to_hour in: query description: The updated to hour (between 0 to 23) schema: type: integer minimum: 0 maximum: 23 - name: page in: query description: Page of entities schema: type: integer - name: limit in: query description: Limit of entities. From 0 to 100 schema: type: integer default: 100 maximum: 100 responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer payments: type: array items: $ref: '#/components/schemas/payment' pagination: type: object properties: page: type: integer limit: type: integer total: type: integer example: status: 1 payments: - id: 5 pid: 1 manager_id: null posted_date: '2022-03-02 17:28:29' pay_sys: 1 pay_sys_name: Webmoney pay_acc: test-update-payment-account status: '4' revenue: '52.12000000' ref_revenue: null currency: '2' currency_code: USD comment: test-update-comment notes: test-update-note cpa_actions: - 62164a9a5a8b7e788f752f13 ref_ids: [] details: details: '4': cost: '22.00000000': count: 1 currency: 2 title: test 4 count: 1 additional_payments: '9': posted_date: '2022-03-31 18:00:55' revenue: '5.02000000' currency: '2' comment: test-add-correction updated_at: '2022-03-03 17:28:29' pagination: page: 1 limit: 100 total: 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 \ --url 'https://api-demo.affise.com/3.1/payments?date_from=&date_to=&id[0]=3&status[0]=1&aid[0]=2&manager_id[0]=62164a9a5a8b7e788f752f13&payment_system[0]=62164a9a5a8b7e788f752f13&payment_account[0]=62164a9a5a8b7e788f752f13&limit=100' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' /3.1/payments/{id}: get: tags: - admin-payments summary: Get payment invoice info description: | `GET /3.1/payments/{id}` Get payment invoice info parameters: - name: api-key in: header description: API key required: true example: 23df424b0a53b0899f78685966243ee61 schema: type: string - name: id in: path description: Payment invoice ID required: true schema: type: integer responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer payment: $ref: '#/components/schemas/payment' example: status: 1 payment: id: 5 pid: 1 manager_id: null posted_date: '2022-03-02 17:28:29' pay_sys: 1 pay_sys_name: Webmoney pay_acc: |- WMR: 344324 WMZ: 23423423 status: '1' revenue: '22.00000000' ref_revenue: null currency: '2' currency_code: USD comment: test notes: test cpa_actions: - 62164a9a5a8b7e788f752f13 ref_ids: [] additional_payments: [] updated_at: '2022-03-03 17:28:29' '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 \ --url 'https://api-demo.affise.com/3.1/payments/{id}' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' post: tags: - admin-payments summary: Update payment invoice description: | `POST /3.1/payments/{id}` Update payment invoice parameters: - name: API-Key in: header description: API key required: true schema: type: string - name: id in: path description: Payment invoice ID required: true schema: type: integer requestBody: content: application/x-www-form-urlencoded: schema: type: object properties: payment_account: type: string description: Payment account information status: type: integer enum: - -1 - 1 - 2 - 3 - 4 description: Status (1 - waiting, 2 - completed, 3 - paid partly, 4 - waiting, -1 - declined) comment: type: string description: Comment for payment invoice note: type: string description: Note for payment invoice responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer result: type: boolean example: status: 1 result: true '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '500': $ref: '#/components/responses/InternalServerError' x-codeSamples: - lang: cURL label: cURL source: |- curl --request POST \ --url 'https://api-demo.affise.com/3.1/payments/{id}' \ --header 'API-Key: ' \ --form 'payment_account=string' \ --form 'status=-1' \ --form 'comment=string' \ --form 'note=string' /3.1/payments/create-for-affiliate: post: tags: - admin-payments summary: Create payment invoice description: | `POST /3.1/payments/create-for-affiliate` Create payment invoice parameters: - name: api-key in: header description: API key required: true example: 23df424b0a53b0899f78685966243ee61 schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: type: object properties: aid: type: integer description: Affiliate Id sum: type: number description: Payment invoice sum currency: type: integer description: Currency Id (/3.0/admin/currency?extended=1) note: type: string description: Note for payment invoice required: - aid - sum - currency responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer message: type: string example: status: 1 message: Payment generates will take a few minutes '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '500': $ref: '#/components/responses/InternalServerError' x-codeSamples: - lang: cURL label: cURL source: |- curl --request POST \ --url 'https://api-demo.affise.com/3.1/payments/create-for-affiliate' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' \ --form 'aid=0' \ --form 'sum=0' \ --form 'currency=0' \ --form 'note=string' /3.1/payments/generate: post: tags: - admin-payments summary: Generate payment invoices for affiliates description: | `POST /3.1/payments/generate` Generate payment invoices for affiliates parameters: - name: api-key in: header description: API key example: 23df424b0a53b0899f78685966243ee61 required: true schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: type: object properties: date: type: string format: date description: To generation day (format YYYY-MM-DD) date_from: type: string format: date description: From generation day (format YYYY-MM-DD) date_to: type: string format: date description: To generation day (format YYYY-MM-DD) aid: type: integer description: Affiliate Id note: type: string description: Note for payment invoice exclude_aids: type: array items: type: integer description: Exclude affiliate ids include_aids: type: array items: type: integer description: Include affiliate ids by_last_unpaid_conversion: type: boolean description: To start generation from the first unpaid conversion by_last_invoice: type: boolean description: To start generation from the last invoice date offer_ids: type: array items: type: integer description: Offer Id advertiser_ids: type: array items: type: string example: '0': 62164a9a5a8b7e788f752f13 description: Advertiser Id currencies: type: array items: type: string example: '0': USD description: Currency code countries: type: array items: type: string example: '0': USA description: Country code responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer message: type: string example: status: 1 message: Payment generates will take a few minutes '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '500': $ref: '#/components/responses/InternalServerError' x-codeSamples: - lang: cURL label: cURL source: |- curl --request POST \ --url 'https://api-demo.affise.com/3.1/payments/generate' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' \ --form 'date=string' \ --form 'date_from=string' \ --form 'date_to=string' \ --form 'aid=0' \ --form 'note=string' \ --form 'exclude_aids[0]=0' \ --form 'exclude_aids[1]=1' \ --form 'include_aids[0]=0' \ --form 'include_aids[1]=1' \ --form 'by_last_unpaid_conversion=false' \ --form 'by_last_invoice=false' \ --form 'offer_ids[0]=0' \ --form 'offer_ids[1]=1' \ --form 'advertiser_ids[0]=62164a9a5a8b7e788f752f13' \ --form 'currencies[0]=USD' \ --form 'countries[0]=USA' /3.1/payments/{id}/add-correction: post: tags: - admin-payments summary: Add correction value for payment invoice description: | `POST /3.1/payments/{id}/add-correction` Add correction value for payment invoice parameters: - name: api-key in: header description: API key required: true example: 23df424b0a53b0899f78685966243ee61 schema: type: string - name: id in: path description: Payment invoice ID required: true schema: type: integer requestBody: content: application/x-www-form-urlencoded: schema: type: object properties: revenue: type: number description: Revenue comment: type: string description: Comment for correction payment required: - revenue - comment responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer result: type: boolean example: status: 1 result: true '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '500': $ref: '#/components/responses/InternalServerError' x-codeSamples: - lang: cURL label: cURL source: |- curl --request POST \ --url 'https://api-demo.affise.com/3.1/payments/{id}/add-correction' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' \ --form 'revenue=0' \ --form 'comment=string' /3.1/payments/del-correction/{id}: delete: tags: - admin-payments summary: Remove correction value for payment invoice description: | `DELETE /3.1/payments/del-correction/{id}` Remove correction value for payment invoice parameters: - name: api-key in: header description: API key example: 23df424b0a53b0899f78685966243ee61 required: true schema: type: string - name: id in: path description: Payment invoice correction sum ID required: true schema: type: integer responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer result: type: boolean example: status: 1 result: true '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '500': $ref: '#/components/responses/InternalServerError' x-codeSamples: - lang: cURL label: cURL source: |- curl --request DELETE \ --url 'https://api-demo.affise.com/3.1/payments/del-correction/{id}' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' /3.1/payments/delete/{id}: delete: tags: - admin-payments summary: Remove payment invoice description: | `DELETE /3.1/payments/delete/{id}` Remove payment invoice parameters: - name: api-key in: header description: API key example: 23df424b0a53b0899f78685966243ee61 required: true schema: type: string - name: id in: path description: Payment invoice ID required: true schema: type: integer responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer result: type: boolean example: status: 1 result: true '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '500': $ref: '#/components/responses/InternalServerError' x-codeSamples: - lang: cURL label: cURL source: |- curl --request DELETE \ --url 'https://api-demo.affise.com/3.1/payments/delete/{id}' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' /3.1/payments/bulk-delete: post: tags: - admin-payments summary: Remove several payment invoices description: | `POST /3.1/payments/bulk-delete` Remove several payment invoices parameters: - name: api-key in: header description: API key example: 23df424b0a53b0899f78685966243ee61 required: true schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: type: object properties: ids: type: array items: type: integer example: - 2 - 3 description: Payment invoice ids required: - ids responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer result: type: object additionalProperties: type: boolean example: status: 1 result: '1': true '2': false '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '500': $ref: '#/components/responses/InternalServerError' x-codeSamples: - lang: cURL label: cURL source: |- curl --request POST \ --url 'https://api-demo.affise.com/3.1/payments/bulk-delete' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' \ --form 'ids[0]=2' \ --form 'ids[1]=3' /3.1/payments/{invoice_id}/conversions/delete: post: tags: - admin-payments summary: Delete conversions from invoice description: Deletes specified conversions from the invoice by ID. operationId: deleteInvoiceConversions parameters: - name: invoice_id in: path description: ID of the invoice required: true schema: type: integer - name: Api-Key in: header description: API key required: true schema: type: string requestBody: required: true content: application/x-www-form-urlencoded: schema: type: object properties: conversion_ids: type: array items: type: string description: Array of conversion IDs to delete. Required if offer_ids is not present. offer_ids: type: array items: type: integer description: Array of offer IDs to delete all their conversions from the invoice. Required if conversion_ids is not present. responses: '200': description: Conversions deleted successfully content: application/json: schema: type: object properties: status: type: integer example: 1 message: type: string example: Conversions successfully deleted from payment '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '500': $ref: '#/components/responses/InternalServerError' x-codeSamples: - lang: cURL label: cURL source: |- curl --request POST \ --url 'https://api-demo.affise.com/3.1/payments/{invoice_id}/conversions/delete' \ --header 'Api-Key: ' \ --form 'conversion_ids[0]=string' \ --form 'conversion_ids[1]=string2' \ --form 'offer_ids[0]=0' \ --form 'offer_ids[1]=1' /3.1/isp: get: tags: - resources summary: ISP list description: | `GET /3.1/isp` Get ISP list parameters: - name: api-key in: header description: API key example: 23df424b0a53b0899f78685966243ee61 required: true schema: type: string - name: country in: query description: Country code. Example "US" required: true schema: type: string - name: q in: query description: Search query schema: type: string responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer isps: type: array items: type: object properties: country: type: string name: type: string pagination: type: object properties: page: type: integer per_page: type: integer total_count: type: integer example: status: 1 isps: - country: KZ name: reliablesite.net llc - country: KZ name: smartnet too - country: KZ name: betting office olimp kz llc pagination: page: 1 per_page: 2147483647 total_count: 3 '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 \ --url 'https://api-demo.affise.com/3.1/isp?country=' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' /3.1/countries: get: tags: - resources summary: Countries list description: | `GET /3.1/countries` Get countries list parameters: - name: api-key in: header description: API key example: 23df424b0a53b0899f78685966243ee61 required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer countries: type: array items: type: object properties: code: type: string name: type: string example: status: 1 countries: - code: KP name: North Korea - code: PF name: French Polynesia - code: EG name: Egypt - code: DE name: Germany - code: GI name: Gibraltar '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 \ --url 'https://api-demo.affise.com/3.1/countries' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' /3.1/regions: get: tags: - resources summary: Regions list description: | `GET /3.1/regions` Get regions list parameters: - name: api-key in: header description: API key required: true example: 23df424b0a53b0899f78685966243ee61 schema: type: string - name: country in: query description: Country code. Example "US" required: true schema: type: array items: type: string example: country[0]: FR - name: code in: query description: Filter regions by id schema: type: array items: type: integer example: code[0]: FR responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer regions: type: array items: type: object properties: id: type: integer name: type: string country_code: type: string example: status: 1 regions: - id: 2 name: Alaska country_code: US - id: 1 name: Alabama country_code: US '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 \ --url 'https://api-demo.affise.com/3.1/regions?country[0]=FR&code[0]=FR' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' /3.1/connection-types: get: tags: - resources summary: Connection types list description: | `GET /3.1/connection-types` Get connection types list parameters: - name: api-key in: header description: API key example: 23df424b0a53b0899f78685966243ee61 required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer types: type: array items: type: string example: status: 1 types: - wi-fi - cellular - other '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 \ --url 'https://api-demo.affise.com/3.1/connection-types' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' /3.1/vendors: get: tags: - resources summary: Vendors list description: | `GET /3.1/vendors` Get vendors list parameters: - name: api-key in: header description: API key example: 23df424b0a53b0899f78685966243ee61 required: true schema: type: string - name: q in: query description: Search query schema: type: string responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer vendors: type: array items: type: string example: status: 1 vendors: - Nextbit - Next - NextBook - NEXTAB - Nextel - NextTab - NEXTPAD - NextWolf '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 \ --url 'https://api-demo.affise.com/3.1/vendors' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' /3.1/oses: get: tags: - resources summary: Oses list description: | `GET /3.1/oses` Get oses list parameters: - name: api-key in: header description: API key example: 23df424b0a53b0899f78685966243ee61 required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer oses: type: object additionalProperties: type: string pagination: type: object properties: page: type: integer per_page: type: integer total_count: type: integer example: status: 1 oses: '0': Firefox OS '1': 3DS System Software '2': DSi System Software '4': VictorReader Stream '5': ThreadX '6': Feedfetcher '7': Maemo '8': Series 60 '9': Android with AOKP '10': Apple TV Software pagination: page: 1 per_page: 2147483647 total_count: 99 '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 \ --url 'https://api-demo.affise.com/3.1/oses' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' /3.1/oses/{os}: get: tags: - resources summary: OS versions list description: | `GET /3.1/oses/{os}` Get os versions list parameters: - name: api-key in: header description: API key example: 23df424b0a53b0899f78685966243ee61 required: true schema: type: string - name: os in: path description: One of OS required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer versions: type: array items: type: string pagination: type: object properties: page: type: integer per_page: type: integer total_count: type: integer example: status: 1 versions: - '11.0' - '10.12' - '10.13' - '10.19' - '10.17' - '10.16' - '10.18' - 10.12.1 - 10.12.2 - 10.12.3 - 10.12.4 - 10.12.5 - 10.12.6 - 10.13.1 - 10.13.2 - 10.13.4 - 10.13.3 - 10.14.0 - 10.12.8 - 10.13.5 - 10.13.6 pagination: page: 1 per_page: 2147483647 total_count: 21 '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 \ --url 'https://api-demo.affise.com/3.1/oses/{os}' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' /3.0/goals: get: tags: - resources summary: Goals list description: | `GET /3.0/goals` Get goals list parameters: - name: api-key in: header description: API key example: 23df424b0a53b0899f78685966243ee61 required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer goals: type: array items: type: object properties: id: type: integer title: type: string example: status: 1 goals: - id: 1 title: Default - id: 2 title: Sale '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 \ --url 'https://api-demo.affise.com/3.0/goals' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' /3.1/presets: get: tags: - admin-presets summary: Get list of presets description: | `GET /3.1/presets` Get presets list parameters: - name: api-key in: header description: API key required: true schema: type: string - name: page in: query description: Page with results schema: type: integer minimum: 1 default: 1 - name: limit in: query description: Results per page schema: type: integer minimum: 1 default: 50 responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer presets: type: array items: type: object properties: id: type: string name: type: string permissions: type: object properties: automation: type: object additionalProperties: true general: type: object additionalProperties: true notificator: type: object additionalProperties: true stats: type: object additionalProperties: true users: type: object additionalProperties: true created_at: type: string format: date-time updated_at: type: string format: date-time example: status: 1 presets: - id: 5f51755a535bac2217eb7619 name: Test affiliate_manager 4 permissions: automation: affise-checker: level: deny general: marketplace: level: read settings: level: deny notificator: client-subscription: level: write transport-configuration: level: write user-subscription: level: write stats: affiliate-postback: level: read clicks-list: level: read comparison-report: level: read conversions-export: level: read conversions-import: level: write conversions-list: level: read entity-account-manager: level: read exceptions: strings: [] entity-affiliate-manager: level: deny exceptions: strings: [] referral: level: deny server-postback: level: read slice-account_manager_id: level: deny slice-advertiser_id: level: deny slice-affiliate_id: level: read slice-affiliate_manager_id: level: deny slice-browser: level: deny slice-city: level: read slice-connection-type: level: deny slice-country: level: read slice-day: level: read slice-device: level: read slice-goal: level: read slice-landing: level: deny slice-mobile-carrier: level: deny slice-offer_id: level: read slice-os: level: read slice-prelanding: level: deny slice-smart_id: level: deny slice-sub1: level: deny slice-sub2: level: deny slice-trafficback_reason: level: read stats-export: level: read view-custom: level: read view-kpi: level: deny view-retention-rate: level: deny users: entity-account-manager: level: deny exceptions: strings: [] entity-advertiser: level: deny exceptions: strings: [] entity-affiliate: level: deny exceptions: ints: [] entity-affiliate-manager: level: write exceptions: strings: [] entity-common-manager: level: deny exceptions: strings: [] entity-preset: level: deny view-users: level: deny created_at: '2020-09-03T22:59:38Z' updated_at: '2020-09-03T22:59:38Z' '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 \ --url 'https://api-demo.affise.com/3.1/presets?page=1&limit=50' \ --header 'api-key: ' post: tags: - admin-presets summary: Create preset description: | `POST /3.1/presets` Create preset using JSON dataset parameters: - name: api-key in: header description: API key required: true schema: type: string requestBody: content: application/json: schema: type: object properties: name: type: string description: Preset name permissions: type: object description: Permissions for preset properties: automation: type: object additionalProperties: true general: type: object additionalProperties: true notificator: type: object additionalProperties: true stats: type: object additionalProperties: true users: type: object additionalProperties: true type: type: string enum: - affiliate_manager - account_manager - common_manager description: Preset type required: - name - permissions - type responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer preset: type: object properties: id: type: string name: type: string permissions: type: object properties: automation: type: object additionalProperties: true general: type: object additionalProperties: true notificator: type: object additionalProperties: true stats: type: object additionalProperties: true users: type: object additionalProperties: true created_at: type: string format: date-time updated_at: type: string format: date-time example: status: 1 preset: id: 5f51755a535bac2217eb7619 name: Test affiliate_manager 4 permissions: automation: affise-checker: level: deny general: marketplace: level: read settings: level: deny notificator: client-subscription: level: write transport-configuration: level: write user-subscription: level: write stats: affiliate-postback: level: read clicks-list: level: read comparison-report: level: read conversions-export: level: read conversions-import: level: write conversions-list: level: read entity-account-manager: level: read exceptions: strings: [] entity-affiliate-manager: level: deny exceptions: strings: [] referral: level: deny server-postback: level: read slice-account_manager_id: level: deny slice-advertiser_id: level: deny slice-affiliate_id: level: read slice-affiliate_manager_id: level: deny slice-browser: level: deny slice-city: level: read slice-connection-type: level: deny slice-country: level: read slice-day: level: read slice-device: level: read slice-goal: level: read slice-landing: level: deny slice-mobile-carrier: level: deny slice-offer_id: level: read slice-os: level: read slice-prelanding: level: deny slice-smart_id: level: deny slice-sub1: level: deny slice-sub2: level: deny slice-trafficback_reason: level: read stats-export: level: read view-custom: level: read view-kpi: level: deny view-retention-rate: level: deny users: entity-account-manager: level: deny exceptions: strings: [] entity-advertiser: level: deny exceptions: strings: [] entity-affiliate: level: deny exceptions: ints: [] entity-affiliate-manager: level: write exceptions: strings: [] entity-common-manager: level: deny exceptions: strings: [] entity-preset: level: deny view-users: level: deny created_at: '2020-09-03T22:59:38Z' updated_at: '2020-09-03T22:59:38Z' '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 POST \ --url 'https://api-demo.affise.com/3.1/presets' \ --header 'api-key: ' \ --header 'Content-Type: application/json' \ --data '{ "name": "string", "permissions": { "automation": {}, "general": {}, "notificator": {}, "stats": {}, "users": {} }, "type": "affiliate_manager" }' /3.1/presets/{preset_id}: post: tags: - admin-presets summary: Update preset description: | `POST /3.1/presets/{preset_id}` Update preset using JSON dataset parameters: - name: api-key in: header description: API key required: true schema: type: string - name: preset_id in: path description: Preset ID required: true schema: type: string requestBody: content: application/json: schema: type: object properties: name: type: string description: Preset name permissions: type: object description: Permissions for update properties: automation: type: object additionalProperties: true general: type: object additionalProperties: true notificator: type: object additionalProperties: true stats: type: object additionalProperties: true users: type: object additionalProperties: true required: - permissions responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer preset: type: object properties: id: type: string name: type: string permissions: type: object properties: automation: type: object additionalProperties: true general: type: object additionalProperties: true notificator: type: object additionalProperties: true stats: type: object additionalProperties: true users: type: object additionalProperties: true created_at: type: string format: date-time updated_at: type: string format: date-time example: status: 1 preset: id: 5f51755a535bac2217eb7619 name: Test affiliate_manager 4 (update) permissions: automation: affise-checker: level: write general: marketplace: level: read settings: level: deny notificator: client-subscription: level: write transport-configuration: level: write user-subscription: level: write stats: affiliate-postback: level: read clicks-list: level: read comparison-report: level: read conversions-export: level: read conversions-import: level: write conversions-list: level: read entity-account-manager: level: read exceptions: strings: [] entity-affiliate-manager: level: deny exceptions: strings: [] referral: level: deny server-postback: level: read slice-account_manager_id: level: deny slice-advertiser_id: level: deny slice-affiliate_id: level: read slice-affiliate_manager_id: level: deny slice-browser: level: deny slice-city: level: read slice-connection-type: level: deny slice-country: level: read slice-day: level: read slice-device: level: read slice-goal: level: read slice-landing: level: deny slice-mobile-carrier: level: deny slice-offer_id: level: read slice-os: level: read slice-prelanding: level: deny slice-smart_id: level: deny slice-sub1: level: deny slice-sub2: level: deny slice-trafficback_reason: level: read stats-export: level: read view-custom: level: read view-kpi: level: deny view-retention-rate: level: deny users: entity-account-manager: level: deny exceptions: strings: [] entity-advertiser: level: deny exceptions: strings: [] entity-affiliate: level: deny exceptions: ints: [] entity-affiliate-manager: level: write exceptions: strings: [] entity-common-manager: level: deny exceptions: strings: [] entity-preset: level: deny view-users: level: deny created_at: '2020-09-03T22:59:38Z' updated_at: '2020-09-03T23:16:22Z' '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 POST \ --url 'https://api-demo.affise.com/3.1/presets/{preset_id}' \ --header 'api-key: ' \ --header 'Content-Type: application/json' \ --data '{ "name": "string", "permissions": { "automation": {}, "general": {}, "notificator": {}, "stats": {}, "users": {} } }' delete: tags: - admin-presets summary: Delete preset description: | `DELETE /3.1/presets/{preset_id}` Delete preset by id parameters: - name: api-key in: header description: API key required: true schema: type: string - name: preset_id in: path description: Preset ID required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer example: 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 DELETE \ --url 'https://api-demo.affise.com/3.1/presets/{preset_id}' \ --header 'api-key: ' /3.1/browsers: get: tags: - admin-other summary: Browsers list description: | `GET /3.1/browsers` Get browsers list parameters: - name: api-key in: header description: API key example: 23df424b0a53b0899f78685966243ee61 required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer browsers: type: array items: type: string pagination: type: object properties: page: type: integer per_page: type: integer total_count: type: integer example: status: 1 browsers: - Yahoo Mobile Messenger for Android - Dillo - lolifox - Facebook for Windows - Web Light - CometBird - MetaCert Safe iPad Browser pagination: page: 1 per_page: 2147483647 total_count: 527 '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 \ --url 'https://api-demo.affise.com/3.1/browsers' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' /3.1/cities: get: tags: - admin-other summary: City list description: | `GET /3.1/cities` Get city list parameters: - name: api-key in: header description: API key example: 23df424b0a53b0899f78685966243ee61 required: true schema: type: string - name: country in: query description: Country code. Example US required: true schema: oneOf: - type: string - type: array items: type: string - name: q in: query description: Search query schema: type: string - name: code in: query description: City codes for filter schema: type: string responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer cities: type: array items: type: object properties: country_code: type: string id: type: integer name: type: string region_code: type: string pagination: type: object properties: page: type: integer per_page: type: integer total_count: type: integer example: status: 1 cities: - country_code: DE id: 79729 name: Thallichtenberg region_code: Rheinland-Pfalz - country_code: DE id: 40034 name: Sindelfingen region_code: Baden-Wurttemberg - country_code: DE id: 75980 name: Hofkirchen region_code: Bayern pagination: page: 1 per_page: 2147483647 total_count: 3 '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 \ --url 'https://api-demo.affise.com/3.1/cities?country=' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' /3.0/admin/currency: get: tags: - admin-other summary: Currency list description: | `GET /3.0/admin/currency` Get list of currency parameters: - name: api-key in: header description: API key example: 23df424b0a53b0899f78685966243ee61 required: true schema: type: string - name: get_only_active in: query description: Ignore inactive currencies schema: type: integer default: 0 enum: - 0 - 1 - name: extended in: query description: Extended currencies information schema: type: integer default: 0 enum: - 0 - 1 responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer quotes: oneOf: - type: object additionalProperties: type: number - type: array items: type: object properties: _id: type: integer code: type: string active: type: boolean default: type: boolean rate: type: number min_payment: type: integer is_crypto: type: boolean nullable: true example: default: value: status: 1 quotes: RUB: 59.312599 USD: 1 AED: 3.672497 AFN: 66.669998 ALL: 125.800003 AMD: 485.299988 ANG: 1.769851 AOA: 165.080994 extended: value: status: 1 quotes: - _id: 2 code: USD active: true default: true rate: 1 min_payment: 20 is_crypto: null '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 \ --url 'https://api-demo.affise.com/3.0/admin/currency?get_only_active=0&extended=0' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' /3.0/admin/custom_fields: get: tags: - admin-other summary: Custom fields list description: | `GET /3.0/admin/custom_fields` Get list of signup settings parameters: - name: api-key in: header description: API key example: 23df424b0a53b0899f78685966243ee61 required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer fields: type: array items: type: object properties: id: type: integer name: type: string required: type: boolean field_type: type: string field_values: type: object nullable: true example: status: 1 fields: - id: 1 name: Skype required: false field_type: text field_values: null '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 \ --url 'https://api-demo.affise.com/3.0/admin/custom_fields' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' /3.1/devices: get: tags: - admin-other summary: Devices list description: | `GET /3.1/devices` Get list of devices parameters: - name: api-key in: header description: API key example: 23df424b0a53b0899f78685966243ee61 required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer types: type: array items: type: string example: status: 1 types: - mediahub - mobile - ereader - console - tv - tablet - desktop - smartwatch '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 \ --url 'https://api-demo.affise.com/3.1/devices' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' /3.0/admin/domains: get: tags: - admin-other summary: Domains list description: | `GET /3.0/admin/domains` Get domains parameters: - name: api-key in: header description: API key example: 23df424b0a53b0899f78685966243ee61 required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer domains: type: array items: type: object properties: url: type: string use_https: type: boolean example: status: 1 domains: - url: domain1.com use_https: false - url: domain2.com use_https: false '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 \ --url 'https://api-demo.affise.com/3.0/admin/domains' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' /3.0/admin/payment_systems: get: tags: - admin-other summary: Payment systems list description: | `GET /3.0/admin/payment_systems` Get list of payment systems parameters: - name: api-key in: header description: API key example: 23df424b0a53b0899f78685966243ee61 required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer payment_systems: type: array items: type: object properties: id: type: integer lang_label: type: string fields: type: array items: type: object properties: id: type: integer lang_label: type: string required: type: boolean currency: type: string nullable: true example: status: 1 payment_systems: - id: 2 lang_label: Wire transfer fields: - id: 1 lang_label: IBAN/Account Number required: true - id: 2 lang_label: Swift/BIC-Code required: true - id: 3 lang_label: Bank name required: true - id: 4 lang_label: Bank address required: true currency: null - id: 3 lang_label: Webmoney WMZ fields: - id: 1 lang_label: WMZ required: true currency: AED '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 \ --url 'https://api-demo.affise.com/3.0/admin/payment_systems' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' /3.0/admin/smartlink/categories: get: tags: - admin-smartlinks summary: SmartLink categories description: | `GET /3.0/admin/smartlink/categories` SmartLink categories list parameters: - name: api-key in: header description: API key required: true schema: type: string - name: id in: query description: SmartLink categories ID schema: type: array items: type: string - name: name in: query description: SmartLink title schema: type: string responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer data: type: array items: type: object properties: _id: type: string name: type: string domain: type: string description: type: string nullable: true use_https: type: boolean privacy_level: type: string excluded_affiliates: type: array items: {} included_affiliates: type: array items: type: integer created_at: type: string format: date-time updated_at: type: string format: date-time example: status: 1 data: - _id: 595e3b547e28fede7b8b456c name: test1 domain: myDomen.com description: null use_https: false privacy_level: premoderated excluded_affiliates: [] included_affiliates: - 1 created_at: '2017-07-06 13:29:56' updated_at: '2017-07-06 13:29:56' '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 \ --url 'https://api-demo.affise.com/3.0/admin/smartlink/categories?id[0]=string&id[1]=string2' \ --header 'api-key: ' /3.0/admin/smartlink/category/{id}/offers-count: get: tags: - admin-smartlinks summary: SmartLink offer count description: | `GET /3.0/admin/smartlink/category/{id}/offers-count` Get offers' count parameters: - name: api-key in: header description: API key example: 23df424b0a53b0899f78685966243ee61 required: true schema: type: string - name: id in: path description: Category ID required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer data: type: object properties: count: type: integer example: status: 1 data: count: 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 \ --url 'https://api-demo.affise.com/3.0/admin/smartlink/category/{id}/offers-count' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' /3.0/admin/smartlink/category: post: tags: - admin-smartlinks summary: SmartLink category description: | `POST /3.0/admin/smartlink/category` Add new SmartLink category parameters: - name: api-key in: header description: API key required: true schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: type: object properties: name: type: string description: Category name description: type: string description: Category description privacy_level: type: string enum: - public - premoderated - private default: public description: Privacy level excluded_affiliates: type: array items: type: integer description: Excluded affiliate IDs included_affiliates: type: array items: type: integer description: Included affiliate IDs tracking_domain: type: string description: The domain name (FQDN) for the tracking URL required: - name responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer data: type: object properties: _id: type: string name: type: string domain: type: string description: type: string use_https: type: boolean privacy_level: type: string excluded_affiliates: type: array items: {} included_affiliates: type: array items: type: integer created_at: type: string format: date-time updated_at: type: string format: date-time example: status: 1 data: _id: 595fd4877e28fee8428b459f name: test domain: myDomen.com description: test use_https: false privacy_level: premoderated excluded_affiliates: [] included_affiliates: - 1 created_at: '2017-07-07 18:35:51' updated_at: '2017-07-07 18:35:51' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '500': $ref: '#/components/responses/InternalServerError' x-codeSamples: - lang: cURL label: cURL source: |- curl --request POST \ --url 'https://api-demo.affise.com/3.0/admin/smartlink/category' \ --header 'api-key: ' \ --form 'name=string' \ --form 'description=string' \ --form 'privacy_level=public' \ --form 'excluded_affiliates[0]=0' \ --form 'excluded_affiliates[1]=1' \ --form 'included_affiliates[0]=0' \ --form 'included_affiliates[1]=1' \ --form 'tracking_domain=string' /3.0/admin/smartlink/category/{id}: post: tags: - admin-smartlinks summary: Smartlink edit category description: | `POST /3.0/admin/smartlink/category/{id}` Edit a SmartLink category parameters: - name: api-key in: header description: API key required: true schema: type: string - name: id in: path description: Category ID required: true schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: type: object properties: name: type: string description: Name of category description: type: string description: Description of the category tracking_domain: type: string description: The domain name (FQDN) for the tracking URL privacy_level: type: string enum: - public - premoderated - private description: Privacy level excluded_affiliates: type: array items: type: integer description: Excluded affiliate IDs included_affiliates: type: array items: type: integer description: Included affiliate IDs responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer data: type: object properties: _id: type: string name: type: string domain: type: string description: type: string use_https: type: boolean privacy_level: type: string excluded_affiliates: type: array items: {} included_affiliates: type: array items: type: integer created_at: type: string format: date-time updated_at: type: string format: date-time example: status: 1 data: _id: 595fd4877e28fee8428b459f name: test123 domain: myDomen.com description: test use_https: false privacy_level: premoderated excluded_affiliates: [] included_affiliates: - 1 created_at: '2017-07-07 18:35:51' updated_at: '2017-07-07 18:35:51' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '500': $ref: '#/components/responses/InternalServerError' x-codeSamples: - lang: cURL label: cURL source: |- curl --request POST \ --url 'https://api-demo.affise.com/3.0/admin/smartlink/category/{id}' \ --header 'api-key: ' \ --form 'name=string' \ --form 'description=string' \ --form 'tracking_domain=string' \ --form 'privacy_level=public' \ --form 'excluded_affiliates[0]=0' \ --form 'excluded_affiliates[1]=1' \ --form 'included_affiliates[0]=0' \ --form 'included_affiliates[1]=1' /3.0/admin/smartlink/category/{id}/remove: post: tags: - admin-smartlinks summary: SmartLink category remove description: | `POST /3.0/admin/smartlink/category/{id}/remove` Remove a SmartLink category parameters: - name: api-key in: header description: API key required: true schema: type: string - name: id in: path description: Category ID required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer data: type: object properties: _id: type: string name: type: string domain: type: string description: type: string use_https: type: boolean privacy_level: type: string excluded_affiliates: type: array items: {} included_affiliates: type: array items: type: integer created_at: type: string format: date-time updated_at: type: string format: date-time example: status: 1 data: _id: 595fd4877e28fee8428b459f name: test123 domain: myDomen.com description: test use_https: false privacy_level: premoderated excluded_affiliates: [] included_affiliates: - 1 created_at: '2017-07-07 18:35:51' updated_at: '2017-07-07 18:35:51' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '500': $ref: '#/components/responses/InternalServerError' x-codeSamples: - lang: cURL label: cURL source: |- curl --request POST \ --url 'https://api-demo.affise.com/3.0/admin/smartlink/category/{id}/remove' \ --header 'api-key: ' /3.0/admin/ticket/{id}: get: tags: - admin-tickets summary: Get ticket description: | `GET /3.0/admin/ticket/{id}` Get ticket parameters: - name: api-key in: header description: API key example: 23df424b0a53b0899f78685966243ee61 required: true schema: type: string - name: id in: path description: Ticket ID required: true schema: type: integer responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer ticket: type: object properties: id: type: string status: type: string type: type: string title: type: string description: type: string partner: type: object properties: id: type: integer created_at: type: string format: date-time updated_at: type: string format: date-time email: type: string login: type: string ref_percent: type: number nullable: true name: type: string notes: type: string manager: type: object nullable: true status: type: string level: type: integer payment_systems: type: array items: {} customFields: type: array items: {} balance: type: object additionalProperties: type: object properties: balance: type: number hold: type: number available: type: number offersCount: type: integer api_key: type: string address_1: type: string nullable: true address_2: type: string nullable: true city: type: string nullable: true country: type: string nullable: true zip_code: type: string nullable: true phone: type: string nullable: true ref: type: string nullable: true offer: type: object properties: id: type: integer offer_id: type: string title: type: string preview_url: type: string description: type: string cr: type: number epc: type: number logo: type: string logo_source: type: string nullable: true stop_at: type: string nullable: true sources: type: array items: {} categories: type: array items: {} full_categories: type: array items: {} countries: type: array items: {} nullable: true payments: type: array items: type: object properties: countries: type: array items: {} cities: type: array items: {} country_exclude: type: boolean title: type: string goal: type: string currency: type: string type: type: string devices: type: array items: {} os: type: array items: {} revenue: type: number goals: type: object additionalProperties: type: string caps: type: array items: {} caps_timezone: type: string cap: type: integer hide_caps: type: integer required_approval: type: boolean strictly_country: type: integer strictly_os: type: array items: {} strictly_brands: type: object nullable: true is_cpi: type: boolean kpi: type: object properties: en: type: string creatives: type: array items: {} creatives_zip: type: string nullable: true landings: type: array items: {} links: type: array items: {} macro_url: type: string link: type: string nullable: true use_https: type: boolean use_http: type: boolean hold_period: type: integer hold_type: type: string click_session: type: string disabled_choice_postback_status: type: boolean strictly_isp: type: array items: {} restriction_isp: type: array items: {} impressions_link: type: string nullable: true attachments: type: array items: type: string created: type: string format: date-time updated: type: string format: date-time nullable: true id: type: string example: status: 1 ticket: id: '1' status: closed type: common title: Connect offer description: I want to connect offer partner: id: 3 created_at: '2018-06-20 14:42:40' updated_at: '2018-06-20 14:42:40' email: testtest@gmail.com login: testtest@gmail.com ref_percent: null name: '' notes: '' manager: null status: not active level: 0 payment_systems: [] customFields: [] balance: USD: balance: 0 hold: 0 available: 0 offersCount: 0 api_key: 742638e984afa1dc12983966b4d424228b483b30 address_1: null address_2: null city: null country: null zip_code: null phone: null ref: null offer: id: 9 offer_id: 5b2ba4beb861fd58ad8b4670 title: Offer preview_url: http://link.preview.com description: '' cr: 7 epc: 0 logo: '' logo_source: null stop_at: null sources: [] categories: [] full_categories: [] countries: null payments: - countries: [] cities: [] country_exclude: false title: RevShare goal: '1' currency: USD type: percent devices: [] os: [] - countries: [] cities: [] country_exclude: false title: Deposit goal: '3' revenue: 0 currency: USD type: fixed devices: [] os: [] goals: '1': RevShare '2': RevShare '3': Deposit '4': Registration caps: [] caps_timezone: Europe/Moscow cap: 0 hide_caps: 0 required_approval: false strictly_country: 1 strictly_os: [] strictly_brands: null is_cpi: false kpi: en: '' creatives: [] creatives_zip: null landings: [] links: [] macro_url: '' link: null use_https: false use_http: true hold_period: 0 hold_type: days click_session: 1y disabled_choice_postback_status: false strictly_isp: [] restriction_isp: [] impressions_link: null attachments: - http://YOUR_API_DOMAIN/3.0/admin/ticket/file/23/faafe9b1df79e05f4eaf8e6516d7bfafbde2e1f4.png created: '2018-09-12 12:05:18' updated: null id: '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 \ --url 'https://api-demo.affise.com/3.0/admin/ticket/{id}' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' /3.0/admin/tickets: get: tags: - admin-tickets summary: Ticket list description: | `GET /3.0/admin/tickets` Get list of tickets for connection to offers parameters: - name: api-key in: header description: API key example: 23df424b0a53b0899f78685966243ee61 required: true schema: type: string - name: page in: query description: Page of stat entities required: true schema: type: integer default: 1 - name: limit in: query description: Limit of entities schema: type: integer default: 100 maximum: 500 - name: status in: query description: Status schema: type: string enum: - open - closed - name: type[] in: query description: Ticket types schema: type: array items: type: string enum: - common - financial - technical - offer_request - smartlink_request - payment_request - name: search in: query description: Search string schema: type: string - name: pid[] in: query description: Affiliate IDs schema: type: array items: type: integer - name: manager_id[] in: query description: Manager IDs schema: type: array items: type: string - name: offer_id[] in: query description: Offer IDs (each value must be greater than 0) schema: type: array items: type: integer minimum: 1 responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer tickets: type: array items: type: object properties: id: type: string status: type: string type: type: string title: type: string description: type: string partner: type: object properties: id: type: integer updated_at: type: string format: date-time email: type: string login: type: string ref_percent: type: number nullable: true name: type: string notes: type: string manager: type: object nullable: true status: type: string level: type: integer payment_systems: type: array items: type: object properties: id: type: integer active: type: integer system: type: string fields: type: object additionalProperties: type: string customFields: type: array items: type: object properties: name: type: string value: type: string label: type: string id: type: integer balance: type: object additionalProperties: type: object properties: balance: type: number hold: type: number available: type: number offersCount: type: integer api_key: type: string offer: type: object properties: id: type: integer offer_id: type: string title: type: string preview_url: type: string description: type: string cr: type: number epc: type: number logo: type: string stop_at: type: string nullable: true 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 countries: type: array items: type: string payments: type: array items: type: object properties: countries: type: array items: type: string cities: type: array items: {} country_exclude: type: boolean title: type: string goal: type: integer revenue: type: number currency: type: string nullable: true type: type: string devices: type: array items: {} os: type: array items: {} goals: type: object additionalProperties: type: string required_approval: type: boolean landings: type: array items: type: object properties: id: type: integer title: type: string url: type: string url_preview: type: string type: type: string is_cpi: type: boolean creatives: type: array items: {} creatives_zip: type: string nullable: true links: type: array items: {} macro_url: type: string nullable: true link: type: string nullable: true use_https: type: boolean use_http: type: boolean hold_period: type: integer hold_type: type: string click_session: type: string nullable: true attachments: type: array items: type: string created: type: string format: date-time updated: type: string format: date-time pagination: type: object properties: per_page: type: integer total_count: type: integer page: type: integer example: status: 1 tickets: - id: '17340' status: open type: common title: ... description: ... partner: id: 9310 updated_at: '2016-03-01 14:07:29' email: ...@... login: ...@... ref_percent: null name: '' notes: ... manager: null status: active level: 0 payment_systems: - id: 10811 active: 0 system: Webmoney WMZ fields: '1': .... - id: 10812 active: 0 system: Webmoney WMR fields: '1': .... customFields: - name: Skype value: ... label: ... id: 1 balance: USD: balance: 14 hold: 0 available: 14 offersCount: 3 api_key: 5099412c192828adfe79892d25e5e4a41ffb offer: id: 718 offer_id: 563785d13b7d9bc31b8b4585 title: ... preview_url: https://YOUR_API_DOMAIN/ description: ... cr: 0.63 epc: 0.03 logo: http://YOUR_API_DOMAIN/images/cpa/logos/292223717.png stop_at: null sources: - id: 51f531f53b7d9b1e0382f6d9 title: Web sites allowed: 1 categories: - ... full_categories: - id: 5368afb23b7d9b4d5d505342 title: ... countries: - us payments: - countries: - US cities: [] country_exclude: false title: '' goal: 1 revenue: 7 currency: null type: fixed devices: [] os: [] goals: '1': '' required_approval: true landings: - id: 1446479313 title: ... url: http://YOUR_API_DOMAIN/landingpages/1811/index.php&click_id={clickid} url_preview: http://YOUR_API_DOMAIN/landingpages/1880/index.php type: landing is_cpi: false creatives: [] creatives_zip: null links: [] macro_url: null link: null use_https: false use_http: true hold_period: 21 hold_type: days click_session: null attachments: - http://YOUR_API_DOMAIN/3.0/admin/ticket/file/23/faafe9b1df79e05f4eaf8e6516d7bfafbde2e1f4.png created: '2016-09-23 19:31:20' updated: '1970-01-01 03:00:00' pagination: per_page: 100 total_count: 0 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 \ --url 'https://api-demo.affise.com/3.0/admin/tickets?page=1&limit=100&status=open&type[0]=common&pid[0]=0&pid[1]=1&manager_id[0]=string&manager_id[1]=string2&offer_id[0]=0&offer_id[1]=1' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' /3.0/admin/ticket/{id}/offer: post: tags: - admin-tickets summary: Approve or reject ticket for connect affiliate to offer description: | `POST /3.0/admin/ticket/{id}/offer` Approve or reject ticket for connect affiliate to offer parameters: - name: api-key in: header description: API key example: 23df424b0a53b0899f78685966243ee61 required: true schema: type: string - name: id in: path description: Ticket ID required: true schema: type: integer requestBody: content: application/x-www-form-urlencoded: schema: type: object properties: do: type: string enum: - approve - reject description: What need to do with a ticket required: - do responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer message: type: string example: status: 1 message: Request is successfully '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '500': $ref: '#/components/responses/InternalServerError' x-codeSamples: - lang: cURL label: cURL source: |- curl --request POST \ --url 'https://api-demo.affise.com/3.0/admin/ticket/{id}/offer' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' \ --form 'do=approve' /3.0/admin/ticket/{id}/smartlink: post: tags: - admin-tickets summary: Approve or reject ticket for connect affiliate to SmartLink description: | `POST /3.0/admin/ticket/{id}/smartlink` Approve or reject ticket for connect affiliate to SmartLink parameters: - name: api-key in: header description: API key example: 23df424b0a53b0899f78685966243ee61 required: true schema: type: string - name: id in: path description: Ticket ID required: true schema: type: integer requestBody: content: application/x-www-form-urlencoded: schema: type: object properties: do: type: string enum: - approve - reject description: What need to do with a ticket required: - do responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer message: type: string example: status: 1 message: SmartLink privacy is updated '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '500': $ref: '#/components/responses/InternalServerError' x-codeSamples: - lang: cURL label: cURL source: |- curl --request POST \ --url 'https://api-demo.affise.com/3.0/admin/ticket/{id}/smartlink' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' \ --form 'do=approve' /3.0/partner/pixels: get: tags: - affiliate-pixels summary: Pixel list description: | `GET /3.0/partner/pixels` Get list of a partner's pixels parameters: - name: api-key in: header description: API key required: true schema: type: string example: 23df424b0a53b0899f78685966243ee61 - name: pid in: query description: Filter by partner IDs schema: type: array items: type: integer example: pid[0]: 610 - name: moderation_status in: query description: 'Filter by moderation status: -1 — rejected, 0 — pending, 1 — approved' schema: type: integer enum: - -1 - 0 - 1 responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer pixel: type: object additionalProperties: $ref: '#/components/schemas/pixel' example: status: 1 pixel: '1': id: 1 name: ... code: code_type: javascript offer_id: '906' pid: '610' is_active: '0' moderation_status: '0' created_at: '2017-06-19 22:49:07' updated_at: '2017-06-19 22:49:07' '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 \ --url 'https://api-demo.affise.com/3.0/partner/pixels?pid[0]=610&moderation_status=-1' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' /3.0/partner/pixel: post: tags: - affiliate-pixels summary: Pixel add description: Add a new pixel for a partner. operationId: addPartnerPixel parameters: - name: API-Key in: header description: API key of the partner required: true schema: type: string requestBody: required: true content: application/x-www-form-urlencoded: schema: type: object required: - offer_id - name - code - code_type properties: offer_id: type: integer description: Offer's ID name: type: string description: Name of the pixel code: type: string description: The pixel code (script, img, or iframe) code_type: type: string description: The type of the pixel code enum: - javascript - iframe - image responses: '200': description: Pixel added successfully content: application/json: schema: type: object properties: status: type: integer example: 1 pixel: type: object properties: id: type: integer name: type: string code: type: string code_type: type: string offer_id: type: string pid: type: string is_active: type: string moderation_status: type: string created_at: type: string format: date-time updated_at: type: string format: date-time '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '500': $ref: '#/components/responses/InternalServerError' x-codeSamples: - lang: cURL label: cURL source: |- curl --request POST \ --url 'https://api-demo.affise.com/3.0/partner/pixel' \ --header 'API-Key: ' \ --form 'offer_id=0' \ --form 'name=string' \ --form 'code=string' \ --form 'code_type=javascript' /3.0/partner/pixel/{id}: post: tags: - affiliate-pixels summary: Pixel edit description: | `POST /3.0/partner/pixel/{id}` Edit a partner's pixel parameters: - name: api-key in: header description: API key required: true schema: type: string example: 23df424b0a53b0899f78685966243ee61 - name: id in: path description: Pixel ID required: true schema: type: integer requestBody: content: application/x-www-form-urlencoded: schema: type: object properties: name: type: string description: Name code: type: string description: Code code_type: type: string enum: - javascript - iframe - image description: Code type responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer pixel: $ref: '#/components/schemas/pixel' example: status: 1 pixel: id: 2 name: test2 code: code_type: javascript offer_id: '906' pid: '610' is_active: '0' moderation_status: '0' created_at: '2017-06-21 03:34:51' updated_at: '2017-06-21 03:34:51' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '500': $ref: '#/components/responses/InternalServerError' x-codeSamples: - lang: cURL label: cURL source: |- curl --request POST \ --url 'https://api-demo.affise.com/3.0/partner/pixel/{id}' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' \ --form 'name=string' \ --form 'code=string' \ --form 'code_type=javascript' /3.0/partner/pixel/{id}/remove: delete: tags: - affiliate-pixels summary: Pixel remove description: | `DELETE /3.0/partner/pixel/{id}/remove` Delete a partner's pixel parameters: - name: api-key in: header description: API key required: true schema: type: string example: 23df424b0a53b0899f78685966243ee61 - name: id in: path description: Pixel ID required: true schema: type: integer responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer pixel: type: object properties: id: type: integer name: type: string code: type: string code_type: type: string offer_id: type: string pid: type: string is_active: type: string moderation_status: type: string created_at: type: string updated_at: type: string example: status: 1 pixel: id: 2 name: test2 code: code_type: javascript offer_id: '906' pid: '610' is_active: '0' moderation_status: '0' created_at: '2017-06-21 03:34:51' updated_at: '2017-06-21 03:34:51' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '500': $ref: '#/components/responses/InternalServerError' x-codeSamples: - lang: cURL label: cURL source: |- curl --request DELETE \ --url 'https://api-demo.affise.com/3.0/partner/pixel/{id}/remove' \ --header 'api-key: 23df424b0a53b0899f78685966243ee61' /3.1/product-feed/{product_feed_id}/items: get: tags: - affiliate-other summary: Product feed items description: | `GET /3.1/product-feed/{product_feed_id}/items` Get product feed items parameters: - name: API-Key in: header description: API key required: true schema: type: string - name: product_feed_id in: path description: Product Feed ID required: true schema: type: string - name: affiliate_id in: query description: Affiliate ID required: true schema: type: integer - name: offer_id in: query description: Offer ID required: true schema: type: integer responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: integer data: type: array items: type: object properties: affise_url: type: string availability: type: string brand: type: string brand_sku: type: string category: type: string client_id: type: integer currency: type: string description: type: string id: type: string image_url: type: string name: type: string price: type: string product_feed_id: type: string sku: type: string subcategory: type: string url: type: string pagination: type: object properties: page: type: integer per_page: type: integer total_count: type: integer example: data: - affise_url: tracking_link availability: '' brand: '' brand_sku: '' category: '' client_id: 5832 currency: '' description: description id: 68618d12a03b6a183ffd8638 image_url: image_url name: name price: '' product_feed_id: 685a595fcde5729d988585cc sku: '8793994' subcategory: '' url: original_url pagination: page: 1 per_page: 100 total_count: 10 status: 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 \ --url 'https://api-demo.affise.com/3.1/product-feed/{product_feed_id}/items?affiliate_id=&offer_id=' \ --header 'API-Key: ' components: responses: BadRequest: description: Bad Request - The request was malformed or contained invalid parameters content: application/json: schema: type: object properties: status: type: integer example: 2 message: type: string example: Bad Request Unauthorized: description: Unauthorized - API key is missing or invalid content: application/json: schema: type: object properties: status: type: integer example: 2 message: type: string example: Token is necessary Forbidden: description: Forbidden - Access denied, insufficient permissions content: application/json: schema: type: object properties: status: type: integer example: 2 message: type: string example: Auth Denied NotFound: description: Not Found - Resource not found content: application/json: schema: type: object properties: status: type: integer example: 2 message: type: string example: Resource Not Found InternalServerError: description: Internal Server Error - Server error, please contact administrator content: application/json: schema: type: object properties: status: type: integer example: 2 message: type: string example: Server error, Please contact your administrator schemas: offer_payment_structure: type: object description: Payment item structure properties: id: type: integer description: Payment id title: type: string description: Payment title countries: type: array items: type: string description: An array of countries in ISO format (or put empty string to clear existing items) country_exclude: type: integer enum: - 0 - 1 description: Exclude these countries. Available:0,1 cities: type: array items: type: integer description: An array of id cities (or put empty string to clear existing items) devices: type: array items: type: string enum: - mediahub - mobile - ereader - console - tv - tablet - desktop - smartwatch description: The array of devices. (or put empty string to clear existing items) os: type: string description: Possible values can be found in oses-list goal: type: string description: Value targets total: type: number description: The amount of payment revenue: type: number description: Payment webmaster currency: type: string description: Currency (Code in ECB format) type: type: string enum: - fixed - percent - mixed - cpc - cpm - first_cpa - first_cps - baseline_onetime - baseline_accumulating description: Type of payment. sub1: type: string description: Comma-separated sub values for sub1 sub2: type: string description: Comma-separated sub values for sub2 sub3: type: string description: Comma-separated sub values for sub3 sub4: type: string description: Comma-separated sub values for sub4 sub5: type: string description: Comma-separated sub values for sub5 sub6: type: string description: Comma-separated sub values for sub6 sub7: type: string description: Comma-separated sub values for sub7 sub8: type: string description: Comma-separated sub values for sub8 custom_field1: type: string custom_field2: type: string custom_field3: type: string custom_field4: type: string custom_field5: type: string custom_field6: type: string custom_field7: type: string custom_field8: type: string custom_field9: type: string custom_field10: type: string custom_field11: type: string custom_field12: type: string custom_field13: type: string custom_field14: type: string custom_field15: type: string baseline_value: type: number description: Baseline value for the payment with the type 'baseline_onetime' and 'baseline_accumulating'. required: - currency - type offer_landing_structure: type: object properties: id: type: integer description: Landing id. Pass an existing landing's id to update that landing in place; omit to create a new landing. Not required. title: type: string description: Title url: type: string description: Tracking URL url_preview: type: string description: View URL type: type: string enum: - landing - transit default: landing description: Type required: - title - url - url_preview offer_caps_structure: type: object description: Cap item structure properties: period: type: string enum: - hour - day - month - all description: 'Possible values: hour (if enabled), day, month, all' type: type: string enum: - budget - conversions - clicks - impressions description: 'Possible values: budget, conversions, clicks, impressions' value: type: number description: The integer value for the type of conversion and the float value for the budget type. goals: type: array items: type: string description: Array[string]. Either specifies goal value or is empty. Empty field requires 'goal_type' values of 'all'/'each'. goal_type: type: string enum: - all - each - exact description: '[string]. Values: ''all'' , ''each'', ''exact''. ''goals'' field is mandatory to be specified for ''exact'' value.' affiliates: type: array items: type: integer description: Array[integer]. Either specifies affiliate ID or is empty filed. Empty field requires 'affiliate_type' values of 'all'/'each'. affiliate_type: type: string enum: - all - each - exact description: '[string]. Values: ''all'' , ''each'', ''exact''. ''affiliates'' field is mandatory to be specified for ''exact'' value.' country: type: array items: type: string description: 'Array[string]. Values: Country codes.' country_type: type: string enum: - all - each - exact description: '[string]. Values: ''all'' , ''each'', ''exact''. ''country'' field is mandatory to be specified for ''exact'' value.' sub_number: type: integer description: '[integer]. Possible values: 2.' enum: - 2 sub_value: type: array items: type: string 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. 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_url_weight: type: object description: URL with weight for traffic redistribution properties: url: type: string description: 'Tracking URL. Example: additional_impression_destination_urls[0][url]=example.com' weight: type: integer minimum: 0 maximum: 100 description: 'track-link weight. Example: additional_impression_destination_urls[0][weight]=50' targeting_group_structure: type: object description: Targeting group structure properties: id: type: string format: uuid description: id in UUID format enabled: type: integer enum: - 0 - 1 description: enable/disable targeting group name: type: string description: name for targeting group condition: type: string enum: - and - or description: condition for rules in targeting group country: type: object properties: allow: type: array items: type: string deny: type: array items: type: string description: 'list of allowed/denied countries. Example: country[allow][]=US' region: type: object properties: allow: type: object additionalProperties: type: array items: type: integer deny: type: object additionalProperties: type: array items: type: integer description: 'list of allowed/denied regions for chosen country(ISO). Example: region[allow][US]=33' city: type: object properties: allow: type: object additionalProperties: type: array items: type: integer deny: type: object additionalProperties: type: array items: type: integer description: 'list of allowed/denied cities for chosen country(ISO). Example: city[allow][US]=57' os: type: object properties: allow: type: array items: $ref: '#/components/schemas/targeting_os_structure' description: list of allowed OSes and them versions. os_deny: type: integer enum: - 0 - 1 default: 0 description: When set to 1 blocks values listed in os isp: type: object properties: allow: type: object additionalProperties: type: array items: type: string deny: type: object additionalProperties: type: array items: type: string description: 'list of allowed/denied ISP for chosen country(ISO). Example: isp[allow][US]=Att' isp_organization: type: object properties: allow: type: array items: type: string deny: type: array items: type: string deny_empty: type: integer enum: - 0 - 1 description: list of allowed ISP organizations. Set deny_empty to block empty isp organizations. ip: type: object properties: allow: type: array items: type: string deny: type: array items: type: string ipv6_deny: type: integer enum: - 0 - 1 description: list of allowed/denied ip ranges (IPv4 , IPv6). device_type: type: array items: type: string enum: - mobile - tablet - desktop - mediahub - ereader - console - tv - smartwatch description: list of allowed device types. device_type_deny: type: integer enum: - 0 - 1 default: 0 description: When set to 1 blocks values listed in device_type device_model: type: object properties: allow: type: array items: type: string deny: type: array items: type: string description: list of allowed/denied device models. browser_version: type: object properties: allow: type: array items: $ref: '#/components/schemas/targeting_browser_version_structure' deny: type: array items: $ref: '#/components/schemas/targeting_browser_version_structure' description: list of allowed/denied browsers and their versions. browser: type: object properties: allow: type: array items: type: string deny: type: array items: type: string description: 'list of allowed/denied browsers. Example: browser[deny][] = "Edge"' brand: type: object properties: allow: type: array items: type: string deny: type: array items: type: string description: 'list of allowed/denied device brands. Example: brand[deny][] = "SAMTEL"' sub: type: object description: Complex sub-account targeting rules. connection: type: array items: type: string enum: - wi-fi - cellular description: list of allowed connection types. connection_deny: type: integer enum: - 0 - 1 default: 0 description: When set to 1 blocks values listed in connection block_proxy: type: integer enum: - 0 - 1 description: enable/disable "Click-level Anti-fraud" feature block_known_bots: type: integer enum: - 0 - 1 description: enable/disable blocking of known bots affiliate_id: type: array items: type: integer description: list of affiliates for personal targeting groups. url: type: string description: Additional Tracking URL urls: type: array items: $ref: '#/components/schemas/targeting_url_weight' description: URLs with weights for traffic redistribution between several track-links referrer: type: object properties: allow: type: array items: type: string deny: type: array items: type: string deny_empty: type: integer enum: - 0 - 1 is_regexp: type: integer enum: - 0 - 1 description: Set to 1 to enable regular expressions in allow or deny values description: list of allowed/denied referrers. Set deny_empty to block empty referrers. Set is_regexp to enable regular expressions in allow or deny values. ua: type: object properties: allow: type: array items: type: string deny: type: array items: type: string deny_crawlers: type: integer enum: - 0 - 1 description: list of allowed/denied user agents. Set deny_crawlers to block known crawlers. zip: type: object properties: allow: type: array items: type: string deny: type: array items: type: string description: list of zip codes macros_replacement: type: object additionalProperties: type: array items: type: string description: 'Available if the Macros Replacement feature is enabled. Example of the structure: macros_replacement[sub1][]=value' macros_replacement_enabled: type: array items: type: string description: Available if the Macros Replacement feature is enabled. offer_tier_structure: type: object description: Commission tier item structure properties: timeframe: type: string enum: - day - week - month - all description: 'Possible values: day, week, month, all' type: type: string enum: - budget - conversions description: 'Possible values: budget, conversions' value: type: number description: The integer value for the type of conversion and the float value for the budget type. modifier_value: type: number format: float description: The float value. modifier_type: type: string enum: - by_fix - by_percent - to_fix - to_percent description: 'Possible values: by_fix, by_percent, to_fix, to_percent.' goals: type: array items: type: string description: Array[string]. Either specifies goal value or is empty. target_goals: type: array items: type: string description: Array[string]. Either specifies target goal value or is empty. affiliate_type: type: string enum: - all - each - exact default: each description: 'Possible values: all, each, exact. Default: each.' affiliates: type: array items: type: integer description: Array[integer]. Either specifies affiliate ID or is empty filed. modifier_payment_type: type: string enum: - payout - total - payout_and_total default: payout description: 'Possible values: payout, total, payout_and_total. Default: payout.' countries: type: array items: type: string description: Array[string]. Countries ISO codes conversion_status: type: array items: type: string enum: - confirmed - pending - declined - hold description: 'Array[string]. Possible values: confirmed, pending, declined, hold.' offer: type: object properties: id: type: integer offer_id: type: string advertiser: type: string external_offer_id: type: string bundle_id: type: string hide_payments: type: boolean title: type: string macro_url: type: string url: type: string cross_postback_url: type: string cross_postback_method: type: string cross_postback_body: type: string url_preview: type: string preview_url: type: string domain_url: type: string parallel_tracking_url: type: string trafficback_url: type: string use_https: type: boolean use_http: type: boolean description_lang: type: object additionalProperties: type: string sources: type: array items: type: object properties: id: type: string title: type: string allowed: type: integer logo: type: string logo_source: type: string status: type: string enum: - active - stopped - suspended privacy: type: string enum: - public - private - premoderated is_top: type: integer payments: type: array items: $ref: '#/components/schemas/offer_payment_structure' partner_payments: type: array items: allOf: - $ref: '#/components/schemas/offer_payment_structure' - type: object properties: partners: type: array items: type: integer landings: type: array items: $ref: '#/components/schemas/offer_landing_structure' strictly_country: type: integer strictly_os: type: array items: type: string nullable: true strictly_brands: type: array items: type: string strictly_connection_type: type: string nullable: true restriction_isp: type: array items: type: object nullable: true is_redirect_overcap: type: boolean is_impression_overcap: type: boolean notice_percent_overcap: type: integer hold_period: type: integer hold_type: type: string categories: type: array items: type: string full_categories: type: array items: type: object properties: id: type: string title: type: string cr: type: number epc: type: number affiliate_epc: type: number notes: type: string allowed_ip: type: string disallowed_ip: type: string hash_password: type: string allow_deeplink: type: boolean hide_referer: type: boolean start_at: type: string format: date-time stop_at: type: string format: date-time nullable: true auto_offer_connect: type: integer required_approval: type: boolean is_cpi: type: boolean creatives: type: array items: type: object creatives_zip: type: string nullable: true created_at: type: string format: date-time sub_accounts: type: object properties: '1': type: object properties: value: type: string except: type: boolean '2': type: object properties: value: type: string except: type: boolean disabled_by: type: string kpi: type: object additionalProperties: type: string strictly_isp: type: array items: type: string caps: type: array items: $ref: '#/components/schemas/offer_caps_structure' updated_at: type: string format: date-time caps_goal_overcap: type: string targeting: type: array items: $ref: '#/components/schemas/targeting_group_structure' commission_tiers: type: array items: $ref: '#/components/schemas/offer_tier_structure' enabled_commission_tiers: type: boolean consider_personal_targeting_only: type: boolean hosts_only: type: boolean allow_impressions: type: boolean impressions_url: type: string smartlink_categories: type: array items: type: string uniq_ip_only: type: boolean reject_not_uniq_ip: type: integer countries: type: array items: type: string description: Offer countries tags: type: array items: type: string duplicate_clicks_threshold: type: integer sign_clicks_integration: type: string description: Sign clicks integration setting allow_duplicate_conversions: type: boolean enable_impression_sub3_uniqueness: type: boolean 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 description: Sign clicks integration setting allow_duplicate_conversions: type: boolean enable_impression_sub3_uniqueness: type: boolean offer_creative_html_structure: type: object description: HTML creative item structure properties: name: type: string description: Creative name width: type: integer description: Creative width height: type: integer description: Creative height code: type: string description: Creative html code with macroses asset_mapping: type: object description: 'How to map macros and asset. For example: {"aaa":0}. Macros {aaa} match to 0 asset' additionalProperties: type: integer offer_schedule_structure: type: object description: Offer schedule structure properties: enabled: type: integer enum: - 0 - 1 description: Enable/Disable offer schedule. date_start: type: string format: date description: Date of launch, YYYY-MM-DD. Offer activation does not depend on `enabled` field. date_to: type: string format: date description: Date of deactivation, YYYY-MM-DD timezone: type: string description: 'Timezone. Example: Europe/London' intervals: type: array description: 'Array of schedule intervals. Example: [weekday_number(0-6)][interval_number(0,1,2,...)][from]=hour(0-23)' items: type: array items: type: object properties: From: type: integer description: Start hour (0-23) minimum: 0 maximum: 23 To: type: integer description: End hour (0-23) minimum: 0 maximum: 23 payment: type: object properties: id: type: integer pid: type: integer manager_id: type: string nullable: true posted_date: type: string format: date-time pay_sys: type: integer pay_sys_name: type: string pay_acc: type: string status: type: string revenue: type: string ref_revenue: type: string nullable: true currency: type: string currency_code: type: string comment: type: string notes: type: string cpa_actions: type: array items: type: string ref_ids: type: array items: type: string details: type: object properties: details: type: object additionalProperties: true count: type: integer additional_payments: type: array items: {} updated_at: type: string format: date-time pixel: type: object properties: id: type: integer name: type: string code: type: string code_type: type: string offer_id: type: string pid: type: string is_active: type: string moderation_status: type: string created_at: type: string format: date-time updated_at: type: string format: date-time x-tagGroups: - name: Admin API tags: - admin-advertisers - admin-affiliates - admin-offers - admin-stats - admin-conversions - admin-users - admin-presets - admin-payments - admin-billing - admin-smartlinks - admin-tickets - admin-automation - admin-adcosts - admin-other - name: Advertiser API tags: - advertiser-auth - advertiser-offers - advertiser-stats - name: Affiliate API tags: - affiliate-profile - affiliate-offers - affiliate-stats - affiliate-postbacks - affiliate-conversions - affiliate-pixels - affiliate-smartlinks - affiliate-news - affiliate-other - name: Resources tags: - resources