API docs by Redocly

24Metrics Adsecurity API Documentation (2.0)

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

The Adsecurity API is organized around REST and uses built-in HTTP features.

offer-dictionary

The Offer Dictionary is a collection of labels that will be used by the reporting system to translate Offer automatically.

List all offer dictionaries

List all offer dictionaries

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
integrationID
required
string

The Integration ID

Responses

Response samples

Content type
application/json
{
  • "data": [
    • {
      • "created_at": "string",
      • "friendly_name": "string",
      • "id": "string",
      • "integration": "string",
      • "last_updated_by": "string",
      • "organization": "string",
      • "source_id": "string",
      • "updated_at": "string"
      }
    ],
  • "meta": {
    • "links": {
      • "next": {
        • "page[number]": 0,
        • "page[size]": 0
        },
      • "prev": {
        • "page[number]": 0,
        • "page[size]": 0
        }
      },
    • "total_count": 0,
    • "total_page": 0
    }
}

Create an offer dictionary

Add an offer dictionary

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
integrationID
required
string

The Integration ID

Request Body schema: application/json

Offer Dictionary

friendly_name
required
string
source_id
required
string

Responses

Request samples

Content type
application/json
{
  • "friendly_name": "string",
  • "source_id": "string"
}

Response samples

Content type
application/json
{
  • "created_item_id": "string"
}

Bulk create offer dictionaries

Bulk create offer dictionaries

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
integrationID
required
string

The Integration ID

Request Body schema: application/json

array of Offer Dictionary

Array of objects (csapi.Dictionary)

Responses

Request samples

Content type
application/json
{
  • "data": [
    • {
      • "friendly_name": "string",
      • "source_id": "string"
      }
    ]
}

Response samples

Content type
application/json
{ }

Bulk delete offer dictionaries

Bulk delete offer dictionaries

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
integrationID
required
string

The Integration ID

Request Body schema: application/json

array of Offer Dictionary IDs

data
Array of strings

Responses

Request samples

Content type
application/json
{
  • "data": [
    • "string"
    ]
}

Response samples

Content type
application/json
{ }

Get an offer dictionary details

Get offer dictionary details

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Offer Dictionary ID

integrationID
required
string

The Integration ID

Responses

Response samples

Content type
application/json
{
  • "data": {
    • "created_at": "string",
    • "friendly_name": "string",
    • "id": "string",
    • "integration": "string",
    • "last_updated_by": "string",
    • "organization": "string",
    • "source_id": "string",
    • "updated_at": "string"
    }
}

Delete an offer dictionary

Delete an offer dictionary

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Offer Dictionary ID

integrationID
required
string

The Integration ID

Responses

Response samples

Content type
application/json
{ }

Update an offer dictionary

Update an offer dictionary

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Offer Dictionary ID

integrationID
required
string

The Integration ID

Request Body schema: application/json

Offer Dictionary

friendly_name
string
source_id
string

Responses

Request samples

Content type
application/json
{
  • "friendly_name": "string",
  • "source_id": "string"
}

Response samples

Content type
application/json
{ }

publisher-dictionary

The Publisher Dictionary is a collection of labels that will be used by the reporting system to translate Publisher automatically.

List all publisher dictionaries

List all publisher dictionaries

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
integrationID
required
string

The Integration ID

Responses

Response samples

Content type
application/json
{
  • "data": [
    • {
      • "created_at": "string",
      • "friendly_name": "string",
      • "id": "string",
      • "integration": "string",
      • "last_updated_by": "string",
      • "organization": "string",
      • "source_id": "string",
      • "updated_at": "string"
      }
    ],
  • "meta": {
    • "links": {
      • "next": {
        • "page[number]": 0,
        • "page[size]": 0
        },
      • "prev": {
        • "page[number]": 0,
        • "page[size]": 0
        }
      },
    • "total_count": 0,
    • "total_page": 0
    }
}

Create a publisher dictionary

Add a publisher dictionary

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
integrationID
required
string

The Integration ID

Request Body schema: application/json

Publisher Dictionary

friendly_name
required
string
source_id
required
string

Responses

Request samples

Content type
application/json
{
  • "friendly_name": "string",
  • "source_id": "string"
}

Response samples

Content type
application/json
{
  • "created_item_id": "string"
}

Bulk create publisher dictionaries

Bulk create publisher dictionaries

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
integrationID
required
string

The Integration ID

Request Body schema: application/json

array of Publisher Dictionary

Array of objects (csapi.Dictionary)

Responses

Request samples

Content type
application/json
{
  • "data": [
    • {
      • "friendly_name": "string",
      • "source_id": "string"
      }
    ]
}

Response samples

Content type
application/json
{ }

Bulk delete publisher dictionaries

Bulk delete publisher dictionaries

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
integrationID
required
string

The Integration ID

Request Body schema: application/json

array of Publisher Dictionary IDs

data
Array of strings

Responses

Request samples

Content type
application/json
{
  • "data": [
    • "string"
    ]
}

Response samples

Content type
application/json
{ }

Get a publisher dictionary details

Get publisher dictionary details

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Publisher Dictionary ID

integrationID
required
string

The Integration ID

Responses

Response samples

Content type
application/json
{
  • "data": {
    • "created_at": "string",
    • "friendly_name": "string",
    • "id": "string",
    • "integration": "string",
    • "last_updated_by": "string",
    • "organization": "string",
    • "source_id": "string",
    • "updated_at": "string"
    }
}

Delete a publisher dictionary

Delete a publisher dictionary

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Publisher Dictionary ID

integrationID
required
string

The Integration ID

Responses

Response samples

Content type
application/json
{ }

Update a publisher dictionary

Update a publisher dictionary

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
id
required
string

Publisher Dictionary ID

integrationID
required
string

The Integration ID

Request Body schema: application/json

Publisher Dictionary

friendly_name
string
source_id
string

Responses

Request samples

Content type
application/json
{
  • "friendly_name": "string",
  • "source_id": "string"
}

Response samples

Content type
application/json
{ }

blocked-subid

List all BlockedSubIDs

You can list all BlockedSubIDs

Authorizations:
ApiKeyAuthBearerAuth
query Parameters
filter[organization]
string

The organization's ID

filter[publisher_incremental_id][eq_n]
integer

The Publisher's Incremental ID

filter[offer_incremental_id][eq_n]
integer

The Offer's Incremental ID

Responses

Response samples

Content type
application/json
{
  • "data": [
    • {
      • "created_at": "string",
      • "description": "string",
      • "id": "string",
      • "last_updated_by": "string",
      • "offer_id": "string",
      • "offer_incremental_id": 0,
      • "offer_name": "string",
      • "organization": "string",
      • "publisher_id": "string",
      • "publisher_incremental_id": 0,
      • "publisher_name": "string",
      • "sub_id": "string",
      • "updated_at": "string"
      }
    ],
  • "meta": {
    • "links": {
      • "next": {
        • "page[number]": 0,
        • "page[size]": 0
        },
      • "prev": {
        • "page[number]": 0,
        • "page[size]": 0
        }
      },
    • "total_count": 0,
    • "total_page": 0
    }
}

Create a BlockedSubID

You can create an BlockedSubID.

Authorizations:
ApiKeyAuthBearerAuth
Request Body schema: application/json

A JSON object containing BlockedSubID information

description
string <= 255 characters
offer_incremental_id
required
integer
organization
required
string
publisher_incremental_id
required
integer
sub_id
required
string <= 30 characters

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "offer_incremental_id": 0,
  • "organization": "string",
  • "publisher_incremental_id": 0,
  • "sub_id": "string"
}

Response samples

Content type
application/json
{
  • "created_item_id": "string"
}

Delete Many BlockedSubID

A super admin can delete many BlockedSubID

Authorizations:
ApiKeyAuthBearerAuth
Request Body schema: application/json

array of BlockedSubID ids

data
Array of strings

Responses

Request samples

Content type
application/json
{
  • "data": [
    • "string"
    ]
}

Response samples

Content type
application/json
{ }

Read an BlockedSubID

You can read an BlockedSubID.

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
blockedSubID_ID
required
string

The BlockedSubID ID

Responses

Response samples

Content type
application/json
{
  • "data": {
    • "created_at": "string",
    • "description": "string",
    • "id": "string",
    • "last_updated_by": "string",
    • "offer_id": "string",
    • "offer_incremental_id": 0,
    • "offer_name": "string",
    • "organization": "string",
    • "publisher_id": "string",
    • "publisher_incremental_id": 0,
    • "publisher_name": "string",
    • "sub_id": "string",
    • "updated_at": "string"
    }
}

Delete an BlockedSubID

You can delete an BlockedSubID.

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
blockedSubID_ID
required
string

The BlockedSubID ID

Responses

Response samples

Content type
application/json
{ }

Update an BlockedSubID

You can update an BlockedSubID.

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
blockedSubID_ID
required
string

The BlockedSubID ID

Request Body schema: application/json

A JSON object containing BlockedSubID information

description
string

Responses

Request samples

Content type
application/json
{
  • "description": "string"
}

Response samples

Content type
application/json
{ }

filter-labels

Get all the filters labels.

Get the human-friendly readable filter names according to the filter type.

query Parameters
fields
string

Return specific JSON fields

Responses

Response samples

Content type
application/json
{
  • "data": {
    • "clicks": {
      • "property1": [
        • {
          • "label": "Bot",
          • "value": "BOT"
          }
        ],
      • "property2": [
        • {
          • "label": "Bot",
          • "value": "BOT"
          }
        ]
      },
    • "common": {
      • "property1": [
        • {
          • "label": "Bot",
          • "value": "BOT"
          }
        ],
      • "property2": [
        • {
          • "label": "Bot",
          • "value": "BOT"
          }
        ]
      },
    • "conversions": {
      • "property1": [
        • {
          • "label": "Bot",
          • "value": "BOT"
          }
        ],
      • "property2": [
        • {
          • "label": "Bot",
          • "value": "BOT"
          }
        ]
      },
    • "impression": {
      • "property1": [
        • {
          • "label": "Bot",
          • "value": "BOT"
          }
        ],
      • "property2": [
        • {
          • "label": "Bot",
          • "value": "BOT"
          }
        ]
      }
    }
}

integration

List all integrations

You can list all integrations within an organization.

Authorizations:
ApiKeyAuthBearerAuth

Responses

Response samples

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,
        • "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
        },
      • "id": "string",
      • "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[number]": 0,
        • "page[size]": 0
        },
      • "prev": {
        • "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)
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

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,
    • "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
    },
  • "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

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

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,
      • "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
      },
    • "id": "string",
    • "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

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)
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

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,
    • "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
    },
  • "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

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

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",
      • "offer_ids": [
        • "string"
        ],
      • "organization": "string",
      • "priority": 0,
      • "publisher_ids": [
        • "string"
        ],
      • "rtb_enabled": true,
      • "updated_at": "string"
      }
    ],
  • "meta": {
    • "links": {
      • "next": {
        • "page[number]": 0,
        • "page[size]": 0
        },
      • "prev": {
        • "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.

Responses

Request samples

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
}

Response samples

Content type
application/json
{
  • "created_item_id": "string"
}

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

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",
    • "offer_ids": [
      • "string"
      ],
    • "organization": "string",
    • "priority": 0,
    • "publisher_ids": [
      • "string"
      ],
    • "rtb_enabled": true,
    • "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

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

Responses

Request samples

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
}

Response samples

Content type
application/json
{ }

fraud-filters

List all fraud filter groups

You can list all fraud filter groups within an attribution integration.

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
integrationID
required
string

The Integration ID

Responses

Response samples

Content type
application/json
{
  • "data": [
    • {
      • "active": true,
      • "click_filter_preset_id": 0,
      • "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
        },
      • "conversion_filter_preset_id": 0,
      • "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,
        • "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
        },
      • "created_at": "string",
      • "description": "string",
      • "id": "string",
      • "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
        },
      • "integration": "string",
      • "last_updated_by": "string",
      • "monitoring_mode": true,
      • "name": "string",
      • "organization": "string",
      • "rtb_enabled": true,
      • "updated_at": "string"
      }
    ],
  • "meta": {
    • "links": {
      • "next": {
        • "page[number]": 0,
        • "page[size]": 0
        },
      • "prev": {
        • "page[number]": 0,
        • "page[size]": 0
        }
      },
    • "total_count": 0,
    • "total_page": 0
    }
}

Create a fraud filter group

You can create a fraud filter group within an attribution 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
click_filter_preset_id
integer
object (filters.FraudClickFilterSettings)
conversion_filter_preset_id
integer
object (filters.FraudConversionFilterSettings)
description
string
object (filters.FraudImpressionFilterSettings)
integration
required
string
monitoring_mode
boolean
name
required
string
organization
required
string
rtb_enabled
boolean

Responses

Request samples

Content type
application/json
{
  • "active": true,
  • "click_filter_preset_id": 0,
  • "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
    },
  • "conversion_filter_preset_id": 0,
  • "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,
    • "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
    },
  • "description": "string",
  • "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
    },
  • "integration": "string",
  • "monitoring_mode": true,
  • "name": "string",
  • "organization": "string",
  • "rtb_enabled": true
}

Response samples

Content type
application/json
{
  • "created_item_id": "string"
}

Read a fraud filter group

You can read a fraud filter group within an attribution integration.

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
integrationID
required
string

The Integration ID

fraudFGID
required
string

The Fraud Filter Group ID

Responses

Response samples

Content type
application/json
{
  • "data": {
    • "active": true,
    • "click_filter_preset_id": 0,
    • "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
      },
    • "conversion_filter_preset_id": 0,
    • "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,
      • "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
      },
    • "created_at": "string",
    • "description": "string",
    • "id": "string",
    • "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
      },
    • "integration": "string",
    • "last_updated_by": "string",
    • "monitoring_mode": true,
    • "name": "string",
    • "organization": "string",
    • "rtb_enabled": true,
    • "updated_at": "string"
    }
}

Delete a filter group

You can delete a fraud filter group within an attribution integration.

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
integrationID
required
string

The Integration ID

fraudFGID
required
string

The Fraud Filter Group ID

Responses

Response samples

Content type
application/json
{ }

Update a fraud filter group

You can update a fraud filter group within an attribution integration.

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
integrationID
required
string

The Integration ID

fraudFGID
required
string

The Filter Group ID

Request Body schema: application/json

A JSON object containing filter group information

active
boolean
click_filter_preset_id
integer
object (filters.FraudClickFilterSettingsPayload)
conversion_filter_preset_id
integer
object (filters.FraudConversionFilterSettingsPayload)
description
string
object (filters.FraudImpressionFilterSettingsPayload)
monitoring_mode
boolean
name
string
organization
required
string
rtb_enabled
boolean

Responses

Request samples

Content type
application/json
{
  • "active": true,
  • "click_filter_preset_id": 0,
  • "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
    },
  • "conversion_filter_preset_id": 0,
  • "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,
    • "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
    },
  • "description": "string",
  • "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
    },
  • "monitoring_mode": true,
  • "name": "string",
  • "organization": "string",
  • "rtb_enabled": true
}

Response samples

Content type
application/json
{ }

postback

List all postback request logs.

List all postback request logs within an integration.

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
integrationID
required
string

The Integration ID

query Parameters
start_date
required
string <date>

The start_date is used with end_date. This applies to the process_time field

end_date
required
string <date>

The end_date is used with start_date. This applies to the process_time field

start_time
required
string <date-time>

The start_time is used with end_time. This applies to the process_time field

end_time
required
string <date-time>

The end_time is used with start_time. This applies to the process_time field

filter[service_type]
string
Enum: "conversion" "click"

The service that triggered the postback event

filter[postback_manager_id]
string

The postback manager that triggered the postback event

filter[tx_id]
string

The Clickshield transaction ID of the event that triggered the postback

filter[offer_id]
string

The offer ID

filter[publisher]
string

The offer ID

filter[postback_ip]
string

The Clickshield server IP address where the postback is executed

filter[postback_url][match]
string

Find postback with URL that matches this string

filter[error][match]
string

Find postback that ended with error which contains this message

filter[status_code]
integer

The postback HTTP status code

filter[duration_ms][gte]
integer

Find postback with latency that has greater than or equal this value

filter[duration_ms][lte]
integer

Find postback with latency that has less than or equal this value

columns[]
Array of strings

columns

sort
string

sort

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

Content type
application/json
{
  • "data": [
    • {
      • "body": "string",
      • "create_time": "2019-08-24T14:15:22Z",
      • "duration_ms": 0,
      • "error": "string",
      • "event_id": "string",
      • "headers": {
        • "property1": [
          • "string"
          ],
        • "property2": [
          • "string"
          ]
        },
      • "integration_id": "string",
      • "is_created_by_asp_publisher": true,
      • "is_processed": 0,
      • "method": "string",
      • "offer_id": "string",
      • "organization_id": "string",
      • "postback_after": "2019-08-24T14:15:22Z",
      • "postback_ip": "string",
      • "postback_manager_id": "string",
      • "process_time": "2019-08-24T14:15:22Z",
      • "publisher": "string",
      • "response_body": "string",
      • "service_type": "string",
      • "status_code": 0,
      • "tx_id": "string",
      • "url": "string"
      }
    ],
  • "meta": {
    • "links": {
      • "next": {
        • "page[number]": 0,
        • "page[size]": 0
        },
      • "prev": {
        • "page[number]": 0,
        • "page[size]": 0
        }
      },
    • "total_count": 0,
    • "total_page": 0
    }
}

List all postback managers

List all postback managers within an integration.

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
integrationID
required
string

The Integration ID

Responses

Response samples

Content type
application/json
{
  • "data": [
    • {
      • "active": true,
      • "body": "string",
      • "created_by_publisher": 0,
      • "delay_metric": "Second",
      • "delay_value": 0,
      • "filters": {
        • "event_id": "string",
        • "filter_status": "Any",
        • "offer_id": "string",
        • "publisher_id": "string",
        • "rejection_reasons": [
          • "string"
          ]
        },
      • "headers": {
        • "property1": [
          • "string"
          ],
        • "property2": [
          • "string"
          ]
        },
      • "id": "string",
      • "integration": "string",
      • "method": "GET",
      • "name": "string",
      • "organization": "string",
      • "service_type": "click",
      • "url": "string"
      }
    ],
  • "meta": {
    • "links": {
      • "next": {
        • "page[number]": 0,
        • "page[size]": 0
        },
      • "prev": {
        • "page[number]": 0,
        • "page[size]": 0
        }
      },
    • "total_count": 0,
    • "total_page": 0
    }
}

Create a postback manager

Create a postback manager within an integration.

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
integrationID
required
string

The Integration ID

Request Body schema: application/json

A JSON object containing postback information

active
boolean
body
string
delay_metric
string
Default: "Second"
Enum: "Second" "Minute" "Hour"
delay_value
integer
object (csapi.PostbackManagerFilters)
object
integration
required
string
method
string
Default: "GET"
Enum: "GET" "POST" "PUT" "DELETE" "PATCH"
name
required
string
organization
required
string
service_type
required
string
Enum: "click" "impression" "conversion" "event"
url
required
string

Responses

Request samples

Content type
application/json
{
  • "active": true,
  • "body": "string",
  • "delay_metric": "Second",
  • "delay_value": 0,
  • "filters": {
    • "event_id": "string",
    • "filter_status": "Any",
    • "offer_id": "string",
    • "publisher_id": "string",
    • "rejection_reasons": [
      • "string"
      ]
    },
  • "headers": {
    • "property1": [
      • "string"
      ],
    • "property2": [
      • "string"
      ]
    },
  • "integration": "string",
  • "method": "GET",
  • "name": "string",
  • "organization": "string",
  • "service_type": "click",
  • "url": "string"
}

Response samples

Content type
application/json
{
  • "created_item_id": "string"
}

Read a postback manager

Get the postback manager details within an integration.

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
postbackID
required
string

The PostbackManager ID

integrationID
required
string

The Integration ID

Responses

Response samples

Content type
application/json
{
  • "data": {
    • "active": true,
    • "body": "string",
    • "created_by_publisher": 0,
    • "delay_metric": "Second",
    • "delay_value": 0,
    • "filters": {
      • "event_id": "string",
      • "filter_status": "Any",
      • "offer_id": "string",
      • "publisher_id": "string",
      • "rejection_reasons": [
        • "string"
        ]
      },
    • "headers": {
      • "property1": [
        • "string"
        ],
      • "property2": [
        • "string"
        ]
      },
    • "id": "string",
    • "integration": "string",
    • "method": "GET",
    • "name": "string",
    • "organization": "string",
    • "service_type": "click",
    • "url": "string"
    }
}

Delete a postback manager

Delete a postback manager within an integration.

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
postbackID
required
string

The PostbackManager ID

integrationID
required
string

The Integration ID

Responses

Response samples

Content type
application/json
{ }

Update a postback manager

Update a postback manager within an integration.

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
postbackID
required
string

The PostbackManager ID

integrationID
required
string

The Integration ID

Request Body schema: application/json

A JSON object containing postback information

active
boolean
body
string
delay_metric
string
Enum: "Second" "Minute" "Hour"
delay_value
integer
object (csapi.PostbackManagerFiltersPayload)
object
method
string
Enum: "GET" "POST" "PUT" "DELETE" "PATCH"
name
string
organization
required
string
url
string

Responses

Request samples

Content type
application/json
{
  • "active": true,
  • "body": "string",
  • "delay_metric": "Second",
  • "delay_value": 0,
  • "filters": {
    • "event_id": "string",
    • "filter_status": "Any",
    • "offer_id": "string",
    • "publisher_id": "string",
    • "rejection_reasons": [
      • "string"
      ]
    },
  • "headers": {
    • "property1": [
      • "string"
      ],
    • "property2": [
      • "string"
      ]
    },
  • "method": "GET",
  • "name": "string",
  • "organization": "string",
  • "url": "string"
}

Response samples

Content type
application/json
{ }

targeting-group

List all targeting groups

You can list all targeting groups within an integration.

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
integrationID
required
string

The Integration ID

Responses

Response samples

Content type
application/json
{
  • "data": [
    • {
      • "active": true,
      • "click_targeting_settings": {
        • "device": {
          • "browsers": {
            • "Chrome": true,
            • "Safari": false
            },
          • "device_types": {
            • "Computer": false,
            • "Phone": true
            },
          • "operating_systems": {
            • "Android": false,
            • "iOS": true
            },
          • "os_versions": {
            • "property1": {
              • "is_allowed": true,
              • "max_version": "string",
              • "min_version": "string"
              },
            • "property2": {
              • "is_allowed": true,
              • "max_version": "string",
              • "min_version": "string"
              }
            }
          },
        • "device_targeting_enabled": true,
        • "geo": {
          • "cities": {
            • "property1": true,
            • "property2": true
            },
          • "countries": {
            • "property1": true,
            • "property2": true
            }
          },
        • "geo_targeting_enabled": true,
        • "ip": {
          • "ip_addresses": {
            • "10.0.0.1": true
            },
          • "ip_ranges": {
            • "10.0.0.1-10.0.0.255": true
            }
          },
        • "ip_targeting_enabled": true,
        • "language": {
          • "property1": true,
          • "property2": true
          },
        • "language_targeting_enabled": true
        },
      • "conversion_targeting_settings": {
        • "device": {
          • "browsers": {
            • "Chrome": true,
            • "Safari": false
            },
          • "device_types": {
            • "Computer": false,
            • "Phone": true
            },
          • "operating_systems": {
            • "Android": false,
            • "iOS": true
            },
          • "os_versions": {
            • "property1": {
              • "is_allowed": true,
              • "max_version": "string",
              • "min_version": "string"
              },
            • "property2": {
              • "is_allowed": true,
              • "max_version": "string",
              • "min_version": "string"
              }
            }
          },
        • "device_targeting_enabled": true,
        • "geo": {
          • "cities": {
            • "property1": true,
            • "property2": true
            },
          • "countries": {
            • "property1": true,
            • "property2": true
            }
          },
        • "geo_targeting_enabled": true,
        • "ip": {
          • "ip_addresses": {
            • "10.0.0.1": true
            },
          • "ip_ranges": {
            • "10.0.0.1-10.0.0.255": true
            }
          },
        • "ip_targeting_enabled": true,
        • "language": {
          • "property1": true,
          • "property2": true
          },
        • "language_targeting_enabled": true
        },
      • "created_at": "string",
      • "description": "string",
      • "id": "string",
      • "impression_targeting_settings": {
        • "device": {
          • "browsers": {
            • "Chrome": true,
            • "Safari": false
            },
          • "device_types": {
            • "Computer": false,
            • "Phone": true
            },
          • "operating_systems": {
            • "Android": false,
            • "iOS": true
            },
          • "os_versions": {
            • "property1": {
              • "is_allowed": true,
              • "max_version": "string",
              • "min_version": "string"
              },
            • "property2": {
              • "is_allowed": true,
              • "max_version": "string",
              • "min_version": "string"
              }
            }
          },
        • "device_targeting_enabled": true,
        • "geo": {
          • "cities": {
            • "property1": true,
            • "property2": true
            },
          • "countries": {
            • "property1": true,
            • "property2": true
            }
          },
        • "geo_targeting_enabled": true,
        • "ip": {
          • "ip_addresses": {
            • "10.0.0.1": true
            },
          • "ip_ranges": {
            • "10.0.0.1-10.0.0.255": true
            }
          },
        • "ip_targeting_enabled": true,
        • "language": {
          • "property1": true,
          • "property2": true
          },
        • "language_targeting_enabled": true
        },
      • "integration": "string",
      • "last_updated_by": "string",
      • "name": "string",
      • "organization": "string",
      • "related_offers": [
        • {
          • "id": "string",
          • "name": "string"
          }
        ],
      • "updated_at": "string"
      }
    ],
  • "meta": {
    • "links": {
      • "next": {
        • "page[number]": 0,
        • "page[size]": 0
        },
      • "prev": {
        • "page[number]": 0,
        • "page[size]": 0
        }
      },
    • "total_count": 0,
    • "total_page": 0
    }
}

Create a targeting group

You can create a targeting group within an integration.

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
integrationID
required
string

The Integration ID

Request Body schema: application/json

A JSON object containing targeting group information

active
boolean
object (csapi.TargetingSettings)
object (csapi.TargetingSettings)
description
string
object (csapi.TargetingSettings)
integration
required
string
name
required
string
organization
required
string

Responses

Request samples

Content type
application/json
{
  • "active": true,
  • "click_targeting_settings": {
    • "device": {
      • "browsers": {
        • "Chrome": true,
        • "Safari": false
        },
      • "device_types": {
        • "Computer": false,
        • "Phone": true
        },
      • "operating_systems": {
        • "Android": false,
        • "iOS": true
        },
      • "os_versions": {
        • "property1": {
          • "is_allowed": true,
          • "max_version": "string",
          • "min_version": "string"
          },
        • "property2": {
          • "is_allowed": true,
          • "max_version": "string",
          • "min_version": "string"
          }
        }
      },
    • "device_targeting_enabled": true,
    • "geo": {
      • "cities": {
        • "property1": true,
        • "property2": true
        },
      • "countries": {
        • "property1": true,
        • "property2": true
        }
      },
    • "geo_targeting_enabled": true,
    • "ip": {
      • "ip_addresses": {
        • "10.0.0.1": true
        },
      • "ip_ranges": {
        • "10.0.0.1-10.0.0.255": true
        }
      },
    • "ip_targeting_enabled": true,
    • "language": {
      • "property1": true,
      • "property2": true
      },
    • "language_targeting_enabled": true
    },
  • "conversion_targeting_settings": {
    • "device": {
      • "browsers": {
        • "Chrome": true,
        • "Safari": false
        },
      • "device_types": {
        • "Computer": false,
        • "Phone": true
        },
      • "operating_systems": {
        • "Android": false,
        • "iOS": true
        },
      • "os_versions": {
        • "property1": {
          • "is_allowed": true,
          • "max_version": "string",
          • "min_version": "string"
          },
        • "property2": {
          • "is_allowed": true,
          • "max_version": "string",
          • "min_version": "string"
          }
        }
      },
    • "device_targeting_enabled": true,
    • "geo": {
      • "cities": {
        • "property1": true,
        • "property2": true
        },
      • "countries": {
        • "property1": true,
        • "property2": true
        }
      },
    • "geo_targeting_enabled": true,
    • "ip": {
      • "ip_addresses": {
        • "10.0.0.1": true
        },
      • "ip_ranges": {
        • "10.0.0.1-10.0.0.255": true
        }
      },
    • "ip_targeting_enabled": true,
    • "language": {
      • "property1": true,
      • "property2": true
      },
    • "language_targeting_enabled": true
    },
  • "description": "string",
  • "impression_targeting_settings": {
    • "device": {
      • "browsers": {
        • "Chrome": true,
        • "Safari": false
        },
      • "device_types": {
        • "Computer": false,
        • "Phone": true
        },
      • "operating_systems": {
        • "Android": false,
        • "iOS": true
        },
      • "os_versions": {
        • "property1": {
          • "is_allowed": true,
          • "max_version": "string",
          • "min_version": "string"
          },
        • "property2": {
          • "is_allowed": true,
          • "max_version": "string",
          • "min_version": "string"
          }
        }
      },
    • "device_targeting_enabled": true,
    • "geo": {
      • "cities": {
        • "property1": true,
        • "property2": true
        },
      • "countries": {
        • "property1": true,
        • "property2": true
        }
      },
    • "geo_targeting_enabled": true,
    • "ip": {
      • "ip_addresses": {
        • "10.0.0.1": true
        },
      • "ip_ranges": {
        • "10.0.0.1-10.0.0.255": true
        }
      },
    • "ip_targeting_enabled": true,
    • "language": {
      • "property1": true,
      • "property2": true
      },
    • "language_targeting_enabled": true
    },
  • "integration": "string",
  • "name": "string",
  • "organization": "string"
}

Response samples

Content type
application/json
{
  • "created_item_id": "string"
}

Read a targeting group

You can read a targeting group within an integration.

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
integrationID
required
string

The Integration ID

targetingGroupID
required
string

The Filter Group ID

Responses

Response samples

Content type
application/json
{
  • "data": {
    • "active": true,
    • "click_targeting_settings": {
      • "device": {
        • "browsers": {
          • "Chrome": true,
          • "Safari": false
          },
        • "device_types": {
          • "Computer": false,
          • "Phone": true
          },
        • "operating_systems": {
          • "Android": false,
          • "iOS": true
          },
        • "os_versions": {
          • "property1": {
            • "is_allowed": true,
            • "max_version": "string",
            • "min_version": "string"
            },
          • "property2": {
            • "is_allowed": true,
            • "max_version": "string",
            • "min_version": "string"
            }
          }
        },
      • "device_targeting_enabled": true,
      • "geo": {
        • "cities": {
          • "property1": true,
          • "property2": true
          },
        • "countries": {
          • "property1": true,
          • "property2": true
          }
        },
      • "geo_targeting_enabled": true,
      • "ip": {
        • "ip_addresses": {
          • "10.0.0.1": true
          },
        • "ip_ranges": {
          • "10.0.0.1-10.0.0.255": true
          }
        },
      • "ip_targeting_enabled": true,
      • "language": {
        • "property1": true,
        • "property2": true
        },
      • "language_targeting_enabled": true
      },
    • "conversion_targeting_settings": {
      • "device": {
        • "browsers": {
          • "Chrome": true,
          • "Safari": false
          },
        • "device_types": {
          • "Computer": false,
          • "Phone": true
          },
        • "operating_systems": {
          • "Android": false,
          • "iOS": true
          },
        • "os_versions": {
          • "property1": {
            • "is_allowed": true,
            • "max_version": "string",
            • "min_version": "string"
            },
          • "property2": {
            • "is_allowed": true,
            • "max_version": "string",
            • "min_version": "string"
            }
          }
        },
      • "device_targeting_enabled": true,
      • "geo": {
        • "cities": {
          • "property1": true,
          • "property2": true
          },
        • "countries": {
          • "property1": true,
          • "property2": true
          }
        },
      • "geo_targeting_enabled": true,
      • "ip": {
        • "ip_addresses": {
          • "10.0.0.1": true
          },
        • "ip_ranges": {
          • "10.0.0.1-10.0.0.255": true
          }
        },
      • "ip_targeting_enabled": true,
      • "language": {
        • "property1": true,
        • "property2": true
        },
      • "language_targeting_enabled": true
      },
    • "created_at": "string",
    • "description": "string",
    • "id": "string",
    • "impression_targeting_settings": {
      • "device": {
        • "browsers": {
          • "Chrome": true,
          • "Safari": false
          },
        • "device_types": {
          • "Computer": false,
          • "Phone": true
          },
        • "operating_systems": {
          • "Android": false,
          • "iOS": true
          },
        • "os_versions": {
          • "property1": {
            • "is_allowed": true,
            • "max_version": "string",
            • "min_version": "string"
            },
          • "property2": {
            • "is_allowed": true,
            • "max_version": "string",
            • "min_version": "string"
            }
          }
        },
      • "device_targeting_enabled": true,
      • "geo": {
        • "cities": {
          • "property1": true,
          • "property2": true
          },
        • "countries": {
          • "property1": true,
          • "property2": true
          }
        },
      • "geo_targeting_enabled": true,
      • "ip": {
        • "ip_addresses": {
          • "10.0.0.1": true
          },
        • "ip_ranges": {
          • "10.0.0.1-10.0.0.255": true
          }
        },
      • "ip_targeting_enabled": true,
      • "language": {
        • "property1": true,
        • "property2": true
        },
      • "language_targeting_enabled": true
      },
    • "integration": "string",
    • "last_updated_by": "string",
    • "name": "string",
    • "organization": "string",
    • "related_offers": [
      • {
        • "id": "string",
        • "name": "string"
        }
      ],
    • "updated_at": "string"
    }
}

Delete a targeting group

You can delete a targeting group within an integration.

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
integrationID
required
string

The Integration ID

targetingGroupID
required
string

The Filter Group ID

Responses

Response samples

Content type
application/json
{ }

Update a targeting group

You can update a targeting group within an integration.

Authorizations:
ApiKeyAuthBearerAuth
path Parameters
integrationID
required
string

The Integration ID

targetingGroupID
required
string

The Filter Group ID

Request Body schema: application/json

A JSON object containing targeting group information

active
boolean
object (csapi.TargetingSettingsPayload)
object (csapi.TargetingSettingsPayload)
description
string
object (csapi.TargetingSettingsPayload)
name
string

Responses

Request samples

Content type
application/json
{
  • "active": true,
  • "click_targeting_settings": {
    • "device": {
      • "browsers": {
        • "Chrome": true,
        • "Safari": false
        },
      • "device_types": {
        • "Computer": false,
        • "Phone": true
        },
      • "operating_systems": {
        • "Android": false,
        • "iOS": true
        },
      • "os_versions": {
        • "property1": {
          • "is_allowed": true,
          • "max_version": "string",
          • "min_version": "string"
          },
        • "property2": {
          • "is_allowed": true,
          • "max_version": "string",
          • "min_version": "string"
          }
        }
      },
    • "device_targeting_enabled": true,
    • "geo": {
      • "cities": {
        • "property1": true,
        • "property2": true
        },
      • "countries": {
        • "property1": true,
        • "property2": true
        }
      },
    • "geo_targeting_enabled": true,
    • "ip": {
      • "ip_addresses": {
        • "10.0.0.1": true
        },
      • "ip_ranges": {
        • "10.0.0.1-10.0.0.255": true
        }
      },
    • "ip_targeting_enabled": true,
    • "language": {
      • "property1": true,
      • "property2": true
      },
    • "language_targeting_enabled": true
    },
  • "conversion_targeting_settings": {
    • "device": {
      • "browsers": {
        • "Chrome": true,
        • "Safari": false
        },
      • "device_types": {
        • "Computer": false,
        • "Phone": true
        },
      • "operating_systems": {
        • "Android": false,
        • "iOS": true
        },
      • "os_versions": {
        • "property1": {
          • "is_allowed": true,
          • "max_version": "string",
          • "min_version": "string"
          },
        • "property2": {
          • "is_allowed": true,
          • "max_version": "string",
          • "min_version": "string"
          }
        }
      },
    • "device_targeting_enabled": true,
    • "geo": {
      • "cities": {
        • "property1": true,
        • "property2": true
        },
      • "countries": {
        • "property1": true,
        • "property2": true
        }
      },
    • "geo_targeting_enabled": true,
    • "ip": {
      • "ip_addresses": {
        • "10.0.0.1": true
        },
      • "ip_ranges": {
        • "10.0.0.1-10.0.0.255": true
        }
      },
    • "ip_targeting_enabled": true,
    • "language": {
      • "property1": true,
      • "property2": true
      },
    • "language_targeting_enabled": true
    },
  • "description": "string",
  • "impression_targeting_settings": {
    • "device": {
      • "browsers": {
        • "Chrome": true,
        • "Safari": false
        },
      • "device_types": {
        • "Computer": false,
        • "Phone": true
        },
      • "operating_systems": {
        • "Android": false,
        • "iOS": true
        },
      • "os_versions": {
        • "property1": {
          • "is_allowed": true,
          • "max_version": "string",
          • "min_version": "string"
          },
        • "property2": {
          • "is_allowed": true,
          • "max_version": "string",
          • "min_version": "string"
          }
        }
      },
    • "device_targeting_enabled": true,
    • "geo": {
      • "cities": {
        • "property1": true,
        • "property2": true
        },
      • "countries": {
        • "property1": true,
        • "property2": true
        }
      },
    • "geo_targeting_enabled": true,
    • "ip": {
      • "ip_addresses": {
        • "10.0.0.1": true
        },
      • "ip_ranges": {
        • "10.0.0.1-10.0.0.255": true
        }
      },
    • "ip_targeting_enabled": true,
    • "language": {
      • "property1": true,
      • "property2": true
      },
    • "language_targeting_enabled": true
    },
  • "name": "string"
}

Response samples

Content type
application/json
{ }

report

Fetch data for the Click UI Report

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[size]
required
integer

page size

page[number]
required
integer

page number

Responses

Response samples

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",
        • "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",
        • "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",
        • "targeting_group_id": "string",
        • "tx_id": "string",
        • "user_agent": "string",
        • "user_email": "string",
        • "uuid": "string"
        }
      ]
    }
}

Fetch data for the Conversion UI Report

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[size]
required
integer

page size

page[number]
required
integer

page number

Responses

Response samples

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",
        • "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,
        • "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",
        • "targeting_group_id": "string",
        • "third_party_rejection_reason": "string",
        • "third_party_status": "string",
        • "tx_id": "string",
        • "user_agent": "string",
        • "user_email": "string",
        • "uuid": "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

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

Content type
application/json
{
  • "success": true
}

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[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

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"
          ]
        }
      ]
    }
}