24Metrics Adsecurity API Documentation (2.0)

24metrics Support: support@24metrics.com URL: https://24metrics.com

Getting Started

The Adsecurity API is organized around REST and uses built-in HTTP features. The main host for all requests is https://api.adsecurity.24metrics.com and all requests and responses are formatted in JSON including errors.

Authentication

All requests to the Adsecurity API must be authenticated using an API key. To authenticate, add a API-KEY header to your request that contains your API Key.

For network administrators you can create individual API keys and find your API keys under Organization > API Access in Adsecurity.
For all users you can use your own API key by going to Profile > Security > Enable API Access.

For example:

curl -H "API-KEY: <YOUR-API-KEY>" -H "Content-Type: application/json" --url https://api.adsecurity.24metrics.com/api/v2/publisher-view/654321abcd/offers

Making Requests

All requests require API-KEY and Content-Type in the header. Requests made without authentication will fail.

Request

When submitting data to a resource via POST, or PATCH, you must submit your payload in JSON.

{
"property" : "value"
}

Response

All responses are returned in JSON format as specificed in the Content-Type header. Conventional HTTP response codes are used by the API to indicate the success or failure of an API request. Codes in the 2xx range indicate success whereas codes in the 4xx or 5xx range indicate failure.

JSONAPI Response

You are also able to use jsonapi specification to modify the GET response as follows:

Filter:

To filter the resul you can simply add filter in the url query params: ?filter[type]=this-type&filter[name]=this-name. Plus, you also can do a text search by having ?query=<keyword> in GET methods.

Fields:

To return specific fields you can add fields in the url query params like: fields=id,name

Sorting:

You can sort the result by adding sort query params like sort=-type,name. - will act for descending

Pagination:

To paginate the result you need to provide page query param like page[number]=1&page[size]=8

Response Table

Code	Description
200	A response code for successful HTTP requests
201	The request has been fulfilled resulting in the creation of a new resource
204	The successful response for deleting a resource
400	Bad Request: The request could not be handled correctly, usually because of missing or malformed request
401	Unauthorized: The request could not be accepted, usually because the API Key is missing from the request
403	Forbidden: The request contained valid data and was understood by the server, but the server is refusing action
404	Not Found: The resource could not be found

download-center

Initiate a click export

Authorizations:

ApiKeyAuthBearerAuth

path Parameters

integrationID

required

string

The Integration ID

query Parameters

organization	string The organization's ID
delimiter	string Delimiter to be used in CSV
start_date	string <date> start date
end_date	string <date> end date
fields required	string Fields to include
extra_parameters required	string Extra Parameters to include

Responses

Response samples

200
400

Content type

application/json

{"artifact": {"download_link": "string",
"meta": {"id": "string",
"organization": "string",
"type": "string"
},
"name": "string",
"size": 0
},
"created_at": "string",
"error": "string",
"export_list_options": {"extra_parameters": ["string"
],
"fields": ["string"
],
"filters": {"booleans": {"property1": true,
"property2": true
},
"date_range": {"end": "string",
"start": "string"
},
"date_time_range": {"end": "string",
"start": "string"
},
"field_exists": {"property1": true,
"property2": true
},
"numbers": {"property1": {"property1": {"property1": [0
],
"property2": [0
]
},
"property2": {"property1": [0
],
"property2": [0
]
}
},
"property2": {"property1": {"property1": [0
],
"property2": [0
]
},
"property2": {"property1": [0
],
"property2": [0
]
}
}
},
"regex_query": {"fieldValue": "string",
"searchableFields": ["string"
]
},
"strings": {"property1": {"property1": {"property1": ["string"
],
"property2": ["string"
]
},
"property2": {"property1": ["string"
],
"property2": ["string"
]
}
},
"property2": {"property1": {"property1": ["string"
],
"property2": ["string"
]
},
"property2": {"property1": ["string"
],
"property2": ["string"
]
}
}
},
"text_search": "string",
"timeZone": "string"
}
},
"format": {"delimiter": "string"
},
"id": "string",
"integration": "string",
"last_updated_by": "string",
"organization": "string",
"reports_query_option": {"end_date": "string",
"extra_parameters_as_new_fields": ["string"
],
"filters": {"property1": {"equal_values": ["string"
],
"greater_than_values": [0
],
"less_than_values": [0
],
"like_values": ["string"
],
"not_equal_values": ["string"
]
},
"property2": {"equal_values": ["string"
],
"greater_than_values": [0
],
"less_than_values": [0
],
"like_values": ["string"
],
"not_equal_values": ["string"
]
}
},
"include_fields": ["string"
],
"relative_date": "string",
"sort_by": [{"is_descending": true,
"name": "string"
}
],
"start_date": "string"
},
"requested_by": "string",
"results_meta": {"duration_seconds": 0,
"range_truncated": true,
"total": 0
},
"status": "PENDING",
"type": "string",
"updated_at": "string"
}

Initiate a conversion export

Authorizations:

ApiKeyAuthBearerAuth

path Parameters

integrationID

required

string

The Integration ID

query Parameters

organization	string The organization's ID
delimiter	string Delimiter to be used in CSV
start_date	string <date> start date
end_date	string <date> end date
fields required	string Fields to include
extra_parameters required	string Extra Parameters to include

Responses

Response samples

200
400

Content type

application/json

{"artifact": {"download_link": "string",
"meta": {"id": "string",
"organization": "string",
"type": "string"
},
"name": "string",
"size": 0
},
"created_at": "string",
"error": "string",
"export_list_options": {"extra_parameters": ["string"
],
"fields": ["string"
],
"filters": {"booleans": {"property1": true,
"property2": true
},
"date_range": {"end": "string",
"start": "string"
},
"date_time_range": {"end": "string",
"start": "string"
},
"field_exists": {"property1": true,
"property2": true
},
"numbers": {"property1": {"property1": {"property1": [0
],
"property2": [0
]
},
"property2": {"property1": [0
],
"property2": [0
]
}
},
"property2": {"property1": {"property1": [0
],
"property2": [0
]
},
"property2": {"property1": [0
],
"property2": [0
]
}
}
},
"regex_query": {"fieldValue": "string",
"searchableFields": ["string"
]
},
"strings": {"property1": {"property1": {"property1": ["string"
],
"property2": ["string"
]
},
"property2": {"property1": ["string"
],
"property2": ["string"
]
}
},
"property2": {"property1": {"property1": ["string"
],
"property2": ["string"
]
},
"property2": {"property1": ["string"
],
"property2": ["string"
]
}
}
},
"text_search": "string",
"timeZone": "string"
}
},
"format": {"delimiter": "string"
},
"id": "string",
"integration": "string",
"last_updated_by": "string",
"organization": "string",
"reports_query_option": {"end_date": "string",
"extra_parameters_as_new_fields": ["string"
],
"filters": {"property1": {"equal_values": ["string"
],
"greater_than_values": [0
],
"less_than_values": [0
],
"like_values": ["string"
],
"not_equal_values": ["string"
]
},
"property2": {"equal_values": ["string"
],
"greater_than_values": [0
],
"less_than_values": [0
],
"like_values": ["string"
],
"not_equal_values": ["string"
]
}
},
"include_fields": ["string"
],
"relative_date": "string",
"sort_by": [{"is_descending": true,
"name": "string"
}
],
"start_date": "string"
},
"requested_by": "string",
"results_meta": {"duration_seconds": 0,
"range_truncated": true,
"total": 0
},
"status": "PENDING",
"type": "string",
"updated_at": "string"
}

Initiate a impression export

Authorizations:

ApiKeyAuthBearerAuth

path Parameters

integrationID

required

string

The Integration ID

query Parameters

organization	string The organization's ID
delimiter	string Delimiter to be used in CSV
start_date	string <date> start date
end_date	string <date> end date
fields required	string Fields to include
extra_parameters required	string Extra Parameters to include

Responses

Response samples

200
400

Content type

application/json

{"artifact": {"download_link": "string",
"meta": {"id": "string",
"organization": "string",
"type": "string"
},
"name": "string",
"size": 0
},
"created_at": "string",
"error": "string",
"export_list_options": {"extra_parameters": ["string"
],
"fields": ["string"
],
"filters": {"booleans": {"property1": true,
"property2": true
},
"date_range": {"end": "string",
"start": "string"
},
"date_time_range": {"end": "string",
"start": "string"
},
"field_exists": {"property1": true,
"property2": true
},
"numbers": {"property1": {"property1": {"property1": [0
],
"property2": [0
]
},
"property2": {"property1": [0
],
"property2": [0
]
}
},
"property2": {"property1": {"property1": [0
],
"property2": [0
]
},
"property2": {"property1": [0
],
"property2": [0
]
}
}
},
"regex_query": {"fieldValue": "string",
"searchableFields": ["string"
]
},
"strings": {"property1": {"property1": {"property1": ["string"
],
"property2": ["string"
]
},
"property2": {"property1": ["string"
],
"property2": ["string"
]
}
},
"property2": {"property1": {"property1": ["string"
],
"property2": ["string"
]
},
"property2": {"property1": ["string"
],
"property2": ["string"
]
}
}
},
"text_search": "string",
"timeZone": "string"
}
},
"format": {"delimiter": "string"
},
"id": "string",
"integration": "string",
"last_updated_by": "string",
"organization": "string",
"reports_query_option": {"end_date": "string",
"extra_parameters_as_new_fields": ["string"
],
"filters": {"property1": {"equal_values": ["string"
],
"greater_than_values": [0
],
"less_than_values": [0
],
"like_values": ["string"
],
"not_equal_values": ["string"
]
},
"property2": {"equal_values": ["string"
],
"greater_than_values": [0
],
"less_than_values": [0
],
"like_values": ["string"
],
"not_equal_values": ["string"
]
}
},
"include_fields": ["string"
],
"relative_date": "string",
"sort_by": [{"is_descending": true,
"name": "string"
}
],
"start_date": "string"
},
"requested_by": "string",
"results_meta": {"duration_seconds": 0,
"range_truncated": true,
"total": 0
},
"status": "PENDING",
"type": "string",
"updated_at": "string"
}

integration

List all integrations

You can list all integrations within an organization.

Authorizations:

ApiKeyAuthBearerAuth

Responses

Response samples

200
400

Content type

application/json

{"data": [{"account_api_url": "string",
"account_key": "string",
"active": true,
"click_filter_preset_id": 0,
"click_signing_configs": {"property1": {"api_key": "string",
"offers": ["string"
],
"parameter_macros": {"expires": "string",
"signature": "string"
}
},
"property2": {"api_key": "string",
"offers": ["string"
],
"parameter_macros": {"expires": "string",
"signature": "string"
}
}
},
"click_signing_enabled": true,
"click_signing_offer_mapping": {"property1": "string",
"property2": "string"
},
"click_tracking_url": "string",
"clicks_config": {"block_on_reject": true,
"global_fallback_url": "string",
"global_redirect_url": "string",
"limited_url_parameters": {"advertiser": true,
"device_id": true,
"extra_parameters": true,
"offer": true,
"publisher": true,
"sub_id": true
},
"redirect_cache_expiry_seconds": 0,
"redirect_strategy": "301",
"request_parameters_mapping": {"advertiser": ["string"
],
"device_id": ["string"
],
"keyword": ["string"
],
"offer": ["string"
],
"publisher": ["string"
],
"sub_id": ["string"
],
"sub_id_2": ["string"
],
"sub_id_3": ["string"
],
"sub_id_4": ["string"
],
"sub_id_5": ["string"
],
"sub_id_6": ["string"
]
},
"secure_redirect_url_enabled": true
},
"conversion_filter_preset_id": 0,
"conversion_secure_code": "string",
"conversion_third_party_sync_enabled": true,
"conversion_third_party_sync_mode": "RejectedOnly",
"conversion_third_party_sync_offer_ids": ["string"
],
"conversion_tracking_url": "string",
"conversions_config": {"request_parameters_mapping": {"advertiser": ["string"
],
"app_id": ["string"
],
"app_version": ["string"
],
"begin_install_time": ["string"
],
"click_ip": ["string"
],
"click_time": ["string"
],
"click_transaction_id": ["string"
],
"device_id": ["string"
],
"finish_install_time": ["string"
],
"offer": ["string"
],
"publisher": ["string"
],
"sub_id": ["string"
],
"sub_id_2": ["string"
],
"sub_id_3": ["string"
],
"sub_id_4": ["string"
],
"sub_id_5": ["string"
],
"sub_id_6": ["string"
],
"third_party_rejected_reason": ["string"
]
}
},
"created_at": "string",
"currency": "string",
"currency_symbol": "string",
"custom_domain": {"activate_js_checks": true,
"click_path": "/",
"conversion_path": "/conversions",
"host": "string"
},
"custom_domain_status": {"acmecname_record": "string",
"acmecname_record_verified": true,
"cname_record_verified": true,
"current_acmecname_record_value": "string",
"current_cname_record_value": "string",
"regional_readiness_status": {"property1": true,
"property2": true
},
"required_acmecname_record_value": "string",
"required_cname_record_value": "string",
"ssl_ready": true,
"txt_record": "string",
"txt_record_verified": true,
"updates_for_custom_domain_host": "string",
"user_errors": ["string"
]
},
"custom_integration_type": "Default",
"data_sync_config": {"enabled": true
},
"data_sync_status": {"conversion_status": {"end_date": "string",
"last_completion_duration_seconds": 0,
"last_error": "string",
"last_exported_data_count": 0,
"last_imported_data_count": 0,
"last_sync_time": "string",
"start_date": "string"
}
},
"default_conversion_filters": [{"block_on_reject": true,
"invert": true,
"settings": null,
"target": "click",
"type": "BOT"
}
],
"default_filters": [{"block_on_reject": true,
"invert": true,
"settings": null,
"target": "click",
"type": "BOT"
}
],
"default_impression_filters": [{"block_on_reject": true,
"invert": true,
"settings": null,
"target": "click",
"type": "BOT"
}
],
"default_revenue_payout": {"click_payout": 0,
"click_revenue": 0,
"conversion_payout": 0,
"conversion_revenue": 0
},
"duplicate_external_tx_id_cache_expiry_seconds": 0,
"duplicate_external_tx_id_enabled": true,
"excluded_sources": {"advertisers": ["string"
],
"countries": ["string"
],
"everflow_encoded_offers": ["string"
],
"everflow_encoded_publishers": ["string"
],
"offers": ["string"
],
"publishers": ["string"
]
},
"external_offer_ids": ["string"
],
"fraud_click_filter_settings": {"bot": {"premium_ip_check_enabled": true,
"reject_empty_browser_language": true
},
"bot_enabled": true,
"click_flooding": {"expires_in_seconds": 1,
"extra_expires_in_seconds_when_rejected": 1,
"max_duplicate_ip": 1,
"properties": {"has_offer": true,
"has_publisher": true,
"has_sub_id": true,
"has_user_agent": true
}
},
"click_flooding_enabled": true,
"conversion_rejection_threshold": {"by_sub_id": true,
"lookback_hours": 0,
"minimum_total": 1,
"threshold": 100
},
"conversion_rejection_threshold_enabled": true,
"device_id": {"reject_empty_value": true
},
"device_id_enabled": true,
"duplicate_user": [{"enable_duplicate_device_id": true,
"enable_duplicate_fingerprint": true,
"enable_duplicate_ip": true,
"enable_duplicate_ipv6": true,
"enable_duplicate_uuid": true,
"expires_in_seconds": 1,
"has_offer": true,
"has_publisher": true,
"has_sub_id": true,
"has_user_agent": true,
"max_duplicates": 1
}
],
"duplicate_user_enabled": true,
"high_conversion_rate": {"block_clicks": true,
"check_by_sub_id": true,
"lookback_times": {"property1": {"enabled": true,
"max_conversion_rate": 100,
"min_click_count": 1,
"min_conversion_count": 1,
"min_conversion_rate": 100
},
"property2": {"enabled": true,
"max_conversion_rate": 100,
"min_click_count": 1,
"min_conversion_count": 1,
"min_conversion_rate": 100
}
}
},
"high_conversion_rate_enabled": true,
"isp": {"invert": true,
"keywords": ["string"
]
},
"isp_enabled": true,
"keyword": {"expires_in_seconds": 1,
"keywords": ["string"
],
"max_duplicate_allowed": 1,
"properties": {"has_offer": true,
"has_publisher": true,
"has_sub_id": true
}
},
"keyword_enabled": true,
"low_conversion_rate": {"block_clicks": true,
"check_by_sub_id": true,
"lookback_times": {"property1": {"enabled": true,
"max_conversion_rate": 100,
"min_click_count": 1,
"min_conversion_count": 1,
"min_conversion_rate": 100
},
"property2": {"enabled": true,
"max_conversion_rate": 100,
"min_click_count": 1,
"min_conversion_count": 1,
"min_conversion_rate": 100
}
}
},
"low_conversion_rate_enabled": true,
"old_browser": {"browsers": {"property1": "string",
"property2": "string"
},
"check_by_sub_id": true,
"invert": true,
"lookback_hours": 0,
"minimum_request_count": 0,
"threshold_percentage": 100
},
"old_browser_enabled": true,
"old_os": {"check_by_sub_id": true,
"invert": true,
"lookback_hours": 0,
"minimum_request_count": 0,
"oses": {"property1": "string",
"property2": "string"
},
"threshold_percentage": 100
},
"old_os_enabled": true,
"parameter": {"configs": {"property1": {"blocked_values": ["string"
],
"reject_empty_value": true,
"valid_values": ["string"
]
},
"property2": {"blocked_values": ["string"
],
"reject_empty_value": true,
"valid_values": ["string"
]
}
}
},
"parameter_enabled": true,
"referer": {"categories": ["oneof=fraud"
],
"invert": true,
"keywords": ["string"
],
"reject_empty_value": true
},
"referer_enabled": true,
"sub_id_validity_check": {"is_integer": true,
"max_length": 50,
"max_unique_threshold": 0,
"min_length": 0,
"unified_sub_id": "string"
},
"sub_id_validity_check_enabled": true,
"vpn": {"check_by_sub_id": true,
"lookback_hours": 0,
"minimum_request_count": 0,
"residential_vpn_check": true,
"threshold_percentage": 100
},
"vpn_enabled": true
},
"fraud_conversion_filter_settings": {"bot": {"premium_ip_check_enabled": true,
"reject_empty_browser_language": true
},
"bot_enabled": true,
"click_spam": [{"check_by_sub_id": true,
"lookback_hours": 0,
"max_session_time_seconds": 0,
"minimum_request_count": 0,
"threshold_percentage": 100
}
],
"click_spam_enabled": true,
"device_id": {"reject_empty_value": true
},
"device_id_enabled": true,
"duplicate_user": [{"enable_duplicate_device_id": true,
"enable_duplicate_fingerprint": true,
"enable_duplicate_ip": true,
"enable_duplicate_ipv6": true,
"enable_duplicate_uuid": true,
"expires_in_seconds": 1,
"has_offer": true,
"has_publisher": true,
"has_sub_id": true,
"has_user_agent": true,
"max_duplicates": 1
}
],
"duplicate_user_enabled": true,
"high_conversion_rate": {"block_clicks": true,
"check_by_sub_id": true,
"lookback_times": {"property1": {"enabled": true,
"max_conversion_rate": 100,
"min_click_count": 1,
"min_conversion_count": 1,
"min_conversion_rate": 100
},
"property2": {"enabled": true,
"max_conversion_rate": 100,
"min_click_count": 1,
"min_conversion_count": 1,
"min_conversion_rate": 100
}
}
},
"high_conversion_rate_enabled": true,
"low_conversion_rate": {"block_clicks": true,
"check_by_sub_id": true,
"lookback_times": {"property1": {"enabled": true,
"max_conversion_rate": 100,
"min_click_count": 1,
"min_conversion_count": 1,
"min_conversion_rate": 100
},
"property2": {"enabled": true,
"max_conversion_rate": 100,
"min_click_count": 1,
"min_conversion_count": 1,
"min_conversion_rate": 100
}
}
},
"low_conversion_rate_enabled": true,
"low_session_time_anomaly": [{"check_by_sub_id": true,
"lookback_hours": 0,
"min_session_time_seconds": 0,
"minimum_request_count": 0,
"threshold_percentage": 100
}
],
"low_session_time_anomaly_enabled": true,
"maximum_session_time": {"max_session_time_seconds": 0
},
"maximum_session_time_enabled": true,
"minimum_session_time": {"min_session_time_seconds": 0
},
"minimum_session_time_enabled": true,
"old_browser": {"browsers": {"property1": "string",
"property2": "string"
},
"check_by_sub_id": true,
"invert": true,
"lookback_hours": 0,
"minimum_request_count": 0,
"threshold_percentage": 100
},
"old_browser_enabled": true,
"old_os": {"check_by_sub_id": true,
"invert": true,
"lookback_hours": 0,
"minimum_request_count": 0,
"oses": {"property1": "string",
"property2": "string"
},
"threshold_percentage": 100
},
"old_os_enabled": true,
"parameter": {"configs": {"property1": {"blocked_values": ["string"
],
"reject_empty_value": true,
"valid_values": ["string"
]
},
"property2": {"blocked_values": ["string"
],
"reject_empty_value": true,
"valid_values": ["string"
]
}
}
},
"parameter_enabled": true,
"referer": {"categories": ["oneof=fraud"
],
"invert": true,
"keywords": ["string"
],
"reject_empty_value": true
},
"referer_enabled": true,
"smart_screen_ai": {"prompt": "string"
},
"smart_screen_ai_enabled": true,
"sub_id_validity_check": {"is_integer": true,
"max_length": 50,
"max_unique_threshold": 0,
"min_length": 0,
"unified_sub_id": "string"
},
"sub_id_validity_check_enabled": true,
"third_party_rejection": {"rejected_keywords": ["string"
]
},
"third_party_rejection_enabled": true,
"vpn": {"check_by_sub_id": true,
"lookback_hours": 0,
"minimum_request_count": 0,
"residential_vpn_check": true,
"threshold_percentage": 100
},
"vpn_enabled": true,
"wrong_install_time": {"time_delta_tolerance_seconds": 999
},
"wrong_install_time_enabled": true
},
"fraud_impression_filter_settings": {"bot": {"premium_ip_check_enabled": true,
"reject_empty_browser_language": true
},
"bot_enabled": true,
"device_id": {"reject_empty_value": true
},
"device_id_enabled": true,
"impression_flooding": {"expires_in_seconds": 1,
"extra_expires_in_seconds_when_rejected": 1,
"max_duplicate_ip": 1,
"properties": {"has_offer": true,
"has_publisher": true,
"has_sub_id": true,
"has_user_agent": true
}
},
"impression_flooding_enabled": true,
"isp": {"invert": true,
"keywords": ["string"
]
},
"isp_enabled": true,
"keyword": {"expires_in_seconds": 1,
"keywords": ["string"
],
"max_duplicate_allowed": 1,
"properties": {"has_offer": true,
"has_publisher": true,
"has_sub_id": true
}
},
"keyword_enabled": true,
"old_browser": {"browsers": {"property1": "string",
"property2": "string"
},
"check_by_sub_id": true,
"invert": true,
"lookback_hours": 0,
"minimum_request_count": 0,
"threshold_percentage": 100
},
"old_browser_enabled": true,
"old_os": {"check_by_sub_id": true,
"invert": true,
"lookback_hours": 0,
"minimum_request_count": 0,
"oses": {"property1": "string",
"property2": "string"
},
"threshold_percentage": 100
},
"old_os_enabled": true,
"parameter": {"configs": {"property1": {"blocked_values": ["string"
],
"reject_empty_value": true,
"valid_values": ["string"
]
},
"property2": {"blocked_values": ["string"
],
"reject_empty_value": true,
"valid_values": ["string"
]
}
}
},
"parameter_enabled": true,
"site_url": {"categories": ["oneof=fraud"
],
"invert": true,
"keywords": ["string"
],
"reject_empty_value": true
},
"site_url_enabled": true,
"sub_id_validity_check": {"is_integer": true,
"max_length": 50,
"max_unique_threshold": 0,
"min_length": 0,
"unified_sub_id": "string"
},
"sub_id_validity_check_enabled": true,
"user_frequency": [{"enable_duplicate_device_id": true,
"enable_duplicate_fingerprint": true,
"enable_duplicate_ip": true,
"enable_duplicate_ipv6": true,
"enable_duplicate_uuid": true,
"expires_in_seconds": 1,
"has_offer": true,
"has_publisher": true,
"has_sub_id": true,
"has_user_agent": true,
"max_duplicates": 1
}
],
"user_frequency_enabled": true,
"vpn": {"check_by_sub_id": true,
"lookback_hours": 0,
"minimum_request_count": 0,
"residential_vpn_check": true,
"threshold_percentage": 100
},
"vpn_enabled": true
},
"google_ads_customer_id": "string",
"google_ads_link_completed": true,
"id": "string",
"ip_privacy_enabled": true,
"is_partnership": true,
"last_updated_by": "string",
"max_attribution_lookup_days": 0,
"monitoring_mode": true,
"name": "string",
"offer_preview_enabled": true,
"organization": "string",
"organization_name": "string",
"original_tracking_domain": "string",
"original_tracking_domain_resolved_addresses": ["string"
],
"original_tracking_domain_verification_status": "string",
"primary_domain": "string",
"requested_for_deletion": true,
"requested_for_deletion_by": "string",
"rtb_enabled": true,
"type": "Custom",
"ui_macros": {"clicks": {"advertiser": "{adv}",
"offer": "{campaign}"
},
"conversions": {"advertiser": "{adv}",
"offer": "{campaign}"
}
},
"updated_at": "string",
"whitelist_sources": {"advertisers": ["string"
],
"countries": ["string"
],
"everflow_encoded_offers": ["string"
],
"everflow_encoded_publishers": ["string"
],
"offers": ["string"
],
"publishers": ["string"
]
}
}
],
"meta": {"links": {"next": {"page[after]": "string",
"page[before]": "string",
"page[number]": 0,
"page[size]": 0
},
"prev": {"page[after]": "string",
"page[before]": "string",
"page[number]": 0,
"page[size]": 0
}
},
"total_count": 0,
"total_page": 0
}
}

Create an integration

You can create an integration within an organization.

Authorizations:

ApiKeyAuthBearerAuth

Request Body schema: application/json

A JSON object containing integration information

account_api_url	string If the Integration is not Custom or REDIRECT_URL, the value here is going to be the tracking platform's API base url.
account_key	string If the Integration is not Custom or REDIRECT_URL, the value here is going to be the API key to authenticate to the AccountAPIURL.
active required	boolean Active determines if traffic will be ignored for this Integration.
click_filter_preset_id	integer The ID of the IntegrationPreset that is used to set default click filters within the Default Filter Group.
	object (csapi.AppsflyerGatewaySigningConfigs)
click_signing_enabled	boolean
required	object Configurations for click redirect urls.
conversion_filter_preset_id	integer The ID of the IntegrationPreset that is used to set default conversion filters within the Default Filter Group
conversion_secure_code required	string ConversionSecureCode is used to authenticate conversions.
conversion_third_party_sync_enabled	boolean If enabled, a postback will be fired to the third party platform when a conversion is recorded.
conversion_third_party_sync_mode	string Default: "RejectedOnly" Enum: "RejectedOnly" "PendingOnly" "All" The mode of syncing conversions to the third party platform.
conversion_third_party_sync_offer_ids	Array of strings unique If set, only conversion from these offer ids will be synced to the third party platform.
required	object Configurations for conversion redirect urls.
currency	string
	object If this is configured, the Integration will have the ability to use a custom tracking domain.
	object The current status of custom domain setup from ingress operator.
custom_integration_type	string Default: "Default" The type if the Integration is Custom type.
	object Tracking platform data synchronization configurations.
	Array of objects (filters.Filter) DefaultConversionFilters is a list of all conversion filters.
	Array of objects (filters.Filter) DefaultFilters is list of all click filters.
	Array of objects (filters.Filter) DefaultImpressionFilters is a list of all impression filters.
required	object The revenue and payout settings for clicks.
duplicate_external_tx_id_cache_expiry_seconds	integer If duplicate_external_tx_id_enabled is true, this is the cache expiry time in seconds.
duplicate_external_tx_id_enabled	boolean If this is true, the gateway service will not save conversions with duplicate external transaction id.
	object (csapi.TrackingSources)
	object This will be the default fraud filters, which will be used for all the offers under attribution integration.
	object (filters.FraudConversionFilterSettings)
	object (filters.FraudImpressionFilterSettings)
google_ads_customer_id	string If Integration type is Custom/GoogleAds, this is required.
ip_privacy_enabled	boolean If this is enabled, the last two dots of the IP record in Reports will be censored
is_partnership	boolean IsPartnership determines if the integration is created using partnership APIs.
max_attribution_lookup_days	integer
monitoring_mode required	boolean MonitoringMode determines if rejected click will not be sent to the fallback url.
name required	string The Integration Name.
offer_preview_enabled required	boolean If this is true and the click is rejected, it will redirect the user to the preview url of the offer. This means that `clicks_config.global_fallback_url` will not be used.
organization required	string Organization is where this Integration is related to.
original_tracking_domain	string If the Integration is not Custom or REDIRECT_URL, the value here is going to be the specific tracking platform's tracking domain.
original_tracking_domain_resolved_addresses	Array of strings nolint: lll
original_tracking_domain_verification_status	string Properties that are updated by the Ingress Operator.
primary_domain	string
requested_for_deletion	boolean
requested_for_deletion_by	string
rtb_enabled	boolean RTBEnabled enables RTB monetization feature for rejected clicks.
type required	string Enum: "Custom" "HasOffer" "Everflow" "EverflowAPI" "Affise" "Trackier" "REDIRECT_URL" "Appsflyer" "Adjust" "AppMetrica" The Integration Type.
	object (csapi.UIMacros)
	object (csapi.TrackingSources)

Responses

Request samples

Payload

Content type

application/json

{"account_api_url": "string",
"account_key": "string",
"active": true,
"click_filter_preset_id": 0,
"click_signing_configs": {"property1": {"api_key": "string",
"offers": ["string"
],
"parameter_macros": {"expires": "string",
"signature": "string"
}
},
"property2": {"api_key": "string",
"offers": ["string"
],
"parameter_macros": {"expires": "string",
"signature": "string"
}
}
},
"click_signing_enabled": true,
"clicks_config": {"block_on_reject": true,
"global_fallback_url": "string",
"global_redirect_url": "string",
"limited_url_parameters": {"advertiser": true,
"device_id": true,
"extra_parameters": true,
"offer": true,
"publisher": true,
"sub_id": true
},
"redirect_cache_expiry_seconds": 0,
"redirect_strategy": "301",
"request_parameters_mapping": {"advertiser": ["string"
],
"device_id": ["string"
],
"keyword": ["string"
],
"offer": ["string"
],
"publisher": ["string"
],
"sub_id": ["string"
],
"sub_id_2": ["string"
],
"sub_id_3": ["string"
],
"sub_id_4": ["string"
],
"sub_id_5": ["string"
],
"sub_id_6": ["string"
]
},
"secure_redirect_url_enabled": true
},
"conversion_filter_preset_id": 0,
"conversion_secure_code": "string",
"conversion_third_party_sync_enabled": true,
"conversion_third_party_sync_mode": "RejectedOnly",
"conversion_third_party_sync_offer_ids": ["string"
],
"conversions_config": {"request_parameters_mapping": {"advertiser": ["string"
],
"app_id": ["string"
],
"app_version": ["string"
],
"begin_install_time": ["string"
],
"click_ip": ["string"
],
"click_time": ["string"
],
"click_transaction_id": ["string"
],
"device_id": ["string"
],
"finish_install_time": ["string"
],
"offer": ["string"
],
"publisher": ["string"
],
"sub_id": ["string"
],
"sub_id_2": ["string"
],
"sub_id_3": ["string"
],
"sub_id_4": ["string"
],
"sub_id_5": ["string"
],
"sub_id_6": ["string"
],
"third_party_rejected_reason": ["string"
]
}
},
"currency": "string",
"custom_domain": {"activate_js_checks": true,
"click_path": "/",
"conversion_path": "/conversions",
"host": "string"
},
"custom_domain_status": {"acmecname_record": "string",
"acmecname_record_verified": true,
"cname_record_verified": true,
"current_acmecname_record_value": "string",
"current_cname_record_value": "string",
"regional_readiness_status": {"property1": true,
"property2": true
},
"required_acmecname_record_value": "string",
"required_cname_record_value": "string",
"ssl_ready": true,
"txt_record": "string",
"txt_record_verified": true,
"updates_for_custom_domain_host": "string",
"user_errors": ["string"
]
},
"custom_integration_type": "Default",
"data_sync_config": {"enabled": true
},
"default_conversion_filters": [{"block_on_reject": true,
"invert": true,
"settings": null,
"target": "click",
"type": "BOT"
}
],
"default_filters": [{"block_on_reject": true,
"invert": true,
"settings": null,
"target": "click",
"type": "BOT"
}
],
"default_impression_filters": [{"block_on_reject": true,
"invert": true,
"settings": null,
"target": "click",
"type": "BOT"
}
],
"default_revenue_payout": {"click_payout": 0,
"click_revenue": 0,
"conversion_payout": 0,
"conversion_revenue": 0
},
"duplicate_external_tx_id_cache_expiry_seconds": 0,
"duplicate_external_tx_id_enabled": true,
"excluded_sources": {"advertisers": ["string"
],
"countries": ["string"
],
"offers": ["string"
],
"publishers": ["string"
]
},
"fraud_click_filter_settings": {"bot": {"premium_ip_check_enabled": true,
"reject_empty_browser_language": true
},
"bot_enabled": true,
"click_flooding": {"expires_in_seconds": 1,
"extra_expires_in_seconds_when_rejected": 1,
"max_duplicate_ip": 1,
"properties": {"has_offer": true,
"has_publisher": true,
"has_sub_id": true,
"has_user_agent": true
}
},
"click_flooding_enabled": true,
"conversion_rejection_threshold": {"by_sub_id": true,
"lookback_hours": 0,
"minimum_total": 1,
"threshold": 100
},
"conversion_rejection_threshold_enabled": true,
"device_id": {"reject_empty_value": true
},
"device_id_enabled": true,
"duplicate_user": [{"enable_duplicate_device_id": true,
"enable_duplicate_fingerprint": true,
"enable_duplicate_ip": true,
"enable_duplicate_ipv6": true,
"enable_duplicate_uuid": true,
"expires_in_seconds": 1,
"has_offer": true,
"has_publisher": true,
"has_sub_id": true,
"has_user_agent": true,
"max_duplicates": 1
}
],
"duplicate_user_enabled": true,
"isp": {"invert": true,
"keywords": ["string"
]
},
"isp_enabled": true,
"keyword": {"expires_in_seconds": 1,
"keywords": ["string"
],
"max_duplicate_allowed": 1,
"properties": {"has_offer": true,
"has_publisher": true,
"has_sub_id": true
}
},
"keyword_enabled": true,
"old_browser": {"browsers": {"property1": "string",
"property2": "string"
},
"check_by_sub_id": true,
"invert": true,
"lookback_hours": 0,
"minimum_request_count": 0,
"threshold_percentage": 100
},
"old_browser_enabled": true,
"old_os": {"check_by_sub_id": true,
"invert": true,
"lookback_hours": 0,
"minimum_request_count": 0,
"oses": {"property1": "string",
"property2": "string"
},
"threshold_percentage": 100
},
"old_os_enabled": true,
"parameter": {"configs": {"property1": {"blocked_values": ["string"
],
"reject_empty_value": true,
"valid_values": ["string"
]
},
"property2": {"blocked_values": ["string"
],
"reject_empty_value": true,
"valid_values": ["string"
]
}
}
},
"parameter_enabled": true,
"referer": {"categories": ["oneof=fraud"
],
"invert": true,
"keywords": ["string"
],
"reject_empty_value": true
},
"referer_enabled": true,
"sub_id_validity_check": {"is_integer": true,
"max_length": 50,
"max_unique_threshold": 0,
"min_length": 0,
"unified_sub_id": "string"
},
"sub_id_validity_check_enabled": true,
"vpn": {"check_by_sub_id": true,
"lookback_hours": 0,
"minimum_request_count": 0,
"residential_vpn_check": true,
"threshold_percentage": 100
},
"vpn_enabled": true
},
"fraud_conversion_filter_settings": {"bot": {"premium_ip_check_enabled": true,
"reject_empty_browser_language": true
},
"bot_enabled": true,
"click_spam": [{"check_by_sub_id": true,
"lookback_hours": 0,
"max_session_time_seconds": 0,
"minimum_request_count": 0,
"threshold_percentage": 100
}
],
"click_spam_enabled": true,
"device_id": {"reject_empty_value": true
},
"device_id_enabled": true,
"duplicate_user": [{"enable_duplicate_device_id": true,
"enable_duplicate_fingerprint": true,
"enable_duplicate_ip": true,
"enable_duplicate_ipv6": true,
"enable_duplicate_uuid": true,
"expires_in_seconds": 1,
"has_offer": true,
"has_publisher": true,
"has_sub_id": true,
"has_user_agent": true,
"max_duplicates": 1
}
],
"duplicate_user_enabled": true,
"high_conversion_rate": {"block_clicks": true,
"check_by_sub_id": true,
"lookback_times": {"property1": {"enabled": true,
"max_conversion_rate": 100,
"min_click_count": 1,
"min_conversion_count": 1,
"min_conversion_rate": 100
},
"property2": {"enabled": true,
"max_conversion_rate": 100,
"min_click_count": 1,
"min_conversion_count": 1,
"min_conversion_rate": 100
}
}
},
"high_conversion_rate_enabled": true,
"low_conversion_rate": {"block_clicks": true,
"check_by_sub_id": true,
"lookback_times": {"property1": {"enabled": true,
"max_conversion_rate": 100,
"min_click_count": 1,
"min_conversion_count": 1,
"min_conversion_rate": 100
},
"property2": {"enabled": true,
"max_conversion_rate": 100,
"min_click_count": 1,
"min_conversion_count": 1,
"min_conversion_rate": 100
}
}
},
"low_conversion_rate_enabled": true,
"low_session_time_anomaly": [{"check_by_sub_id": true,
"lookback_hours": 0,
"min_session_time_seconds": 0,
"minimum_request_count": 0,
"threshold_percentage": 100
}
],
"low_session_time_anomaly_enabled": true,
"maximum_session_time": {"max_session_time_seconds": 0
},
"maximum_session_time_enabled": true,
"minimum_session_time": {"min_session_time_seconds": 0
},
"minimum_session_time_enabled": true,
"old_browser": {"browsers": {"property1": "string",
"property2": "string"
},
"check_by_sub_id": true,
"invert": true,
"lookback_hours": 0,
"minimum_request_count": 0,
"threshold_percentage": 100
},
"old_browser_enabled": true,
"old_os": {"check_by_sub_id": true,
"invert": true,
"lookback_hours": 0,
"minimum_request_count": 0,
"oses": {"property1": "string",
"property2": "string"
},
"threshold_percentage": 100
},
"old_os_enabled": true,
"parameter": {"configs": {"property1": {"blocked_values": ["string"
],
"reject_empty_value": true,
"valid_values": ["string"
]
},
"property2": {"blocked_values": ["string"
],
"reject_empty_value": true,
"valid_values": ["string"
]
}
}
},
"parameter_enabled": true,
"referer": {"categories": ["oneof=fraud"
],
"invert": true,
"keywords": ["string"
],
"reject_empty_value": true
},
"referer_enabled": true,
"smart_screen_ai": {"prompt": "string"
},
"smart_screen_ai_enabled": true,
"sub_id_validity_check": {"is_integer": true,
"max_length": 50,
"max_unique_threshold": 0,
"min_length": 0,
"unified_sub_id": "string"
},
"sub_id_validity_check_enabled": true,
"third_party_rejection": {"rejected_keywords": ["string"
]
},
"third_party_rejection_enabled": true,
"vpn": {"check_by_sub_id": true,
"lookback_hours": 0,
"minimum_request_count": 0,
"residential_vpn_check": true,
"threshold_percentage": 100
},
"vpn_enabled": true,
"wrong_install_time": {"time_delta_tolerance_seconds": 999
},
"wrong_install_time_enabled": true
},
"fraud_impression_filter_settings": {"bot": {"premium_ip_check_enabled": true,
"reject_empty_browser_language": true
},
"bot_enabled": true,
"device_id": {"reject_empty_value": true
},
"device_id_enabled": true,
"impression_flooding": {"expires_in_seconds": 1,
"extra_expires_in_seconds_when_rejected": 1,
"max_duplicate_ip": 1,
"properties": {"has_offer": true,
"has_publisher": true,
"has_sub_id": true,
"has_user_agent": true
}
},
"impression_flooding_enabled": true,
"isp": {"invert": true,
"keywords": ["string"
]
},
"isp_enabled": true,
"keyword": {"expires_in_seconds": 1,
"keywords": ["string"
],
"max_duplicate_allowed": 1,
"properties": {"has_offer": true,
"has_publisher": true,
"has_sub_id": true
}
},
"keyword_enabled": true,
"old_browser": {"browsers": {"property1": "string",
"property2": "string"
},
"check_by_sub_id": true,
"invert": true,
"lookback_hours": 0,
"minimum_request_count": 0,
"threshold_percentage": 100
},
"old_browser_enabled": true,
"old_os": {"check_by_sub_id": true,
"invert": true,
"lookback_hours": 0,
"minimum_request_count": 0,
"oses": {"property1": "string",
"property2": "string"
},
"threshold_percentage": 100
},
"old_os_enabled": true,
"parameter": {"configs": {"property1": {"blocked_values": ["string"
],
"reject_empty_value": true,
"valid_values": ["string"
]
},
"property2": {"blocked_values": ["string"
],
"reject_empty_value": true,
"valid_values": ["string"
]
}
}
},
"parameter_enabled": true,
"site_url": {"categories": ["oneof=fraud"
],
"invert": true,
"keywords": ["string"
],
"reject_empty_value": true
},
"site_url_enabled": true,
"sub_id_validity_check": {"is_integer": true,
"max_length": 50,
"max_unique_threshold": 0,
"min_length": 0,
"unified_sub_id": "string"
},
"sub_id_validity_check_enabled": true,
"user_frequency": [{"enable_duplicate_device_id": true,
"enable_duplicate_fingerprint": true,
"enable_duplicate_ip": true,
"enable_duplicate_ipv6": true,
"enable_duplicate_uuid": true,
"expires_in_seconds": 1,
"has_offer": true,
"has_publisher": true,
"has_sub_id": true,
"has_user_agent": true,
"max_duplicates": 1
}
],
"user_frequency_enabled": true,
"vpn": {"check_by_sub_id": true,
"lookback_hours": 0,
"minimum_request_count": 0,
"residential_vpn_check": true,
"threshold_percentage": 100
},
"vpn_enabled": true
},
"google_ads_customer_id": "string",
"ip_privacy_enabled": true,
"is_partnership": true,
"max_attribution_lookup_days": 0,
"monitoring_mode": true,
"name": "string",
"offer_preview_enabled": true,
"organization": "string",
"original_tracking_domain": "string",
"original_tracking_domain_resolved_addresses": ["string"
],
"original_tracking_domain_verification_status": "string",
"primary_domain": "string",
"requested_for_deletion": true,
"requested_for_deletion_by": "string",
"rtb_enabled": true,
"type": "Custom",
"ui_macros": {"clicks": {"advertiser": "{adv}",
"offer": "{campaign}"
},
"conversions": {"advertiser": "{adv}",
"offer": "{campaign}"
}
},
"whitelist_sources": {"advertisers": ["string"
],
"countries": ["string"
],
"offers": ["string"
],
"publishers": ["string"
]
}
}

Response samples

201
400

Content type

application/json

{"created_item_id": "string"
}

Read an integration

You can read an integration within an organization.

Authorizations:

ApiKeyAuthBearerAuth

path Parameters

integrationID

required

string

The Integration ID

Responses

Response samples

200
400

Content type

application/json

{"data": {"account_api_url": "string",
"account_key": "string",
"active": true,
"click_filter_preset_id": 0,
"click_signing_configs": {"property1": {"api_key": "string",
"offers": ["string"
],
"parameter_macros": {"expires": "string",
"signature": "string"
}
},
"property2": {"api_key": "string",
"offers": ["string"
],
"parameter_macros": {"expires": "string",
"signature": "string"
}
}
},
"click_signing_enabled": true,
"click_signing_offer_mapping": {"property1": "string",
"property2": "string"
},
"click_tracking_url": "string",
"clicks_config": {"block_on_reject": true,
"global_fallback_url": "string",
"global_redirect_url": "string",
"limited_url_parameters": {"advertiser": true,
"device_id": true,
"extra_parameters": true,
"offer": true,
"publisher": true,
"sub_id": true
},
"redirect_cache_expiry_seconds": 0,
"redirect_strategy": "301",
"request_parameters_mapping": {"advertiser": ["string"
],
"device_id": ["string"
],
"keyword": ["string"
],
"offer": ["string"
],
"publisher": ["string"
],
"sub_id": ["string"
],
"sub_id_2": ["string"
],
"sub_id_3": ["string"
],
"sub_id_4": ["string"
],
"sub_id_5": ["string"
],
"sub_id_6": ["string"
]
},
"secure_redirect_url_enabled": true
},
"conversion_filter_preset_id": 0,
"conversion_secure_code": "string",
"conversion_third_party_sync_enabled": true,
"conversion_third_party_sync_mode": "RejectedOnly",
"conversion_third_party_sync_offer_ids": ["string"
],
"conversion_tracking_url": "string",
"conversions_config": {"request_parameters_mapping": {"advertiser": ["string"
],
"app_id": ["string"
],
"app_version": ["string"
],
"begin_install_time": ["string"
],
"click_ip": ["string"
],
"click_time": ["string"
],
"click_transaction_id": ["string"
],
"device_id": ["string"
],
"finish_install_time": ["string"
],
"offer": ["string"
],
"publisher": ["string"
],
"sub_id": ["string"
],
"sub_id_2": ["string"
],
"sub_id_3": ["string"
],
"sub_id_4": ["string"
],
"sub_id_5": ["string"
],
"sub_id_6": ["string"
],
"third_party_rejected_reason": ["string"
]
}
},
"created_at": "string",
"currency": "string",
"currency_symbol": "string",
"custom_domain": {"activate_js_checks": true,
"click_path": "/",
"conversion_path": "/conversions",
"host": "string"
},
"custom_domain_status": {"acmecname_record": "string",
"acmecname_record_verified": true,
"cname_record_verified": true,
"current_acmecname_record_value": "string",
"current_cname_record_value": "string",
"regional_readiness_status": {"property1": true,
"property2": true
},
"required_acmecname_record_value": "string",
"required_cname_record_value": "string",
"ssl_ready": true,
"txt_record": "string",
"txt_record_verified": true,
"updates_for_custom_domain_host": "string",
"user_errors": ["string"
]
},
"custom_integration_type": "Default",
"data_sync_config": {"enabled": true
},
"data_sync_status": {"conversion_status": {"end_date": "string",
"last_completion_duration_seconds": 0,
"last_error": "string",
"last_exported_data_count": 0,
"last_imported_data_count": 0,
"last_sync_time": "string",
"start_date": "string"
}
},
"default_conversion_filters": [{"block_on_reject": true,
"invert": true,
"settings": null,
"target": "click",
"type": "BOT"
}
],
"default_filters": [{"block_on_reject": true,
"invert": true,
"settings": null,
"target": "click",
"type": "BOT"
}
],
"default_impression_filters": [{"block_on_reject": true,
"invert": true,
"settings": null,
"target": "click",
"type": "BOT"
}
],
"default_revenue_payout": {"click_payout": 0,
"click_revenue": 0,
"conversion_payout": 0,
"conversion_revenue": 0
},
"duplicate_external_tx_id_cache_expiry_seconds": 0,
"duplicate_external_tx_id_enabled": true,
"excluded_sources": {"advertisers": ["string"
],
"countries": ["string"
],
"everflow_encoded_offers": ["string"
],
"everflow_encoded_publishers": ["string"
],
"offers": ["string"
],
"publishers": ["string"
]
},
"external_offer_ids": ["string"
],
"fraud_click_filter_settings": {"bot": {"premium_ip_check_enabled": true,
"reject_empty_browser_language": true
},
"bot_enabled": true,
"click_flooding": {"expires_in_seconds": 1,
"extra_expires_in_seconds_when_rejected": 1,
"max_duplicate_ip": 1,
"properties": {"has_offer": true,
"has_publisher": true,
"has_sub_id": true,
"has_user_agent": true
}
},
"click_flooding_enabled": true,
"conversion_rejection_threshold": {"by_sub_id": true,
"lookback_hours": 0,
"minimum_total": 1,
"threshold": 100
},
"conversion_rejection_threshold_enabled": true,
"device_id": {"reject_empty_value": true
},
"device_id_enabled": true,
"duplicate_user": [{"enable_duplicate_device_id": true,
"enable_duplicate_fingerprint": true,
"enable_duplicate_ip": true,
"enable_duplicate_ipv6": true,
"enable_duplicate_uuid": true,
"expires_in_seconds": 1,
"has_offer": true,
"has_publisher": true,
"has_sub_id": true,
"has_user_agent": true,
"max_duplicates": 1
}
],
"duplicate_user_enabled": true,
"high_conversion_rate": {"block_clicks": true,
"check_by_sub_id": true,
"lookback_times": {"property1": {"enabled": true,
"max_conversion_rate": 100,
"min_click_count": 1,
"min_conversion_count": 1,
"min_conversion_rate": 100
},
"property2": {"enabled": true,
"max_conversion_rate": 100,
"min_click_count": 1,
"min_conversion_count": 1,
"min_conversion_rate": 100
}
}
},
"high_conversion_rate_enabled": true,
"isp": {"invert": true,
"keywords": ["string"
]
},
"isp_enabled": true,
"keyword": {"expires_in_seconds": 1,
"keywords": ["string"
],
"max_duplicate_allowed": 1,
"properties": {"has_offer": true,
"has_publisher": true,
"has_sub_id": true
}
},
"keyword_enabled": true,
"low_conversion_rate": {"block_clicks": true,
"check_by_sub_id": true,
"lookback_times": {"property1": {"enabled": true,
"max_conversion_rate": 100,
"min_click_count": 1,
"min_conversion_count": 1,
"min_conversion_rate": 100
},
"property2": {"enabled": true,
"max_conversion_rate": 100,
"min_click_count": 1,
"min_conversion_count": 1,
"min_conversion_rate": 100
}
}
},
"low_conversion_rate_enabled": true,
"old_browser": {"browsers": {"property1": "string",
"property2": "string"
},
"check_by_sub_id": true,
"invert": true,
"lookback_hours": 0,
"minimum_request_count": 0,
"threshold_percentage": 100
},
"old_browser_enabled": true,
"old_os": {"check_by_sub_id": true,
"invert": true,
"lookback_hours": 0,
"minimum_request_count": 0,
"oses": {"property1": "string",
"property2": "string"
},
"threshold_percentage": 100
},
"old_os_enabled": true,
"parameter": {"configs": {"property1": {"blocked_values": ["string"
],
"reject_empty_value": true,
"valid_values": ["string"
]
},
"property2": {"blocked_values": ["string"
],
"reject_empty_value": true,
"valid_values": ["string"
]
}
}
},
"parameter_enabled": true,
"referer": {"categories": ["oneof=fraud"
],
"invert": true,
"keywords": ["string"
],
"reject_empty_value": true
},
"referer_enabled": true,
"sub_id_validity_check": {"is_integer": true,
"max_length": 50,
"max_unique_threshold": 0,
"min_length": 0,
"unified_sub_id": "string"
},
"sub_id_validity_check_enabled": true,
"vpn": {"check_by_sub_id": true,
"lookback_hours": 0,
"minimum_request_count": 0,
"residential_vpn_check": true,
"threshold_percentage": 100
},
"vpn_enabled": true
},
"fraud_conversion_filter_settings": {"bot": {"premium_ip_check_enabled": true,
"reject_empty_browser_language": true
},
"bot_enabled": true,
"click_spam": [{"check_by_sub_id": true,
"lookback_hours": 0,
"max_session_time_seconds": 0,
"minimum_request_count": 0,
"threshold_percentage": 100
}
],
"click_spam_enabled": true,
"device_id": {"reject_empty_value": true
},
"device_id_enabled": true,
"duplicate_user": [{"enable_duplicate_device_id": true,
"enable_duplicate_fingerprint": true,
"enable_duplicate_ip": true,
"enable_duplicate_ipv6": true,
"enable_duplicate_uuid": true,
"expires_in_seconds": 1,
"has_offer": true,
"has_publisher": true,
"has_sub_id": true,
"has_user_agent": true,
"max_duplicates": 1
}
],
"duplicate_user_enabled": true,
"high_conversion_rate": {"block_clicks": true,
"check_by_sub_id": true,
"lookback_times": {"property1": {"enabled": true,
"max_conversion_rate": 100,
"min_click_count": 1,
"min_conversion_count": 1,
"min_conversion_rate": 100
},
"property2": {"enabled": true,
"max_conversion_rate": 100,
"min_click_count": 1,
"min_conversion_count": 1,
"min_conversion_rate": 100
}
}
},
"high_conversion_rate_enabled": true,
"low_conversion_rate": {"block_clicks": true,
"check_by_sub_id": true,
"lookback_times": {"property1": {"enabled": true,
"max_conversion_rate": 100,
"min_click_count": 1,
"min_conversion_count": 1,
"min_conversion_rate": 100
},
"property2": {"enabled": true,
"max_conversion_rate": 100,
"min_click_count": 1,
"min_conversion_count": 1,
"min_conversion_rate": 100
}
}
},
"low_conversion_rate_enabled": true,
"low_session_time_anomaly": [{"check_by_sub_id": true,
"lookback_hours": 0,
"min_session_time_seconds": 0,
"minimum_request_count": 0,
"threshold_percentage": 100
}
],
"low_session_time_anomaly_enabled": true,
"maximum_session_time": {"max_session_time_seconds": 0
},
"maximum_session_time_enabled": true,
"minimum_session_time": {"min_session_time_seconds": 0
},
"minimum_session_time_enabled": true,
"old_browser": {"browsers": {"property1": "string",
"property2": "string"
},
"check_by_sub_id": true,
"invert": true,
"lookback_hours": 0,
"minimum_request_count": 0,
"threshold_percentage": 100
},
"old_browser_enabled": true,
"old_os": {"check_by_sub_id": true,
"invert": true,
"lookback_hours": 0,
"minimum_request_count": 0,
"oses": {"property1": "string",
"property2": "string"
},
"threshold_percentage": 100
},
"old_os_enabled": true,
"parameter": {"configs": {"property1": {"blocked_values": ["string"
],
"reject_empty_value": true,
"valid_values": ["string"
]
},
"property2": {"blocked_values": ["string"
],
"reject_empty_value": true,
"valid_values": ["string"
]
}
}
},
"parameter_enabled": true,
"referer": {"categories": ["oneof=fraud"
],
"invert": true,
"keywords": ["string"
],
"reject_empty_value": true
},
"referer_enabled": true,
"smart_screen_ai": {"prompt": "string"
},
"smart_screen_ai_enabled": true,
"sub_id_validity_check": {"is_integer": true,
"max_length": 50,
"max_unique_threshold": 0,
"min_length": 0,
"unified_sub_id": "string"
},
"sub_id_validity_check_enabled": true,
"third_party_rejection": {"rejected_keywords": ["string"
]
},
"third_party_rejection_enabled": true,
"vpn": {"check_by_sub_id": true,
"lookback_hours": 0,
"minimum_request_count": 0,
"residential_vpn_check": true,
"threshold_percentage": 100
},
"vpn_enabled": true,
"wrong_install_time": {"time_delta_tolerance_seconds": 999
},
"wrong_install_time_enabled": true
},
"fraud_impression_filter_settings": {"bot": {"premium_ip_check_enabled": true,
"reject_empty_browser_language": true
},
"bot_enabled": true,
"device_id": {"reject_empty_value": true
},
"device_id_enabled": true,
"impression_flooding": {"expires_in_seconds": 1,
"extra_expires_in_seconds_when_rejected": 1,
"max_duplicate_ip": 1,
"properties": {"has_offer": true,
"has_publisher": true,
"has_sub_id": true,
"has_user_agent": true
}
},
"impression_flooding_enabled": true,
"isp": {"invert": true,
"keywords": ["string"
]
},
"isp_enabled": true,
"keyword": {"expires_in_seconds": 1,
"keywords": ["string"
],
"max_duplicate_allowed": 1,
"properties": {"has_offer": true,
"has_publisher": true,
"has_sub_id": true
}
},
"keyword_enabled": true,
"old_browser": {"browsers": {"property1": "string",
"property2": "string"
},
"check_by_sub_id": true,
"invert": true,
"lookback_hours": 0,
"minimum_request_count": 0,
"threshold_percentage": 100
},
"old_browser_enabled": true,
"old_os": {"check_by_sub_id": true,
"invert": true,
"lookback_hours": 0,
"minimum_request_count": 0,
"oses": {"property1": "string",
"property2": "string"
},
"threshold_percentage": 100
},
"old_os_enabled": true,
"parameter": {"configs": {"property1": {"blocked_values": ["string"
],
"reject_empty_value": true,
"valid_values": ["string"
]
},
"property2": {"blocked_values": ["string"
],
"reject_empty_value": true,
"valid_values": ["string"
]
}
}
},
"parameter_enabled": true,
"site_url": {"categories": ["oneof=fraud"
],
"invert": true,
"keywords": ["string"
],
"reject_empty_value": true
},
"site_url_enabled": true,
"sub_id_validity_check": {"is_integer": true,
"max_length": 50,
"max_unique_threshold": 0,
"min_length": 0,
"unified_sub_id": "string"
},
"sub_id_validity_check_enabled": true,
"user_frequency": [{"enable_duplicate_device_id": true,
"enable_duplicate_fingerprint": true,
"enable_duplicate_ip": true,
"enable_duplicate_ipv6": true,
"enable_duplicate_uuid": true,
"expires_in_seconds": 1,
"has_offer": true,
"has_publisher": true,
"has_sub_id": true,
"has_user_agent": true,
"max_duplicates": 1
}
],
"user_frequency_enabled": true,
"vpn": {"check_by_sub_id": true,
"lookback_hours": 0,
"minimum_request_count": 0,
"residential_vpn_check": true,
"threshold_percentage": 100
},
"vpn_enabled": true
},
"google_ads_customer_id": "string",
"google_ads_link_completed": true,
"id": "string",
"ip_privacy_enabled": true,
"is_partnership": true,
"last_updated_by": "string",
"max_attribution_lookup_days": 0,
"monitoring_mode": true,
"name": "string",
"offer_preview_enabled": true,
"organization": "string",
"organization_name": "string",
"original_tracking_domain": "string",
"original_tracking_domain_resolved_addresses": ["string"
],
"original_tracking_domain_verification_status": "string",
"primary_domain": "string",
"requested_for_deletion": true,
"requested_for_deletion_by": "string",
"rtb_enabled": true,
"type": "Custom",
"ui_macros": {"clicks": {"advertiser": "{adv}",
"offer": "{campaign}"
},
"conversions": {"advertiser": "{adv}",
"offer": "{campaign}"
}
},
"updated_at": "string",
"whitelist_sources": {"advertisers": ["string"
],
"countries": ["string"
],
"everflow_encoded_offers": ["string"
],
"everflow_encoded_publishers": ["string"
],
"offers": ["string"
],
"publishers": ["string"
]
}
}
}

Delete an integration

You can delete an integration within an organization.

Authorizations:

ApiKeyAuthBearerAuth

path Parameters

integrationID

required

string

The Integration ID

Responses

Response samples

202
400

Content type

application/json

{ }

Update an integration

You can update an integration within an integration.

Authorizations:

ApiKeyAuthBearerAuth

path Parameters

integrationID

required

string

The Integration ID

Request Body schema: application/json

A JSON object containing integration information

account_api_url	string
account_key	string
active	boolean
click_filter_preset_id	integer
	object (csapi.AppsflyerGatewaySigningConfigs)
click_signing_enabled	boolean
	object (csapi.ClicksConfigPayload)
conversion_filter_preset_id	integer
conversion_secure_code	string
conversion_third_party_sync_enabled	boolean
conversion_third_party_sync_mode	string Enum: "RejectedOnly" "PendingOnly" "All"
conversion_third_party_sync_offer_ids	Array of strings
	object (csapi.ConversionsConfigPayload)
currency	string
	object (csapi.CustomDomainPayload)
	object (csapi.DataSyncConfigPayload)
	Array of objects (filters.Filter)
	Array of objects (filters.Filter)
	Array of objects (filters.Filter)
	object (csapi.DefaultRevenuePayoutPayload)
duplicate_external_tx_id_cache_expiry_seconds	integer
duplicate_external_tx_id_enabled	boolean
	object (csapi.TrackingSourcesPayload)
	object (filters.FraudClickFilterSettingsPayload)
	object (filters.FraudConversionFilterSettingsPayload)
	object (filters.FraudImpressionFilterSettingsPayload)
google_ads_customer_id	string
ip_privacy_enabled	boolean
max_attribution_lookup_days	integer
monitoring_mode	boolean
name	string
offer_preview_enabled	boolean
organization required	string
original_tracking_domain	string
primary_domain	string
requested_for_deletion	boolean
requested_for_deletion_by	string
rtb_enabled	boolean
	object (csapi.UIMacrosPayload)
	object (csapi.TrackingSourcesPayload)

Responses

Request samples

Payload

Content type

application/json

{"account_api_url": "string",
"account_key": "string",
"active": true,
"click_filter_preset_id": 0,
"click_signing_configs": {"property1": {"api_key": "string",
"offers": ["string"
],
"parameter_macros": {"expires": "string",
"signature": "string"
}
},
"property2": {"api_key": "string",
"offers": ["string"
],
"parameter_macros": {"expires": "string",
"signature": "string"
}
}
},
"click_signing_enabled": true,
"clicks_config": {"block_on_reject": true,
"global_fallback_url": "string",
"global_redirect_url": "string",
"limited_url_parameters": {"advertiser": true,
"device_id": true,
"extra_parameters": true,
"offer": true,
"publisher": true,
"sub_id": true
},
"redirect_cache_expiry_seconds": 0,
"redirect_strategy": "301",
"request_parameters_mapping": {"advertiser": ["string"
],
"device_id": ["string"
],
"keyword": ["string"
],
"offer": ["string"
],
"publisher": ["string"
],
"sub_id": ["string"
],
"sub_id_2": ["string"
],
"sub_id_3": ["string"
],
"sub_id_4": ["string"
],
"sub_id_5": ["string"
],
"sub_id_6": ["string"
]
},
"secure_redirect_url_enabled": true
},
"conversion_filter_preset_id": 0,
"conversion_secure_code": "string",
"conversion_third_party_sync_enabled": true,
"conversion_third_party_sync_mode": "RejectedOnly",
"conversion_third_party_sync_offer_ids": ["string"
],
"conversions_config": {"request_parameters_mapping": {"advertiser": ["string"
],
"app_id": ["string"
],
"app_version": ["string"
],
"begin_install_time": ["string"
],
"click_ip": ["string"
],
"click_time": ["string"
],
"click_transaction_id": ["string"
],
"device_id": ["string"
],
"finish_install_time": ["string"
],
"offer": ["string"
],
"publisher": ["string"
],
"sub_id": ["string"
],
"sub_id_2": ["string"
],
"sub_id_3": ["string"
],
"sub_id_4": ["string"
],
"sub_id_5": ["string"
],
"sub_id_6": ["string"
],
"third_party_rejected_reason": ["string"
]
}
},
"currency": "string",
"custom_domain": {"activate_js_checks": true,
"click_path": "string",
"conversion_path": "string",
"host": "string"
},
"data_sync_config": {"enabled": true
},
"default_conversion_filters": [{"block_on_reject": true,
"invert": true,
"settings": null,
"target": "click",
"type": "BOT"
}
],
"default_filters": [{"block_on_reject": true,
"invert": true,
"settings": null,
"target": "click",
"type": "BOT"
}
],
"default_impression_filters": [{"block_on_reject": true,
"invert": true,
"settings": null,
"target": "click",
"type": "BOT"
}
],
"default_revenue_payout": {"click_payout": 0,
"click_revenue": 0,
"conversion_payout": 0,
"conversion_revenue": 0
},
"duplicate_external_tx_id_cache_expiry_seconds": 0,
"duplicate_external_tx_id_enabled": true,
"excluded_sources": {"advertisers": ["string"
],
"countries": ["string"
],
"offers": ["string"
],
"publishers": ["string"
]
},
"fraud_click_filter_settings": {"bot": {"premium_ip_check_enabled": true,
"reject_empty_browser_language": true
},
"bot_enabled": true,
"click_flooding": {"expires_in_seconds": 0,
"extra_expires_in_seconds_when_rejected": 0,
"max_duplicate_ip": 0,
"properties": {"has_offer": true,
"has_publisher": true,
"has_sub_id": true,
"has_user_agent": true
}
},
"click_flooding_enabled": true,
"conversion_rejection_threshold": {"by_sub_id": true,
"lookback_hours": 0,
"minimum_total": 0,
"threshold": 0
},
"conversion_rejection_threshold_enabled": true,
"device_id": {"reject_empty_value": true
},
"device_id_enabled": true,
"duplicate_user": [{"enable_duplicate_device_id": true,
"enable_duplicate_fingerprint": true,
"enable_duplicate_ip": true,
"enable_duplicate_ipv6": true,
"enable_duplicate_uuid": true,
"expires_in_seconds": 0,
"has_offer": true,
"has_publisher": true,
"has_sub_id": true,
"has_user_agent": true,
"max_duplicates": 0
}
],
"duplicate_user_enabled": true,
"isp": {"invert": true,
"keywords": ["string"
]
},
"isp_enabled": true,
"keyword": {"expires_in_seconds": 0,
"keywords": ["string"
],
"max_duplicate_allowed": 0,
"properties": {"has_offer": true,
"has_publisher": true,
"has_sub_id": true
}
},
"keyword_enabled": true,
"old_browser": {"browsers": {"property1": "string",
"property2": "string"
},
"check_by_sub_id": true,
"invert": true,
"lookback_hours": 0,
"minimum_request_count": 0,
"threshold_percentage": 0
},
"old_browser_enabled": true,
"old_os": {"check_by_sub_id": true,
"invert": true,
"lookback_hours": 0,
"minimum_request_count": 0,
"oses": {"property1": "string",
"property2": "string"
},
"threshold_percentage": 0
},
"old_os_enabled": true,
"parameter": {"configs": {"property1": {"blocked_values": ["string"
],
"reject_empty_value": true,
"valid_values": ["string"
]
},
"property2": {"blocked_values": ["string"
],
"reject_empty_value": true,
"valid_values": ["string"
]
}
}
},
"parameter_enabled": true,
"referer": {"categories": ["string"
],
"invert": true,
"keywords": ["string"
],
"reject_empty_value": true
},
"referer_enabled": true,
"sub_id_validity_check": {"is_integer": true,
"max_length": 0,
"max_unique_threshold": 0,
"min_length": 0,
"unified_sub_id": "string"
},
"sub_id_validity_check_enabled": true,
"vpn": {"check_by_sub_id": true,
"lookback_hours": 0,
"minimum_request_count": 0,
"residential_vpn_check": true,
"threshold_percentage": 0
},
"vpn_enabled": true
},
"fraud_conversion_filter_settings": {"bot": {"premium_ip_check_enabled": true,
"reject_empty_browser_language": true
},
"bot_enabled": true,
"click_spam": [{"check_by_sub_id": true,
"lookback_hours": 0,
"max_session_time_seconds": 0,
"minimum_request_count": 0,
"threshold_percentage": 0
}
],
"click_spam_enabled": true,
"device_id": {"reject_empty_value": true
},
"device_id_enabled": true,
"duplicate_user": [{"enable_duplicate_device_id": true,
"enable_duplicate_fingerprint": true,
"enable_duplicate_ip": true,
"enable_duplicate_ipv6": true,
"enable_duplicate_uuid": true,
"expires_in_seconds": 0,
"has_offer": true,
"has_publisher": true,
"has_sub_id": true,
"has_user_agent": true,
"max_duplicates": 0
}
],
"duplicate_user_enabled": true,
"high_conversion_rate": {"block_clicks": true,
"check_by_sub_id": true,
"lookback_times": {"property1": {"enabled": true,
"max_conversion_rate": 100,
"min_click_count": 1,
"min_conversion_count": 1,
"min_conversion_rate": 100
},
"property2": {"enabled": true,
"max_conversion_rate": 100,
"min_click_count": 1,
"min_conversion_count": 1,
"min_conversion_rate": 100
}
}
},
"high_conversion_rate_enabled": true,
"low_conversion_rate": {"block_clicks": true,
"check_by_sub_id": true,
"lookback_times": {"property1": {"enabled": true,
"max_conversion_rate": 100,
"min_click_count": 1,
"min_conversion_count": 1,
"min_conversion_rate": 100
},
"property2": {"enabled": true,
"max_conversion_rate": 100,
"min_click_count": 1,
"min_conversion_count": 1,
"min_conversion_rate": 100
}
}
},
"low_conversion_rate_enabled": true,
"low_session_time_anomaly": [{"check_by_sub_id": true,
"lookback_hours": 0,
"min_session_time_seconds": 0,
"minimum_request_count": 0,
"threshold_percentage": 0
}
],
"low_session_time_anomaly_enabled": true,
"maximum_session_time": {"max_session_time_seconds": 0
},
"maximum_session_time_enabled": true,
"minimum_session_time": {"min_session_time_seconds": 0
},
"minimum_session_time_enabled": true,
"old_browser": {"browsers": {"property1": "string",
"property2": "string"
},
"check_by_sub_id": true,
"invert": true,
"lookback_hours": 0,
"minimum_request_count": 0,
"threshold_percentage": 0
},
"old_browser_enabled": true,
"old_os": {"check_by_sub_id": true,
"invert": true,
"lookback_hours": 0,
"minimum_request_count": 0,
"oses": {"property1": "string",
"property2": "string"
},
"threshold_percentage": 0
},
"old_os_enabled": true,
"parameter": {"configs": {"property1": {"blocked_values": ["string"
],
"reject_empty_value": true,
"valid_values": ["string"
]
},
"property2": {"blocked_values": ["string"
],
"reject_empty_value": true,
"valid_values": ["string"
]
}
}
},
"parameter_enabled": true,
"referer": {"categories": ["string"
],
"invert": true,
"keywords": ["string"
],
"reject_empty_value": true
},
"referer_enabled": true,
"smart_screen_ai": {"prompt": "string"
},
"smart_screen_ai_enabled": true,
"sub_id_validity_check": {"is_integer": true,
"max_length": 0,
"max_unique_threshold": 0,
"min_length": 0,
"unified_sub_id": "string"
},
"sub_id_validity_check_enabled": true,
"third_party_rejection": {"rejected_keywords": ["string"
]
},
"third_party_rejection_enabled": true,
"vpn": {"check_by_sub_id": true,
"lookback_hours": 0,
"minimum_request_count": 0,
"residential_vpn_check": true,
"threshold_percentage": 0
},
"vpn_enabled": true,
"wrong_install_time": {"time_delta_tolerance_seconds": 0
},
"wrong_install_time_enabled": true
},
"fraud_impression_filter_settings": {"bot": {"premium_ip_check_enabled": true,
"reject_empty_browser_language": true
},
"bot_enabled": true,
"device_id": {"reject_empty_value": true
},
"device_id_enabled": true,
"duplicate_user": [{"enable_duplicate_device_id": true,
"enable_duplicate_fingerprint": true,
"enable_duplicate_ip": true,
"enable_duplicate_ipv6": true,
"enable_duplicate_uuid": true,
"expires_in_seconds": 0,
"has_offer": true,
"has_publisher": true,
"has_sub_id": true,
"has_user_agent": true,
"max_duplicates": 0
}
],
"duplicate_user_enabled": true,
"impression_flooding": {"expires_in_seconds": 0,
"extra_expires_in_seconds_when_rejected": 0,
"max_duplicate_ip": 0,
"properties": {"has_offer": true,
"has_publisher": true,
"has_sub_id": true,
"has_user_agent": true
}
},
"impression_flooding_enabled": true,
"isp": {"invert": true,
"keywords": ["string"
]
},
"isp_enabled": true,
"keyword": {"expires_in_seconds": 0,
"keywords": ["string"
],
"max_duplicate_allowed": 0,
"properties": {"has_offer": true,
"has_publisher": true,
"has_sub_id": true
}
},
"keyword_enabled": true,
"old_browser": {"browsers": {"property1": "string",
"property2": "string"
},
"check_by_sub_id": true,
"invert": true,
"lookback_hours": 0,
"minimum_request_count": 0,
"threshold_percentage": 0
},
"old_browser_enabled": true,
"old_os": {"check_by_sub_id": true,
"invert": true,
"lookback_hours": 0,
"minimum_request_count": 0,
"oses": {"property1": "string",
"property2": "string"
},
"threshold_percentage": 0
},
"old_os_enabled": true,
"parameter": {"configs": {"property1": {"blocked_values": ["string"
],
"reject_empty_value": true,
"valid_values": ["string"
]
},
"property2": {"blocked_values": ["string"
],
"reject_empty_value": true,
"valid_values": ["string"
]
}
}
},
"parameter_enabled": true,
"site_url": {"categories": ["string"
],
"invert": true,
"keywords": ["string"
],
"reject_empty_value": true
},
"site_url_enabled": true,
"sub_id_validity_check": {"is_integer": true,
"max_length": 0,
"max_unique_threshold": 0,
"min_length": 0,
"unified_sub_id": "string"
},
"sub_id_validity_check_enabled": true,
"vpn": {"check_by_sub_id": true,
"lookback_hours": 0,
"minimum_request_count": 0,
"residential_vpn_check": true,
"threshold_percentage": 0
},
"vpn_enabled": true
},
"google_ads_customer_id": "string",
"ip_privacy_enabled": true,
"max_attribution_lookup_days": 0,
"monitoring_mode": true,
"name": "string",
"offer_preview_enabled": true,
"organization": "string",
"original_tracking_domain": "string",
"primary_domain": "string",
"requested_for_deletion": true,
"requested_for_deletion_by": "string",
"rtb_enabled": true,
"ui_macros": {"clicks": {"property1": "string",
"property2": "string"
},
"conversions": {"property1": "string",
"property2": "string"
}
},
"whitelist_sources": {"advertisers": ["string"
],
"countries": ["string"
],
"offers": ["string"
],
"publishers": ["string"
]
}
}

Response samples

200
400

Content type

application/json

{ }

filter-group

List all filter groups

You can list all filter groups within an integration.

Authorizations:

ApiKeyAuthBearerAuth

path Parameters

integrationID

required

string

The Integration ID

Responses

Response samples

200
400

Content type

application/json

{"data": [{"active": true,
"advertiser_ids": ["string"
],
"click_filter_preset_id": 0,
"conversion_filter_preset_id": 0,
"created_at": "string",
"description": "string",
"everflow_encoded_offers": ["string"
],
"everflow_encoded_publishers": ["string"
],
"filters": [{"block_on_reject": true,
"invert": true,
"settings": null,
"target": "click",
"type": "BOT"
}
],
"id": "string",
"integration": "string",
"last_updated_by": "string",
"monitoring_mode": true,
"name": "string",
"name_with_id": "string",
"offer_ids": ["string"
],
"organization": "string",
"priority": 0,
"publisher_ids": ["string"
],
"rtb_enabled": true,
"tags": ["string"
],
"tags_meta": [{"color": "string",
"created_at": "string",
"id": "string",
"last_updated_by": "string",
"name": "string",
"organization": "string",
"updated_at": "string"
}
],
"updated_at": "string"
}
],
"meta": {"links": {"next": {"page[after]": "string",
"page[before]": "string",
"page[number]": 0,
"page[size]": 0
},
"prev": {"page[after]": "string",
"page[before]": "string",
"page[number]": 0,
"page[size]": 0
}
},
"total_count": 0,
"total_page": 0
}
}

Create a filter group

You can create a filter group within an integration.

Authorizations:

ApiKeyAuthBearerAuth

path Parameters

integrationID

required

string

The Integration ID

Request Body schema: application/json

A JSON object containing filter group information

active	boolean When inactive, this filter group is not going to used.
advertiser_ids	Array of strings unique A list of database ID of Clickshield advertisers that can use this filter group.
click_filter_preset_id	integer The FilterPreset ID which is used to automatically populate the click filters.
conversion_filter_preset_id	integer The FilterPreset ID which is used to automatically populate the conversion filters.
description	string Description of the filter group.
	Array of objects (filters.Filter) The list of Filters to be used by the Gateway.
integration required	string Integration ID parent of this filter group.
monitoring_mode	boolean MonitoringMode at filter group level. This takes precedence over Integration MonitoringMode.
name required	string Friendly name of the filter group.
offer_ids	Array of strings unique A list of Clickshield offers external ID or any offer ID that can use this filter group.
organization required	string Organization parent of this filter group and integration.
priority required	integer Priority used during matching in Gateway. An Integration can have multiple filter groups and if there are multiple equal matches score found by the Gateway, then priority is going to be considered. Priority value is unique from other Filter group instances.
publisher_ids	Array of strings unique A list of database ID of Clickshield publishers that can use this filter group.
rtb_enabled	boolean RTBEnabled at filter group level. This takes precedence over Integration RTBEnabled.
tags	Array of strings <= 50 items A list of tags that is be used to categorize the filter group.

Responses

Request samples

Payload

Content type

application/json

{"active": true,
"advertiser_ids": ["string"
],
"click_filter_preset_id": 0,
"conversion_filter_preset_id": 0,
"description": "string",
"filters": [{"block_on_reject": true,
"invert": true,
"settings": null,
"target": "click",
"type": "BOT"
}
],
"integration": "string",
"monitoring_mode": true,
"name": "string",
"offer_ids": ["string"
],
"organization": "string",
"priority": 0,
"publisher_ids": ["string"
],
"rtb_enabled": true,
"tags": ["string"
]
}

Response samples

201
400

Content type

application/json

{"created_item_id": "string"
}

Bulk delete filter groups

You can bulk delete filter groups.

Authorizations:

ApiKeyAuthBearerAuth

path Parameters

integrationID

required

string

The Integration ID

query Parameters

organization

string

The Organization ID of the filter group.

Request Body schema: application/json

An array of filter group IDs to delete

data	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"data": ["string"
]
}

Response samples

202
400

Content type

application/json

{ }

Bulk update filter groups

You can bulk update the filter groups value.

Authorizations:

ApiKeyAuthBearerAuth

path Parameters

integrationID

required

string

The Integration ID

query Parameters

organization

string

The Organization ID of the filter group.

Request Body schema: application/json

An array of filter group IDs to update

data	Array of strings
monitoring_mode	boolean

Responses

Request samples

Payload

Content type

application/json

{"data": ["string"
],
"monitoring_mode": true
}

Response samples

202
400

Content type

application/json

{ }

Read a filter group

You can read a filter group within an integration.

Authorizations:

ApiKeyAuthBearerAuth

path Parameters

integrationID required	string The Integration ID
filterGroupID required	string The Filter Group ID

Responses

Response samples

200
400

Content type

application/json

{"data": {"active": true,
"advertiser_ids": ["string"
],
"click_filter_preset_id": 0,
"conversion_filter_preset_id": 0,
"created_at": "string",
"description": "string",
"everflow_encoded_offers": ["string"
],
"everflow_encoded_publishers": ["string"
],
"filters": [{"block_on_reject": true,
"invert": true,
"settings": null,
"target": "click",
"type": "BOT"
}
],
"id": "string",
"integration": "string",
"last_updated_by": "string",
"monitoring_mode": true,
"name": "string",
"name_with_id": "string",
"offer_ids": ["string"
],
"organization": "string",
"priority": 0,
"publisher_ids": ["string"
],
"rtb_enabled": true,
"tags": ["string"
],
"tags_meta": [{"color": "string",
"created_at": "string",
"id": "string",
"last_updated_by": "string",
"name": "string",
"organization": "string",
"updated_at": "string"
}
],
"updated_at": "string"
}
}

Delete a filter group

You can delete a filter group within an integration.

Authorizations:

ApiKeyAuthBearerAuth

path Parameters

integrationID required	string The Integration ID
filterGroupID required	string The Filter Group ID

Responses

Response samples

202
400

Content type

application/json

{ }

Update a filter group

You can update a filter group within an integration.

Authorizations:

ApiKeyAuthBearerAuth

path Parameters

integrationID required	string The Integration ID
filterGroupID required	string The Filter Group ID

Request Body schema: application/json

A JSON object containing filter group information

active	boolean
advertiser_ids	Array of strings
click_filter_preset_id	integer
conversion_filter_preset_id	integer
description	string
	Array of objects (filters.Filter)
monitoring_mode	boolean
name	string
offer_ids	Array of strings
organization required	string
priority	integer
publisher_ids	Array of strings
rtb_enabled	boolean
tags	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"active": true,
"advertiser_ids": ["string"
],
"click_filter_preset_id": 0,
"conversion_filter_preset_id": 0,
"description": "string",
"filters": [{"block_on_reject": true,
"invert": true,
"settings": null,
"target": "click",
"type": "BOT"
}
],
"monitoring_mode": true,
"name": "string",
"offer_ids": ["string"
],
"organization": "string",
"priority": 0,
"publisher_ids": ["string"
],
"rtb_enabled": true,
"tags": ["string"
]
}

Response samples

200
400

Content type

application/json

{ }

report

Fetch Click raw data

Only max 100 rows per API call is allowed. Use pagination to get more data. We recommend using the Download Center feature to perform massive data export.

Authorizations:

ApiKeyAuthBearerAuth

query Parameters

organization_id	string organization id
integration_id required	string integration id
start_date required	string <date> start date
end_date required	string <date> end date
sort	string sort
page[number] required	integer page number

Request Body schema: application/json

A JSON object containing filter group information

end_date required	string End date in format "YYYY-MM-DD"
fields	Array of strings Fields to be included in the report
	Array of objects (options.ListOptionsJSONFilter) Example: [ { "field": "isp", "operator": "contains", "value": "foo" }, { "field": "asn", "value": 100 } ]
integration_id required	string integration id
page_number required	integer The number of pages to be returned given the page size.
page_size required	integer Limit the number of objects to be returned.
start_date required	string Start date in format "YYYY-MM-DD"

Responses

Request samples

Payload

Content type

application/json

{"end_date": "string",
"fields": ["string"
],
"filters": [{"field": "string",
"operator": "is",
"value": null
}
],
"integration_id": "string",
"page_number": 0,
"page_size": 0,
"start_date": "string"
}

Response samples

200
400

Content type

application/json

{"data": {"count": 0,
"data": [{"advertiser": "string",
"advertiser_id": "string",
"asn": 0,
"blocked": 0,
"browser_language": ["string"
],
"browser_name": "string",
"browser_timezone": "string",
"browser_version": "string",
"bundle_id": "string",
"city": "string",
"click_ip": "string",
"country": "string",
"coupon_code": "string",
"device_id": "string",
"device_type": "string",
"external_transaction_id": "string",
"extra_params.keys": ["string"
],
"extra_params.values": ["string"
],
"filter_group_id": "string",
"final_offer": "string",
"final_offer_id": "string",
"fingerprint": "string",
"integration_id": "string",
"integration_type": "string",
"invalid_sub_id": "string",
"ip_network": "string",
"is_bot": 0,
"is_old_browser": 0,
"is_old_os": 0,
"isp": "string",
"lat": 0,
"long": 0,
"monitoring_mode": 0,
"offer": "string",
"offer_group_id": "string",
"offer_id": "string",
"organization_id": "string",
"os_name": "string",
"os_version": "string",
"payout": 0,
"postal_code": "string",
"preview_url_enabled": 0,
"proxy_type": "string",
"publisher": "string",
"real_advertiser": "string",
"real_filter_group_id": "string",
"real_offer_id": "string",
"real_publisher": "string",
"real_tx_id": "string",
"referer": "string",
"referer_categories": ["string"
],
"rejected_advanced_reason": "string",
"rejected_language": "string",
"rejected_primary_reason": "string",
"rejected_simple_reason": "string",
"rejections": ["string"
],
"request_date": "2019-08-24",
"request_time": "2019-08-24T14:15:22Z",
"revenue": 0,
"rtb_url_used": 0,
"rtt": 0,
"server_region": "string",
"smart_link_id": "string",
"status": "Approved",
"sub_id": "string",
"sub_id_2": "string",
"sub_id_3": "string",
"sub_id_4": "string",
"sub_id_5": "string",
"sub_id_6": "string",
"tags": ["string"
],
"targeting_group_id": "string",
"tx_id": "string",
"user_agent": "string",
"user_email": "string",
"uuid": "string"
}
],
"pageInfo": {"endCursor": "string",
"hasNextPage": true,
"hasPreviousPage": true,
"startCursor": "string"
}
}
}

Fetch Conversion raw data

Only max 100 rows per API call is allowed. Use pagination to get more data. We recommend using the Download Center feature to perform massive data export.

Authorizations:

ApiKeyAuthBearerAuth

query Parameters

organization_id	string organization id
integration_id required	string integration id
start_date required	string <date> start date
end_date required	string <date> end date
sort	string sort
page[number] required	integer page number

Request Body schema: application/json

A JSON object containing filter group information

end_date required	string End date in format "YYYY-MM-DD"
fields	Array of strings Fields to be included in the report
	Array of objects (options.ListOptionsJSONFilter) Example: [ { "field": "isp", "operator": "contains", "value": "foo" }, { "field": "asn", "value": 100 } ]
integration_id required	string integration id
page_number required	integer The number of pages to be returned given the page size.
page_size required	integer Limit the number of objects to be returned.
start_date required	string Start date in format "YYYY-MM-DD"

Responses

Request samples

Payload

Content type

application/json

{"end_date": "string",
"fields": ["string"
],
"filters": [{"field": "string",
"operator": "is",
"value": null
}
],
"integration_id": "string",
"page_number": 0,
"page_size": 0,
"start_date": "string"
}

Response samples

200
400

Content type

application/json

{"data": {"count": 0,
"data": [{"advertiser": "string",
"advertiser_name": "string",
"app_id": "string",
"app_version": "string",
"asn": 0,
"begin_install_time": "2019-08-24T14:15:22Z",
"browser_language": ["string"
],
"browser_name": "string",
"browser_timezone": "string",
"browser_version": "string",
"city": "string",
"click_ip": "string",
"click_time": "2019-08-24T14:15:22Z",
"click_tx_id": "string",
"conversion_ip": "string",
"conversion_time": "2019-08-24T14:15:22Z",
"country": "string",
"coupon_code": "string",
"device_id": "string",
"device_type": "string",
"event_id": 0,
"event_name": "string",
"event_status": 0,
"external_transaction_id": "string",
"extra_params.keys": ["string"
],
"extra_params.values": ["string"
],
"filter_group_id": "string",
"fingerprint": "string",
"finish_install_time": "2019-08-24T14:15:22Z",
"hash": "string",
"integration_id": "string",
"integration_type": "string",
"invalid_sub_id": "string",
"ip_network": "string",
"is_bot": 0,
"is_click_spam": 0,
"is_low_session_time": 0,
"is_old_browser": 0,
"is_old_os": 0,
"isp": "string",
"lat": 0,
"long": 0,
"network": "string",
"offer": "string",
"offer_group_id": "string",
"offer_id": "string",
"offer_id_name": "string",
"organization_id": "string",
"os_name": "string",
"os_version": "string",
"payout": 0,
"postal_code": "string",
"proxy_type": "string",
"publisher": "string",
"publisher_name": "string",
"purchase_value": 0,
"real_advertiser": "string",
"real_filter_group_id": "string",
"real_offer_id": "string",
"real_publisher": "string",
"real_rejected_advanced_reason": "string",
"real_rejected_simple_reason": "string",
"real_tx_id": "string",
"referer": "string",
"referer_categories": ["string"
],
"rejected": 0,
"rejected_advanced_reason": "string",
"rejected_language": "string",
"rejected_simple_reason": "string",
"rejections": ["string"
],
"request_time": "2019-08-24T14:15:22Z",
"revenue": 0,
"risk": "string",
"rtt": 0,
"score": 0,
"server_ip": "string",
"server_region": "string",
"session_time": 0,
"smart_link_id": "string",
"status": "Approved",
"sub_id": "string",
"sub_id_2": "string",
"sub_id_3": "string",
"sub_id_4": "string",
"sub_id_5": "string",
"sub_id_6": "string",
"tags": ["string"
],
"targeting_group_id": "string",
"third_party_rejection_reason": "string",
"third_party_status": "string",
"tx_id": "string",
"user_agent": "string",
"user_email": "string",
"uuid": "string"
}
],
"pageInfo": {"endCursor": "string",
"hasNextPage": true,
"hasPreviousPage": true,
"startCursor": "string"
}
}
}

Update conversion status

Authorizations:

ApiKeyAuthBearerAuth

Request Body schema: application/json

The update payload

integration_id	string
organization_id	string
	Array of objects (service.ConversionUpdateRequest)

Responses

Request samples

Payload

Content type

application/json

{"integration_id": "string",
"organization_id": "string",
"updates": [{"action": "Approve",
"hash": "string",
"new_rejected_advanced_reason": "string",
"tx_id": "string"
}
]
}

Response samples

200
400

Content type

application/json

{"success": true
}

Fetch Impression raw data

Only max 100 rows per API call is allowed. Use pagination to get more data. We recommend using the Download Center feature to perform massive data export.

Authorizations:

ApiKeyAuthBearerAuth

query Parameters

organization_id	string organization id
integration_id required	string integration id
start_date required	string <date> start date
end_date required	string <date> end date
sort	string sort
page[number] required	integer page number

Request Body schema: application/json

A JSON object containing filter group information

end_date required	string End date in format "YYYY-MM-DD"
fields	Array of strings Fields to be included in the report
	Array of objects (options.ListOptionsJSONFilter) Example: [ { "field": "isp", "operator": "contains", "value": "foo" }, { "field": "asn", "value": 100 } ]
integration_id required	string integration id
page_number required	integer The number of pages to be returned given the page size.
page_size required	integer Limit the number of objects to be returned.
start_date required	string Start date in format "YYYY-MM-DD"

Responses

Request samples

Payload

Content type

application/json

{"end_date": "string",
"fields": ["string"
],
"filters": [{"field": "string",
"operator": "is",
"value": null
}
],
"integration_id": "string",
"page_number": 0,
"page_size": 0,
"start_date": "string"
}

Response samples

200
400

Content type

application/json

{"data": {"count": 0,
"data": [{"advertiser": "string",
"advertiser_id": "string",
"asn": 0,
"blocked": 0,
"browser_language": ["string"
],
"browser_name": "string",
"browser_timezone": "string",
"browser_version": "string",
"bundle_id": "string",
"city": "string",
"click_ip": "string",
"country": "string",
"device_id": "string",
"device_type": "string",
"extra_params.keys": ["string"
],
"extra_params.values": ["string"
],
"filter_group_id": "string",
"fingerprint": "string",
"integration_id": "string",
"integration_type": "string",
"invalid_sub_id": "string",
"ip_network": "string",
"is_bot": 0,
"is_old_browser": 0,
"is_old_os": 0,
"isp": "string",
"lat": 0,
"long": 0,
"monitoring_mode": 0,
"offer_id": "string",
"organization_id": "string",
"os_name": "string",
"os_version": "string",
"payout": 0,
"postal_code": "string",
"proxy_type": "string",
"publisher": "string",
"real_advertiser": "string",
"real_filter_group_id": "string",
"real_offer_id": "string",
"real_publisher": "string",
"real_tx_id": "string",
"referer": "string",
"referer_categories": ["string"
],
"rejected_advanced_reason": "string",
"rejected_language": "string",
"rejected_primary_reason": "string",
"rejected_simple_reason": "string",
"rejections": ["string"
],
"request_date": "2019-08-24",
"request_time": "2019-08-24T14:15:22Z",
"revenue": 0,
"rtt": 0,
"server_region": "string",
"site_url": "string",
"site_url_categories": ["string"
],
"status": "string",
"sub_id": "string",
"sub_id_2": "string",
"sub_id_3": "string",
"sub_id_4": "string",
"sub_id_5": "string",
"sub_id_6": "string",
"tags": ["string"
],
"targeting_group_id": "string",
"tx_id": "string",
"user_agent": "string",
"user_email": "string",
"uuid": "string"
}
],
"pageInfo": {"endCursor": "string",
"hasNextPage": true,
"hasPreviousPage": true,
"startCursor": "string"
}
}
}

Fetch data for overview table

Authorizations:

ApiKeyAuthBearerAuth

query Parameters

integration_id required	string integration id
start_date required	string <date> start date
end_date required	string <date> end date
columns[]	Array of strings columns
sort	string sort
count	boolean count
page[after]	string This is the cursor that points to the end of the page of data that has been returned.
page[before]	string This is the cursor that points to the start of the page of data that has been returned.
page[number]	integer The number of pages to be returned given the page size.
page[size]	integer Limit the number of objects to be returned.

Responses

Response samples

200
400

Content type

application/json

{"data": {"count": 0,
"data": [{"advertiser": "string",
"clicks_risk": 0,
"clicks_total": 0,
"clicks_total_approved": 0,
"clicks_total_rejected": 0,
"conversion_rate": 0,
"conversions_risk": 0,
"conversions_total": 0,
"conversions_total_approved": 0,
"conversions_total_rejected": 0,
"date": "2019-08-24",
"event_rate": 0,
"events_total": 0,
"events_total_approved": 0,
"events_total_rejected": 0,
"impressions_risk": 0,
"impressions_total": 0,
"impressions_total_approved": 0,
"impressions_total_rejected": 0,
"offer": "string",
"offer_id": "string",
"payout": 0,
"publisher": "string",
"rejected_payout": 0,
"rejected_revenue": 0,
"revenue": 0,
"sub_id": "string",
"top_click_per_rejection_total": [0
],
"top_click_rejection": "string",
"top_click_rejections": ["string"
],
"top_conversion_per_rejection_total": [0
],
"top_conversion_rejection": "string",
"top_conversion_rejections": ["string"
],
"top_event_per_rejection_total": [0
],
"top_event_rejection": "string",
"top_event_rejections": ["string"
],
"top_impression_per_rejection_total": [0
],
"top_impression_rejection": "string",
"top_impression_rejections": ["string"
]
}
]
}
}