Capping API

POST https://api.offer18.com/api/m/offer_capping

Common Parameters

Query	Type	Description
mid	Integer	Network Account ID
api-key	String	Network API Key
secret-key	String	Network Secret Key

Action

Query	Type	Description
action	String	Allowed Values: create / update / delete
offer_id	Integer	Required for all actions

Filter

Query	Type	Description
rule_id	Integer	Id of the Capping Rule
status	String	enable/disable
limit	Integer	Number of Capping Rules per page (max 30 rules)
page	Integer	Page Number

https://api.offer18.com/api/m/offer_capping?mid=000&api-key=000000&secret-key=000000000&action=create

Fields

Query	Type	Description
offer_id	Integer	Offer ID
rule_name	String	Capping Rule Name
rule_type	String	advertiser_capping affiliate_capping
affiliate_id	Integer	Affiliate ID if affiliate capping
timezone	Integer	Capping Timezone
capping_type	String	gross_conversions approved_conversions gross_revenue approved_revenue gross_payout approved_payout gross_clicks approved_clicks
capping_period	String	daily weekly monthly hourly
capping_value	Integer	Capping Value
overcap_action	String	stop fallback fallback_conversion_accept conversion_accept conversion_reject conversion_pending
event	String	Event for event capping
affiliate_visibility	String	show hide
notification_email	String	Email ID for capping notification
notification_earlier_threshold	String	Email ID for capping threshold notification
status	String	Capping Rule Status enable disable
rule_id	Integer	To update and delete the capping rule

Example API Request

API Response

{
    "status": 200,
    "response": "capping_rule_created_successfully",
    "data": {
        "rule_id": 70xxx1
    }
}