Partnerize · Schema
Partnerize Brands API Schemas
JSON Schema definitions extracted from the Partnerize Brands API (OAS 3.0.1)
Affiliate MarketingPartner MarketingPartnershipsPerformance MarketingCommissionsTrackingAnalytics
JSON Schema
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Partnerize Brands API Schemas",
"description": "JSON Schema definitions extracted from the Partnerize Brands API (OAS 3.0.1)",
"definitions": {
"Fraud_Incident_Base": {
"properties": {
"id": {
"description": "A unique ID for the incident",
"type": "string"
},
"type": {
"description": "Which type of entity triggered this incident",
"type": "string",
"enum": [
"ip_address",
"conversion",
"partner"
]
},
"date": {
"description": "The date of the incident",
"type": "string"
},
"time_window": {
"description": "Over how many days did we calculate the metric",
"type": "string"
},
"status": {
"description": "Status of the record",
"type": "string",
"enum": [
"active",
"deleted"
]
},
"created_at": {
"description": "Timestamp of the record creation",
"type": "string"
},
"deleted_at": {
"description": "Timestamp of the record deletion",
"type": "string"
}
},
"required": [
"id",
"type",
"date",
"time_window",
"status",
"created_at",
"deleted_at"
]
},
"type": "object",
"Fraud_Incident_Type_Partner": {
"allOf": [
{
"$ref": "#/components/schemas/Fraud_Incident_Base"
},
{
"type": "object",
"properties": {
"partner": {
"type": "object",
"properties": {
"id": {
"description": "ID of the partner",
"type": "string"
},
"name": {
"description": "The name of the partner",
"type": "string"
}
},
"required": [
"id",
"name"
]
}
},
"required": [
"partner"
]
}
]
},
"Fraud_Incident_Type_IP_Address": {
"allOf": [
{
"$ref": "#/components/schemas/Fraud_Incident_Base"
},
{
"type": "object",
"properties": {
"ip_address": {
"type": "string",
"description": "A hashed identifier for an IP address"
}
},
"required": [
"ip_address"
]
}
]
},
"Fraud_Incident_Metric_Basket": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Fraud_Incident_Type_IP_Address"
},
{
"$ref": "#/components/schemas/Fraud_Incident_Type_Partner"
}
]
},
{
"type": "object",
"description": "Properties unique to fraud incident baskets",
"allOf": [
{
"type": "object",
"required": [
"metric"
],
"properties": {
"metric": {
"type": "string",
"description": "The metric name",
"enum": [
"basket_variability_sku"
]
}
}
},
{
"type": "object",
"description": "This is supplemental data for fraud incident baskets",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"conversions",
"total"
],
"properties": {
"total": {
"type": "number",
"description": "Total value of this basket"
},
"conversions": {
"type": "array",
"items": {
"type": "object",
"title": "The Items Schema",
"required": [
"items",
"count",
"conversion_reference"
],
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"sku",
"category",
"status"
],
"properties": {
"id": {
"type": "string",
"description": "The conversion item ID"
},
"sku": {
"type": "string",
"description": "The conversion item SKU"
},
"category": {
"type": "string",
"description": "The conversion item category"
},
"status": {
"type": "string",
"description": "Status of the conversion item"
}
}
}
},
"count": {
"type": "integer",
"description": "The number of items"
},
"conversion_reference": {
"type": "string",
"description": "The conversion reference"
}
}
}
}
}
}
}
},
{
"$ref": "#/components/schemas/Fraud_Incident_Metric_Ttc/allOf/1/allOf/2"
}
]
}
]
},
"Fraud_Incident_Metric_Basic": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Fraud_Incident_Type_IP_Address"
},
{
"$ref": "#/components/schemas/Fraud_Incident_Type_Partner"
}
]
},
{
"type": "object",
"description": "Properties that all indicent types share",
"required": [
"metric"
],
"allOf": [
{
"type": "object",
"properties": {
"metric": {
"type": "string",
"description": "The metric name",
"enum": [
"volume_clicks",
"volume_conversions",
"conversion_ratio"
]
}
}
},
{
"$ref": "#/components/schemas/Fraud_Incident_Metric_Ttc/allOf/1/allOf/2"
}
]
}
]
},
"Fraud_Incident_Metric_Conversion_Value": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Fraud_Incident_Type_IP_Address"
},
{
"$ref": "#/components/schemas/Fraud_Incident_Type_Partner"
}
]
},
{
"type": "object",
"description": "Properties for Conversion value",
"allOf": [
{
"type": "object",
"required": [
"metric"
],
"properties": {
"metric": {
"type": "string",
"description": "The metric name",
"enum": [
"conversion_value"
]
}
}
},
{
"allOf": [
{
"$ref": "#/components/schemas/Fraud_Incident_Metric_Ttc/allOf/1/allOf/1"
},
{
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"currency"
],
"properties": {
"currency": {
"type": "string",
"description": "The campaigns default currency"
}
}
}
}
},
{
"$ref": "#/components/schemas/Fraud_Incident_Metric_Ttc/allOf/1/allOf/2"
}
]
}
]
}
]
},
"Fraud_Incident_Metric_Ttc": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/Fraud_Incident_Type_IP_Address"
},
{
"$ref": "#/components/schemas/Fraud_Incident_Type_Partner"
}
]
},
{
"type": "object",
"description": "Properties for ttc",
"allOf": [
{
"type": "object",
"required": [
"metric"
],
"properties": {
"metric": {
"type": "string",
"description": "The metric name",
"enum": [
"ttc"
]
}
}
},
{
"type": "object",
"description": "This is supplemental data for fraud incidents ttc and conversion value",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"conversion_reference",
"conversion_items"
],
"properties": {
"conversion_reference": {
"type": "string",
"description": "The conversion reference"
},
"conversion_items": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"sku",
"category",
"status"
],
"properties": {
"id": {
"type": "string",
"description": "The conversion item ID"
},
"sku": {
"type": "string",
"description": "The conversion item SKU"
},
"category": {
"type": "string",
"description": "The conversion item category"
},
"status": {
"type": "string",
"description": "Status of the conversion item"
}
}
}
}
}
}
}
},
{
"type": "object",
"description": "This is supplemental data common to all fraud incidents",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"threshold",
"value"
],
"properties": {
"threshold": {
"type": "number",
"description": "The threshold for this metric"
},
"value": {
"type": "number",
"description": "The actual value of this metric"
}
}
}
}
}
]
}
]
},
"Network": {
"properties": {
"auto_approve_publishers": {
"$ref": "#/components/schemas/YesOrNo"
},
"cm_client_id": {
"type": "string"
},
"default_campaign_id": {
"type": "string"
},
"network_application_id": {
"type": "string"
},
"network_contact_email": {
"type": "string"
},
"network_description": {
"description": "Description of the network",
"type": "string"
},
"network_id": {
"description": "ID of the network",
"type": "string"
},
"network_locale": {
"$ref": "#/components/schemas/Locale"
},
"network_name": {
"description": "Name of the network",
"type": "string"
},
"network_notes": {
"description": "Any additional notes for the network",
"type": "string"
}
},
"type": "object"
},
"Network_Wrapper": {
"properties": {
"network": {
"$ref": "#/components/schemas/Network"
}
},
"type": "object"
},
"Publisher": {
"type": "object",
"properties": {
"websites": {
"items": {
"$ref": "#/components/schemas/Publisher_Website_Wrapper"
},
"type": "array"
},
"us_tax_state": {
"type": "string"
},
"reporting_identifier": {
"type": "string"
},
"publisher_id": {
"description": "ID of the partner",
"type": "string"
},
"network_status": {
"$ref": "#/components/schemas/Status"
},
"network_notes": {
"type": "string"
},
"network_id": {
"description": "ID of the network this partner belongs to",
"type": "string"
},
"legal_entity": {
"$ref": "#/components/schemas/Country"
},
"is_affiliate_user": {
"$ref": "#/components/schemas/YesOrNo"
},
"gst_registered": {
"type": "string"
},
"foreign_identifier": {
"type": "string"
},
"databases": {
"items": {
"$ref": "#/components/schemas/Publisher_Database_Wrapper"
},
"type": "array"
},
"campaign_select": {
"type": "string"
},
"abn": {
"type": "string"
},
"account_name": {
"type": "string"
},
"company_division": {
"type": "string"
},
"company_name": {
"type": "string"
},
"contact_email": {
"type": "string"
},
"contact_locale": {
"$ref": "#/components/schemas/Locale"
},
"contact_name": {
"type": "string"
},
"default_currency": {
"$ref": "#/components/schemas/Currency"
},
"description": {
"description": "Description of the partner",
"type": "string"
},
"im_provider": {
"type": "string"
},
"im_username": {
"type": "string"
},
"is_foreign_network": {
"$ref": "#/components/schemas/YesOrNo",
"description": "Reporting only flag. All conversions will be automatically approved but will not be invoiceable."
},
"is_lead_user": {
"$ref": "#/components/schemas/YesOrNo"
},
"operating_country": {
"$ref": "#/components/schemas/Country"
},
"promotional_method": {
"type": "number"
},
"promotional_method_name": {
"type": "string"
},
"promotional_countries": {
"type": "array",
"items": {
"type": "object",
"properties": {
"iso": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"uk_vat_registered": {
"$ref": "#/components/schemas/YesOrNo"
},
"vat_number": {
"type": "number"
},
"vertical": {
"type": "number"
},
"vertical_name": {
"type": "string"
}
}
},
"Publisher_Wrapper": {
"properties": {
"publisher": {
"$ref": "#/components/schemas/Publisher"
}
}
},
"User_Publisher": {
"type": "object",
"properties": {
"user_name": {
"type": "string",
"description": "Username of the user"
},
"email_address": {
"type": "string",
"description": "Email address of the user"
},
"password": {
"type": "string",
"description": "Password of the user"
},
"address1": {
"type": "string",
"description": "Address Line 1 of the user"
},
"postcode": {
"type": "string",
"description": "Postcode of the user"
},
"country": {
"type": "string",
"description": "ISO-2 country code of the user"
},
"phone": {
"type": "string",
"description": "Phone number of the user"
},
"signup_ip": {
"type": "string",
"description": "The signup IP address of the user"
},
"firstname": {
"type": "string",
"description": "The first name of the user"
},
"lastname": {
"type": "string",
"description": "The last name of the user"
},
"address2": {
"type": "string",
"description": "Address Line 2 of the user"
},
"address3": {
"type": "string",
"description": "Address Line 3 of the user"
},
"address4": {
"type": "string",
"description": "Address Line 4 of the user"
},
"locale": {
"type": "string",
"description": "Locale of the user"
},
"user_id": {
"type": "string",
"description": "The ID of the user"
},
"created": {
"type": "string",
"description": "Datetime stamp of when the user account was created"
},
"network_id": {
"type": "string",
"description": "The network ID of which the user belongs to"
},
"network_name": {
"type": "string",
"description": "The network name of which the user belongs to"
},
"user_api_key": {
"type": "string",
"description": "The API key of the user account"
},
"publisher": {
"type": "object",
"properties": {
"account_name": {
"type": "string",
"description": "Name of the partner"
},
"vertical": {
"type": "string",
"description": "The vertical ID of the partner"
},
"promotional_method": {
"type": "string",
"description": "The promotional method ID of the partner"
},
"signup_ip": {
"type": "string",
"description": "The signup IP address of the partner"
},
"entity_terms_id": {
"type": "string",
"description": "The agreed terms and conditions ID. The ID must be retrieved by retrieving the terms and conditions from the [network terms and conditions API.](#tag/Network-Terms-and-Conditions)"
},
"network_terms_id": {
"type": "string",
"description": "The agreed network terms and conditions ID"
},
"vat_number": {
"type": "string",
"description": "The VAT number of the partner"
},
"description": {
"type": "string",
"description": "Description of the partner"
},
"company_name": {
"type": "string",
"description": "Company name associated to the partner"
},
"operating_country": {
"type": "string",
"description": "Country of operation for the partner"
},
"reporting_timezone": {
"type": "string",
"description": "Reporting timezone of the partner."
},
"default_currency": {
"type": "string",
"description": "Default currency of the partner."
},
"phone": {
"type": "string",
"description": "Phone number of the partner."
},
"contact_name": {
"type": "string",
"description": "The contact name of the partner."
},
"contact_email": {
"type": "string",
"description": "The contact email of the partner."
},
"contact_locale": {
"type": "string",
"description": "The contact ISO locale for the partner."
}
}
}
}
},
"User_Publisher_Wrapper": {
"properties": {
"user": {
"$ref": "#/components/schemas/User_Publisher"
}
},
"type": "object"
},
"Publisher_Website": {
"properties": {
"publisher_id": {
"description": "ID of the partner the website belongs to",
"type": "string"
},
"website_id": {
"description": "ID of the partner website",
"type": "string"
},
"active": {
"$ref": "#/components/schemas/YesOrNo"
},
"primary": {
"$ref": "#/components/schemas/YesOrNo"
},
"website_country": {
"$ref": "#/components/schemas/Country"
},
"website_name": {
"type": "string"
},
"website_type": {
"type": "number"
},
"website_type_name": {
"type": "string"
},
"website_url": {
"type": "string"
},
"website_vertical": {
"type": "number"
},
"website_vertical_name": {
"type": "string"
}
},
"required": [
"website_url"
],
"type": "object"
},
"Publisher_Website_Wrapper": {
"properties": {
"website": {
"$ref": "#/components/schemas/Publisher_Website"
}
},
"type": "object"
},
"Publisher_Database": {
"properties": {
"database_id": {
"description": "ID of the partner database",
"type": "string"
},
"publisher_id": {
"description": "ID of the partner the database belongs to",
"type": "string"
},
"active": {
"$ref": "#/components/schemas/YesOrNo"
},
"creation_method": {
"type": "string"
},
"database_name": {
"type": "string"
},
"female": {
"type": "number"
},
"male": {
"type": "number"
},
"max_age": {
"type": "number"
},
"min_age": {
"type": "number"
},
"size": {
"type": "number"
}
},
"required": [
"database_name",
"creation_method",
"size"
],
"type": "object"
},
"Publisher_Database_Wrapper": {
"properties": {
"database": {
"$ref": "#/components/schemas/Publisher_Database"
}
},
"type": "object"
},
"Term_Wrapper": {
"properties": {
"database": {
"$ref": "#/components/schemas/Term"
}
},
"type": "object"
},
"Term": {
"properties": {
"locale": {
"$ref": "#/components/schemas/Locale",
"description": "Locale of the terms"
},
"ref_legal_entity_id": {
"$ref": "#/components/schemas/Legal_Entities",
"description": "Legal entity of the terms"
},
"ref_terms_and_conditions_locale_id": {
"description": "Terms and conditions ID, used for partner signup",
"type": "string"
},
"terms_and_conditions": {
"description": "Terms and condition content",
"type": "string"
},
"tnc_type": {
"enum": [
"entity",
"network"
],
"type": "string"
}
},
"type": "object"
},
"Campaign_Wrapper": {
"properties": {
"campaign": {
"$ref": "#/components/schemas/Campaign"
}
},
"type": "object"
},
"Campaign": {
"oneOf": [
{
"properties": {
"default_commission_rate": {
"type": "string"
}
},
"type": "object"
},
{
"properties": {
"default_commission_value": {
"type": "string"
}
},
"type": "object"
}
],
"properties": {
"advertiser_icon": {
"type": "string",
"nullable": true
},
"advertiser_id": {
"description": "ID of the brand the campaign should belong to",
"type": "string"
},
"advertiser_name": {
"description": "Advertiser name",
"type": "string"
},
"allow_deep_linking": {
"$ref": "#/components/schemas/YesOrNo"
},
"allow_third_party_pixel": {
"$ref": "#/components/schemas/YesOrNo"
},
"app_tracking_provider_tracking_link": {
"type": "string"
},
"app_tracking_provider": {
"type": "string",
"enum": [
"branch",
"partnerize"
]
},
"append_url_parameters": {
"type": "string"
},
"associated_campaigns": {
"type": "string"
},
"automated_invoicing_date": {
"type": "number"
},
"automated_invoicing_po_number": {
"type": "string"
},
"auto_approve_publisher": {
"$ref": "#/components/schemas/YesOrNo"
},
"auto_rejected_ips": {
"nullable": true,
"type": "string"
},
"basket_value_cap": {
"nullable": true,
"type": "number"
},
"budget_summary_interval": {
"nullable": true,
"type": "number"
},
"budget_summary_start_time": {
"nullable": true,
"type": "string"
},
"campaign_currency_conversions": {},
"campaign_id": {
"description": "ID of the campaign",
"type": "string"
},
"campaign_icon": {
"description": "URL to image",
"type": "string"
},
"campaign_icon_upload": {
"description": "base64 encoded image",
"type": "string"
},
"campaign_languages": {
"nullable": true,
"properties": {},
"type": "object"
},
"campaign_logo": {
"nullable": true,
"type": "string"
},
"campaign_notes": {
"type": "string"
},
"campaign_overloads": {},
"commission_by_meta": {
"type": "string"
},
"commission_by_meta_label": {
"type": "string"
},
"commissions": {},
"conversion_hiatus_period": {
"type": "number"
},
"conversion_type": {
"type": "string"
},
"cookie_period": {
"type": "number"
},
"cookie_status": {
"nullable": true,
"type": "string"
},
"deeplink_method": {
"type": "string",
"enum": [
"standard",
"direct"
]
},
"default_currency": {
"$ref": "#/components/schemas/Currency"
},
"default_override": {
"type": "number"
},
"deferred_lead_submission": {
"nullable": true,
"type": "string"
},
"description": {
"nullable": true,
"properties": {
"en": {
"type": "string"
}
},
"type": "object"
},
"destination_url": {
"type": "string"
},
"dont_consolidate": {
"$ref": "#/components/schemas/YesOrNo"
},
"dont_invoice": {
"$ref": "#/components/schemas/YesOrNo"
},
"extra_restricted_deep_linking": {
"type": "string"
},
"force_approve_period": {
"type": "number"
},
"hidden_campaign": {
"$ref": "#/components/schemas/YesOrNo"
},
"invoice_address_1": {
"nullable": true,
"type": "string"
},
"invoice_address_2": {
"nullable": true,
"type": "string"
},
"invoice_address_3": {
"nullable": true,
"type": "string"
},
"invoice_address_4": {
"nullable": true,
"type": "string"
},
"invoice_address_country": {
"nullable": true,
"type": "string"
},
"invoice_address_postcode": {
"nullable": true,
"type": "string"
},
"invoice_company": {
"nullable": true,
"type": "string"
},
"invoice_contact": {
"nullable": true,
"type": "string"
},
"invoice_only": {
"nullable": true,
"type": "string"
},
"ip_tracking_time": {
"type": "number"
},
"is_cpc": {
"$ref": "#/components/schemas/YesOrNo"
},
"lead_confirmation_url_fail": {
"type": "string"
},
"lead_confirmation_url_success": {
"type": "string"
},
"meta_field_values_field_limit": {
"type": "number"
},
"meta_field_values_total_limit": {
"type": "number"
},
"multiple_conversions_per_click": {
"anyOf": [
{
"enum": [
"y",
"n"
],
"type": "string"
},
{
"enum": [
2,
3,
4,
5,
6,
7,
8,
9,
10
],
"type": "number"
}
]
},
"network_fee": {
"nullable": true,
"type": "string"
},
"pay_publisher_directly": {
"$ref": "#/components/schemas/YesOrNo"
},
"payment_date": {
"nullable": true,
"type": "string"
},
"prepend_url_string": {
"description": "Prepend all destination URLs",
"nullable": true,
"type": "string"
},
"promotional_countrie
# --- truncated at 32 KB (114 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/partnerize/refs/heads/main/json-schema/partnerize-brands-api-schema.json