Partnerize · Schema
Partnerize Partners API Schemas
JSON Schema definitions extracted from the Partnerize Partners API (OAS 3.0.1)
Affiliate MarketingPartner MarketingPartnershipsPerformance MarketingCommissionsTrackingAnalytics
JSON Schema
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Partnerize Partners API Schemas",
"description": "JSON Schema definitions extracted from the Partnerize Partners API (OAS 3.0.1)",
"definitions": {
"Partner": {
"properties": {
"abn": {
"type": "string"
},
"account_name": {
"type": "string"
},
"campaign_select": {
"type": "string"
},
"company_name": {
"type": "string"
},
"company_division": {
"type": "string"
},
"company_logo": {
"type": "string",
"nullable": true
},
"contact_email": {
"type": "string",
"format": "email"
},
"contact_locale": {
"$ref": "#/components/schemas/Locale"
},
"contact_name": {
"type": "string"
},
"default_currency": {
"$ref": "#/components/schemas/Currency"
},
"description": {
"type": "string",
"description": "Description of the publisher"
},
"foreign_identifier": {
"type": "string"
},
"gst_registered": {
"type": "string"
},
"im_provider": {
"type": "string"
},
"im_username": {
"type": "string"
},
"is_affiliate_user": {
"$ref": "#/components/schemas/YesOrNo"
},
"is_foreign_network": {
"description": "Reporting only flag. All conversions will be automatically approved but will not be invoiceable.",
"$ref": "#/components/schemas/YesOrNo"
},
"is_lead_user": {
"$ref": "#/components/schemas/YesOrNo"
},
"legal_entity": {
"$ref": "#/components/schemas/Country"
},
"network_id": {
"type": "string",
"description": "ID of the network this publisher belongs to"
},
"network_notes": {
"type": "string"
},
"network_status": {
"$ref": "#/components/schemas/Status"
},
"operating_country": {
"$ref": "#/components/schemas/Country"
},
"phone": {
"type": "string",
"description": "Primary contact telephone number"
},
"phone_area": {
"type": "string",
"description": "Phone prefix to declare country or region"
},
"promotional_method_name": {
"type": "string"
},
"promotional_method": {
"type": "integer"
},
"publisher_id": {
"type": "string",
"description": "ID of the publisher"
},
"reporting_identifier": {
"type": "string"
},
"reporting_timezone": {
"type": "string"
},
"signup_ip": {
"type": "string",
"format": "ipv4"
},
"uk_vat_registered": {
"$ref": "#/components/schemas/YesOrNo"
},
"us_tax_state": {
"type": "string"
},
"vat_number": {
"type": "integer"
},
"vertical": {
"type": "integer"
},
"vertical_name": {
"type": "string"
},
"week_start": {
"type": "string"
}
}
},
"Partner_Campaign_Wrapper": {
"properties": {
"campaign": {
"allOf": [
{
"$ref": "#/components/schemas/Campaign"
},
{
"properties": {
"campaign_custom_terms_and_conditions_id": {
"type": "string"
},
"campaign_custom_terms_and_conditions_title": {
"type": "string"
},
"publisher_status": {
"$ref": "#/components/schemas/Status"
}
},
"type": "object"
}
]
}
},
"type": "object"
},
"Partner_Campaign_Creative": {
"properties": {
"campaign_creative": {
"properties": {
"campaign_id": {
"description": "Id of the campaign",
"type": "string"
},
"creatives": {
"properties": {
"Banner": {
"description": "number of Banner creatives",
"type": "number"
},
"Email": {
"description": "number of Emails",
"type": "number"
},
"Feed": {
"description": "number of Feeds",
"type": "number"
},
"HTML": {
"description": "number of HTML creatives",
"type": "number"
},
"HTML Form": {
"description": "number of HTML Forms",
"type": "number"
},
"Text Link": {
"description": "number of Text links",
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
}
}
},
"Feed": {
"properties": {
"feed": {
"properties": {
"campaign_feeds_id": {
"description": "ID of the Feed",
"type": "string"
},
"campaign_id": {
"description": "ID of the Campaign",
"type": "string"
},
"creative_id": {
"description": "ID of the Creative",
"type": "string"
},
"filename": {
"type": "string"
},
"filesize": {
"type": "number"
},
"filesize_compressed": {
"type": "number"
},
"last_processed": {
"description": "UNIX timestamp",
"type": "number"
},
"location": {
"type": "string"
},
"name": {
"type": "string"
},
"title": {
"description": "name of the Campaign",
"type": "string"
},
"updated": {
"description": "UNIX timestamp",
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"Selfbill": {
"properties": {
"selfbill": {
"properties": {
"creation_date": {
"type": "string"
},
"download": {
"description": "URL for PDF download",
"nullable": true,
"type": "string"
},
"item_download": {
"description": "URL for CSV item download",
"nullable": true,
"type": "string"
},
"items_in_bill": {
"type": "number"
},
"legal_entity": {
"$ref": "#/components/schemas/Country"
},
"majority_received_currency": {
"$ref": "#/components/schemas/Currency"
},
"net_value": {
"type": "number"
},
"paid_currency": {
"$ref": "#/components/schemas/Currency"
},
"payment_batch_id": {
"nullable": true,
"type": "string"
},
"payment_date": {
"nullable": true,
"type": "string"
},
"payment_detail_set_id": {
"type": "number"
},
"publisher_id": {
"description": "ID of the partner",
"type": "string"
},
"publisher_payment_detail_set_id": {
"nullable": true,
"type": "string"
},
"publisher_self_bill_id": {
"type": "string"
},
"publisher_self_bill_reference": {
"nullable": true,
"type": "string"
},
"self_bill_reference": {
"type": "string"
},
"selfbill_currency": {
"$ref": "#/components/schemas/Currency"
},
"status": {
"enum": [
"created"
],
"type": "string"
},
"timestamp": {
"type": "string"
},
"total_value": {
"type": "number"
},
"tracked_currency": {
"$ref": "#/components/schemas/Currency"
},
"tracked_net_value": {
"type": "number"
},
"vat_rate": {
"type": "number"
},
"vat_value": {
"type": "number"
},
"withheld_tax": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
},
"Payment_Details": {
"properties": {
"1011l22": {
"description": "Dynamic property name equal to the Payment details set Id. Example - 1011l22",
"properties": {
"publisher_payment_detail_set_id": {
"type": "string"
},
"country": {
"$ref": "#/components/schemas/Country"
},
"paid_currency": {
"$ref": "#/components/schemas/Currency"
},
"tracked_currency": {
"items": {
"$ref": "#/components/schemas/Currency"
},
"type": "array"
},
"payment_type_code": {
"type": "string"
},
"payment_type_name": {
"type": "string"
},
"automatic_self_bill_creation_date": {
"type": "string"
},
"automatic_self_bill_creation_threshold": {
"type": "string"
},
"suspended": {
"$ref": "#/components/schemas/YesOrNo"
},
"suspended_at": {
"type": "string"
},
"suspended_by": {
"type": "string"
},
"suspended_notes": {
"type": "string"
},
"payment_detail_values": {
"properties": {
"bank_address": {
"type": "string"
},
"account_number": {
"type": "number"
},
"account_name": {
"type": "string"
},
"bank_name": {
"type": "string"
},
"routing_number": {
"type": "number"
}
},
"type": "object"
}
},
"type": "object"
}
}
},
"Link": {
"properties": {
"id": {
"type": "string"
},
"campaign_id": {
"type": "string"
},
"description": {
"type": "string"
},
"destination_url": {
"type": "string"
},
"tracking_short_url": {
"type": "string"
},
"tracking_url": {
"type": "string"
},
"params": {
"items": {
"$ref": "#/components/schemas/Key_Value_Pair"
}
},
"active": {
"type": "boolean"
}
},
"type": "object"
},
"Key_Value_Pair": {
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "string"
}
},
"type": "object"
},
"Partner_Overview_Base": {
"properties": {
"count": {
"type": "number"
},
"execution_time": {
"type": "string"
},
"start_date_time": {
"type": "string"
},
"end_date_time": {
"type": "string"
},
"total_impression_count": {
"type": "number"
},
"total_click_count": {
"type": "number"
},
"total_conversion_count": {
"description": "conversion count for each currency. E.g. \"USD\": 25, \"EUR\": 37",
"type": "object",
"properties": {
"currency_iso": {
"description": "key value pairs where the currency iso is the key. E.g. EUR: 37",
"type": "number"
}
}
},
"total_commission_value": {
"description": "commission value for each currency. E.g. \"USD\": 324.65, \"EUR\": 583.59",
"type": "object",
"properties": {
"currency_iso": {
"description": "key value pairs where the currency iso is the key. E.g. EUR: 37",
"type": "number"
}
}
},
"total_order_value": {
"description": "order value for each currency. E.g. \"USD\": 4000, \"EUR\": 5400.25",
"type": "object",
"properties": {
"currency_iso": {
"description": "key value pairs where the currency iso is the key. E.g. EUR: 37",
"type": "number"
}
}
},
"total_publisher_commission_value": {
"description": "commission value for each currency. E.g. \"USD\": 400, \"EUR\": 311.215",
"type": "object",
"properties": {
"currency_iso": {
"description": "key value pairs where the currency iso is the key. E.g. EUR: 37",
"type": "number"
}
}
},
"total_rejection_rate": {
"properties": {
"all_conversions_count": {
"type": "number"
},
"percentage": {
"type": "number"
},
"rejected_conversions_count": {
"type": "number"
}
},
"type": "object"
},
"total_quantity": {
"type": "number"
},
"total_clickthrough_rate": {
"type": "number"
},
"total_ordersize_avg": {
"type": "number"
}
}
},
"Partner_Overview_Currency_Stats": {
"properties": {
"impressions": {
"type": "number"
},
"clicks": {
"type": "number"
},
"currency": {
"items": {
"properties": {
"currency_iso": {
"description": "key value pairs where the `currency iso` is the key and the value is an object containing a set of stats for the currency",
"properties": {
"commissions": {
"type": "number"
},
"conversions": {
"type": "number"
},
"ordervalue": {
"type": "number"
},
"quantity": {
"type": "number"
},
"publisher_commission": {
"type": "number"
},
"ordervalue_avg": {
"type": "number"
},
"conversion_rate": {
"type": "number"
},
"earnings_per_click": {
"type": "number"
},
"ordersize_avg": {
"type": "number"
}
}
}
},
"type": "object"
},
"type": "array"
},
"quantity": {
"type": "number"
},
"rejection_rate": {
"properties": {
"percentage": {
"type": "number"
},
"all_conversions_count": {
"type": "number"
},
"rejected_conversions_count": {
"type": "number"
}
},
"type": "object"
},
"clickthrough_rate": {
"type": "number"
},
"ordersize_avg": {
"type": "number"
}
}
},
"Partner_Overview_Primary": {
"allOf": [
{
"$ref": "#/components/schemas/Partner_Overview_Base"
},
{
"type": "object",
"properties": {
"campaigns": {
"items": {
"properties": {
"campaign": {
"allOf": [
{
"$ref": "#/components/schemas/Partner_Overview_Currency_Stats"
},
{
"type": "object",
"properties": {
"campaign_id": {
"type": "string"
},
"title": {
"type": "string"
}
}
}
]
}
}
},
"type": "array"
}
}
}
]
},
"Partner_Overview_Country": {
"allOf": [
{
"$ref": "#/components/schemas/Partner_Overview_Base"
},
{
"type": "object",
"properties": {
"countrys": {
"items": {
"properties": {
"country": {
"allOf": [
{
"$ref": "#/components/schemas/Partner_Overview_Currency_Stats"
},
{
"type": "object",
"properties": {
"country_iso": {
"$ref": "#/components/schemas/Country"
}
}
}
]
}
}
},
"type": "array"
}
}
}
]
},
"Partner_Overview_Self": {
"allOf": [
{
"$ref": "#/components/schemas/Partner_Overview_Base"
},
{
"type": "object",
"properties": {
"publishers": {
"items": {
"properties": {
"publisher": {
"allOf": [
{
"$ref": "#/components/schemas/Partner_Overview_Currency_Stats"
},
{
"type": "object",
"properties": {
"publisher_id": {
"type": "string"
},
"title": {
"type": "string"
}
}
}
]
}
}
},
"type": "array"
}
}
}
]
},
"Partner_Overview_Product": {
"allOf": [
{
"$ref": "#/components/schemas/Partner_Overview_Base"
},
{
"type": "object",
"properties": {
"products": {
"items": {
"properties": {
"product": {
"allOf": [
{
"$ref": "#/components/schemas/Partner_Overview_Currency_Stats"
},
{
"type": "object",
"properties": {
"product": {
"type": "string"
}
}
}
]
}
}
},
"type": "array"
}
}
}
]
},
"Partner_Overview_Pubref": {
"allOf": [
{
"$ref": "#/components/schemas/Partner_Overview_Base"
},
{
"type": "object",
"properties": {
"pubrefs": {
"items": {
"properties": {
"pubref": {
"allOf": [
{
"$ref": "#/components/schemas/Partner_Overview_Currency_Stats"
},
{
"type": "object",
"properties": {
"reserved_tag_name": {
"type": "boolean"
},
"pubref": {
"type": "string"
}
}
}
]
}
}
},
"type": "array"
}
}
}
]
},
"Partner_Overview_Adref": {
"allOf": [
{
"$ref": "#/components/schemas/Partner_Overview_Base"
},
{
"type": "object",
"properties": {
"adrefs": {
"items": {
"properties": {
"adref": {
"allOf": [
{
"$ref": "#/components/schemas/Partner_Overview_Currency_Stats"
},
{
"type": "object",
"properties": {
"adref": {
"type": "string"
}
}
}
]
}
}
},
"type": "array"
}
}
}
]
},
"Partner_Overview_Creative": {
"allOf": [
{
"$ref": "#/components/schemas/Partner_Overview_Base"
},
{
"type": "object",
"properties": {
"creatives": {
"items": {
"properties": {
"creative": {
"allOf": [
{
"$ref": "#/components/schemas/Partner_Overview_Currency_Stats"
},
{
"type": "object",
"properties": {
"reserved_tag_name": {
"type": "boolean"
},
"creative_id": {
"type": "string"
},
"creative_description": {
"type": "string"
},
"creative_items": {
"items": {
"$ref": "#/components/schemas/Creative_Item"
},
"type": "array"
}
}
}
]
}
}
},
"type": "array"
}
}
}
]
},
"Partner_Overview_Agent": {
"allOf": [
{
"$ref": "#/components/schemas/Partner_Overview_Base"
},
{
"type": "object",
"properties": {
"agents": {
"items": {
"properties": {
"agent": {
"allOf": [
{
"$ref": "#/components/schemas/Partner_Overview_Currency_Stats"
},
{
"type": "object",
"properties": {
"agent_name": {
"type": "string"
},
"agent_items": {
"items": {},
"type": "array"
}
}
}
]
}
}
},
"type": "array"
}
}
}
]
},
"Partner_Overview_Custref": {
"allOf": [
{
"$ref": "#/components/schemas/Partner_Overview_Base"
},
{
"type": "object",
"properties": {
"custrefs": {
"items": {
"properties": {
"custref": {
"allOf": [
{
"$ref": "#/components/schemas/Partner_Overview_Currency_Stats"
},
{
"type": "object",
"properties": {
"custref": {
"type": "string"
}
}
}
]
}
}
},
"type": "array"
}
}
}
]
},
"Partner_Overview_Type": {
"allOf": [
{
"$ref": "#/components/schemas/Partner_Overview_Base"
},
{
"type": "object",
"properties": {
"types": {
"items": {
"properties": {
"type": {
"allOf": [
{
"$ref": "#/components/schemas/Partner_Overview_Currency_Stats"
},
{
"type": "object",
"properties": {
"type": {
"type": "number"
}
}
}
]
}
}
},
"type": "array"
}
}
}
]
},
"Partner_Overview_Device": {
"allOf": [
{
"$ref": "#/components/schemas/Partner_Overview_Base"
},
{
"type": "object",
"properties": {
"devices": {
"items": {
"properties": {
"device": {
"allOf": [
{
"$ref": "#/components/schemas/Partner_Overview_Currency_Stats"
},
{
"type": "object",
"properties": {
"device_id": {
"type": "number"
},
"device_title": {
"type": "string"
}
}
}
]
}
}
},
"type": "array"
}
}
}
]
},
"Partner_Overview_Source": {
"allOf": [
{
"$ref": "#/components/schemas/Partner_Overview_Base"
},
{
"type": "object",
"properties": {
"sources": {
"items": {
"properties": {
"source": {
"allOf": [
{
"$ref": "#/components/schemas/Partner_Overview_Currency_Stats"
},
{
"type": "object",
"properties": {
"source_id": {
"type": "number"
},
"source_title": {
"type": "string"
}
}
}
]
}
}
},
"type": "array"
}
}
}
]
},
"Partner_Overview_Partnership": {
"allOf": [
{
"$ref": "#/components/schemas/Partner_Overview_Base"
},
{
"type": "object",
"properties": {
"parnterships": {
"items": {
"properties": {
"parntership": {
"allOf": [
{
"$ref": "#/components/schemas/Partner_Overview_Currency_Stats"
},
{
"type": "object",
"properties": {
"parntership_id": {
"type": "number"
},
"partnership_title": {
"type": "string"
}
}
}
]
}
}
},
"type": "array"
}
}
}
]
},
"Partner_Overview_Metric": {
"allOf": [
{
"$ref": "#/components/schemas/Partner_Overview_Base"
},
{
"type": "object",
"properties": {
"metrics": {
"items": {
"properties": {
"metric": {
"allOf": [
{
"$ref": "#/components/schemas/Partner_Overview_Currency_Stats"
},
{
"type": "object",
"properties": {
"metric_id": {
"type": "number"
},
"metric_title": {
"type": "string"
}
}
}
]
}
}
},
"type": "array"
}
}
}
]
},
"Partner_Overview_Context": {
"allOf": [
{
"$ref": "#/components/schemas/Partner_Overview_Base"
},
{
"type": "object",
"properties": {
"contexts": {
"items": {
"properties": {
"context": {
"allOf": [
{
"$ref": "#/components/schemas/Partner_Overview_Currency_Stats"
},
{
"type": "object",
"properties": {
"context_id": {
"type": "number"
},
"context_title": {
"type": "string"
}
}
}
]
}
}
},
"type": "array"
}
}
}
]
},
"Partner_Overview_Period_Stats": {
"properties": {
"impressions": {
"type": "number"
},
"clicks": {
"type": "number"
},
"currency": {
"items": {
"properties": {
"currency_iso": {
"description": "key value pairs where the `currency iso` is the key and the value is an object containing a set of stats for the currency",
"properties": {
"commissions": {
"type": "number"
},
"conversions": {
"type": "number"
},
"ordervalue": {
"type": "number"
},
"quantity": {
# --- truncated at 32 KB (80 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/partnerize/refs/heads/main/json-schema/partnerize-partners-api-schema.json