Custom Caps

Operations for custom caps

Find All

GET /v1/networks/custom/caps

Paging

This endpoint supports paging. Refer to our User Guide for usage.

Filters

This endpoint supports basic filtering. Refer to API filters page for usage.

Value Description
network_offer_id Filter based on the offer id
network_affiliate_id Filter based on the affiliate id
time_created Filter based on the creation time
time_saved Filter based on the last update time

cURL
curl --request GET 'https://api.eflow.team/v1/networks/custom/caps' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'content-type: application/json'
Response
 {
     "custom_cap_settings": [
     {
         "network_custom_cap_setting_id": 0,
         "network_id": 0,
         "network_affiliate_id": 0,
         "network_offer_id": 0,
         "name": "Custum Cap Example",
         "daily_conversion_cap": 0,
         "weekly_conversion_cap": 0,
         "monthly_conversion_cap": 0,
         "global_conversion_cap": 0,
         "daily_payout_cap": 0,
         "weekly_payout_cap": 0,
         "monthly_payout_cap": 0,
         "global_payout_cap": 0,
         "daily_click_cap": 0,
         "weekly_click_cap": 0,
         "monthly_click_cap": 0,
         "global_click_cap": 0,
         "daily_revenue_cap": 0,
         "weekly_revenue_cap": 0,
         "monthly_revenue_cap": 0,
         "global_revenue_cap": 0,
         "time_created": 1493662646,
         "time_saved": 1493662646,
         "relationship":
         {
             "affiliate":
             {
                 "network_affiliate_id": 0,
                 "network_id": 0,
                 "name": "Affiliate Example",
                 "account_status": "inactive",
                 "network_employee_id": 0,
                 "internal_notes": "",
                 "has_notifications": false,
                 "network_traffic_source_id": 0,
                 "account_executive_id": 0,
                 "adress_id": 0,
                 "default_currency_id": "USD",
                 "is_contact_address_enabled": false,
                 "enable_media_cost_tracking_links": true,
                 "time_created": 1493662524,
                 "time_saved": 1495028680,
                 "referrer_id": 0
             },
             "offer":
             {
                 "network_offer_id": 0,
                 "network_id": 0,
                 "network_advertiser_id": 0,
                 "network_offer_group_id": 0,
                 "name": "Offer Example",
                 "offer_status": "paused",
                 "network_tracking_domain_id": 0,
                 "visibility": "public",
                 "currency_id": "USD"
             },
             "currency_id": "USD"
         }
     }],
     "paging":
     {
         "page": 1,
         "page_size": 50,
         "total_count": 54
     }
 }

Find By ID

GET /v1/networks/custom/caps/:settingId

Path Parameters

Parameter Description
settingId The ID of a network custom setting

cURL
curl --request GET 'https://api.eflow.team/v1/networks/custom/caps/<INSERT SETTING ID>' \
--header 'X-Eflow-API-Key: <INSERT API KEY>' \
--header 'content-type: application/json'
Response
 {
     "network_custom_cap_setting_id": 0,
     "network_id": 0,
     "network_affiliate_id": 0,
     "network_offer_id": 0,
     "name": "Custom Cap Example",
     "daily_conversion_cap": 0,
     "weekly_conversion_cap": 0,
     "monthly_conversion_cap": 0,
     "global_conversion_cap": 0,
     "daily_payout_cap": 0,
     "weekly_payout_cap": 0,
     "monthly_payout_cap": 0,
     "global_payout_cap": 0,
     "daily_click_cap": 0,
     "weekly_click_cap": 0,
     "monthly_click_cap": 0,
     "global_click_cap": 0,
     "daily_revenue_cap": 0,
     "weekly_revenue_cap": 0,
     "monthly_revenue_cap": 0,
     "global_revenue_cap": 0,
     "time_created": 1493662524,
     "time_saved": 1493662524,
     "relationship":
     {
         "affiliate":
         {
             "network_affiliate_id": 0,
             "network_id": 0,
             "name": "Affiliate Example",
             "account_status": "inactive",
             "network_employee_id": 0,
             "internal_notes": "",
             "has_notifications": false,
             "network_traffic_source_id": 0,
             "account_executive_id": 0,
             "adress_id": 0,
             "default_currency_id": "USD",
             "is_contact_address_enabled": false,
             "enable_media_cost_tracking_links": true,
             "time_created": 0,
             "time_saved": 1594668150,
             "referrer_id": 1594668150
         },
         "offer":
         {
             "network_offer_id": 0,
             "network_id": 0,
             "network_advertiser_id": 0,
             "network_offer_group_id": 0,
             "name": "Offer Example",
             "offer_status": "paused",
             "network_tracking_domain_id": 0,
             "visibility": "public",
             "currency_id": "USD"
         },
         "currency_id": "USD"
     }
 }

Create

POST /v1/networks/custom/caps

network_affiliate_id int

The affiliate id.

network_offer_id int

The offer id.

name string

The custom cap setting name.

daily_conversion_cap int

The daily conversion cap.

weekly_conversion_cap int

The weekly conversion cap.

monthly_conversion_cap int

The monthly conversion cap.

global_conversion_cap int

The global conversion cap.

daily_payout_cap number

The daily payout cap.

weekly_payout_cap number

The weekly payout cap.

monthly_payout_cap number

The monthly payout cap.

global_payout_cap number

The global payout cap.

daily_click_cap int

The daily click cap.

weekly_click_cap int

The weekly click cap.

monthly_click_cap int

The monthly click cap.

global_click_cap int

The global click cap.

daily_revenue_cap number

The daily revenue cap.

weekly_revenue_cap number

The weekly revenue cap.

monthly_revenue_cap number

The monthly revenue cap.

global_revenue_cap number

The global revenue cap.

{
  "network_affiliate_id": 11,
  "network_offer_id": 234,
  "name": "Custom Cap Example",
  "daily_conversion_cap": 0,
  "weekly_conversion_cap": 0,
  "monthly_conversion_cap": 0,
  "global_conversion_cap": 125,
  "daily_payout_cap": 10.3,
  "weekly_payout_cap": 0,
  "monthly_payout_cap": 0,
  "global_payout_cap": 300.50,
  "daily_click_cap": 0,
  "weekly_click_cap": 0,
  "monthly_click_cap": 250000,
  "global_click_cap": 0,
  "daily_revenue_cap": 0,
  "weekly_revenue_cap": 0,
  "monthly_revenue_cap": 0,
  "global_revenue_cap": 0
}

cURL
curl --request POST \
  --url 'https://api.eflow.team/v1/networks/custom/caps' \
  --header 'x-eflow-api-key: <INSERT API KEY>' \
  --header 'content-type: application/json' \
  --data '<INSERT PAYLOAD>'
Response
{
  "network_custom_cap_setting_id": 4,
  "network_id": 64,
  "network_affiliate_id": 11,
  "network_offer_id": 234,
  "name": "Custom Cap Example",
  "daily_conversion_cap": 0,
  "weekly_conversion_cap": 0,
  "monthly_conversion_cap": 0,
  "global_conversion_cap": 125,
  "daily_payout_cap": 10.3,
  "weekly_payout_cap": 0,
  "monthly_payout_cap": 0,
  "global_payout_cap": 300.50,
  "daily_click_cap": 0,
  "weekly_click_cap": 0,
  "monthly_click_cap": 250000,
  "global_click_cap": 0,
  "daily_revenue_cap": 0,
  "weekly_revenue_cap": 0,
  "monthly_revenue_cap": 0,
  "global_revenue_cap": 0,
  "time_created": 0,
  "time_saved": 0,
  "relationship": {
    "affiliate": {
      "network_affiliate_id": 11,
      "network_id": 64,
      "name": "Affiliate Example",
      "account_status": "active",
      "network_employee_id": 0,
      "internal_notes": "",
      "has_notifications": true,
      "network_traffic_source_id": 0,
      "account_executive_id": 0,
      "adress_id": 0,
      "default_currency_id": "",
      "is_contact_address_enabled": true,
      "enable_media_cost_tracking_links": true,
      "time_created": 0,
      "time_saved": 0,
      "referrer_id": 0
    },
    "offer": {
      "network_offer_id": 234,
      "network_id": 64,
      "network_advertiser_id": 0,
      "network_offer_group_id": 0,
      "name": "Offer Example",
      "offer_status": "active",
      "network_tracking_domain_id": 0,
      "visibility": "public",
      "currency_id": ""
    },
    "currency_id": ""
  }
}

Patch

PATCH /v1/networks/custom/caps

network_custom_cap_setting_ids int array

List of network custom cap setting ids separated by comas.

fields object array

List of fields to update.

field_type string

Allowed values: daily_conversion_cap, weekly_conversion_cap, monthly_conversion_cap, global_conversion_cap, daily_payout_cap, weekly_payout_cap, monthly_payout_cap, global_payout_cap, daily_click_cap, weekly_click_cap, monthly_click_cap, global_click_cap, daily_revenue_cap, weekly_revenue_cap, monthly_revenue_cap, global_revenue_cap

field_value dynamic

WARNING: dynamic value, please see endpoint docs

{
  "network_custom_cap_setting_ids": [
    0
  ],
  "fields": [
    {
      "field_type": "",
      "field_value": ""
    }
  ]
}

cURL
curl --request PATCH \
  --url 'https://api.eflow.team/v1/networks/custom/caps' \
  --header 'x-eflow-api-key: <INSERT API KEY>' \
  --header 'content-type: application/json' \
  --data '<INSERT PAYLOAD>'
Response
{
  "result": true
}