Awesome new campaign
" }, "destination_url": "http://www.performancehorizon.com", "dont_consolidate": "y", "dont_invoice": "y", "extra_restricted_deep_linking": "", "force_approve_period": 0, "hidden_campaign": "y", "invoice_address_1": null, "invoice_address_2": null, "invoice_address_3": null, "invoice_address_4": null, "invoice_address_country": null, "invoice_address_postcode": null, "invoice_company": null, "invoice_contact": null, "invoice_only": null, "ip_tracking_time": 0, "is_cpc": "y", "lead_confirmation_url_fail": "", "lead_confirmation_url_success": "", "multiple_conversions_per_click": "n", "network_fee": null, "pay_publisher_directly": "y", "payment_date": null, "prepend_url_string": "http://google.com", "recurring_payment_setup": "y", "report_meta_purge_period": null, "reporting_timezone": "Australia/Sydney", "restricted_deep_linking": "y", "secure_tracking": "y", "status": "a", "terms": { "en": { "terms": "Important campaign terms and conditions" } }, "test_mode": "y", "title": "PHG Aff Demo", "tq_auto_approve": 60, "tq_enabled": "y", "tq_enabled_publishers": "", "tracking_method": "s2s", "tracking_subdomain": null, "unique_conversion_refs": "y", "vertical_id": 10, "vertical_name": "Other", "week_start": "Monday", "advertiser_name": "Advertiser Name" } } ] } } }, "brands_createACampaign_200_response": { "response": { "value": { "campaign": { "advertiser_id": "10l110", "allow_deep_linking": "y", "allow_third_party_pixel": "y", "append_url_parameters": "", "associated_campaigns": "", "automated_invoicing_date": 4, "automated_invoicing_po_number": null, "auto_approve_publisher": "y", "auto_rejected_ips": null, "budget_summary_interval": null, "budget_summary_start_time": null, "campaign_currency_conversions": [], "campaign_id": "10l176", "campaign_languages": null, "campaign_logo": "http://performancehorizon.com/logo.png", "campaign_notes": "", "campaign_overloads": [], "commission_by_meta_label": "[ \"label 1\",\"label 2\" ]", "commission_by_meta": "[ \"field_1\",\"field_2\" ]", "commissions": [], "conversion_hiatus_period": 7, "conversion_type": "sale", "cookie_period": 0, "cookie_status": null, "default_commission_rate": "5", "default_currency": "GBP", "default_override": 10, "deferred_lead_submission": null, "description": { "en": "Awesome new campaign
" }, "destination_url": "http://www.performancehorizon.com", "dont_consolidate": "y", "dont_invoice": "y", "extra_restricted_deep_linking": "", "force_approve_period": 0, "hidden_campaign": "y", "invoice_address_1": null, "invoice_address_2": null, "invoice_address_3": null, "invoice_address_4": null, "invoice_address_country": null, "invoice_address_postcode": null, "invoice_company": null, "invoice_contact": null, "invoice_only": null, "ip_tracking_time": 0, "is_cpc": "y", "lead_confirmation_url_fail": "", "lead_confirmation_url_success": "", "multiple_conversions_per_click": "n", "network_fee": null, "pay_publisher_directly": "y", "payment_date": null, "prepend_url_string": "http://google.com", "promotional_countries": [ { "iso": "US", "name": "United States" }, { "iso": "GB", "name": "United Kingdom" } ], "recurring_payment_setup": "y", "report_meta_purge_period": null, "reporting_timezone": "Australia/Sydney", "restricted_deep_linking": "y", "secure_tracking": "y", "status": "a", "terms": { "en": { "terms": "Important campaign terms and conditions" } }, "test_mode": "y", "title": "PHG Aff Demo", "tq_auto_approve": 60, "tq_enabled": "y", "tq_enabled_publishers": "", "tracking_method": "s2s", "tracking_subdomain": null, "unique_conversion_refs": "y", "vertical_id": 10, "vertical_name": "Other", "week_start": "Monday", "advertiser_name": "Advertiser Name" } } } }, "brands_Retrieve a Campaign_200_response": { "response": { "value": { "campaign": { "campaign_icon": "https://console.partnerize.com/assets/icons/campaigns/10l176.png", "advertiser_id": "10l110", "allow_deep_linking": "y", "allow_third_party_pixel": "y", "append_url_parameters": "", "associated_campaigns": "", "automated_invoicing_date": 4, "automated_invoicing_po_number": null, "auto_approve_publisher": "y", "auto_rejected_ips": null, "budget_summary_interval": null, "budget_summary_start_time": null, "campaign_currency_conversions": [], "campaign_id": "10l176", "campaign_languages": null, "campaign_logo": "http://performancehorizon.com/logo.png", "campaign_notes": "", "campaign_overloads": [], "commission_by_meta_label": "[ \"label 1\",\"label 2\" ]", "commission_by_meta": "[ \"field_1\",\"field_2\" ]", "commissions": [], "conversion_hiatus_period": 7, "conversion_type": "sale", "cookie_period": 0, "cookie_status": null, "default_commission_rate": "5", "default_currency": "GBP", "default_override": 10, "deferred_lead_submission": null, "description": { "en": "Awesome new campaign" }, "destination_url": "http://www.performancehorizon.com", "dont_consolidate": "y", "dont_invoice": "y", "extra_restricted_deep_linking": "", "force_approve_period": 0, "hidden_campaign": "y", "invoice_address_1": null, "invoice_address_2": null, "invoice_address_3": null, "invoice_address_4": null, "invoice_address_country": null, "invoice_address_postcode": null, "invoice_company": null, "invoice_contact": null, "invoice_only": null, "ip_tracking_time": 0, "is_cpc": "y", "lead_confirmation_url_fail": "", "lead_confirmation_url_success": "", "multiple_conversions_per_click": "n", "network_fee": null, "pay_publisher_directly": "y", "payment_date": null, "prepend_url_string": "http://google.com", "promotional_countries": [ { "iso": "US", "name": "United States" }, { "iso": "GB", "name": "United Kingdom" } ], "recurring_payment_setup": "y", "report_meta_purge_period": null, "reporting_timezone": "Australia/Sydney", "restricted_deep_linking": "y", "secure_tracking": "y", "status": "a", "terms": { "en": { "terms": "Important campaign terms and conditions" } }, "test_mode": "y", "title": "PHG Aff Demo", "tq_auto_approve": 60, "tq_enabled": "y", "tq_enabled_publishers": "", "tracking_method": "s2s", "tracking_subdomain": null, "unique_conversion_refs": "y", "vertical_id": 10, "vertical_name": "Other", "week_start": "Monday", "advertiser_name": "Advertiser Name" } } } }, "brands_Delete a Campaign_200_response": { "response": { "value": { "campaign": { "campaign_icon": "http://example.com/path/to/image.png", "advertiser_id": "10l110", "allow_deep_linking": "y", "allow_third_party_pixel": "y", "append_url_parameters": "", "associated_campaigns": "", "automated_invoicing_date": 4, "automated_invoicing_po_number": null, "auto_approve_publisher": "y", "auto_rejected_ips": null, "budget_summary_interval": null, "budget_summary_start_time": null, "campaign_currency_conversions": [], "campaign_id": "10l176", "campaign_languages": null, "campaign_logo": "http://performancehorizon.com/logo.png", "campaign_notes": "", "campaign_overloads": [], "commission_by_meta_label": "[ \"label 1\",\"label 2\" ]", "commission_by_meta": "[ \"field_1\",\"field_2\" ]", "commissions": [], "conversion_hiatus_period": 7, "conversion_type": "sale", "cookie_period": 0, "cookie_status": null, "default_commission_rate": "5", "default_currency": "GBP", "default_override": 10, "deferred_lead_submission": null, "description": { "en": "Awesome new campaign" }, "destination_url": "http://www.performancehorizon.com", "dont_consolidate": "y", "dont_invoice": "y", "extra_restricted_deep_linking": "", "force_approve_period": 0, "hidden_campaign": "y", "invoice_address_1": null, "invoice_address_2": null, "invoice_address_3": null, "invoice_address_4": null, "invoice_address_country": null, "invoice_address_postcode": null, "invoice_company": null, "invoice_contact": null, "invoice_only": null, "ip_tracking_time": 0, "is_cpc": "y", "lead_confirmation_url_fail": "", "lead_confirmation_url_success": "", "multiple_conversions_per_click": "n", "network_fee": null, "pay_publisher_directly": "y", "payment_date": null, "prepend_url_string": "http://google.com", "recurring_payment_setup": "y", "report_meta_purge_period": null, "reporting_timezone": "Australia/Sydney", "restricted_deep_linking": "y", "secure_tracking": "y", "status": "a", "terms": { "en": { "terms": "Important campaign terms and conditions" } }, "test_mode": "y", "title": "PHG Aff Demo", "tq_auto_approve": 60, "tq_enabled": "y", "tq_enabled_publishers": "", "tracking_method": "s2s", "tracking_subdomain": null, "unique_conversion_refs": "y", "vertical_id": 10, "vertical_name": "Other", "week_start": "Monday" }, "status": { "campaign_id": "10l176", "message": "Campaign successfully deleted", "retire_reason": "No longer needed", "status": "Deleted" } } } }, "brands_Update a Campaign_200_response": { "response": { "value": { "campaign": { "campaign_icon": "https://console.partnerize.com/assets/icons/campaigns/10l176.png", "advertiser_id": "10l110", "allow_deep_linking": "y", "allow_third_party_pixel": "y", "append_url_parameters": "", "associated_campaigns": "", "automated_invoicing_date": 4, "automated_invoicing_po_number": null, "auto_approve_publisher": "y", "auto_rejected_ips": null, "budget_summary_interval": null, "budget_summary_start_time": null, "campaign_currency_conversions": [], "campaign_id": "10l176", "campaign_languages": null, "campaign_logo": "http://performancehorizon.com/logo.png", "campaign_notes": "", "campaign_overloads": [], "commission_by_meta_label": "[ \"label 1\",\"label 2\" ]", "commission_by_meta": "[ \"field_1\",\"field_2\" ]", "commissions": [], "conversion_hiatus_period": 7, "conversion_type": "sale", "cookie_period": 0, "cookie_status": null, "default_commission_rate": "5", "default_currency": "GBP", "default_override": 10, "deferred_lead_submission": null, "description": { "en": "Awesome new campaign" }, "destination_url": "http://www.performancehorizon.com", "dont_consolidate": "y", "dont_invoice": "y", "extra_restricted_deep_linking": "", "force_approve_period": 0, "hidden_campaign": "y", "invoice_address_1": null, "invoice_address_2": null, "invoice_address_3": null, "invoice_address_4": null, "invoice_address_country": null, "invoice_address_postcode": null, "invoice_company": null, "invoice_contact": null, "invoice_only": null, "ip_tracking_time": 0, "is_cpc": "y", "lead_confirmation_url_fail": "", "lead_confirmation_url_success": "", "multiple_conversions_per_click": "n", "network_fee": null, "pay_publisher_directly": "y", "payment_date": null, "prepend_url_string": "http://google.com", "recurring_payment_setup": "y", "report_meta_purge_period": null, "reporting_timezone": "Australia/Sydney", "restricted_deep_linking": "y", "secure_tracking": "y", "status": "a", "terms": { "en": { "terms": "terms for the locale" } }, "test_mode": "y", "title": "PHG Aff Demo", "tq_auto_approve": 60, "tq_enabled": "y", "tq_enabled_publishers": "", "tracking_method": "s2s", "tracking_subdomain": null, "unique_conversion_refs": "y", "vertical_id": 10, "vertical_name": "Other", "week_start": "Monday" } } } }, "brands_List all Participating Partners_200_response": { "response": { "value": { "publishers": [ { "publisher": { "abn": null, "account_name": "partner123", "campaign_custom_terms_and_conditions_id": "10l176", "campaign_custom_terms_and_conditions_title": "Some fancy title", "campaign_select": null, "campaign_status": "a", "company_division": null, "company_name": "Demo Partner", "contact_email": "demo@partnerize.com", "contact_locale": "bg", "contact_name": "John Smith", "databases": [ { "active": "y", "creation_method": "Email", "database_id": "111111l300347", "database_name": "Partnerize Database", "female": 50, "male": 50, "max_age": 77, "min_age": 25, "publisher_id": "1l1007802", "size": 53000 } ], "default_currency": "GBP", "description": null, "foreign_identifier": null, "gst_registered": null, "im_provider": "Skype", "im_username": "elisangis", "is_affiliate_user": "y", "is_foreign_network": "y", "is_lead_user": "y", "legal_entity": "GB", "network_id": "1l1000003", "network_notes": null, "network_status": "a", "operating_country": "GB", "phone": "01595725007", "phone_area": "+44", "promotional_method": 10, "promotional_method_name": "Portal", "publisher_id": "1l1007802", "reporting_identifier": null, "reporting_timezone": "Australia/Sydney", "signup_ip": "178.23.129.160", "uk_vat_registered": "y", "us_tax_state": null, "vat_number": 974997534, "vertical": 10, "vertical_name": "Other", "websites": [ { "active": "y", "primary": "n", "description": "Demo Partner website", "publisher_id": "1l1007802", "website_country": "GB", "website_id": "11l18694", "website_name": null, "website_type": 9, "website_type_name": "PPC", "website_url": "http://www.partnerize.com", "website_vertical": 10, "website_vertical_name": "Technical" } ], "week_start": "Monday" } } ] } } }, "brands_update-partner-participation_200_response": { "response": { "value": { "publishers": [ { "publisher": { "abn": null, "account_name": "partner123", "campaign_custom_terms_and_conditions_id": "10l176", "campaign_custom_terms_and_conditions_title": "Some fancy title", "campaign_select": null, "campaign_status": "a", "company_division": null, "company_name": "Demo Partner", "contact_email": "demo@partnerize.com", "contact_locale": "bg", "contact_name": "John Smith", "databases": [ { "active": "y", "creation_method": "Email", "database_id": "111111l300347", "database_name": "Partnerize Database", "female": 50, "male": 50, "max_age": 77, "min_age": 25, "publisher_id": "1l1007802", "size": 53000 } ], "default_currency": "GBP", "description": null, "foreign_identifier": null, "gst_registered": null, "im_provider": "Skype", "im_username": "elisangis", "is_affiliate_user": "y", "is_foreign_network": "y", "is_lead_user": "y", "legal_entity": "GB", "network_id": "1l1000003", "network_notes": null, "network_status": "a", "operating_country": "GB", "phone": "01595725007", "phone_area": "+44", "promotional_method": 10, "promotional_method_name": "Portal", "publisher_id": "1l1007802", "reporting_identifier": null, "reporting_timezone": "Australia/Sydney", "signup_ip": "178.23.129.160", "uk_vat_registered": "y", "us_tax_state": null, "vat_number": 974997534, "vertical": 10, "vertical_name": "Other", "websites": [ { "active": "y", "primary": "n", "description": "Demo Partner website", "publisher_id": "1l1007802", "website_country": "GB", "website_id": "11l18694", "website_name": null, "website_type": 9, "website_type_name": "PPC", "website_url": "http://www.partnerize.com", "website_vertical": 10, "website_vertical_name": "Technical" } ], "week_start": "Monday" } } ] } } }, "brands_Retrieve a Participating Partner_200_response": { "response": { "value": { "publishers": [ { "publisher": { "abn": null, "account_name": "partner123", "campaign_custom_terms_and_conditions_id": "10l176", "campaign_custom_terms_and_conditions_title": "Some fancy title", "campaign_select": null, "campaign_status": "a", "company_division": null, "company_name": "Demo Partner", "contact_email": "demo@partnerize.com", "contact_locale": "bg", "contact_name": "John Smith", "databases": [ { "active": "y", "creation_method": "Email", "database_id": "111111l300347", "database_name": "Partnerize Database", "female": 50, "male": 50, "max_age": 77, "min_age": 25, "publisher_id": "1l1007802", "size": 53000 } ], "default_currency": "GBP", "description": null, "foreign_identifier": null, "gst_registered": null, "im_provider": "Skype", "im_username": "elisangis", "is_affiliate_user": "y", "is_foreign_network": "y", "is_lead_user": "y", "legal_entity": "GB", "network_id": "1l1000003", "network_notes": null, "network_status": "a", "operating_country": "GB", "phone": "01595725007", "phone_area": "+44", "promotional_method": 10, "promotional_method_name": "Portal", "publisher_id": "1l1007802", "reporting_identifier": null, "reporting_timezone": "Australia/Sydney", "signup_ip": "178.23.129.160", "uk_vat_registered": "y", "us_tax_state": null, "vat_number": 974997534, "vertical": 10, "vertical_name": "Other", "websites": [ { "active": "y", "primary": "n", "description": "Demo Partner website", "publisher_id": "1l1007802", "website_country": "GB", "website_id": "11l18694", "website_name": null, "website_type": 9, "website_type_name": "PPC", "website_url": "http://www.partnerize.com", "website_vertical": 10, "website_vertical_name": "Technical" } ], "week_start": "Monday" } } ] } } }, "brands_List all Brand Campaigns_200_response": { "response": { "value": { "campaigns": [ { "campaign": { "advertiser_id": "10l110", "allow_deep_linking": "y", "allow_third_party_pixel": "y", "append_url_parameters": "", "associated_campaigns": "", "automated_invoicing_date": 4, "automated_invoicing_po_number": null, "auto_approve_publisher": "y", "auto_rejected_ips": null, "budget_summary_interval": null, "budget_summary_start_time": null, "campaign_currency_conversions": [], "campaign_id": "10l176", "campaign_languages": null, "campaign_logo": "http://partnerize.com/logo.png", "campaign_notes": "", "campaign_overloads": [], "commission_by_meta_label": "[\"label 1\",\"label 2\"]", "commission_by_meta": "[\"field_1\",\"field_2\"]", "commissions": [], "conversion_hiatus_period": 7, "conversion_type": "sale", "cookie_period": 0, "cookie_status": null, "default_commission_rate": "5", "default_currency": "GBP", "default_override": 10, "deferred_lead_submission": null, "description": { "en": "Awesome new campaign" }, "destination_url": "http://www.partnerize.com", "dont_consolidate": "y", "dont_invoice": "y", "extra_restricted_deep_linking": "", "force_approve_period": 0, "hidden_campaign": "y", "invoice_address_1": null, "invoice_address_2": null, "invoice_address_3": null, "invoice_address_4": null, "invoice_address_country": null, "invoice_address_postcode": null, "invoice_company": null, "invoice_contact": null, "invoice_only": null, "ip_tracking_time": 0, "is_cpc": "y", "lead_confirmation_url_fail": "", "lead_confirmation_url_success": "", "multiple_conversions_per_click": "n", "network_fee": null, "pay_publisher_directly": "y", "payment_date": null, "prepend_url_string": "http://google.com", "recurring_payment_setup": "y", "report_meta_purge_period": null, "reporting_timezone": "Australia/Sydney", "restricted_deep_linking": "y", "secure_tracking": "y", "status": "a", "terms": { "en": { "terms": "Important campaign terms and conditions" } }, "test_mode": "y", "title": "PHG Aff Demo", "tq_auto_approve": 60, "tq_enabled": "y", "tq_enabled_publishers": "", "tracking_method": "s2s", "tracking_subdomain": null, "unique_conversion_refs": "y", "vertical_id": 10, "vertical_name": "Other", "week_start": "Monday" } } ], "count": 5, "execution_time": "0.08001 seconds" } } }, "brands_List all Brands_200_response": { "response": { "value": { "advertisers": [ { "advertiser": { "account_name": "demo_brand", "address1": "Gardegasse 11", "address2": "Top 7", "address3": "London", "address4": null, "advertiser_id": "10l110", "budget_summary_interval": null, "budget_summary_start_time": null, "company_name": "Partnerize Demo Brand", "contact_email": "someone@partnerize.com", "country": "GB", "current_balance": null, "default_currency": "GBP", "display_name": "PHG", "payment_currency": "GBP", "phone": "01595725007", "phone_area": "+44", "postcode": "A-101", "pre_payment": null, "signup_ip": "178.23.129.160", "status": "a", "vat_number": "GB974997534" } } ], "count": 86, "execution_time": "0.23640 seconds", "limit": 100, "offset": 0 } } }, "brands_Create Brand Account_200_response": { "response": { "value": { "advertiser": { "account_name": "demo_brand", "address1": "Gardegasse 11", "address2": "Top 7", "address3": "London", "address4": null, "advertiser_id": "10l110", "budget_summary_interval": null, "budget_summary_start_time": null, "company_name": "Partnerize Demo Brand", "contact_email": "someone@partnerize.com", "country": "GB", "current_balance": null, "default_currency": "GBP", "display_name": "PHG", "payment_currency": "GBP", "phone": "01595725007", "phone_area": "+44", "postcode": "A-101", "pre_payment": null, "signup_ip": "178.23.129.160", "status": "a", "vat_number": "GB974997534" } } } }, "brands_Retrieve a Brand_200_response": { "response": { "value": { "advertiser": { "account_name": "demo_brand", "address1": "Gardegasse 11", "address2": "Top 7", "address3": "London", "address4": null, "advertiser_id": "10l110", "budget_summary_interval": null, "budget_summary_start_time": null, "company_name": "Partnerize Demo Brand", "contact_email": "someone@partnerize.com", "country": "GB", "current_balance": null, "default_currency": "GBP", "display_name": "PHG", "payment_currency": "GBP", "phone": "01595725007", "phone_area": "+44", "postcode": "A-101", "pre_payment": null, "signup_ip": "178.23.129.160", "status": "a", "vat_number": "GB974997534" } } } }, "brands_Update a Brand_200_response": { "response": { "value": { "advertiser": { "account_name": "demo_brand", "address1": "Gardegasse 11", "address2": "Top 7", "address3": "London", "address4": null, "advertiser_id": "10l110", "advertiser_icon": "https://console.partnerize.com/assets/icons/10l110.png", "budget_summary_interval": null, "budget_summary_start_time": null, "company_name": "Partnerize Demo Brand", "contact_email": "someone@partnerize.com", "country": "GB", "current_balance": null, "default_currency": "GBP", "display_name": "PHG", "payment_currency": "GBP", "phone": "01595725007", "phone_area": "+44", "postcode": "A-101", "pre_payment": null, "signup_ip": "178.23.129.160", "status": "a", "vat_number": "GB974997534" } } } }, "brands_List all Voucher Codes_200_response": { "response": { "value": { "voucher_codes": [ { "voucher_code": { "active": "y", "campaign_id": "10l176", "commission_groups": [], "description": "", "end_date_time": "2013-09-30 15:00:00", "on_expiry": "ignore", "on_invalid_user": "ignore", "start_date_time": "2013-08-31 15:00:00", "voucher_code": "promocode", "voucher_code_id": "111111l1000015" } } ] } } }, "brands_Create Voucher Codes_200_response": { "response": { "value": { "voucher_code": { "active": "y", "campaign_id": "10l176", "commission_groups": [], "description": "", "end_date_time": "2013-09-30 15:00:00", "on_expiry": "ignore", "on_invalid_user": "ignore", "start_date_time": "2013-08-31 15:00:00", "voucher_code": "promocode", "voucher_code_id": "111111l1000015" } } } }, "brands_Update Voucher Codes_200_response": { "response": { "value": { "voucher_code": { "active": "y", "campaign_id": "10l176", "commission_groups": [], "description": "", "end_date_time": "2013-09-30 15:00:00", "on_expiry": "ignore", "on_invalid_user": "ignore", "start_date_time": "2013-08-31 15:00:00", "voucher_code": "promocode", "voucher_code_id": "111111l1000015" } } } }, "brands_Retrieve a Voucher Code_200_response": { "response": { "value": { "voucher_code": { "active": "y", "campaign_id": "10l176", "commission_groups": [], "description": "", "end_date_time": "2013-09-30 15:00:00", "on_expiry": "ignore", "on_invalid_user": "ignore", "start_date_time": "2013-08-31 15:00:00", "voucher_code": "promocode", "voucher_code_id": "111111l1000015" } } } }, "brands_List all Creatives for a Campaign_200_response": { "response": { "value": { "creatives": [ { "creative": { "tags": "", "active": "y", "advertiser_reference": "Promotion July 2020", "campaign_id": "10l176", "created_at": "2016-04-07 04:21:51", "created_by": "300621", "creative_id": "300441", "creative_items": [ { "tags": "", "active": "y", "campaign_id": "10l176", "content_type": "image/jpeg", "created_at": "2016-04-07 04:21:51", "created_by": "300621", "creative_item_id": "300396", "creative_type_id": 1, "custom_append_url_parameters": "", "custom_prepend_url_parameters": "", "description": "", "filename": "4fdf4b3879da1funny-animals-page.jpg", "img_url": "https://demophgconsole.partnerize.com/upload/4fdf4b3879da1funny-animals-page.jpg", "preview": "https://demo.prf.hn/preview/screativeref:300396", "specific_destination": "" } ], "creative_tracking_link": "", "creative_tracking_link_rotate": "", "creative_type_id": 1, "custom_append_url_parameters": "", "custom_prepend_url_parameters": "", "default_specific_creative_id": "300396", "description": "Demo Text", "destination": "http://www.partnerize.com", "dynamic_tracking_link": "", "end_date_time": "2013-09-30 15:00:00", "height": 360, "html_tracking_link": "", "limits": "", "preview": "https://demo.prf.hn/preview/creativeref:300442", "start_date_time": "2013-08-31 15:00:00", "width": 400 } } ] } } }, "brands_Create Campaign Creatives_200_response": { "response": { "value": { "creatives": [ { "creative": { "tags": "", "active": "y", "advertiser_reference": "Promotion July 2016", "campaign_id": "10l176", "created_at": "2016-04-07 04:21:51", "created_by": "300621", "creative_id": "300441", "creative_items": [ { "tags": "", "active": "y", "campaign_id": "10l176", "content_type": "image/jpeg", "created_at": "2016-04-07 04:21:51", "created_by": "300621", "creative_item_id": "300396", "creative_type_id": 1, "custom_append_url_parameters": "", "custom_prepend_url_parameters": "", "description": "", "filename": "4fdf4b3879da1funny-animals-page.jpg", "img_url": "https://demophgconsole.partnerize.com/upload/4fdf4b3879da1funny-animals-page.jpg", "preview": "https://demo.prf.hn/preview/screativeref:300396", "specific_destination": "" } ], "creative_tracking_link": "", "creative_tracking_link_rotate": "", "creative_type_id": 1, "custom_append_url_parameters": "", "custom_prepend_url_parameters": "", "default_specific_creative_id": "300396", "description": "Demo Text", "destination": "http://www.partnerize.com", "dynamic_tracking_link": "", "end_date_time": "2013-09-30 15:00:00", "height": 360, "html_tracking_link": "", "limits": "", "preview": "https://demo.prf.hn/preview/creativeref:300442", "start_date_time": "2013-08-31 15:00:00", "width": 400 } } ] } } }, "brands_Update Campaign Creatives_200_response": { "response": { "value": { "creatives": [ { "creative": { "tags": "", "active": "y", "advertiser_reference": "Promotion July 2016", "campaign_id": "10l176", "created_at": "2016-04-07 04:21:51", "created_by": "300621", "creative_id": "300441", "creative_items": [ { "tags": "", "active": "y", "campaign_id": "10l176", "content_type": "image/jpeg", "created_at": "2016-04-07 04:21:51", "created_by": "300621", "creative_item_id": "300396", "creative_type_id": 1, "custom_append_url_parameters": "", "custom_prepend_url_parameters": "", "description": "", "filename": "4fdf4b3879da1funny-animals-page.jpg", "img_url": "https://demophgconsole.partnerize.com/upload/4fdf4b3879da1funny-animals-page.jpg", "preview": "https://demo.prf.hn/preview/screativeref:300396", "specific_destination": "" } ], "creative_tracking_link": "", "creative_tracking_link_rotate": "", "creative_type_id": 1, "custom_append_url_parameters": "", "custom_prepend_url_parameters": "", "default_specific_creative_id": "300396", "description": "Demo Text", "destination": "http://www.partnerize.com", "dynamic_tracking_link": "", "end_date_time": "2013-09-30 15:00:00", "height": 360, "html_tracking_link": "", "limits": "", "preview": "https://demo.prf.hn/preview/creativeref:300442", "start_date_time": "2013-08-31 15:00:00", "width": 400 } } ] } } }, "brands_List all Creative Tags for Campaign_200_response": { "response": { "value": { "creative_tags": [ { "creative_tag": { "campaign_id": "10l176", "created_at": "2016-04-07 04:21:51", "created_by": "300621", "creative_tag_id": "111111l2", "creatives": [ { "creative_id": "300441", "creative_item_id": "300396" } ], "name": "logo" } } ] } } }, "brands_Create Campaign Creative Tags_200_response": { "response": { "value": { "creative_tags": [ { "creative_tag": { "campaign_id": "10l176", "created_at": "2016-04-07 04:21:51", "created_by": "300621", "creative_tag_id": "111111l2", "creatives": [ { "creative_id": "300441", "creative_item_id": "300396" } ], "name": "logo" } } ] } } }, "brands_Update Campaign Creative Tags_200_response": { "response": { "value": { "creative_tags": [ { "creative_tag": { "campaign_id": "10l176", "created_at": "2016-04-07 04:21:51", "created_by": "300621", "creative_tag_id": "111111l2", "creatives": [ { "creative_id": "300441", "creative_item_id": "300396" } ], "name": "logo" } } ] } } }, "brands_Delete Campaign Creative Tags_200_response": { "response": { "value": { "creative_tags": [ { "creative_tag": { "campaign_id": "10l176", "created_at": "2016-04-07 04:21:51", "created_by": "300621", "creative_tag_id": "111111l2", "creatives": [ { "creative_id": "300441", "creative_item_id": "300396" } ], "name": "logo" } } ] } } }, "brands_List all Creatives for a Campaign by Tags_200_response": { "response": { "value": { "creatives": [ { "creative": { "tags": "", "active": "y", "advertiser_reference": "Promotion July 2020", "campaign_id": "10l176", "created_at": "2016-04-07 04:21:51", "created_by": "300621", "creative_id": "300441", "creative_items": [ { "tags": [ { "creative_tag_id": "1011l56", "campaign_id": "10l176", "name": "My tag", "created_at": "2016-04-03 16:16:02" } ], "active": "y", "campaign_id": "10l176", "content_type": "image/jpeg", "created_at": "2016-04-07 04:21:51", "created_by": "300621", "creative_item_id": "300396", "creative_type_id": 1, "custom_append_url_parameters": "", "custom_prepend_url_parameters": "", "description": "", "filename": "4fdf4b3879da1funny-animals-page.jpg", "img_url": "https://demophgconsole.partnerize.com/upload/4fdf4b3879da1funny-animals-page.jpg", "preview": "https://demo.prf.hn/preview/screativeref:300396", "specific_destination": "" } ], "creative_tracking_link": "", "creative_tracking_link_rotate": "", "creative_type_id": 1, "custom_append_url_parameters": "", "custom_prepend_url_parameters": "", "default_specific_creative_id": "300396", "description": "Demo Text", "destination": "http://www.partnerize.com", "dynamic_tracking_link": "", "end_date_time": "2013-09-30 15:00:00", "height": 360, "html_tracking_link": "", "limits": "", "preview": "https://demo.prf.hn/preview/creativeref:300442", "start_date_time": "2013-08-31 15:00:00", "width": 400 } } ] } } }, "brands_List all Product Feeds_200_response": { "response": { "value": { "feeds": [ { "feed": { "active": "y", "dynamic": 0, "feed_id": "1111l13", "fetch_frequency": 3600, "filesize": 0, "last_processed": 1378980455, "location": "http://example.com/feed.xml", "name": "Sample Product Feed", "updated": 1378980455 } } ] } } }, "brands_Create a Product Feed for a Campaign_201_response": { "response": { "value": { "feeds": [ { "feed": { "active": "y", "dynamic": 0, "feed_id": "1111l13", "fetch_frequency": 3600, "filesize": 0, "last_processed": 1378980455, "location": "http://example.com/feed.xml", "name": "Sample Feed", "updated": 1378980455 } } ] } } }, "brands_Update a Campaign Feed_200_response": { "response": { "value": { "feeds": [ { "feed": { "action": "update", "active": "y", "dynamic": 0, "feed_id": "1111l13", "fetch_frequency": 3600, "filesize": 0, "last_processed": 1378980455, "location": "http://example.com/feed.xml", "name": "Sample Feed", "updated": 1378980455 } } ] } } }, "brands_List all Campaign Deals_200_response": { "response": { "value": { "campaign_deals": [ { "campaign_deal": { "active": "y", "advertiser_reference": "Promo012", "category": "Clothing", "country_iso": "GB", "coupon_code": "DEAL45", "description": "There are a lot of awesome deals", "destination": "https://dealz.bargain/promo", "end_date_time": "2017-09-01T00:00:00+01:00", "offer_type": "coupon", "offer_value": "40% off", "start_date_time": "2017-08-01T00:00:00+01:00", "terms": "No terms for this deal", "title": "40% off everything" } } ] } } }, "brands_Create a Campaign Deal_201_response": { "response": { "value": { "campaign_deal": { "active": "y", "advertiser_reference": "Promo012", "campaign_deal_id": "111111l2", "category": "Clothing", "country_iso": "GB", "coupon_code": "DEAL45", "created_at": "2017-07-01T00:00:00+01:00", "description": "There are a lot of awesome deals", "destination": "https://dealz.bargain/promo", "end_date_time": "2017-09-01T00:00:00+01:00", "offer_type": "coupon", "offer_value": "40% off", "start_date_time": "2017-08-01T00:00:00+01:00", "terms": "No terms for this deal", "title": "40% off everything", "updated_at": null } } } }, "brands_Retrieve a Campaign Deal_200_response": { "response": { "value": { "campaign_deal": { "active": "y", "advertiser_reference": "Promo012", "campaign_deal_id": "111111l2", "category": "Clothing", "country_iso": "GB", "coupon_code": "DEAL45", "created_at": "2017-07-01T00:00:00+01:00", "description": "There are a lot of awesome deals", "destination": "https://dealz.bargain/promo", "end_date_time": "2017-09-01T00:00:00+01:00", "offer_type": "coupon", "offer_value": "40% off", "start_date_time": "2017-08-01T00:00:00+01:00", "terms": "No terms for this deal", "title": "40% off everything", "updated_at": null } } } }, "brands_Update a Campaign Deal_200_response": { "response": { "value": { "campaign_deal": { "active": "y", "advertiser_reference": "Promo012", "campaign_deal_id": "111111l2", "category": "Clothing", "country_iso": "GB", "coupon_code": "DEAL45", "created_at": "2017-07-01T00:00:00+01:00", "description": "There are a lot of awesome deals", "destination": "https://dealz.bargain/promo", "end_date_time": "2017-09-01T00:00:00+01:00", "offer_type": "coupon", "offer_value": "40% off", "start_date_time": "2017-08-01T00:00:00+01:00", "terms": "No terms for this deal", "title": "40% off everything", "updated_at": null } } } }, "brands_List all Meta attributes for Campaign_200_response": { "response": { "value": { "campaign": { "campaign_id": "10l176", "meta": { "currencies": [ "GBP" ], "meta_conversion": [], "meta_item": [] } } } } }, "brands_List all Transaction Queries_200_response": { "response": { "value": { "count": 5, "execution_time": "0.08001 seconds", "filters": {}, "sort": { "column": "created_at", "direction": "ASC" }, "transaction_queries": [ { "transaction_query": { "actions_available": [ "approve", "reject" ], "campaign": { "advertiser_id": "10l110", "campaign_id": "10l176", "created": "2017-01-01 00:00:00", "created_by": "11l16829", "default_override": "1", "hidden_campaign": "y", "last_modified": "2017-01-01 00:00:00", "network_fee": null, "payment_date": null, "reporting_timezone": "Australia/Sydney", "status": "a", "title": "Example Campaign", "type": "sale", "vertical_id": 10, "week_start": "monday" }, "campaign_id": "10l176", "camref": "hrDu67", "conversion_currency": "GBP", "conversion_date_time": "2017-01-01 00:00:00", "conversion_id": "111111l304972", "conversion_reference": "AUTO-5953bd8c5fe7b", "conversion_value": 9729, "created_at": "2017-01-01 00:00:00", "current_state": "pending", "expected_commission": 907.43, "notes": "Quam ex rerum nulla enim.", "publisher": { "agreed_to_latest_network_terms": "y", "created": "2017-01-01 00:00:00", "created_by": "11l16829", "name": "Example Partner", "network_id": "1l1000003", "network_status": "a", "publisher_id": "1l1007802", "ref_terms_and_conditions_locale_id": "1l100284", "reporting_timezone": "Australia/Sydney", "signup_ip": "127.0.0.1", "week_start": "saturday" }, "publisher_id": "1l1007802", "publisher_reference": "rerum", "state_history": { "conversion_expected_commission": 837.49, "conversion_item_id": "111111l1107235", "created_at": "2017-01-01 00:00:00", "notes": "Quidem facilis iste sapiente reiciendis.", "state": "pending", "transaction_query_id": "111111l10", "transaction_query_state_id": "111111l9", "user_id": "11l16829" }, "transaction_query_id": "111111l10", "transaction_query_type": "untracked", "updated_at": "2017-02-01 00:00:00" } } ] } } }, "brands_Approve a Transaction Query_200_response": { "response": { "value": { "execution_time": "0.08001 seconds", "transaction_query": { "actions_available": [], "campaign": { "advertiser_id": "10l110", "campaign_id": "10l176", "created": "2017-01-01 00:00:00", "created_by": "11l16829", "default_override": "1", "hidden_campaign": "y", "last_modified": "2017-01-01 00:00:00", "network_fee": null, "payment_date": null, "reporting_timezone": "Australia/Sydney", "status": "a", "title": "Example Campaign", "type": "sale", "vertical_id": 10, "week_start": "monday" }, "campaign_id": "10l176", "camref": "hrDu67", "conversion_currency": "GBP", "conversion_date_time": "2017-01-01 00:00:00", "conversion_id": "111111l304972", "conversion_reference": "AUTO-5953bd8c5fe7b", "conversion_value": 9729, "created_at": "2017-01-01 00:00:00", "current_state": "pending", "expected_commission": 907.43, "notes": "Quam ex rerum nulla enim.", "publisher": { "agreed_to_latest_network_terms": "y", "created": "2017-01-01 00:00:00", "created_by": "11l16829", "name": "Example Partner", "network_id": "1l1000003", "network_status": "a", "publisher_id": "1l1007802", "ref_terms_and_conditions_locale_id": "1l100284", "reporting_timezone": "Australia/Sydney", "signup_ip": "127.0.0.1", "week_start": "saturday" }, "publisher_id": "1l1007802", "publisher_reference": "rerum", "state_history": { "conversion_expected_commission": 837.49, "conversion_item_id": "111111l1107235", "created_at": "2017-01-01 00:00:00", "notes": "Quidem facilis iste sapiente reiciendis.", "state": "pending", "transaction_query_id": "111111l10", "transaction_query_state_id": "111111l9", "user_id": "11l16829" }, "transaction_query_id": "111111l10", "transaction_query_type": "untracked", "updated_at": "2017-02-01 00:00:00" } } } }, "brands_Approve a Transaction Query_400_response": { "response": { "value": { "error": { "message": "Requested action around TQs that does not exists", "type": "400" } } } }, "brands_Approve a Transaction Query_404_response": { "response": { "value": { "error": { "message": "The TQ ID supplied for this action does not match an existing TQ.", "type": "404" } } } }, "brands_Pend a Transaction Query_200_response": { "response": { "value": { "execution_time": "0.08001 seconds", "transaction_query": { "actions_available": [ "approve", "reject" ], "campaign": { "advertiser_id": "10l110", "campaign_id": "10l176", "created": "2017-01-01 00:00:00", "created_by": "11l16829", "default_override": "1", "hidden_campaign": "y", "last_modified": "2017-01-01 00:00:00", "network_fee": null, "payment_date": null, "reporting_timezone": "Australia/Sydney", "status": "a", "title": "Example Campaign", "type": "sale", "vertical_id": 10, "week_start": "monday" }, "campaign_id": "10l176", "camref": "hrDu67", "conversion_currency": "GBP", "conversion_date_time": "2017-01-01 00:00:00", "conversion_id": "111111l304972", "conversion_reference": "AUTO-5953bd8c5fe7b", "conversion_value": 9729, "created_at": "2017-01-01 00:00:00", "current_state": "pending", "expected_commission": 907.43, "notes": "Quam ex rerum nulla enim.", "publisher": { "agreed_to_latest_network_terms": "y", "created": "2017-01-01 00:00:00", "created_by": "11l16829", "name": "Example Partner", "network_id": "1l1000003", "network_status": "a", "publisher_id": "1l1007802", "ref_terms_and_conditions_locale_id": "1l100284", "reporting_timezone": "Australia/Sydney", "signup_ip": "127.0.0.1", "week_start": "saturday" }, "publisher_id": "1l1007802", "publisher_reference": "rerum", "state_history": { "conversion_expected_commission": 837.49, "conversion_item_id": "111111l1107235", "created_at": "2017-01-01 00:00:00", "notes": "Quidem facilis iste sapiente reiciendis.", "state": "pending", "transaction_query_id": "111111l10", "transaction_query_state_id": "111111l9", "user_id": "11l16829" }, "transaction_query_id": "111111l10", "transaction_query_type": "untracked", "updated_at": "2017-02-01 00:00:00" } } } }, "brands_Pend a Transaction Query_400_response": { "response": { "value": { "error": { "message": "Requested action around TQs that does not exists", "type": "400" } } } }, "brands_Pend a Transaction Query_404_response": { "response": { "value": { "error": { "message": "The TQ ID supplied for this action does not match an existing TQ.", "type": "404" } } } }, "brands_Reject a Transaction Query_200_response": { "response": { "value": { "execution_time": "0.08001 seconds", "transaction_query": { "actions_available": [ "pend" ], "campaign": { "advertiser_id": "10l110", "campaign_id": "10l176", "created": "2017-01-01 00:00:00", "created_by": "11l16829", "default_override": "1", "hidden_campaign": "y", "last_modified": "2017-01-01 00:00:00", "network_fee": null, "payment_date": null, "reporting_timezone": "Australia/Sydney", "status": "a", "title": "Example Campaign", "type": "sale", "vertical_id": 10, "week_start": "monday" }, "campaign_id": "10l176", "camref": "hrDu67", "conversion_currency": "GBP", "conversion_date_time": "2017-01-01 00:00:00", "conversion_id": "111111l304972", "conversion_reference": "AUTO-5953bd8c5fe7b", "conversion_value": 9729, "created_at": "2017-01-01 00:00:00", "current_state": "pending", "expected_commission": 907.43, "notes": "Quam ex rerum nulla enim.", "publisher": { "agreed_to_latest_network_terms": "y", "created": "2017-01-01 00:00:00", "created_by": "11l16829", "name": "Example Partner", "network_id": "1l1000003", "network_status": "a", "publisher_id": "1l1007802", "ref_terms_and_conditions_locale_id": "1l100284", "reporting_timezone": "Australia/Sydney", "signup_ip": "127.0.0.1", "week_start": "saturday" }, "publisher_id": "1l1007802", "publisher_reference": "rerum", "state_history": { "conversion_expected_commission": 837.49, "conversion_item_id": "111111l1107235", "created_at": "2017-01-01 00:00:00", "notes": "Quidem facilis iste sapiente reiciendis.", "state": "pending", "transaction_query_id": "111111l10", "transaction_query_state_id": "111111l9", "user_id": "11l16829" }, "transaction_query_id": "111111l10", "transaction_query_type": "untracked", "updated_at": "2017-02-01 00:00:00" } } } }, "brands_Reject a Transaction Query_400_response": { "response": { "value": { "error": { "message": "Requested action around TQs that does not exists", "type": "400" } } } }, "brands_Reject a Transaction Query_404_response": { "response": { "value": { "error": { "message": "The TQ ID supplied for this action does not match an existing TQ.", "type": "404" } } } }, "brands_Bulk process Transaction Queries_200_response": { "response": { "value": { "execution_time": "0.08001 seconds", "job": { "completed_at": "2016-04-07 04:21:52", "created_at": "2016-04-07 04:21:51", "created_by": "300621", "created_by_uri": "", "estimated_completion": null, "job_id": "111111l470", "percentage_complete": 100, "reference": null, "response": "/job/111111l1177306/response.json", "response_within_retention": true, "status": "complete", "time_elapsed": 0, "update": "/job/111111l1177306.json" } } } }, "brands_Bulk process Transaction Queries_400_response": { "response": { "value": { "error": { "message": "Requested action around TQs that does not exists", "type": "400" } } } }, "brands_List Transaction Query Reasons_200_response": { "response": { "value": { "count": 1, "execution_time": "0.08001 seconds", "transaction_query_reasons": [ { "transaction_query_reason": { "campaign_id": "10l176", "created_at": "2017-01-01 00:00:00", "reason": "Example reason", "transaction_query_reason_id": "111111l3" } } ] } } }, "brands_Create a Transaction Query Reason_200_response": { "response": { "value": { "execution_time": "0.08001 seconds", "transaction_query_reason": { "campaign_id": "10l176", "created_at": "2017-01-01 00:00:00", "reason": "Example reason", "transaction_query_reason_id": "111111l3" } } } }, "brands_Create a Transaction Query Reason_400_response": { "response": { "value": { "error": { "fields": {}, "message": "Reason already exists", "type": "Validation Fail" } } } }, "brands_Delete a Transaction Query Reason_200_response": { "response": { "value": { "execution_time": "0.08001 seconds", "transaction_query_reason": { "deleted": "true" } } } }, "brands_Delete a Transaction Query Reason_404_response": { "response": { "value": { "error": { "message": "Transaction Query Reason not found", "type": "404" } } } }, "brands_List all Invoices_200_response": { "response": { "value": { "invoices": [ { "invoice": { "average_conversion_age": 14, "campaign_id": "10l176", "creation_date": "2015-12-14 22:58:25", "currency": "GBP", "download": null, "invoice_id": "1101l1536", "invoice_net_value": 770.84, "invoice_reference": "I-10l176-1101l1536", "invoice_total_value": 770.84, "invoice_vat_value": 0, "invoiced": "All", "item_download": null, "merchant_invoice_id": null, "paid_currency": "GBP", "payment_date": "", "payment_due_by_date": "", "payment_reference": null, "publisher_commission": 700.76, "publisher_override": 70.08, "set_end_date": "2015-12-09", "set_start_date": "2015-08-30", "set_timezone": "Australia/Sydney", "status": "created", "vat_rate": 0 } } ] } } }, "brands_Retrieve an Invoice_200_response": { "response": { "value": { "invoice": { "average_conversion_age": 14, "campaign_id": "10l176", "creation_date": "2015-12-14 22:58:25", "currency": "GBP", "download": null, "invoice_id": "1101l1536", "invoice_net_value": 770.84, "invoice_reference": "I-10l176-1101l1536", "invoice_total_value": 770.84, "invoice_vat_value": 0, "invoiced": "All", "item_download": null, "merchant_invoice_id": null, "paid_currency": "GBP", "payment_date": "", "payment_due_by_date": "", "payment_reference": null, "publisher_commission": 700.76, "publisher_override": 70.08, "set_end_date": "2015-12-09", "set_start_date": "2015-08-30", "set_timezone": "Australia/Sydney", "status": "created", "vat_rate": 0 } } } }, "brands_Create Custom Terms and Conditions_request": { "publisher_id": [ "21", "250001", "3", "300009", "4d00ecdbe65e6", "4d0122781f1f6", "4d012e7a77288" ], "title": "Terms and conditions title", "terms": "Terms and conditions content", "locale": "pl" }, "brands_Create Custom Terms and Conditions_201_response": { "execution_time": "1.05973 seconds", "custom_terms": [ { "campaign_custom_terms_and_conditions_id": "111111l43", "title": "Terms and conditions title", "terms": "Terms and conditions content", "created": "2019-05-29 09:18:17", "campaign_id": "10l176", "locale": "pl", "active": "y" } ] }, "brands_Create Custom Terms and Conditions_400_response": { "error": { "message": "Locale is invalid", "type": "Validation Fail", "fields": [ "locale" ] } }, "brands_List Terms and Conditions for a given Campaign_200_response": { "execution_time": "1.05973 seconds", "custom_terms": [ { "campaign_custom_terms_and_conditions_id": "111111l43", "title": "Terms and conditions title", "terms": "Terms and conditions content", "created": "2019-05-29 09:18:17", "campaign_id": "10l176", "locale": "pl", "active": "y", "publishers": [] } ] }, "brands_readCustomTerms_200_response": { "execution_time": "1.05973 seconds", "custom_terms": [ { "campaign_custom_terms_and_conditions_id": "111111l43", "title": "Terms and conditions title", "terms": "Terms and conditions content", "created": "2019-05-29 09:18:17", "campaign_id": "10l176", "locale": "pl", "active": "y" } ] }, "brands_readPartnerCampaignCustomTerms_200_response": { "execution_time": "1.05973 seconds", "custom_terms": [ { "campaign_custom_terms_and_conditions_id": "111111l43", "title": "Terms and conditions title", "terms": "Terms and conditions content", "created": "2019-05-29 09:18:17", "campaign_id": "10l176", "locale": "pl", "active": "y", "publisher_id": "1", "approved": "null", "agreed_latest_terms": "n", "status": "a" } ] }, "brands_deleteCampaignCustomTerms_200_response": { "execution_time": "1.05973 seconds", "custom_terms": [ { "removed_terms": 1 } ] }, "brands_deleteCampaignCustomTerms_404_response": { "error": { "message": "Terms with given id (111111l3) does not exist", "type": "404" } }, "brands_createAssocCampaignCustomTerms_request": { "publisher_id": [ "4d00ecdbe65e6", "4d0122781f1f6", "4d012e7a77288" ] }, "brands_createAssocCampaignCustomTerms_200_response": { "$ref": "#/paths/~1campaign~1%7Bcampaign_id%7D~1custom_terms~1/get/responses/200/content/application~1json/example" }, "brands_createAssocCampaignCustomTerms_404_response": { "$ref": "#/paths/~1campaign~1%7Bcampaign_id%7D~1custom_terms~1%7Bcustom_terms_id%7D/delete/responses/404/content/application~1json/example" }, "brands_deleteAssocCampaignCustomTerms_request": { "publisher_id": [ "4d00ecdbe65e6", "4d0122781f1f6", "4d012e7a77288" ] }, "brands_deleteAssocCampaignCustomTerms_200_response": { "execution_time": "1.05973 seconds", "custom_terms": [ { "removed_associations": 1 } ] }, "brands_deleteAssocCampaignCustomTerms_207_response": { "execution_time": "1.05973 seconds", "custom_terms": [ { "removed_associations": 1 } ], "errors": [ "Terms with given id (111111l3) does not exist" ] }, "brands_deleteAssocCampaignCustomTerms_404_response": { "$ref": "#/paths/~1campaign~1%7Bcampaign_id%7D~1custom_terms~1%7Bcustom_terms_id%7D/delete/responses/404/content/application~1json/example" }, "brands_get-commission-csv-download_200_response": { "response": { "value": "commission_group_id,commission_id,commission_type,scope,campaign_id,group_id,group_name,publisher_id,publisher_name,voucher_id,voucher_code,group_limit,start_date_time,end_date_time,status,name,performance_model,commission,commission_based_on_field,cookie_period_seconds,dynamic_sut,created,created_by_id,created_by_name,last_modified,last_modified_by,last_modified_by_name\n1111111l1,1111111l3,promotional,publisher,,,,111111l9,test_publisher,,,,\"2023-05-05 16:00:00\",\"2023-09-30 00:00:00\",ACTIVE,\"Test Promotional Commission\",\"% CPA\",10.0000,,,,,,,,promosku,,,,avalue,\"2023-05-05 14:46:54\",111111l1,user_name,\"2023-05-05 14:46:54\",111111l1,user_name\n" } }, "brands_get-publisher-commissions-default_200_response": { "Commission": { "value": { "description": "The Default Commission", "performance_value": "2.5", "performance_model": "fixed_cpa", "last_modified_by": "3", "last_modified": "2010-01-01 12:30:00", "publishers": { "id": "10110l2398476", "performance_value": "3.25", "name": "Best Partner" }, "groups": { "id": "111001l90872354", "performance_value": "3.75", "name": "Special Group" } } } }, "brands_List Partner Groups_200_response": { "response": { "value": { "commission_groups": [ { "commission_group": { "active": "y", "campaign_id": "10l176", "commission_group_id": "10l169", "description": "", "end_date_time": "2013-09-30 15:00:00", "last_modified": "2015-04-10 01:59:54", "name": "Fansites 3 percent", "publishers": [ "100l06", "100l08" ], "start_date_time": "2013-08-31 15:00:00" } } ] } } }, "brands_Retrieve a Partner Group_200_response": { "response": { "value": { "commission_group": { "active": "y", "campaign_id": "10l176", "commission_group_id": "10l169", "description": "", "end_date_time": "2013-09-30 15:00:00", "last_modified": "2015-04-10 01:59:54", "name": "Fansites 3 percent", "publishers": [ "100l06", "100l08" ], "start_date_time": "2013-08-31 15:00:00" } } } }, "brands_Create Partner Groups_200_response": { "response": { "value": { "commission_group": { "active": "y", "campaign_id": "10l176", "commission_group_id": "10l169", "description": "", "end_date_time": "2013-09-30 15:00:00", "last_modified": "2015-04-10 01:59:54", "name": "Fansites 3 percent", "publishers": [ "100l06", "100l08" ], "start_date_time": "2013-08-31 15:00:00" } } } }, "brands_Update Partner (Commission) Groups_200_response": { "response": { "value": { "commission_group": { "active": "y", "campaign_id": "10l176", "commission_group_id": "10l169", "description": "", "end_date_time": "2013-09-30 15:00:00", "last_modified": "2015-04-10 01:59:54", "name": "Fansites 3 percent", "publishers": [ "100l06", "100l08" ], "start_date_time": "2013-08-31 15:00:00" } } } }, "brands_bulk-delete-v2-campaigns-campaignId-attribution-suppressed-codes_400_response": { "Cannot delete active Suppressed Code": { "value": { "error": { "errors": [ { "type": "validation_error", "code": "invalid_suppressed_code", "message": "Unable to delete Suppressed Code 12344. Only scheduled Suppressed Code can be deleted." } ] }, "code": 400, "message": "Bad Request" } } }, "brands_export-publishers_201_response": "created_date,signup_ip,publisher_id,account_name,reporting_identifier,available_campaigns,approved_campaigns,invited_campaigns,requested_campaigns,rejected_campaigns,contact_name,contact_email,company_name,phone_area,phone,im_provider,im_username,operating_country,contact_locale,vertical_name,promotional_method_name,websites_website_url,website_verification_status,network_metadata_1,network_metadata_2,network_metadata_3\n\"2019-10-30 11:08:41\",80.80.80.80,111111l1,my_account,acc_reporting_id,\"Campaign Avail\",\"Campaign App A,Campaign App B\",\"Campaign Inv\",\"Campaign Req\",\"Campaign Rej\",\"Joe Bloggs\",info@partnerize.com,\"Partnerize\",0191,12345678,Skype,jbskype,GB,en,Retail,PPC,http://www.partnerize.com,\"https://partnerize.com :: verified | https://partner.com :: unverified\",\"Network metadata 1\",\"Network metadata 2\",\"Network metadata 3\"\n", "brands_post-v2-networks-network_id-invite-network-partners_request": { "Collection based request": { "value": { "partner_collection_id": "11111l1", "campaign_id": [ "11111l21", "11111l22" ] } }, "Selection based request": { "value": { "publisher_id": [ "11111l1", "11111l2" ], "campaign_id": [ "11111l21", "11111l22" ] } }, "Filter based request": { "value": { "filter": [ { "property": "search", "value": "cash" }, { "property": "vertical_id", "value": [ "6" ] }, { "property": "promo_method_id", "value": [ "70" ] }, { "property": "operating_country", "value": [ "US" ] }, { "property": "promotional_country", "value": [ "US" ] }, { "property": "campaign_id", "value": [ "11111l90" ] }, { "property": "campaign_status", "value": [ "approved", "requested" ] } ], "campaign_id": [ "11111l21", "11111l22" ], "excluded_publisher_id": [ "11111l102" ] } } }, "brands_exportDryRun_201_response": "partner_id,partner_name,company_name,partner_website,campaign_id,campaign_name,campaign_status,campaign_approval_date\n111111l1,voucherbox_demo,16plus_voucherbox,https://www.bbc.co.uk,111111l1,\"Cards & Loans\",approved,2019-10-30T11:08:41+00:00\n", "brands_post-v2-networks-network_id-reject-partners_request": { "Selection based request": { "value": { "publisher_id": [ "11111l1", "11111l2" ], "campaign_id": [ "11111l1", "11111l2" ] } }, "Filter based request": { "value": { "filter": [ { "property": "search", "value": "cash" }, { "property": "vertical_id", "value": [ "6" ] }, { "property": "promo_method_id", "value": [ "70" ] }, { "property": "operating_country", "value": [ "US" ] }, { "property": "promotional_country", "value": [ "US" ] }, { "property": "campaign_id", "value": [ "11111l90" ] }, { "property": "campaign_status", "value": [ "approved", "requested", "requested" ] } ], "excluded_publisher_id": [ "11111l102" ], "campaign_id": [ "11111l1", "11111l2" ] } } }, "brands_create-communication_201_response": { "response": { "value": { "execution_time": "0.08853 seconds", "communication": { "id": "100l06", "name": "Awesome communication", "subject": "Wonderful subject", "type": "general", "from_name": "Joy O'Happy", "from_email": "user@example.com", "reply_to_email": "user@example.com", "send_date": "2020-07-23T10:02:53Z", "timezone": "Europe/London", "status": "sent", "preview_url": "http://...", "publisher_ids": [ "string" ] }, "hypermedia": { "links": { "content": "/v2/communications/{id}/content" } } } } }, "brands_brand-conversions_200_response": { "response": { "value": { "total_conversion_count": { "USD": 1 }, "total_commission_value": { "USD": 44 }, "total_publisher_commission": { "USD": 40 }, "total_value": { "USD": 400 }, "start_date_time_utc": "2019-08-10 00:00:00", "end_date_time_utc": null, "start_date_time": "2020-05-13 00:00:00", "end_date_time": "2020-05-13 00:00:00", "limit": 300, "meta_data": [], "count": 1, "execution_time": "1.97706 seconds", "conversions": [ { "conversion_data": { "conversion_id": "111111l10", "campaign_id": "111111l26", "publisher_id": "111111l92", "conversion_time": "2020-05-13 00:00:00", "device_id": "111111l12", "creative_type": 0, "creative_id": 0, "specific_creative_id": 0, "currency": "USD", "advertiser_reference": "adrefc", "conversion_reference": "AUTO-5ebc12334abb39.26532332", "customer_type": null, "referer_ip": "33c0:7b2c:2cad:5eb:a6cd:b312:111a:cf23", "source_referer": "", "last_modified": "2020-05-13 15:28:51", "conversion_type": 1, "country": "US", "customer_reference": "custrefc", "ref_device_id": 2, "ref_partnership_model_id": 2, "ref_traffic_source_id": 3, "ref_conversion_metric_id": 2, "ref_user_context_id": 2, "campaign_title": "rubycampaigncoybwvsv", "publisher_name": null, "click": { "click_id": "111111l12", "device_id": "111111l12", "campaign_id": "111111l26", "publisher_id": "111111l92", "type": "standard", "status": "nibbled", "set_time": "2020-05-13 00:00:00", "set_ip": "33c0:7b2c:2cad:5eb:a6cd:b312:111a:cf23", "last_used": 1589383731, "last_ip": "33c0:7b2c:2cad:5eb:a6cd:b312:111a:cf23", "advertiser_reference": "", "referer": "", "creative_id": 0, "creative_type": 0, "specific_creative_id": 0, "country": "US", "ref_device_id": 2, "ref_traffic_source_id": 3, "ref_partnership_model_id": 2, "ref_user_context_id": 2, "ref_device": "Desktop", "ref_traffic_source": "Affiliate", "ref_partnership_model": "CPA", "ref_user_context": "Web", "clickref": "111111lk" }, "ref_conversion_metric": "Standard", "ref_device": "Desktop", "ref_partnership_model": "CPA", "ref_traffic_source": "Affiliate", "ref_user_context": "Web", "conversion_value": { "conversion_value_id": "111111l10", "conversion_status": "pending", "value": 400, "commission": 44, "publisher_commission": 40 }, "meta_data": { "gclid": "adword_google_meta_data" }, "conversion_items": [ { "conversion_item_id": "111111l10", "sku": 123, "category": "Product", "item_value": 400, "item_commission": 44, "item_publisher_commission": 40, "item_status": "pending", "invoice_id": null, "last_update": "2020-05-13 15:28:51", "display_to_publisher": 1, "approved_at": null, "item_status_id": 1, "reject_reason": null, "voucher_codes": [], "meta_data": { "gclid": "adword_google_meta_data" } } ], "was_disputed": false, "currency_original": "", "currency_conversion_rate": "", "conversion_lag": 0, "clickref": "111111lk" } } ] } } }, "brands_brand-clicks_200_response": { "response": { "value": { "unique_click_count": 2, "start_date_time_utc": "2019-08-10 00:00:00", "end_date_time_utc": null, "start_date_time": "2020-05-13 00:00:00", "end_date_time": "2020-05-13 00:00:00", "limit": 300, "offset": 0, "count": 2, "execution_time": "0.50885 seconds", "clicks": [ { "click": { "click_id": "111111l11", "device_id": "111111l11", "campaign_id": "111111l26", "publisher_id": "111111l92", "type": "standard", "status": "nibbled", "set_time": "2020-05-13 00:00:00", "set_ip": "33c0:7b2c:2cad:5eb:a6cd:b312:111a:cf23", "last_used": "2020-05-13 15:28:52", "last_ip": "33c0:7b2c:2cad:5eb:a6cd:b312:111a:cf23", "advertiser_reference": "", "referer": "", "creative_id": 0, "creative_type": 0, "specific_creative_id": 0, "country": "RU", "ref_device_id": 2, "ref_traffic_source_id": 3, "ref_partnership_model_id": 2, "ref_user_context_id": 2, "clickref": "111111lj", "publisher_name": null } }, { "click": { "click_id": "111111l12", "device_id": "111111l12", "campaign_id": "111111l26", "publisher_id": "111111l92", "type": "standard", "status": "nibbled", "set_time": "2020-05-13 00:00:00", "set_ip": "33c0:7b2c:2cad:5eb:a6cd:b312:111a:cf23", "last_used": "2020-05-13 15:28:51", "last_ip": "33c0:7b2c:2cad:5eb:a6cd:b312:111a:cf23", "advertiser_reference": "", "referer": "", "creative_id": 0, "creative_type": 0, "specific_creative_id": 0, "country": "US", "ref_device_id": 2, "ref_traffic_source_id": 3, "ref_partnership_model_id": 2, "ref_user_context_id": 2, "clickref": "111111lk", "publisher_name": null } } ] } } }, "brands_Export Clicks_200_response": { "response": { "value": "click_id,cookie_id,campaign_id,publisher_id,status,set_time,set_ip,last_used,last_ip,advertiser_reference,referer,creative_id,creative_type,specific_creative_id,country,publisher_name\n111111l2210,111111l2136,10l176,1l1007802,nibbled,\"2016-03-02 10:11:36\",127.0.0.1,\"2016-06-17 19:13:09\",127.0.0.1,,,0,0,0,GB,apipublisher123\n" } }, "brands_Export Conversions_200_response": { "response": { "value": "conversion_id,campaign_id,publisher_id,conversion_date,conversion_date_time,click_time,click_date,click_date_time,currency,advertiser_reference,conversion_reference,referer_ip,source_referer,campaign_title,publisher_name,conversion_status,conversion_lag,value,commission,publisher_commission,creative_type,creative_id,specific_creative_id,customer_type,was_disputed,cookie_id,country,currency_original,currency_conversion_rate,customer_reference,camref\n111111l3919676,10l176,1l1007802,2016-03-02,\"2016-03-02 10:22:02\",10:11:36,2016-03-02,\"2016-03-02 10:11:36\",EUR,,AUTO-57643db548165,127.0.0.1,,\"API Campaign Demo\",apipublisher123,pending,626,90.92,1.0001,0.9092,0,0,0,,,111111l2136,GB,,,,1l3v9UA\n" } }, "brands_Export Conversion Items_200_response": { "response": { "value": "conversion_id,campaign_id,publisher_id,conversion_date,conversion_date_time,click_time,click_date,click_date_time,currency,advertiser_reference,conversion_reference,referer_ip,source_referer,campaign_title,publisher_name,conversion_status,conversion_lag,value,commission,publisher_commission,creative_type,creative_id,specific_creative_id,customer_type,was_disputed,cookie_id,country,currency_original,currency_conversion_rate,conversion_item_id,sku,category,item_value,item_commission,item_publisher_commission,item_status,item_status_id,reject_reason,last_update,voucher_codes,customer_reference,camref,invoice_id,meta_item_cabin_code,meta_item_departure_date,meta_item_dest,meta_item_device,meta_item_origin,meta_item_passenger,meta_item_payment_method,meta_item_product_ids,meta_item_return_date\n111111l3919676,10l176,1l1007802,2016-03-02,\"2016-03-02 10:22:02\",10:11:36,2016-03-02,\"2016-03-02 10:11:36\",EUR,,AUTO-57643db548165,127.0.0.1,,\"API Campaign Demo\",apipublisher123,pending,626,90.92,1.0001,0.9092,0,0,0,,,111111l2136,GB,,,111111l4118583,,,90.92,1.0001,0.9092,pending,1,,\"2016-06-17 19:13:09\",,,1l3v9UA,,,,,,,,,,\n" } }, "brands_List all Meta Reports for a Campaign_200_response": { "response": { "value": { "count": 143, "execution_time": "0.09004 seconds", "reports": [ { "report": { "campaign_id": "300685", "completed_at": "null", "created_at": "2017-07-13 10:20:50", "created_by": "300740", "end_date": "2017-01-01 00:00:00", "filter": [ { "operator": "=", "property": "status", "value": "approved" } ], "filter_meta_conversion": [ { "operator": "=", "property": "item_code", "value": "P-123" } ], "filter_meta_item": [ { "operator": "in", "property": "hotel_name", "value": [ "marriott", "travelodge", "premier inn" ] } ], "id": "11l011", "job_id": "11l32133", "name": "Test Report", "output_currency": "GBP", "start_date": "2016-01-01 00:00:00", "status": "created", "updated_at": "null" } } ] } } }, "brands_Create Meta Report_201_response": { "response": { "value": { "execution_time": "0.09004 seconds", "report": { "campaign_id": "300685", "completed_at": "null", "created_at": "2017-07-13 10:20:50", "created_by": "300740", "end_date": "2017-01-01 00:00:00", "filter": [ { "operator": "=", "property": "status", "value": "approved" } ], "filter_meta_conversion": [ { "operator": "=", "property": "item_code", "value": "P-123" } ], "filter_meta_item": [ { "operator": "in", "property": "hotel_name", "value": [ "marriott", "travelodge", "premier inn" ] } ], "id": "11l011", "job_id": "11l32133", "name": "Test Report", "output_currency": "GBP", "start_date": "2016-01-01 00:00:00", "status": "created", "updated_at": "null" } } } }, "brands_Delete Meta Report_200_response": { "response": { "value": { "delete_report": { "success": true }, "execution_time": "0.09004 seconds" } } }, "brands_Retrieve Meta Report_200_response": { "response": { "value": { "execution_time": "0.09004 seconds", "report": { "campaign_id": "300685", "completed_at": "null", "created_at": "2017-07-13 10:20:50", "created_by": "300740", "end_date": "2017-01-01 00:00:00", "filter": [ { "operator": "=", "property": "status", "value": "approved" } ], "filter_meta_conversion": [ { "operator": "=", "property": "item_code", "value": "P-123" } ], "filter_meta_item": [ { "operator": "in", "property": "hotel_name", "value": [ "marriott", "travelodge", "premier inn" ] } ], "id": "11l011", "job_id": "11l32133", "name": "Test Report", "output_currency": "GBP", "start_date": "2016-01-01 00:00:00", "status": "created", "updated_at": "null" } } } }, "brands_View Meta Report Results_200_response": { "response": { "value": { "execution_time": "0.09004 seconds", "report_result": { "{\"hotel_name\":\"marriott\"}": { "commission": 268761.889889, "count": 3, "currency": "JPY", "ecpa": 11654146.437911, "order_value": 3839455.569847, "partner_commission": 268761.889889 } } } } }, "brands_List Meta Values_200_response": { "response": { "value": { "meta_values": { "conversion": { "conversion_key_name_1": [ "value_1", "value_2", "value_3" ] }, "item": { "item_key_name_1": [ "value_1", "value_2", "value_3" ] } } } } }, "brands_List Meta Whitelist Keys_200_response": { "response": { "value": { "whitelist": { "conversion": [ "conversion_key_name_1", "conversion_key_name_2" ], "item": [ "item_key_name_1", "item_key_name_2" ] } } } }, "brands_get-incidents_200_response": { "Incidents": { "value": { "limit": 1, "cursor_id": "1234l12345678", "incidents": [ { "id": "1234l12345678", "metric": "conversion_value", "type": "partner", "date": "2019-11-01", "time_window": 1, "partner": { "id": "1001l1111", "name": "PZ Finance" }, "status": "active", "created_at": "2020-04-01T00:00:00.000Z", "deleted_at": "2020-04-01T00:00:00.000Z" } ], "hypermedia": { "pagination": { "previous_page": "v2/campaigns/111111/fraud/incidents?limit=1&cursor_id=1234l12345677", "next_page": "v2/campaigns/111111/fraud/incidents?limit=1&cursor_id=1234l12345679" } } } } }, "brands_get-incidents_400_response": { "Bad Status": { "value": { "error": { "errors": [ { "type": "error", "code": "invalid_status", "message": "No status with the name `status` was found" } ], "code": 400, "message": "Bad Request" } } }, "Bad Metric": { "value": { "error": { "errors": [ { "type": "error", "code": "invalid_metric", "message": "No metric with the name `metric` was found" } ], "code": 400, "message": "Bad Request" } } }, "Bad Metric Type": { "value": { "error": { "errors": [ { "type": "error", "code": "invalid_metric_type", "message": "No metric type of `metric_type` was found" } ], "code": 400, "message": "Bad Request" } } }, "Bad Request": { "value": { "error": { "errors": [ { "type": "error", "code": "invalid_params", "message": "If you specify a metric filter, you must also specify type" } ], "code": 400, "message": "Bad Request" } } } }, "brands_get-incidents_403_response": { "Unauthorised": { "value": { "error": { "errors": [ { "type": "error", "code": "unauthorised", "message": "Feature 'fraud_detection' not enabled for this Network" } ], "code": 403, "message": "Forbidden" } } } }, "brands_get-incidents_503_response": { "Fraud Service Unavailable": { "value": { "error": { "errors": [ { "type": "error", "code": "remote_service_unavailable", "message": "The remote service 'Fraud Detection' is currently unavailable" } ], "code": 503, "message": "Remote Service Unavailable" } } } }, "brands_get-fraud-metrics_403_response": { "Unauthorised": { "value": { "error": { "errors": [ { "type": "error", "code": "unauthorised", "message": "Feature 'fraud_detection' not enabled for this Network" } ], "code": 403, "message": "Forbidden" } } } }, "brands_get-fraud-metrics_503_response": { "Fraud Service Unavailable": { "value": { "error": { "errors": [ { "type": "error", "code": "remote_service_unavailable", "message": "The remote service 'Fraud Detection' is currently unavailable" } ], "code": 503, "message": "Remote Service Unavailable" } } } }, "brands_get-incident_200_response": { "Volume Clicks Incident": { "value": { "incident": { "id": "1234l12345678", "metric": "volume_clicks", "type": "partner", "date": "2019-11-01", "time_window": 1, "partner": { "id": "1001l1111", "name": "PZ Finance" }, "status": "active", "created_at": "2020-04-01T00:00:00.000Z", "deleted_at": "2020-04-01T00:00:00.000Z", "data": { "threshold": 100, "value": 150 } }, "hypermedia": { "links": { "reject-partner": "v2/campaigns/111111/fraud/incidents/1234l12345678/reject-partner" } } } }, "Volume Conversions Incident": { "value": { "incident": { "id": "1234l12345678", "metric": "volume_conversions", "type": "partner", "date": "2019-11-01", "time_window": 1, "partner": { "id": "1001l1111", "name": "PZ Finance" }, "status": "active", "created_at": "2020-04-01T00:00:00.000Z", "deleted_at": "2020-04-01T00:00:00.000Z", "data": { "threshold": 101, "value": 150 } }, "hypermedia": { "links": { "reject-partner": "v2/campaigns/111111/fraud/incidents/1234l12345678/reject-partner" } } } }, "Conversion Ratio Incident": { "value": { "incident": { "id": "1234l12345678", "metric": "conversion_ratio", "type": "partner", "date": "2019-11-01", "time_window": 1, "partner": { "id": "1001l1111", "name": "PZ Finance" }, "status": "active", "created_at": "2020-04-01T00:00:00.000Z", "deleted_at": "2020-04-01T00:00:00.000Z", "data": { "threshold": 100, "value": 150 } }, "hypermedia": { "links": { "reject-partner": "v2/campaigns/111111/fraud/incidents/1234l12345678/reject-partner" } } } }, "Conversion Value Incident": { "value": { "incident": { "id": "1234l12345678", "metric": "conversion_value", "type": "partner", "date": "2019-11-01", "time_window": 1, "partner": { "id": "1001l1111", "name": "PZ Finance" }, "status": "active", "created_at": "2020-04-01T00:00:00.000Z", "deleted_at": "2020-04-01T00:00:00.000Z", "data": { "conversion_reference": "1111l1234", "threshold": 100, "value": 150, "currency": "USD", "conversion_items": [ { "id": "item1", "sku": "skuValue1", "category": "categoryValue1", "status": "approved" }, { "id": "item2", "sku": "skuValue2", "category": "categoryValue2", "status": "pending" } ] } }, "hypermedia": { "links": { "reject-conversions": "v2/campaigns/111111/fraud/incidents/1234l12345678/reject-conversions", "pend-conversions": "v2/campaigns/111111/fraud/incidents/1234l12345678/pend-conversions", "reject-partner": "v2/campaigns/111111/fraud/incidents/1234l12345678/reject-partner" } } } }, "Time To Conversion Incident": { "value": { "incident": { "id": "1234l12345678", "metric": "ttc", "type": "partner", "date": "2019-11-01", "time_window": 1, "partner": { "id": "1001l1111", "name": "PZ Finance" }, "status": "active", "created_at": "2020-04-01T00:00:00.000Z", "deleted_at": "2020-04-01T00:00:00.000Z", "data": { "conversion_reference": "1111l1234", "threshold": 100, "value": 150, "conversion_items": [ { "id": "item1", "sku": "skuValue1", "category": "categoryValue1", "status": "approved" }, { "id": "item2", "sku": "skuValue2", "category": "categoryValue2", "status": "pending" } ] } }, "hypermedia": { "links": { "reject-conversions": "v2/campaigns/111111/fraud/incidents/1234l12345678/reject-conversions", "pend-conversions": "v2/campaigns/111111/fraud/incidents/1234l12345678/pend-conversions", "reject-partner": "v2/campaigns/111111/fraud/incidents/1234l12345678/reject-partner" } } } }, "Identical Purchases Incident": { "value": { "incident": { "id": "1234l12345678", "metric": "basket_variability_sku", "type": "partner", "date": "2019-11-01", "time_window": 1, "partner": { "id": "1001l1111", "name": "PZ Finance" }, "status": "active", "created_at": "2020-04-01T00:00:00.000Z", "deleted_at": "2020-04-01T00:00:00.000Z", "data": { "threshold": 200, "value": 245, "total": 1000, "conversions": [ { "conversion_reference": "1111l1234", "count": 245, "items": [ { "id": "item1", "sku": "skuValue1", "category": "categoryValue1", "status": "approved" }, { "id": "item2", "sku": "skuValue2", "category": "categoryValue2", "status": "pending" } ] } ] } }, "hypermedia": { "links": { "reject-partner": "v2/campaigns/111111/fraud/incidents/1234l12345678/reject-partner" } } } } }, "brands_get-incident_403_response": { "Unauthorised": { "value": { "error": { "errors": [ { "type": "error", "code": "unauthorised", "message": "Feature 'fraud_detection' not enabled for this Network" } ], "code": 403, "message": "Forbidden" } } } }, "brands_get-incident_404_response": { "basic": { "value": { "error": { "errors": [ { "type": "error", "code": "entity_not_found", "message": "Incident not found for id 'string'" } ], "code": 404, "message": "Not Found" } } } }, "brands_get-incident_503_response": { "Fraud Service Unavailable": { "value": { "error": { "errors": [ { "type": "error", "code": "remote_service_unavailable", "message": "The remote service 'Fraud Detection' is currently unavailable" } ], "code": 503, "message": "Remote Service Unavailable" } } } }, "brands_delete-incident_403_response": { "Unauthorised": { "value": { "error": { "errors": [ { "type": "error", "code": "unauthorised", "message": "Feature 'fraud_detection' not enabled for this Network" } ], "code": 403, "message": "Forbidden" } } } }, "brands_delete-incident_404_response": { "Not Found": { "value": { "error": { "errors": [ { "type": "error", "code": "entity_not_found", "message": "Incident not found for id 'string'" } ], "code": 404, "message": "Not Found" } } } }, "brands_delete-incident_503_response": { "Fraud Detection Service Unavailable": { "value": { "error": { "errors": [ { "type": "error", "code": "remote_service_unavailable", "message": "The remote service 'Fraud Detection' is currently unavailable" } ], "code": 503, "message": "Remote Service Unavailable" } } }, "API Service Unavailable": { "value": { "error": { "errors": [ { "type": "error", "code": "remote_service_unavailable", "message": "The remote service 'API' is currently unavailable" } ], "code": 503, "message": "Remote Service Unavailable" } } } }, "brands_get-incidents-aggregation_200_response": { "Incidents": { "value": { "data": [ { "date_time_range": { "start": "2019-10-02T00:00:00.000Z", "end": "2019-10-03T00:00:00.000Z" }, "volume_clicks": 10, "volume_conversions": 20, "conversion_ratio": 15, "basket_variability_sku": 25, "conversion_value": 30, "ttc": 35 }, { "date_time_range": { "start": "2019-10-03T00:00:00.000Z", "end": "2019-10-04T00:00:00.000Z" }, "volume_clicks": 11, "volume_conversions": 21, "conversion_ratio": 16, "basket_variability_sku": 26, "conversion_value": 31, "ttc": 36 }, { "date_time_range": { "start": "2019-10-04T00:00:00.000Z", "end": "2019-10-05T00:00:00.000Z" }, "volume_clicks": 12, "volume_conversions": 22, "conversion_ratio": 17, "basket_variability_sku": 27, "conversion_value": 32, "ttc": 37 } ] } } }, "brands_get-incidents-aggregation_403_response": { "Unauthorised": { "value": { "error": { "errors": [ { "type": "error", "code": "unauthorised", "message": "Feature 'fraud_detection' not enabled for this Network" } ], "code": 403, "message": "Forbidden" } } } }, "brands_get-incidents-aggregation_404_response": { "basic": { "value": { "error": { "errors": [ { "type": "error", "code": "entity_not_found", "message": "Incident not found for id 'string'" } ], "code": 404, "message": "Not Found" } } } }, "brands_get-incidents-aggregation_503_response": { "Fraud Service Unavailable": { "value": { "error": { "errors": [ { "type": "error", "code": "remote_service_unavailable", "message": "The remote service 'Fraud Detection' is currently unavailable" } ], "code": 503, "message": "Remote Service Unavailable" } } } }, "brands_fraud-reject-partner_400_response": { "Unable to Reject Partner": { "value": { "error": { "errors": [ { "type": "error", "code": "partner_not_rejected", "message": "The Partner was not rejected" } ], "code": 400, "message": "Bad Request" } } } }, "brands_fraud-reject-partner_403_response": { "Unauthorised": { "value": { "error": { "errors": [ { "type": "error", "code": "unauthorised", "message": "Feature 'fraud_detection' not enabled for this Network" } ], "code": 403, "message": "Forbidden" } } } }, "brands_fraud-reject-partner_404_response": { "Not Found": { "value": { "error": { "errors": [ { "type": "error", "code": "entity_not_found", "message": "Incident not found for id 'string'" } ], "code": 404, "message": "Not Found" } } } }, "brands_fraud-reject-partner_503_response": { "Fraud Detection Service Unavailable": { "value": { "error": { "errors": [ { "type": "error", "code": "remote_service_unavailable", "message": "The remote service 'Fraud Detection' is currently unavailable" } ], "code": 503, "message": "Remote Service Unavailable" } } }, "API Service Unavailable": { "value": { "error": { "errors": [ { "type": "error", "code": "remote_service_unavailable", "message": "The remote service 'API' is currently unavailable" } ], "code": 503, "message": "Remote Service Unavailable" } } } }, "brands_get-whitelisted-partners_403_response": { "Unauthorised": { "value": { "error": { "errors": [ { "type": "error", "code": "unauthorised", "message": "Feature 'fraud_detection' not enabled for this Network" } ], "code": 403, "message": "Forbidden" } } } }, "brands_get-whitelisted-partners_503_response": { "Fraud Service Unavailable": { "value": { "error": { "errors": [ { "type": "error", "code": "remote_service_unavailable", "message": "The remote service 'Fraud Detection' is currently unavailable" } ], "code": 503, "message": "Remote Service Unavailable" } } } }, "brands_fraud-whitelist-partner_400_response": { "Unable to Whitelist Partner": { "value": { "error": { "errors": [ { "type": "error", "code": "partner_not_whitelisted", "message": "The partner was not whitelisted" } ], "code": 400, "message": "Bad Request" } } } }, "brands_fraud-whitelist-partner_403_response": { "Unauthorised": { "value": { "error": { "errors": [ { "type": "error", "code": "unauthorised", "message": "Feature 'fraud_detection' not enabled for this Network" } ], "code": 403, "message": "Forbidden" } } } }, "brands_fraud-whitelist-partner_404_response": { "Not Found": { "value": { "error": { "errors": [ { "type": "error", "code": "entity_not_found", "message": "Partner not found for id '{id}'" } ], "code": 404, "message": "Not Found" } } } }, "brands_fraud-whitelist-partner_503_response": { "Fraud Detection Service Unavailable": { "value": { "error": { "errors": [ { "type": "error", "code": "remote_service_unavailable", "message": "The remote service 'Fraud Detection' is currently unavailable" } ], "code": 503, "message": "Remote Service Unavailable" } } }, "API Service Unavailable": { "value": { "error": { "errors": [ { "type": "error", "code": "remote_service_unavailable", "message": "The remote service 'API' is currently unavailable" } ], "code": 503, "message": "Remote Service Unavailable" } } } }, "brands_delete-whitelisted-partner_403_response": { "Unauthorised": { "value": { "error": { "errors": [ { "type": "error", "code": "unauthorised", "message": "Feature 'fraud_detection' not enabled for this Network" } ], "code": 403, "message": "Forbidden" } } } }, "brands_delete-whitelisted-partner_404_response": { "Not Found": { "value": { "error": { "errors": [ { "type": "error", "code": "entity_not_found", "message": "Partner not found for id 'string'" } ], "code": 404, "message": "Not Found" } } } }, "brands_delete-whitelisted-partner_503_response": { "Fraud Detection Service Unavailable": { "value": { "error": { "errors": [ { "type": "error", "code": "remote_service_unavailable", "message": "The remote service 'Fraud Detection' is currently unavailable" } ], "code": 503, "message": "Remote Service Unavailable" } } }, "API Service Unavailable": { "value": { "error": { "errors": [ { "type": "error", "code": "remote_service_unavailable", "message": "The remote service 'API' is currently unavailable" } ], "code": 503, "message": "Remote Service Unavailable" } } } }, "brands_fraud-reject-conversions_403_response": { "Unauthorised": { "value": { "error": { "errors": [ { "type": "error", "code": "unauthorised", "message": "Feature 'fraud_detection' not enabled for this Network" } ], "code": 403, "message": "Forbidden" } } } }, "brands_fraud-reject-conversions_404_response": { "Not Found": { "value": { "error": { "errors": [ { "type": "error", "code": "entity_not_found", "message": "Incident not found for id 'string'" } ], "code": 404, "message": "Not Found" } } } }, "brands_fraud-reject-conversions_503_response": { "Fraud Detection Service Unavailable": { "value": { "error": { "errors": [ { "type": "error", "code": "remote_service_unavailable", "message": "The remote service 'Fraud Detection' is currently unavailable" } ], "code": 503, "message": "Remote Service Unavailable" } } }, "API Service Unavailable": { "value": { "error": { "errors": [ { "type": "error", "code": "remote_service_unavailable", "message": "The remote service 'API' is currently unavailable" } ], "code": 503, "message": "Remote Service Unavailable" } } } }, "brands_fraud-pend-conversions_403_response": { "Unauthorised": { "value": { "error": { "errors": [ { "type": "error", "code": "unauthorised", "message": "Feature 'fraud_detection' not enabled for this Network" } ], "code": 403, "message": "Forbidden" } } } }, "brands_fraud-pend-conversions_404_response": { "Not Found": { "value": { "error": { "errors": [ { "type": "error", "code": "entity_not_found", "message": "Incident not found for id 'string'" } ], "code": 404, "message": "Not Found" } } } }, "brands_fraud-pend-conversions_503_response": { "Fraud Detection Service Unavailable": { "value": { "error": { "errors": [ { "type": "error", "code": "remote_service_unavailable", "message": "The remote service 'Fraud Detection' is currently unavailable" } ], "code": 503, "message": "Remote Service Unavailable" } } }, "API Service Unavailable": { "value": { "error": { "errors": [ { "type": "error", "code": "remote_service_unavailable", "message": "The remote service 'API' is currently unavailable" } ], "code": 503, "message": "Remote Service Unavailable" } } } }, "brands_get-incident-partners_400_response": { "Bad Status": { "value": { "error": { "errors": [ { "type": "error", "code": "invalid_status", "message": "No status with the name `status` was found" } ], "code": 400, "message": "Bad Request" } } }, "Bad Metric": { "value": { "error": { "errors": [ { "type": "error", "code": "invalid_metric", "message": "No metric with the name `metric` was found" } ], "code": 400, "message": "Bad Request" } } }, "Bad Metric Type": { "value": { "error": { "errors": [ { "type": "error", "code": "invalid_metric_type", "message": "No metric type of `metric_type` was found" } ], "code": 400, "message": "Bad Request" } } }, "Bad Request": { "value": { "error": { "errors": [ { "type": "error", "code": "invalid_params", "message": "If you specify a metric filter, you must also specify type" } ], "code": 400, "message": "Bad Request" } } } }, "brands_get-incident-partners_403_response": { "Unauthorised": { "value": { "error": { "errors": [ { "type": "error", "code": "unauthorised", "message": "Feature 'fraud_detection' not enabled for this Network" } ], "code": 403, "message": "Forbidden" } } } }, "brands_get-incident-partners_503_response": { "Fraud Service Unavailable": { "value": { "error": { "errors": [ { "type": "error", "code": "remote_service_unavailable", "message": "The remote service 'Fraud Detection' is currently unavailable" } ], "code": 503, "message": "Remote Service Unavailable" } } } }, "brands_Delete Campaign Group Saved Report_200_response": { "response": { "value": { "count": 1, "errors": [], "execution_time": "0.23640 seconds", "filter_sets": [ { "filter_set": { "campaign_id": "42C32", "created_at": "2016-03-10T19:02:35Z", "created_by": "31v02", "data": "", "is_default": false, "name": "My saved report", "reporting_filter_set_id": "gh51kn", "updated_at": "2016-03-15T15:38:11Z", "updated_by": "68i34", "user_id": "53vc3a" } } ] } } }, "brands_Retrieve Campaign Group Saved Report_200_response": { "response": { "value": { "count": 1, "execution_time": "0.23640 seconds", "filter_sets": [ { "filter_set": { "campaign_id": "42C32", "created_at": "2016-03-10T19:02:35Z", "created_by": "31v02", "data": "", "is_default": false, "name": "My filter set", "reporting_filter_set_id": "gh51kn", "updated_at": "2016-03-15T15:38:11Z", "updated_by": "68i34", "user_id": "53vc3a" } } ] } } }, "brands_Update Campaign Group Saved Report_200_response": { "response": { "value": { "count": 1, "errors": [], "execution_time": "0.23640 seconds", "filter_sets": [ { "filter_set": { "campaign_id": "42C32", "created_at": "2016-03-10T19:02:35Z", "created_by": "31v02", "data": "", "is_default": false, "name": "My filter set", "reporting_filter_set_id": "gh51kn", "updated_at": "2016-03-15T15:38:11Z", "updated_by": "68i34", "user_id": "53vc3a" } } ] } } }, "brands_postClicksCount_request": { "date_time_ranges": [ { "start": "2019-10-01T00:00:00+00:00", "end": "2019-10-03T00:00:00+00:00" } ], "scope": { "campaigns": [ "111111l10" ] }, "metrics": [ "total_clicks" ], "filter_by": [ { "field": "country", "value": "US", "operator": "EQUALS" }, { "field": "device_id", "value": 5, "operator": "EQUALS", "not": true } ], "timezone": "GMT" }, "brands_postClicksExplode_request": { "date_time_ranges": [ { "start": "2019-10-01T00:00:00+00:00", "end": "2019-10-03T00:00:00+00:00" } ], "scope": { "campaigns": [ "111111l10" ] }, "metrics": [ "total_clicks" ], "group_by": [ "device" ], "filter_by": [ { "field": "country", "value": "US", "operator": "EQUALS" }, { "field": "device_id", "value": 5, "operator": "EQUALS", "not": true } ], "order_by": [ { "field": "total_clicks", "direction": "DESCENDING" } ], "interval": { "field": "date_time", "period": "P1D" }, "include_total_row_count": false, "timezone": "GMT", "top": 2 }, "brands_postClicksFilter_request": { "date_time_ranges": [ { "start": "2019-10-01T00:00:00+00:00", "end": "2019-10-03T00:00:00+00:00" } ], "scope": { "campaigns": [ "111111l10" ] }, "group_by": [ "device" ], "filter_by": [ { "field": "country", "value": "US", "operator": "EQUALS" }, { "field": "device_id", "value": 5, "operator": "EQUALS", "not": true } ], "order_by": [ { "field": "total_clicks", "direction": "DESCENDING" } ], "top": 2, "include_total_row_count": false, "timezone": "GMT" }, "brands_postClicksTimeseries_request": { "date_time_ranges": [ { "start": "2019-10-01T00:00:00+00:00", "end": "2019-10-03T00:00:00+00:00" } ], "scope": { "campaigns": [ "111111l10" ] }, "metrics": [ "total_clicks" ], "filter_by": [ { "field": "country", "value": "US", "operator": "EQUALS" }, { "field": "device_id", "value": 5, "operator": "EQUALS", "not": true } ], "interval": { "field": "date_time", "period": "P1D" }, "timezone": "GMT", "zerofill": false }, "brands_postConversionsCount_request": { "date_time_ranges": [ { "start": "2019-10-01T00:00:00+00:00", "end": "2019-10-03T00:00:00+00:00" } ], "scope": { "campaigns": [ "111111l10" ] }, "metrics": [ "total_commission" ], "filter_by": [ { "field": "country", "value": "US", "operator": "EQUALS" }, { "field": "device_id", "value": 5, "operator": "EQUALS", "not": true } ], "output_currency": "GBP", "timezone": "GMT" }, "brands_postConversionsExplode_request": { "date_time_ranges": [ { "start": "2019-10-01T00:00:00+00:00", "end": "2019-10-03T00:00:00+00:00" } ], "scope": { "campaigns": [ "111111l10" ] }, "metrics": [ "total_commission" ], "group_by": [ "partner" ], "filter_by": [ { "field": "country", "value": "US", "operator": "EQUALS" }, { "field": "device_id", "value": 5, "operator": "EQUALS", "not": true } ], "order_by": [ { "field": "total_commission", "direction": "DESCENDING" } ], "interval": { "field": "date_time", "period": "P1D" }, "output_currency": "USD", "top": 2, "include_total_row_count": false, "timezone": "GMT" }, "brands_postConversionsFilter_request": { "date_time_ranges": [ { "start": "2019-10-01T00:00:00+00:00", "end": "2019-10-03T00:00:00+00:00" } ], "scope": { "campaigns": [ "111111l10" ] }, "group_by": [ "partner" ], "filter_by": [ { "field": "country", "value": "US", "operator": "EQUALS" }, { "field": "device_id", "value": 5, "operator": "EQUALS", "not": true } ], "order_by": [ { "field": "total_commission", "direction": "DESCENDING" } ], "interval": { "field": "date_time", "period": "P1D" }, "output_currency": "USD", "top": 10, "include_total_row_count": false, "timezone": "GMT" }, "brands_postConversionsTimeseries_request": { "date_time_ranges": [ { "start": "2019-10-01T00:00:00+00:00", "end": "2019-10-03T00:00:00+00:00" } ], "scope": { "campaigns": [ "111111l10" ] }, "metrics": [ "total_commission" ], "filter_by": [ { "field": "country", "value": "US", "operator": "EQUALS" }, { "field": "device_id", "value": 5, "operator": "EQUALS", "not": true } ], "interval": { "field": "date_time", "period": "P1D" }, "output_currency": "GBP", "timezone": "GMT", "zerofill": false }, "brands_postImpressionsCount_request": { "date_time_ranges": [ { "start": "2019-10-01T00:00:00+00:00", "end": "2019-10-03T00:00:00+00:00" } ], "scope": { "campaigns": [ "111111l10" ] }, "metrics": [ "total_impressions" ], "filter_by": [ { "field": "device_id", "value": 5, "operator": "EQUALS", "not": true } ], "timezone": "GMT" }, "brands_postImpressionsExplode_request": { "date_time_ranges": [ { "start": "2019-10-01T00:00:00+00:00", "end": "2019-10-03T00:00:00+00:00" } ], "scope": { "campaigns": [ "111111l10" ] }, "metrics": [ "total_impressions" ], "group_by": [ "partner" ], "filter_by": [ { "field": "device_id", "value": 5, "operator": "EQUALS" } ], "order_by": [ { "field": "total_impressions", "direction": "DESCENDING" } ], "interval": { "field": "date_time", "period": "P1D" }, "top": 10, "include_total_row_count": false, "timezone": "GMT" }, "brands_postImpressionsFilter_request": { "date_time_ranges": [ { "start": "2019-10-01T00:00:00+00:00", "end": "2019-10-03T00:00:00+00:00" } ], "scope": { "campaigns": [ "111111l10" ] }, "group_by": [ "partner" ], "filter_by": [ { "field": "device_id", "value": 5, "operator": "EQUALS" } ], "order_by": [ { "field": "total_impressions", "direction": "DESCENDING" } ], "top": 10, "include_total_row_count": false, "timezone": "GMT" }, "brands_postImpressionsTimeseries_request": { "date_time_ranges": [ { "start": "2019-10-01T00:00:00+00:00", "end": "2019-10-03T00:00:00+00:00" } ], "scope": { "campaigns": [ "111111l10" ] }, "metrics": [ "total_impressions" ], "filter_by": [ { "field": "device_id", "value": 5, "operator": "EQUALS" } ], "interval": { "field": "date_time", "period": "P1D" }, "timezone": "GMT", "zerofill": false }, "brands_Retrieve a List of Campaigns in a Campaign Group_200_response": { "response": { "value": { "data": [ { "campaign_id": "111111l6", "title": "campaign_title" } ] } } }, "brands_createPartnerizeTag_201_response": { "response": { "value": { "data": { "id": "111111l35", "scope": { "brand": "111111l2" }, "name": "my-tag-website", "active": true, "created_at": "2020-07-22T12:23:58.000Z", "created_by": "111111l1", "last_modified_at": "2020-07-22T12:23:58.000Z", "last_modified_by": "111111l1", "url": "https://pzapi-kg.com/b/1100l12/1011l1.js" } } } }, "brands_updatePartnerizeTag_200_response": { "response": { "value": { "data": { "id": "111111l35", "scope": { "brand": "111111l2" }, "name": "my-tag-website", "active": true, "created_at": "2020-07-22T12:23:58.000Z", "created_by": "111111l1", "last_modified_at": "2020-07-22T12:23:58.000Z", "last_modified_by": "111111l1", "url": "https://pzapi-kg.com/b/1100l12/1011l1.js" } } } }, "brands_enablePartnerizeTagFeature_request": { "First Party Tracking": { "value": { "name": "first-party-tracking", "config": null } }, "Revlifter Tag": { "value": { "name": "revlifter", "config": { "uuid": "5ad7ef40-a4bd-4d34-b522-1eee9e127dc6" } } }, "Upsellit Tag": { "value": { "name": "upsellit", "config": { "usi_launch_tag": "partnerize" } } }, "Intently Tag": { "value": { "name": "intent.ly", "config": { "domain": "test.com" } } } }, "brands_enablePartnerizeTagFeature_201_response": { "First Party Tracking": { "value": { "data": { "name": "first-party-tracking", "config": null } } }, "Revlifter Tag": { "value": { "data": { "name": "revlifter", "config": { "uuid": "5ad7ef40-a4bd-4d34-b522-1eee9e127dc6" } } } }, "Upsellit Tag": { "value": { "data": { "name": "upsellit", "config": { "usi_launch_tag": "partnerize" } } } } }, "brands_updateCurrentUser_200_response": { "response": { "value": { "data": { "user_id": "111111l63", "email_verified": false, "email": "user@test.com" } } } }, "brands_List all Verticals_200_response": { "response": { "value": { "verticals": [ { "vertical": { "description": "App downloads", "name": "Downloads", "vertical_id": 1 } } ] } } }, "brands_List all Locales_200_response": { "response": { "value": { "locales": [ { "locale": { "code": "en", "printable_name": "English" } } ] } } }, "brands_List all Countries_200_response": { "response": { "value": { "countries": [ { "country": { "area_sq_km": 468, "capital": "Andorra la Vella", "continent_iso": "EU", "continent_name": "Europe", "currency_iso": "EUR", "east": "42.656043", "fips_code": "AN", "geoname_id": 3041565, "iso": "AD", "iso3": "AND", "iso_numeric": "020", "languages": "ca", "north": "42.656043", "population": 84000, "printable_name": "Andorra", "ref_country_id": 1, "south": "42.656043", "west": "42.656043", "zone": "Outside EU VAT area" } } ] } } }, "brands_List all Currencies_200_response": { "response": { "value": { "currencies": [ { "currency": { "currency_id": 51, "iso": "GBP", "minor_unit": 2, "name": "Pound Sterling" } } ] } } }, "brands_List Country Currency Combinations_200_response": { "response": { "value": [ { "currency_country": { "currency_iso": { "AED": { "country_iso": [ "GB" ] }, "AUD": { "country_iso": [ "AU", "CN", "HK", "LV", "US" ] } } } } ] } }, "brands_List US States_200_response": { "response": { "value": { "us_states": [ { "us_state": { "code": "AZ", "printable_name": "Alabama" } } ] } } }, "brands_List all Timezones_200_response": { "response": { "value": { "timezones": [ { "timezone": { "description": "[GMT-10:00] Pacific/Tahiti", "local_time": "", "name": "Pacific/Tahiti", "ref_timezone_id": "3", "utc_offset": "-36000" } } ] } } }, "brands_List all Devices_200_response": { "response": { "value": { "devices": [ { "device": { "ref_device_id": 2, "title": "Desktop", "description": "Standard desktop web", "skip_invoice": 0, "skip_selfbill": 0, "skip_override": 0, "key": "desktop" } } ] } } }, "brands_List all Campaign Extra Fields_200_response": { "response": { "value": { "campaign_extra_fields": [ { "campaign_extra_field": { "campaign_extra_field_id": 102, "field_comment": "campaign level country setting", "field_default_value": "nil", "field_name": "country" } } ] } } }, "brands_List all User Contexts_200_response": { "response": { "value": { "user_contexts": [ { "user_context": { "ref_user_context_id": 1, "title": "Other", "description": "Other user context", "skip_invoice": 0, "skip_selfbill": 0, "skip_override": 0, "key": "other" } } ] } } }, "brands_List Traffic Sources_200_response": { "response": { "value": { "traffic_sources": [ { "traffic_source": { "ref_traffic_source_id": 1, "title": "Other", "description": "Other traffic source", "skip_invoice": 0, "skip_selfbill": 0, "skip_override": 0 } } ] } } }, "brands_List Website Types_200_response": { "response": { "value": { "website_types": [ { "website_type": { "description": null, "name": "Blog", "website_id": "1" } } ] } } }, "brands_List all Promotional Method_200_response": { "response": { "value": { "promotional_methods": [ { "promotional_method": { "description": "Pay per click", "name": "PPC", "promotional_method_id": 1 } } ] } } }, "brands_List Conversion Type_200_response": { "response": { "value": { "conversion_types": [ { "conversion_type": { "available_to_invoice": "y", "available_to_selfbill": "y", "conversion_type": "standard", "conversion_type_id": 1, "description": "Standard Transaction", "exclude_from_override_rules": "y" } } ] } } }, "brands_List Conversion Metrics_200_response": { "response": { "value": { "conversion_metrics": [ { "conversion_metrics": { "ref_conversion_metric_id": 3, "title": "App Download", "description": "", "skip_invoice": 0, "skip_selfbill": 0, "skip_override": 0 } } ] } } }, "brands_List Partnership Models_200_response": { "response": { "value": { "partnership_models": [ { "partnership_model": { "ref_partnership_model_id": 2, "title": "CPA", "description": "Cost per acquisition", "skip_invoice": 0, "skip_selfbill": 0, "skip_override": 0 } } ] } } } }, "partners": { "partners_List Campaigns_200_response": { "response": { "value": { "campaigns": [ { "campaign": { "advertiser_id": "10l110", "allow_deep_linking": "y", "allow_third_party_pixel": "y", "append_url_parameters": "", "associated_campaigns": "", "automated_invoicing_date": 4, "automated_invoicing_po_number": null, "auto_approve_publisher": "y", "auto_rejected_ips": null, "budget_summary_interval": null, "budget_summary_start_time": null, "campaign_currency_conversions": [], "campaign_custom_terms_and_conditions_id": "10l176", "campaign_custom_terms_and_conditions_title": "Some fancy title", "campaign_id": "10l176", "campaign_languages": null, "campaign_logo": "http://performancehorizon.com/logo.png", "campaign_notes": "", "campaign_overloads": [], "commission_by_meta_label": "[ \"label 1\",\"label 2\" ]", "commission_by_meta": "[ \"field_1\",\"field_2\" ]", "commissions": [], "conversion_hiatus_period": 7, "conversion_type": "sale", "cookie_period": 0, "cookie_status": null, "default_commission_rate": "5", "default_currency": "GBP", "default_override": 10, "deferred_lead_submission": null, "description": { "en": "Awesome new campaign" }, "destination_url": "http://www.performancehorizon.com", "dont_consolidate": "y", "dont_invoice": "y", "extra_restricted_deep_linking": "", "force_approve_period": 0, "hidden_campaign": "y", "invoice_address_1": null, "invoice_address_2": null, "invoice_address_3": null, "invoice_address_4": null, "invoice_address_country": null, "invoice_address_postcode": null, "invoice_company": null, "invoice_contact": null, "invoice_only": null, "ip_tracking_time": 0, "is_cpc": "y", "lead_confirmation_url_fail": "", "lead_confirmation_url_success": "", "multiple_conversions_per_click": "n", "network_fee": null, "pay_publisher_directly": "y", "payment_date": null, "prepend_url_string": "http://google.com", "publisher_status": "a", "recurring_payment_setup": "y", "report_meta_purge_period": null, "reporting_timezone": "Australia/Sydney", "restricted_deep_linking": "y", "secure_tracking": "y", "status": "a", "terms": { "en": { "terms": "Important campaign terms and conditions" } }, "test_mode": "y", "title": "PHG Aff Demo", "tq_auto_approve": 60, "tq_enabled": "y", "tq_enabled_publishers": "", "tracking_method": "s2s", "tracking_subdomain": null, "unique_conversion_refs": "y", "vertical_id": 10, "vertical_name": "Other", "week_start": "Monday" } } ] } } }, "partners_Request Access to Campaigns_200_response": { "response": { "value": { "campaigns": [ { "campaign": { "advertiser_id": "10l110", "allow_deep_linking": "y", "allow_third_party_pixel": "y", "append_url_parameters": "", "associated_campaigns": "", "automated_invoicing_date": 4, "automated_invoicing_po_number": null, "auto_approve_publisher": "y", "auto_rejected_ips": null, "budget_summary_interval": null, "budget_summary_start_time": null, "campaign_currency_conversions": [], "campaign_custom_terms_and_conditions_id": "10l176", "campaign_custom_terms_and_conditions_title": "Some fancy title", "campaign_id": "10l176", "campaign_languages": null, "campaign_logo": "http://partnerize.com/logo.png", "campaign_notes": "", "campaign_overloads": [], "commission_by_meta_label": "[ \"label 1\",\"label 2\" ]", "commission_by_meta": "[ \"field_1\",\"field_2\" ]", "commissions": [], "conversion_hiatus_period": 7, "conversion_type": "sale", "cookie_period": 0, "cookie_status": null, "default_commission_rate": "5", "default_currency": "GBP", "default_override": 10, "deferred_lead_submission": null, "description": { "en": "Awesome new campaign" }, "destination_url": "http://www.partnerize.com", "dont_consolidate": "y", "dont_invoice": "y", "extra_restricted_deep_linking": "", "force_approve_period": 0, "hidden_campaign": "y", "invoice_address_1": null, "invoice_address_2": null, "invoice_address_3": null, "invoice_address_4": null, "invoice_address_country": null, "invoice_address_postcode": null, "invoice_company": null, "invoice_contact": null, "invoice_only": null, "ip_tracking_time": 0, "is_cpc": "y", "lead_confirmation_url_fail": "", "lead_confirmation_url_success": "", "multiple_conversions_per_click": "n", "network_fee": null, "pay_publisher_directly": "y", "payment_date": null, "prepend_url_string": "http://google.com", "publisher_status": "a", "recurring_payment_setup": "y", "report_meta_purge_period": null, "reporting_timezone": "Australia/Sydney", "restricted_deep_linking": "y", "secure_tracking": "y", "status": "a", "terms": { "en": { "terms": "Important campaign terms and conditions" } }, "test_mode": "y", "title": "Partnerize Aff Demo", "tq_auto_approve": 60, "tq_enabled": "y", "tq_enabled_publishers": "", "tracking_method": "s2s", "tracking_subdomain": null, "unique_conversion_refs": "y", "vertical_id": 10, "vertical_name": "Other", "week_start": "Monday" } } ] } } }, "partners_List Campaign Voucher Codes_200_response": { "response": { "value": { "count": 1, "commission_fields": [ "conversion_type", "customer_reference", "advertiser_reference", "country", "vertical", "sku", "cookie_status", "category", "customer_type" ], "voucher_codes": [ { "voucher_code": { "active": "y", "campaign_id": "10l176", "commission_groups": [], "description": "", "end_date_time": "2013-09-30 15:00:00", "on_expiry": "ignore", "on_invalid_user": "ignore", "start_date_time": "2013-08-31 15:00:00", "voucher_code": "promocode", "voucher_code_id": "111111l1000015" } } ] } } }, "partners_List all Creatives on each participating Campaign_200_response": { "response": { "value": { "campaign_creatives": [ { "campaign_creative": { "campaign_id": "10l176", "creatives": { "Banner": 1, "Email": 1, "Feed": 1, "HTML": 1, "HTML Form": 1, "Text Link": 1 } } } ] } } }, "partners_List Creatives on a Campaign_200_response": { "response": { "value": { "creatives": [ { "creative": { "tags": "", "active": "y", "advertiser_reference": "Promotion July 2016", "campaign_id": "10l176", "created_at": "2016-04-07 04:21:51", "created_by": "300621", "creative_id": "300441", "creative_items": [ { "tags": "", "active": "y", "campaign_id": "10l176", "content_type": "image/jpeg", "created_at": "2016-04-07 04:21:51", "created_by": "300621", "creative_item_id": "300396", "creative_type_id": 1, "custom_append_url_parameters": "", "custom_prepend_url_parameters": "", "description": "", "filename": "4fdf4b3879da1funny-animals-page.jpg", "img_url": "https://demophgconsole.partnerize.com/upload/4fdf4b3879da1funny-animals-page.jpg", "preview": "https://demo.prf.hn/preview/screativeref:300396", "specific_destination": "" } ], "creative_tracking_link": "", "creative_tracking_link_rotate": "", "creative_type_id": 1, "custom_append_url_parameters": "", "custom_prepend_url_parameters": "", "default_specific_creative_id": "300396", "description": "Demo Text", "destination": "http://www.partnerize.com", "dynamic_tracking_link": "", "end_date_time": "2013-09-30 15:00:00", "height": 360, "html_tracking_link": "", "limits": "", "preview": "https://demo.prf.hn/preview/creativeref:300442", "start_date_time": "2013-08-31 15:00:00", "width": 400 } } ] } } }, "partners_List all Available Feeds_200_response": { "response": { "value": { "campaigns": [ { "campaign": { "campaign_id": "10l176", "title": "SportsBetting", "feeds": [ { "campaign_feeds_id": "1011l10", "campaign_id": "10l176", "creative_id": "300441", "filename": "uk_destinations.csv", "filesize": 581427, "filesize_compressed": 27691, "last_processed": 1432235983, "location": "http://www.partnerize.com/", "location_compressed": "http://www.partnerize.com/", "name": "UK Destinations", "title": "SportBetting", "updated": 1432228514 } ] } } ], "count": 1, "execution_time": "0.53595 seconds" } } }, "partners_Retrieve Partner Custom Terms and Conditions_200_response": { "response": { "value": { "custom_terms": [ { "active": "y", "campaign_custom_terms_and_conditions_id": "111111l43", "campaign_id": "10l176", "created": "2019-05-29 09:18:17", "locale": "pl", "terms": "Terms and conditions content", "title": "Terms and conditions title" } ], "execution_time": "1.05973 seconds" } } }, "partners_List Campaign References_200_response": { "response": { "value": "Advertiser,Campaign,camref Leadsbox,Healthcare,6" } }, "partners_List all Partner Websites_200_response": { "response": { "value": { "websites": [ { "website": { "active": "y", "primary": "n", "description": "Demo Partner website", "publisher_id": "1l1007802", "website_country": "GB", "website_id": "11l18694", "website_name": null, "website_type": 9, "website_type_name": "PPC", "website_url": "http://www.partnerize.com", "website_vertical": 10, "website_vertical_name": "Technical" } } ] } } }, "partners_Create Partner Website_200_response": { "response": { "value": { "websites": [ { "website": { "active": "y", "primary": "n", "description": "Demo Partner website", "publisher_id": "1l1007802", "website_country": "GB", "website_id": "11l18694", "website_name": null, "website_type": 9, "website_type_name": "PPC", "website_url": "http://www.partnerize.com", "website_vertical": 10, "website_vertical_name": "Technical" } } ] } } }, "partners_Update Partner Websites_200_response": { "response": { "value": { "websites": [ { "website": { "active": "y", "primary": "n", "description": "Demo Partner website", "publisher_id": "1l1007802", "website_country": "GB", "website_id": "11l18694", "website_name": null, "website_type": 9, "website_type_name": "PPC", "website_url": "http://www.partnerize.com", "website_vertical": 10, "website_vertical_name": "Technical" } } ] } } }, "partners_Retrieve a Partner Website_200_response": { "response": { "value": { "website": { "active": "y", "primary": "n", "description": "Demo Partner website", "publisher_id": "1l1007802", "website_country": "GB", "website_id": "11l18694", "website_name": null, "website_type": 9, "website_type_name": "PPC", "website_url": "http://www.partnerize.com", "website_vertical": 10, "website_vertical_name": "Technical" } } } }, "partners_List Partner Databases_200_response": { "response": { "value": { "databases": [ { "database": { "active": "y", "creation_method": "Email", "database_id": "111111l300347", "database_name": "Partnerize Test Database", "female": 50, "male": 50, "max_age": 77, "min_age": 25, "publisher_id": "1l1007802", "size": 53000 } } ] } } }, "partners_Create Partner Database_200_response": { "response": { "value": { "databases": [ { "database": { "active": "y", "creation_method": "Email", "database_id": "111111l300347", "database_name": "PHG Test Database", "female": 50, "male": 50, "max_age": 77, "min_age": 25, "publisher_id": "1l1007802", "size": 53000 } } ] } } }, "partners_Update Partner Databases_200_response": { "response": { "value": { "databases": [ { "database": { "active": "y", "creation_method": "Email", "database_id": "111111l300347", "database_name": "Partnerize Test Database", "female": 50, "male": 50, "max_age": 77, "min_age": 25, "publisher_id": "1l1007802", "size": 53000 } } ] } } }, "partners_Retrieve a Partner Database_200_response": { "response": { "value": { "database": { "active": "y", "creation_method": "Email", "database_id": "111111l300347", "database_name": "Partnerize Test Database", "female": 50, "male": 50, "max_age": 77, "min_age": 25, "publisher_id": "1l1007802", "size": 53000 } } } }, "partners_List Transaction Queries_200_response": { "response": { "value": { "count": 5, "execution_time": "0.08001 seconds", "filters": {}, "sort": { "column": "created_at", "direction": "ASC" }, "transaction_queries": [ { "transaction_query": { "campaign": { "advertiser_id": "10l110", "campaign_id": "10l176", "created": "2017-01-01 00:00:00", "created_by": "11l16829", "default_override": "1", "hidden_campaign": "y", "last_modified": "2017-01-01 00:00:00", "network_fee": null, "payment_date": null, "reporting_timezone": "Australia/Sydney", "status": "a", "title": "Example Campaign", "type": "sale", "vertical_id": 10, "week_start": "monday" }, "campaign_id": "10l176", "camref": "hrDu67", "conversion_currency": "GBP", "conversion_date_time": "2017-01-01 00:00:00", "conversion_id": "111111l304972", "conversion_reference": "AUTO-5953bd8c5fe7b", "conversion_value": 9729, "created_at": "2017-01-01 00:00:00", "current_state": "pending", "expected_commission": 907.43, "notes": "Quam ex rerum nulla enim.", "publisher": { "agreed_to_latest_network_terms": "y", "created": "2017-01-01 00:00:00", "created_by": "11l16829", "name": "Example Publisher", "network_id": "1l1000003", "network_status": "a", "publisher_id": "1l1007802", "ref_terms_and_conditions_locale_id": "1l100284", "reporting_timezone": "Australia/Sydney", "signup_ip": "127.0.0.1", "week_start": "saturday" }, "publisher_id": "1l1007802", "publisher_reference": "rerum", "state_history": { "conversion_expected_commission": 837.49, "conversion_item_id": "111111l1107235", "created_at": "2017-01-01 00:00:00", "notes": "Quidem facilis iste sapiente reiciendis.", "state": "pending", "transaction_query_id": "111111l10", "transaction_query_state_id": "111111l9", "user_id": "11l16829" }, "transaction_query_id": "111111l10", "transaction_query_type": "untracked", "updated_at": "2017-02-01 00:00:00" } } ] } } }, "partners_List Transaction Queries_401_response": { "response": { "value": { "error": { "message": "Permission Denied: User cannot perform tq_read action on publisher-1l1007802", "type": "Access Permission Denied" } } } }, "partners_Create Transaction Queries_200_response": { "response": { "value": { "execution_time": "1.16076 seconds", "job": { "completed_at": "2016-04-07 04:21:52", "created_at": "2016-04-07 04:21:51", "created_by": "300621", "created_by_uri": "", "estimated_completion": null, "job_id": "111111l470", "percentage_complete": 100, "reference": null, "response": "/job/111111l1177306/response.json", "response_within_retention": true, "status": "complete", "time_elapsed": 0, "update": "/job/111111l1177306.json" } } } }, "partners_Create Transaction Queries_400_response": { "response": { "value": { "error": { "fields": {}, "message": "transaction_queries not found", "type": "Validation Fail" } } } }, "partners_Create Transaction Queries_401_response": { "response": { "value": { "error": { "message": "Permission Denied: User cannot perform tq_read action on publisher-1l1007802", "type": "Access Permission Denied" } } } }, "partners_Delete a Transaction Query_200_response": { "response": { "value": { "execution_time": "1.16076 seconds", "transaction_query": { "deleted": true } } } }, "partners_Delete a Transaction Query_401_response": { "response": { "value": { "error": { "message": "Permission Denied: User cannot perform tq_read action on publisher-1l1007802", "type": "Access Permission Denied" } } } }, "partners_Delete a Transaction Query_404_response": { "response": { "value": { "error": { "message": "Transaction Query could not be found; possibly because it does not exist. Please check your selection and try again.", "type": "404" } } } }, "partners_Delete a Transaction Query_405_response": { "response": { "value": { "error": { "message": "You cannot remove a Transaction Query that has been changed to Approved or Rejected.", "type": "405" } } } }, "partners_List all Selfbills_200_response": { "response": { "value": { "selfbills": [ { "selfbill": { "creation_date": "2012-07-25 14:22:35", "download": null, "item_download": null, "items_in_bill": 5, "legal_entity": "GB", "majority_received_currency": "GBP", "net_value": 430.17, "paid_currency": "GBP", "payment_batch_id": null, "payment_date": null, "payment_detail_set_id": 24, "publisher_id": "1l1007802", "publisher_payment_detail_set_id": "111111l80", "publisher_self_bill_id": "1011l5403", "publisher_self_bill_reference": null, "self_bill_reference": "S-1l1007802-1011l5403", "selfbill_currency": "GBP", "status": "created", "timestamp": "2012-07-25 14:22:35", "total_value": 430.17, "tracked_currency": "GBP", "tracked_net_value": 430.17, "vat_rate": 0, "vat_value": 0, "withheld_tax": 0 } } ] } } }, "partners_Retrieve a Selfbill_200_response": { "response": { "value": { "selfbill": { "creation_date": "2012-07-25 14:22:35", "download": null, "item_download": null, "items_in_bill": 5, "legal_entity": "GB", "majority_received_currency": "GBP", "net_value": 430.17, "paid_currency": "GBP", "payment_batch_id": null, "payment_date": null, "payment_detail_set_id": 24, "publisher_id": "1l1007802", "publisher_payment_detail_set_id": "111111l80", "publisher_self_bill_id": "1011l5403", "publisher_self_bill_reference": null, "self_bill_reference": "S-1l1007802-1011l5403", "selfbill_currency": "GBP", "status": "created", "timestamp": "2012-07-25 14:22:35", "total_value": 430.17, "tracked_currency": "GBP", "tracked_net_value": 430.17, "vat_rate": 0, "vat_value": 0, "withheld_tax": 0 } } } }, "partners_List Payment Details_200_response": { "response": { "value": { "payment_details": { "1011l22": { "publisher_payment_detail_set_id": "1011l22", "country": "US", "paid_currency": "USD", "tracked_currency": [ "USD" ], "payment_type_code": "eft", "payment_type_name": "Electronic funds transfer", "automatic_self_bill_creation_date": "-1", "automatic_self_bill_creation_threshold": "-1", "suspended": "n", "suspended_at": null, "suspended_by": null, "suspension_notes": null, "payment_detail_values": { "bank_address": "8th Floor, West One, Forth Banks", "account_number": 12345678, "account_name": "joe bloggs", "bank_name": "bob bank", "routing_number": 122105155 } } } } } }, "partners_Create Payment Details_200_response": { "response": { "value": { "payment_details": { "1011l23": { "publisher_payment_detail_set_id": "1011l23", "country": "US", "paid_currency": "USD", "tracked_currency": [ "USD" ], "payment_type_code": "eft", "payment_type_name": "Electronic funds transfer", "automatic_self_bill_creation_date": "-1", "automatic_self_bill_creation_threshold": "-1", "suspended": "n", "suspended_at": null, "suspended_by": null, "suspension_notes": null, "payment_detail_values": { "bank_address": "8th Floor, West One, Forth Banks", "account_number": 12345678, "account_name": "joe bloggs", "bank_name": "bob bank", "routing_number": 122105155 } } } } } }, "partners_Retrieve Available Commission_200_response": { "response": { "value": { "available_commissions": { "available_commission": { "no_items": 1, "value": 568, "publisher_commission": 312.4, "currency": "SGD", "publisher_id": "1l1007802", "publisher_commission_converted": { "currency": "USD", "value": 228.88 } } } } } }, "partners_Partner payments summary_200_response": { "response": { "value": { "execution_time": "2.25885 seconds", "summary": { "available": { "CAD": 12.45, "AUD": 0.4 }, "confirmed": { "EUR": 11, "GBP": 54.2 }, "pending": { "EUR": 125.11, "GBP": 57.65, "JPY": 97 }, "approved": { "GBP": 90.8, "USD": 100.23 }, "paid": { "PLN": 68.96 } } } } }, "partners_Retrieve Tracking Links_200_response": { "response": { "value": { "execution_time": "0.29440 seconds", "count": 2, "limit": 200, "offset": 0, "links": [ { "id": "1011l10", "campaign_id": "4d36c720be593", "description": null, "destination_url": "http://test.com", "tracking_short_url": "https://staging.prf.hn/l/bKVPQEz", "tracking_url": "https://staging.prf.hn/click/camref:cCdTebt4e/pubref:fdghjdkf/destination:http://test.com", "params": [ { "key": "pubref", "value": "fdghjdkf" } ], "active": true }, { "id": "1011l18", "campaign_id": "300045", "description": null, "destination_url": "http://dfdff", "tracking_short_url": "https://staging.prf.hn/l/GE082EL", "tracking_url": "https://staging.prf.hn/click/camref:i995/pubref:fdfdf/adref:dfdff/destination:http://dfdff", "params": [ { "key": "pubref", "value": "fdfdf" }, { "key": "adref", "value": "dfdff" } ], "active": true } ], "hypermedia": { "pagination": { "total_page_count": 1, "total_item_count": 1, "first_page": "/v2/publishers/2/links?limit=200&offset=0", "last_page": "/v2/publishers/2/links?limit=200&offset=0", "next_page": null, "previous_page": null } } } } }, "partners_Create Tracking Links_request": { "campaign_id": "4d36c720be593", "description": null, "destination_url": "http://test.com", "params": [ { "key": "pubref", "value": "fdghjdkf" } ], "active": true }, "partners_Create Tracking Links_200_response": { "response": { "value": { "execution_time": "0.29440 seconds", "link": { "id": "1011l10", "campaign_id": "4d36c720be593", "description": null, "destination_url": "http://test.com", "tracking_short_url": "https://staging.prf.hn/l/bKVPQEz", "tracking_url": "https://staging.prf.hn/click/camref:cCdTebt4e/pubref:fdghjdkf/destination:http://test.com", "params": [ { "key": "pubref", "value": "fdghjdkf" } ], "active": true } } } }, "partners_Retrieve a Tracking Link_200_response": { "response": { "value": { "execution_time": "0.29440 seconds", "link": { "id": "1011l10", "campaign_id": "4d36c720be593", "description": null, "destination_url": "http://test.com", "tracking_short_url": "https://staging.prf.hn/l/bKVPQEz", "tracking_url": "https://staging.prf.hn/click/camref:cCdTebt4e/pubref:fdghjdkf/destination:http://test.com", "params": [ { "key": "pubref", "value": "fdghjdkf" } ], "active": true } } } }, "partners_Update a Tracking Link_request": { "campaign_id": "4d36c720be593", "description": "test", "destination_url": "http://test.com", "params": [ { "key": "pubref", "value": "fdghjdkf" } ], "active": true }, "partners_Update a Tracking Link_200_response": { "response": { "value": { "execution_time": "0.29440 seconds", "link": { "id": "1011l10", "campaign_id": "4d36c720be593", "description": "test", "destination_url": "http://test.com", "tracking_short_url": "https://staging.prf.hn/l/bKVPQEz", "tracking_url": "https://staging.prf.hn/click/camref:cCdTebt4e/pubref:fdghjdkf/destination:http://test.com", "params": [ { "key": "pubref", "value": "fdghjdkf" } ], "active": true } } } }, "partners_get-publisher-commissions-default_200_response": { "Commission": { "value": { "description": "The Default Commission", "performance_value": "2.5", "performance_model": "fixed_cpa", "last_modified_by": "3", "last_modified": "2010-01-01 12:30:00", "publishers": { "id": "10110l2398476", "performance_value": "3.25", "name": "Best Partner" }, "groups": { "id": "111001l90872354", "performance_value": "3.75", "name": "Special Group" } } } }, "partners_get-partner-commission-groups_200_response": { "response": { "value": { "count": 2, "execution_time": "0.02571 seconds", "commission_groups": [ { "commission_group": { "commission_group_id": "1011l1", "campaign_id": 1, "name": "The_group", "description": "", "start_date_time": "2018-11-01 12:00:00" }, "end_date_time": null, "active": "y", "last_modified": "2018-11-29 14:57:05" }, { "commission_group": { "commission_group_id": "1011l16", "campaign_id": 300659, "name": "Blog", "description": "", "start_date_time": "2019-06-03 11:00:00" }, "end_date_time": null, "active": "n", "last_modified": "2019-07-29 11:03:32" } ] } } }, "partners_List Invitations_200_response": { "response": { "value": { "advertisers": [ { "address": { "country": "Chile", "line1": "123 Super street", "line2": "", "line3": "Super city", "line4": "", "postcode": "SU5 PER" }, "id": "301284", "invitations": [ { "campaign": { "currency": { "iso": "CLP", "name": "Chilean peso", "symbol": "$" }, "default_destination": "https://mysuperdefaultdestination.com", "id": "300866", "campaign_logo": "https://path/to/campaign/logo.png", "title": "My that is a super campaign", "vertical": { "id": "131", "name": "boats" } }, "id": "11111|1" } ], "name": "Super brand", "network": { "id": "111111l300118", "name": "Super nework" } } ], "count": 1, "execution_time": "0.98709 seconds" } } }, "partners_acceptInvitations_request": { "campaign_ids": [ "111111l300140", "111111l400044" ] }, "partners_declineInvitations_request": { "campaign_ids": [ "111111l300140", "111111l400044" ] }, "partners_get__v2_publishers_{publisherId}_campaigns_terms?campaigns={campaigns}_200_response": { "count": 3, "terms": [ { "title": "Network terms", "content": "Hostels.com operates a closed and strict keyword policy. Affiliates are unable to participate in specific PPC activity to drive traffic directly to Hostels.com on Google, Yahoo or Bing search engines.
" }, { "title": "Campaign A standard terms", "content": "
There is a maximum cap of 2 units per order on new phone and 5 units per order for all other products. Commissions will not be paid on units exceeding this cap.
" }, { "title": "Partner custom terms for Campaign B", "content": { "object": "value", "document": { "object": "document", "data": {}, "nodes": [ { "object": "block", "type": "paragraph", "data": {}, "nodes": [ { "object": "text", "leaves": [ { "object": "leaf", "text": "Custom campaign terms for Publisher Y", "marks": [] } ] } ] } ] } } } ] }, "partners_partner-conversions_200_response": { "response": { "value": { "total_conversion_count": { "EUR": 1 }, "total_publisher_commission": { "EUR": 95.5 }, "total_value": { "EUR": 955 }, "start_date_time_utc": "2019-08-10 00:00:00", "end_date_time_utc": "2020-03-10 00:00:00", "start_date_time": "2020-03-08 17:18:33", "end_date_time": "2020-03-08 17:18:33", "limit": 300, "meta_data": [], "count": 1, "execution_time": "1.04266 seconds", "conversions": [ { "conversion_data": { "conversion_id": "111111l314", "campaign_id": "111111l29", "publisher_id": "111111l92", "conversion_time": "2020-03-08 17:18:33", "creative_type": 0, "creative_id": 0, "specific_creative_id": 0, "currency": "EUR", "publisher_reference": "", "advertiser_reference": "adrefd", "conversion_reference": "AUTO-5ebc127cb2ddf3.85382959", "customer_type": null, "referer_ip": "265c:5b77:7721:e466:9e91:cf97:9b7a:b1f1", "source_referer": "", "last_modified": "2020-05-13 15:31:42", "conversion_type": 1, "country": "ES", "customer_reference": "custrefa", "ref_device_id": 2, "ref_partnership_model_id": 2, "ref_traffic_source_id": 3, "ref_conversion_metric_id": 2, "ref_user_context_id": 2, "campaign_title": "rubycampaignsuvwlynm", "publisher_name": "syjmmcll", "click": { "campaign_id": "111111l29", "publisher_id": "111111l92", "type": "standard", "status": "nibbled", "set_time": "2020-03-08 17:18:33", "set_ip": "265c:5b77:7721:e466:9e91:cf97:9b7a:b1f1", "last_used": 1589383804, "last_ip": "265c:5b77:7721:e466:9e91:cf97:9b7a:b1f1", "publisher_reference": "", "referer": "", "creative_id": 0, "creative_type": 0, "specific_creative_id": 0, "ref_device_id": 2, "ref_traffic_source_id": 3, "ref_partnership_model_id": 2, "ref_user_context_id": 2, "ref_device": "Desktop", "ref_traffic_source": "Affiliate", "ref_partnership_model": "CPA", "ref_user_context": "Web", "clickref": "111111lfo" }, "ref_conversion_metric": "Standard", "ref_device": "Desktop", "ref_partnership_model": "CPA", "ref_traffic_source": "Affiliate", "ref_user_context": "Web", "conversion_value": { "conversion_status": "pending", "value": 955, "publisher_commission": 95.5 }, "meta_data": { "gclid": "adword_google_meta_data" }, "conversion_items": [ { "conversion_item_id": "111111l314", "sku": 123, "category": "Producte", "item_value": 955, "item_publisher_commission": 95.5, "item_status": "pending", "last_update": "2020-05-13 15:30:04", "publisher_self_bill_id": null, "approved_at": null, "item_status_id": 1, "reject_reason": null, "voucher_codes": [], "meta_data": { "gclid": "adword_google_meta_data" }, "payable": false } ], "was_disputed": false, "conversion_lag": 0, "clickref": "111111lfo" } } ] } } }, "partners_partner-clicks_200_response": { "response": { "value": { "unique_click_count": 2, "start_date_time_utc": "2019-08-10 00:00:00", "end_date_time_utc": "2020-03-10 00:00:00", "start_date_time": "2020-03-08 17:18:33", "end_date_time": "2020-03-09 14:27:15", "limit": 300, "offset": 0, "count": 2, "execution_time": "0.27682 seconds", "clicks": [ { "click": { "campaign_id": "111111l29", "publisher_id": "111111l92", "type": "standard", "status": "nibbled", "set_time": "2020-03-08 17:18:33", "set_ip": "265c:5b77:7721:e466:9e91:cf97:9b7a:b1f1", "last_used": "2020-05-13 15:30:04", "last_ip": "265c:5b77:7721:e466:9e91:cf97:9b7a:b1f1", "publisher_reference": "", "referer": "", "creative_id": 0, "creative_type": 0, "specific_creative_id": 0, "ref_device_id": 2, "ref_traffic_source_id": 3, "ref_partnership_model_id": 2, "ref_user_context_id": 2, "clickref": "111111lfo", "meta_data": [] } }, { "click": { "campaign_id": "111111l29", "publisher_id": "111111l92", "type": "standard", "status": "nibbled", "set_time": "2020-03-09 14:27:15", "set_ip": "265c:5b77:7721:e466:9e91:cf97:9b7a:b1f1", "last_used": "2020-05-13 15:30:18", "last_ip": "265c:5b77:7721:e466:9e91:cf97:9b7a:b1f1", "publisher_reference": "", "referer": "", "creative_id": 0, "creative_type": 0, "specific_creative_id": 0, "ref_device_id": 2, "ref_traffic_source_id": 3, "ref_partnership_model_id": 2, "ref_user_context_id": 2, "clickref": "111111lfq", "meta_data": [] } } ] } } }, "partners_partner-payable_200_response": { "response": { "value": { "offset": 0, "limit": 300, "count": 0, "total_conversion_count": { "EUR": 1, "GBP": 6, "USD": 1 }, "total_commission_value": { "EUR": 44, "GBP": 342.3365, "USD": 44 }, "total_value": { "EUR": 400, "GBP": 3112.15, "USD": 400 }, "total_publisher_commission_value": { "EUR": 40, "GBP": 311.215, "USD": 40 }, "execution_time": "0.55225 seconds", "conversion_items": [] } } }, "partners_Export Clicks_200_response": { "response": { "value": "click_id,cookie_id,campaign_id,publisher_id,status,set_time,set_ip,last_used,last_ip,advertiser_reference,referer,creative_id,creative_type,specific_creative_id,country,publisher_name\n111111l2210,111111l2136,10l176,1l1007802,nibbled,\"2016-03-02 10:11:36\",127.0.0.1,\"2016-06-17 19:13:09\",127.0.0.1,,,0,0,0,GB,apipublisher123\n" } }, "partners_Export Conversions_200_response": { "response": { "value": "conversion_id,campaign_id,publisher_id,conversion_date,conversion_date_time,click_time,click_date,click_date_time,currency,advertiser_reference,conversion_reference,referer_ip,source_referer,campaign_title,publisher_name,conversion_status,conversion_lag,value,commission,publisher_commission,creative_type,creative_id,specific_creative_id,customer_type,was_disputed,cookie_id,country,currency_original,currency_conversion_rate,customer_reference,camref\n111111l3919676,10l176,1l1007802,2016-03-02,\"2016-03-02 10:22:02\",10:11:36,2016-03-02,\"2016-03-02 10:11:36\",EUR,,AUTO-57643db548165,127.0.0.1,,\"API Campaign Demo\",apipublisher123,pending,626,90.92,1.0001,0.9092,0,0,0,,,111111l2136,GB,,,,1l3v9UA\n" } }, "partners_Export Conversion Items_200_response": { "response": { "value": "conversion_id,campaign_id,publisher_id,conversion_date,conversion_date_time,click_time,click_date,click_date_time,currency,advertiser_reference,conversion_reference,referer_ip,source_referer,campaign_title,publisher_name,conversion_status,conversion_lag,value,commission,publisher_commission,creative_type,creative_id,specific_creative_id,customer_type,was_disputed,cookie_id,country,currency_original,currency_conversion_rate,conversion_item_id,sku,category,item_value,item_commission,item_publisher_commission,item_status,item_status_id,reject_reason,last_update,voucher_codes,customer_reference,camref,invoice_id,meta_item_cabin_code,meta_item_departure_date,meta_item_dest,meta_item_device,meta_item_origin,meta_item_passenger,meta_item_payment_method,meta_item_product_ids,meta_item_return_date\n111111l3919676,10l176,1l1007802,2016-03-02,\"2016-03-02 10:22:02\",10:11:36,2016-03-02,\"2016-03-02 10:11:36\",EUR,,AUTO-57643db548165,127.0.0.1,,\"API Campaign Demo\",apipublisher123,pending,626,90.92,1.0001,0.9092,0,0,0,,,111111l2136,GB,,,111111l4118583,,,90.92,1.0001,0.9092,pending,1,,\"2016-06-17 19:13:09\",,,1l3v9UA,,,,,,,,,,\n" } }, "partners_postClicksCount_request": { "date_time_ranges": [ { "start": "2019-10-01T00:00:00+00:00", "end": "2019-10-03T00:00:00+00:00" } ], "scope": { "partner": "111111l10" }, "metrics": [ "total_clicks" ], "filter_by": [ { "field": "country", "value": "US", "operator": "EQUALS" }, { "field": "device_id", "value": 5, "operator": "EQUALS", "not": true } ], "timezone": "GMT" }, "partners_postClicksExplode_request": { "date_time_ranges": [ { "start": "2019-10-01T00:00:00+00:00", "end": "2019-10-03T00:00:00+00:00" } ], "scope": { "partner": "111111l10" }, "metrics": [ "total_clicks" ], "group_by": [ "device" ], "filter_by": [ { "field": "country", "value": "US", "operator": "EQUALS" }, { "field": "device_id", "value": 5, "operator": "EQUALS", "not": true } ], "order_by": [ { "field": "total_clicks", "direction": "DESCENDING" } ], "interval": { "field": "date_time", "period": "P1D" }, "include_total_row_count": false, "timezone": "GMT", "top": 2 }, "partners_postClicksFilter_request": { "date_time_ranges": [ { "start": "2019-10-01T00:00:00+00:00", "end": "2019-10-03T00:00:00+00:00" } ], "scope": { "partner": "111111l10" }, "group_by": [ "device" ], "filter_by": [ { "field": "country", "value": "US", "operator": "EQUALS" }, { "field": "device_id", "value": 5, "operator": "EQUALS", "not": true } ], "order_by": [ { "field": "total_clicks", "direction": "DESCENDING" } ], "top": 2, "include_total_row_count": false, "timezone": "GMT" }, "partners_postClicksTimeseries_request": { "date_time_ranges": [ { "start": "2019-10-01T00:00:00+00:00", "end": "2019-10-03T00:00:00+00:00" } ], "scope": { "partner": "111111l10" }, "metrics": [ "total_clicks" ], "filter_by": [ { "field": "country", "value": "US", "operator": "EQUALS" }, { "field": "device_id", "value": 5, "operator": "EQUALS", "not": true } ], "interval": { "field": "date_time", "period": "P1D" }, "timezone": "GMT", "zerofill": false }, "partners_postConversionsCount_request": { "date_time_ranges": [ { "start": "2019-10-01T00:00:00+00:00", "end": "2019-10-03T00:00:00+00:00" } ], "scope": { "partner": "111111l10" }, "metrics": [ "total_partner_commission" ], "filter_by": [ { "field": "country", "value": "US", "operator": "EQUALS" }, { "field": "device_id", "value": 5, "operator": "EQUALS", "not": true } ], "output_currency": "GBP", "timezone": "GMT" }, "partners_postConversionsExplode_request": { "date_time_ranges": [ { "start": "2019-10-01T00:00:00+00:00", "end": "2019-10-03T00:00:00+00:00" } ], "scope": { "partner": "111111l10" }, "metrics": [ "total_partner_commission" ], "group_by": [ "country" ], "filter_by": [ { "field": "country", "value": "US", "operator": "EQUALS" }, { "field": "device_id", "value": 5, "operator": "EQUALS", "not": true } ], "order_by": [ { "field": "total_commission", "direction": "DESCENDING" } ], "interval": { "field": "date_time", "period": "P1D" }, "output_currency": "USD", "top": 2, "include_total_row_count": false, "timezone": "GMT" }, "partners_postConversionsFilter_request": { "date_time_ranges": [ { "start": "2019-10-01T00:00:00+00:00", "end": "2019-10-03T00:00:00+00:00" } ], "scope": { "partner": "111111l10" }, "group_by": [ "country" ], "filter_by": [ { "field": "country", "value": "US", "operator": "EQUALS" }, { "field": "device_id", "value": 5, "operator": "EQUALS", "not": true } ], "order_by": [ { "field": "total_partner_commission", "direction": "DESCENDING" } ], "interval": { "field": "date_time", "period": "P1D" }, "output_currency": "USD", "top": 10, "include_total_row_count": false, "timezone": "GMT" }, "partners_postConversionsTimeseries_request": { "date_time_ranges": [ { "start": "2019-10-01T00:00:00+00:00", "end": "2019-10-03T00:00:00+00:00" } ], "scope": { "partner": "111111l10" }, "metrics": [ "total_partner_commission" ], "filter_by": [ { "field": "country", "value": "US", "operator": "EQUALS" }, { "field": "device_id", "value": 5, "operator": "EQUALS", "not": true } ], "interval": { "field": "date_time", "period": "P1D" }, "output_currency": "GBP", "timezone": "GMT", "zerofill": false }, "partners_postImpressionsCount_request": { "date_time_ranges": [ { "start": "2019-10-01T00:00:00+00:00", "end": "2019-10-03T00:00:00+00:00" } ], "scope": { "partner": "111111l10" }, "metrics": [ "total_impressions" ], "filter_by": [ { "field": "device_id", "value": 5, "operator": "EQUALS", "not": true } ], "timezone": "GMT" }, "partners_postImpressionsExplode_request": { "date_time_ranges": [ { "start": "2019-10-01T00:00:00+00:00", "end": "2019-10-03T00:00:00+00:00" } ], "scope": { "partner": "111111l10" }, "metrics": [ "total_impressions" ], "group_by": [ "campaign" ], "filter_by": [ { "field": "device_id", "value": 5, "operator": "EQUALS" } ], "order_by": [ { "field": "total_impressions", "direction": "DESCENDING" } ], "interval": { "field": "date_time", "period": "P1D" }, "top": 10, "include_total_row_count": false, "timezone": "GMT" }, "partners_postImpressionsFilter_request": { "date_time_ranges": [ { "start": "2019-10-01T00:00:00+00:00", "end": "2019-10-03T00:00:00+00:00" } ], "scope": { "partner": "111111l10" }, "group_by": [ "campaign" ], "filter_by": [ { "field": "device_id", "value": 5, "operator": "EQUALS" } ], "order_by": [ { "field": "total_impressions", "direction": "DESCENDING" } ], "top": 10, "include_total_row_count": false, "timezone": "GMT" }, "partners_postImpressionsTimeseries_request": { "date_time_ranges": [ { "start": "2019-10-01T00:00:00+00:00", "end": "2019-10-03T00:00:00+00:00" } ], "scope": { "partner": "111111l10" }, "metrics": [ "total_impressions" ], "filter_by": [ { "field": "device_id", "value": 5, "operator": "EQUALS" } ], "interval": { "field": "date_time", "period": "P1D" }, "timezone": "GMT", "zerofill": false }, "partners_List all Countries_200_response": { "response": { "value": { "countries": [ { "country": { "area_sq_km": 468, "capital": "Andorra la Vella", "continent_iso": "EU", "continent_name": "Europe", "currency_iso": "EUR", "east": "42.656043", "fips_code": "AN", "geoname_id": 3041565, "iso": "AD", "iso3": "AND", "iso_numeric": "020", "languages": "ca", "north": "42.656043", "population": 84000, "printable_name": "Andorra", "ref_country_id": 1, "south": "42.656043", "west": "42.656043", "zone": "Outside EU VAT area" } } ] } } }, "partners_List all Currencies_200_response": { "response": { "value": { "currencies": [ { "currency": { "currency_id": 51, "iso": "GBP", "minor_unit": 2, "name": "Pound Sterling" } } ] } } }, "partners_List all Timezones_200_response": { "response": { "value": { "timezones": [ { "timezone": { "description": "[GMT-10:00] Pacific/Tahiti", "local_time": "", "name": "Pacific/Tahiti", "ref_timezone_id": "3", "utc_offset": "-36000" } } ] } } }, "partners_List all Devices_200_response": { "response": { "value": { "devices": [ { "device": { "ref_device_id": 2, "title": "Desktop", "description": "Standard desktop web", "skip_invoice": 0, "skip_selfbill": 0, "skip_override": 0, "key": "desktop" } } ] } } }, "partners_List all User Contexts_200_response": { "response": { "value": { "user_contexts": [ { "user_context": { "ref_user_context_id": 1, "title": "Other", "description": "Other user context", "skip_invoice": 0, "skip_selfbill": 0, "skip_override": 0, "key": "other" } } ] } } }, "partners_List Traffic Sources_200_response": { "response": { "value": { "traffic_sources": [ { "traffic_source": { "ref_traffic_source_id": 1, "title": "Other", "description": "Other traffic source", "skip_invoice": 0, "skip_selfbill": 0, "skip_override": 0 } } ] } } }, "partners_List Conversion Type_200_response": { "response": { "value": { "conversion_types": [ { "conversion_type": { "available_to_invoice": "y", "available_to_selfbill": "y", "conversion_type": "standard", "conversion_type_id": 1, "description": "Standard Transaction", "exclude_from_override_rules": "y" } } ] } } }, "partners_List Conversion Metrics_200_response": { "response": { "value": { "conversion_metrics": [ { "conversion_metrics": { "ref_conversion_metric_id": 3, "title": "App Download", "description": "", "skip_invoice": 0, "skip_selfbill": 0, "skip_override": 0 } } ] } } }, "partners_List Partnership Models_200_response": { "response": { "value": { "partnership_models": [ { "partnership_model": { "ref_partnership_model_id": 2, "title": "CPA", "description": "Cost per aquisition", "skip_invoice": 0, "skip_selfbill": 0, "skip_override": 0 } } ] } } }, "partners_createPartnerizeTag_201_response": { "response": { "value": { "data": { "id": "111111l35", "scope": { "partner": "111111l2" }, "name": "my-tag-website", "active": true, "created_at": "2020-07-22T12:23:58.000Z", "created_by": "111111l1", "last_modified_at": "2020-07-22T12:23:58.000Z", "last_modified_by": "111111l1", "url": "https://pzapi-kg.com/tags/file.js" } } } }, "partners_updatePartnerizeTag_200_response": { "response": { "value": { "data": { "id": "111111l35", "scope": { "partner": "111111l2" }, "name": "my-tag-website", "active": true, "created_at": "2020-07-22T12:23:58.000Z", "created_by": "111111l1", "last_modified_at": "2020-07-22T12:23:58.000Z", "last_modified_by": "111111l1", "url": "https://pzapi-kg.com/tags/file.js" } } } }, "partners_enablePartnerizeTagFeature_201_response": { "response": { "value": { "data": { "name": "tracking-link-generation", "config": null } } } }, "partners_createCampaignTermAcknowledgment_request": { "partner_id": "111111l34", "campaign_terms_and_conditions_id": "111111l50" }, "partners_updateCurrentUser_200_response": { "response": { "value": { "data": { "user_id": "111111l63", "email_verified": false, "email": "user@test.com" } } } } } }