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.

download-center

Initiate a click export

Authorizations:

ApiKeyAuthBearerAuth

path Parameters

integrationID

required

string

The Integration ID

query Parameters

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

Responses

Response samples

Content type

application/json

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

Initiate a conversion export

Authorizations:

ApiKeyAuthBearerAuth

path Parameters

integrationID

required

string

The Integration ID

query Parameters

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

Responses

Response samples

Content type

application/json

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

Initiate a impression export

Authorizations:

ApiKeyAuthBearerAuth

path Parameters

integrationID

required

string

The Integration ID

query Parameters

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

Responses

Response samples

Content type

application/json

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

utilities

List ISP filters

You can list available ISPs for filter group

Authorizations:

ApiKeyAuthBearerAuth

query Parameters

query

string

search keyword

Responses

Response samples

Content type

application/json

{"data": ["string"
]
}

publisher

List all publishers

You can list all publishers

Authorizations:

ApiKeyAuthBearerAuth

Responses

Response samples

Content type

application/json

{"data": [{"active": true,
"address": "string",
"api_access_enabled": true,
"api_key": "string",
"archived": true,
"asp_integration_id": "string",
"avatar_color": "#6F5DE6",
"company_name": "string",
"countries": ["string"
],
"created_at": "string",
"description": "string",
"email": "string",
"first_name": "string",
"id": "string",
"incremental_id": 0,
"last_name": "string",
"last_updated_by": "string",
"login_meta": {"first_login_ip": "string",
"last_login_at": "string",
"last_login_country": "string",
"last_login_ip": "string"
},
"manager_email": "string",
"manager_id": "string",
"manager_name": "string",
"messenger": "string",
"name": "string",
"name_with_id": "string",
"organization": "string",
"pending": true,
"phone": "string",
"promotional_method": ["Content"
],
"publisher_wizard_completed": true,
"report_permissions": {"hide_publisher_name": true,
"hide_rejected_clicks": true,
"hide_rejected_conversions": true,
"hide_rejection_reason": true
},
"signup_meta": {"country": "string",
"ip": "string",
"signup_source": "Adsecurity"
},
"tags": ["string"
],
"tags_meta": [{"color": "string",
"created_at": "string",
"id": "string",
"last_updated_by": "string",
"name": "string",
"organization": "string",
"updated_at": "string"
}
],
"theme": "light",
"timezone": "UTC",
"updated_at": "string",
"website": "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 publisher

You can create an publisher.

Authorizations:

ApiKeyAuthBearerAuth

Request Body schema: application/json

A JSON object containing publisher information

active	boolean
address	string
api_access_enabled	boolean If this is disabled, the API Key is going to be invalid.
api_key	string If APIAccessEnabled is true and this is not empty, this is the API Key that can be used to perform API requests.
archived	boolean
avatar_color	string Default: "#6F5DE6"
company_name	string
countries	Array of strings
description	string <= 255 characters The description of the publisher.
email required	string
first_name	string
last_name	string
messenger	string
name required	string
pending	boolean
phone	string
promotional_method	Array of strings Items Enum: "Content" "DirectDisplay" "Email" "Incent" "Influencers" "MediaBuying" "NativeAds" "OwedOperated" "Partner" "PushMarketing" "SearchMarketing" "SMSMarketing" "SocialMedia" "Surveys" "VideoPromotions"
publisher_wizard_completed	boolean
	object (apicontext.ReportPermissions)
tags	Array of strings <= 50 items
theme	string Default: "light" Enum: "light" "dark" "auto"
timezone	string Default: "UTC"
website	string

Responses

Request samples

Payload

Content type

application/json

{"active": true,
"address": "string",
"api_access_enabled": true,
"api_key": "string",
"archived": true,
"avatar_color": "#6F5DE6",
"company_name": "string",
"countries": ["string"
],
"description": "string",
"email": "string",
"first_name": "string",
"last_name": "string",
"messenger": "string",
"name": "string",
"pending": true,
"phone": "string",
"promotional_method": ["Content"
],
"publisher_wizard_completed": true,
"report_permissions": {"hide_publisher_name": true,
"hide_rejected_clicks": true,
"hide_rejected_conversions": true,
"hide_rejection_reason": true
},
"tags": ["string"
],
"theme": "light",
"timezone": "UTC",
"website": "string"
}

Response samples

Content type

application/json

{"created_item_id": "string"
}

Bulk delete publishers

You can bulk delete publishers.

Authorizations:

ApiKeyAuthBearerAuth

query Parameters

organization

string

The Organization ID of the publisher. Required for super admin.

Request Body schema: application/json

An array of publisher IDs to delete

data	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"data": ["string"
]
}

Response samples

Content type

application/json

{ }

Bulk update publishers status

You can bulk update the publishers status.

Authorizations:

ApiKeyAuthBearerAuth

query Parameters

organization

string

The Organization ID of the publisher. Required for super admin.

Request Body schema: application/json

An array of publisher IDs to update and the new status

active	boolean
data	Array of strings

Responses

Request samples

Payload

Content type

application/json

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

Response samples

Content type

application/json

{ }

Read an publisher

You can read an publisher.

Authorizations:

ApiKeyAuthBearerAuth

path Parameters

publisherID

required

string

The Publisher ID

Responses

Response samples

Content type

application/json

{"data": {"active": true,
"address": "string",
"api_access_enabled": true,
"api_key": "string",
"archived": true,
"asp_integration_id": "string",
"avatar_color": "#6F5DE6",
"company_name": "string",
"countries": ["string"
],
"created_at": "string",
"description": "string",
"email": "string",
"first_name": "string",
"id": "string",
"incremental_id": 0,
"last_name": "string",
"last_updated_by": "string",
"login_meta": {"first_login_ip": "string",
"last_login_at": "string",
"last_login_country": "string",
"last_login_ip": "string"
},
"manager_email": "string",
"manager_id": "string",
"manager_name": "string",
"messenger": "string",
"name": "string",
"name_with_id": "string",
"organization": "string",
"pending": true,
"phone": "string",
"promotional_method": ["Content"
],
"publisher_wizard_completed": true,
"report_permissions": {"hide_publisher_name": true,
"hide_rejected_clicks": true,
"hide_rejected_conversions": true,
"hide_rejection_reason": true
},
"signup_meta": {"country": "string",
"ip": "string",
"signup_source": "Adsecurity"
},
"tags": ["string"
],
"tags_meta": [{"color": "string",
"created_at": "string",
"id": "string",
"last_updated_by": "string",
"name": "string",
"organization": "string",
"updated_at": "string"
}
],
"theme": "light",
"timezone": "UTC",
"updated_at": "string",
"website": "string"
}
}

Delete an publisher

You can delete an publisher.

Authorizations:

ApiKeyAuthBearerAuth

path Parameters

publisherID

required

string

The Publisher ID

Responses

Response samples

Content type

application/json

{ }

Update an publisher

You can update an publisher.

Authorizations:

ApiKeyAuthBearerAuth

path Parameters

publisherID

required

string

The Publisher ID

query Parameters

organization

string

The organization ID of the publisher. Required for super admin.

Request Body schema: application/json

A JSON object containing publisher information

active	boolean
address	string
api_access_enabled	boolean
avatar_color	string
company_name	string
countries	Array of strings
description	string
email	string
first_name	string
last_name	string
manager_id	string
messenger	string
name	string
pending	boolean
phone	string
promotional_method	Array of strings Items Enum: "Content" "DirectDisplay" "Email" "Incent" "Influencers" "MediaBuying" "NativeAds" "OwedOperated" "Partner" "PushMarketing" "SearchMarketing" "SMSMarketing" "SocialMedia" "Surveys" "VideoPromotions"
	object (apicontext.ReportPermissionsPayload)
tags	Array of strings
theme	string
timezone	string
website	string

Responses

Request samples

Payload

Content type

application/json

{"active": true,
"address": "string",
"api_access_enabled": true,
"avatar_color": "string",
"company_name": "string",
"countries": ["string"
],
"description": "string",
"email": "string",
"first_name": "string",
"last_name": "string",
"manager_id": "string",
"messenger": "string",
"name": "string",
"pending": true,
"phone": "string",
"promotional_method": ["Content"
],
"report_permissions": {"hide_publisher_name": true,
"hide_rejected_clicks": true,
"hide_rejected_conversions": true,
"hide_rejection_reason": true
},
"tags": ["string"
],
"theme": "string",
"timezone": "string",
"website": "string"
}

Response samples

Content type

application/json

{ }

report

Fetch Click raw data

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

Authorizations:

ApiKeyAuthBearerAuth

query Parameters

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

Request Body schema: application/json

A JSON object containing filter group information

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

Responses

Request samples

Payload

Content type

application/json

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

Response samples

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 Conversion raw data

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

Authorizations:

ApiKeyAuthBearerAuth

query Parameters

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

Request Body schema: application/json

A JSON object containing filter group information

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

Responses

Request samples

Payload

Content type

application/json

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

Response samples

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

Payload

Content type

application/json

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

Response samples

Content type

application/json

{"success": true
}

Fetch Impression raw data

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

Authorizations:

ApiKeyAuthBearerAuth

query Parameters

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

Request Body schema: application/json

A JSON object containing filter group information

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

Responses

Request samples

Payload

Content type

application/json

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

Response samples

Content type

application/json

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

Fetch data for overview table

Authorizations:

ApiKeyAuthBearerAuth

query Parameters

integration_id required	string integration id
start_date required	string <date> start date
end_date required	string <date> end date
columns[]	Array of strings columns
sort	string sort
count	boolean count
page[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"
]
}
]
}
}

publisher-report

Fetch data for partner Click UI Report

Authorizations:

ApiKeyAuthBearerAuth

query Parameters

filter[organization_id] required	string The organization's ID
start_date	string <date> start date
end_date	string <date> end date

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 partner Conversion UI Report

Authorizations:

ApiKeyAuthBearerAuth

query Parameters

filter[organization_id] required	string The organization's 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"
}
]
}
}

Fetch data for partner Impression UI Report

Authorizations:

ApiKeyAuthBearerAuth

query Parameters

filter[organization_id] required	string The organization's 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",
"extra_params.keys": ["string"
],
"extra_params.values": ["string"
],
"filter_group_id": "string",
"fingerprint": "string",
"integration_id": "string",
"integration_type": "string",
"invalid_sub_id": "string",
"ip_network": "string",
"is_bot": 0,
"is_old_browser": 0,
"is_old_os": 0,
"isp": "string",
"lat": 0,
"long": 0,
"monitoring_mode": 0,
"offer_id": "string",
"organization_id": "string",
"os_name": "string",
"os_version": "string",
"payout": 0,
"postal_code": "string",
"proxy_type": "string",
"publisher": "string",
"real_advertiser": "string",
"real_filter_group_id": "string",
"real_offer_id": "string",
"real_publisher": "string",
"real_tx_id": "string",
"referer": "string",
"referer_categories": ["string"
],
"rejected_advanced_reason": "string",
"rejected_language": "string",
"rejected_primary_reason": "string",
"rejected_simple_reason": "string",
"rejections": ["string"
],
"request_date": "2019-08-24",
"request_time": "2019-08-24T14:15:22Z",
"revenue": 0,
"rtt": 0,
"server_region": "string",
"site_url": "string",
"site_url_categories": ["string"
],
"status": "string",
"sub_id": "string",
"sub_id_2": "string",
"sub_id_3": "string",
"sub_id_4": "string",
"sub_id_5": "string",
"sub_id_6": "string",
"targeting_group_id": "string",
"tx_id": "string",
"user_agent": "string",
"user_email": "string",
"uuid": "string"
}
]
}
}

Fetch data for partner overview table

Authorizations:

ApiKeyAuthBearerAuth

query Parameters

filter[organization_id] required	string The organization's ID
start_date required	string <date> start date
end_date required	string <date> end date

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

stats

Get publishers count

You can get publishers count

Authorizations:

ApiKeyAuthBearerAuth

query Parameters

organization

string

The Organization ID. Required for super admin.

Responses

Response samples

Content type

application/json

{"active": 0,
"all": 0,
"deactivated": 0,
"pending": 0
}