HubSpot: Campaigns schemas

← Campaigns operations · All schemas

Add budget item — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
amount	number	Required within parent	The monetary value of the budget item, represented as a number.
description	string	Optional	A string providing additional details about the budget item.
name	string	Required within parent	The name of the budget item. It is a string that identifies the budget item.
order	integer	Required within parent	An integer indicating the order or sequence of the budget item. Format: int32

Add budget item — response body

Field	Type	Presence	Description and constraints
$	object	Root
amount	JSON	Required within parent
amount (anyOf 1)	number	Alternative	The financial amount allocated to this budget item, represented as a number.
amount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
createdAt	JSON	Required within parent
createdAt (anyOf 1)	integer	Alternative	A Unix timestamp in milliseconds indicating when this budget item was created. Format: int64
createdAt (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
description	string	Optional	A description of the budget item, represented as a string.
id	string	Required within parent	The unique identifier for this budget item, represented as a string.
name	string	Required within parent	The name of the budget item, represented as a string.
order	JSON	Required within parent
order (anyOf 1)	integer	Alternative	An integer representing the order or sequence of this budget item within the campaign. Format: int32
order (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
updatedAt	JSON	Required within parent
updatedAt (anyOf 1)	integer	Alternative	A Unix timestamp in milliseconds indicating when this budget item was last updated. Format: int64
updatedAt (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Batch archive campaigns — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
inputs	array	Required within parent	An array of PublicCampaignDeleteInput objects, each representing a campaign to be deleted. Each object must include the campaign's unique identifier.
inputs[]	Model	Each item	Expand Batch archive campaigns — request body — body inputs item

Referenced models: Batch archive campaigns — request body — body inputs item

Batch archive campaigns — request body — body inputs item

Field	Type	Presence	Description and constraints
$	object	Root
id	string	Required within parent	The unique identifier of the campaign to be deleted. It is a string.

Batch create campaigns — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
inputs	array	Required within parent	An array of PublicCampaignInput objects, each representing the properties of a campaign to be created. This is a required field.
inputs[]	Model	Each item	Expand Create a campaign — request body — body

Referenced models: Create a campaign — request body — body

Batch create campaigns — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item

Field	Type	Presence	Description and constraints
$	object	Root	Ye olde error
category	string	Required within parent	A string categorizing the type of error.
context	object	Required within parent	An object containing additional context about the error, with keys as context names and values as arrays of strings. Additional keys: see wildcard field
context.*	array	Additional keys
context.*[]	string	Each item
errors	array	Required within parent	An array of ErrorDetail objects providing further information about the error.
errors[]	Model	Each item	Expand Batch create campaigns — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item errors item
id	string	Optional	A string representing a unique identifier for the error.
links	object	Required within parent	An object mapping link names to associated URIs that contain documentation or remediation steps related to the error. Additional keys: see wildcard field
links.*	string	Additional keys
message	string	Required within parent	A string containing a human-readable message describing the error.
status	string	Required within parent	A string indicating the status of the error.
subCategory	object	Optional	An object providing more specific categorization of the error.

Referenced models: Batch create campaigns — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item errors item

Batch create campaigns — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item errors item

Field	Type	Presence	Description and constraints
$	object	Root	Represents detailed information about an error that occurred in the API. This component is used to provide additional context and specifics about errors, typically as part of an error response.
code	string	Optional	The status code associated with the error detail. This is a string.
context	object	Optional	Context about the error condition, provided as an object where each key is a context name and the value is an array of strings providing additional information. Additional keys: see wildcard field
context.*	array	Additional keys
context.*[]	string	Each item
in	string	Optional	The name of the field or parameter in which the error was found. This is a string.
message	string	Required within parent	A human readable message describing the error along with remediation steps where appropriate. This is a string.
subCategory	string	Optional	A specific category that contains more specific detail about the error. This is a string.

Batch create campaigns — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Batch Response Public Campaign

Field	Type	Presence	Description and constraints
$	object	Root
completedAt	string	Required within parent	The date and time when the batch operation was completed, in ISO 8601 format. Format: date-time
links	object	Optional	A map of link names to associated URIs that provide additional information related to the batch operation. Additional keys: see wildcard field
links.*	string	Additional keys
requestedAt	string	Optional	The date and time when the batch operation was requested, in ISO 8601 format. Format: date-time
results	array	Required within parent	An array of public campaign objects that represent the results of the batch operation.
results[]	Model	Each item	Expand Create a campaign — response body
startedAt	string	Required within parent	The date and time when the batch operation started, in ISO 8601 format. Format: date-time
status	string	Required within parent	The current status of the batch operation. Valid values include 'PENDING', 'PROCESSING', 'CANCELED', and 'COMPLETE'. Known values: CANCELED, COMPLETE, PENDING, PROCESSING

Referenced models: Create a campaign — response body

Batch create campaigns — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Batch Response Public Campaign With Errors

Field	Type	Presence	Description and constraints
$	object	Root
completedAt	string	Required within parent	The date and time when the batch operation was completed, in ISO 8601 format. Format: date-time
errors	array	Optional	An array of standard error objects detailing any errors that occurred during the batch operation.
errors[]	Model	Each item	Expand Batch create campaigns — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item
links	object	Optional	A map of link names to associated URIs, providing additional information or actions related to the batch operation. Additional keys: see wildcard field
links.*	string	Additional keys
numErrors	JSON	Optional
numErrors (anyOf 1)	integer	Alternative	The number of errors encountered during the batch operation. Format: int32
numErrors (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
requestedAt	string	Optional	The date and time when the batch operation was requested, in ISO 8601 format. Format: date-time
results	array	Required within parent	An array of public campaign objects representing the results of the batch operation.
results[]	Model	Each item	Expand Create a campaign — response body
startedAt	string	Required within parent	The date and time when the batch operation started, in ISO 8601 format. Format: date-time
status	string	Required within parent	The current status of the batch operation. Valid values include 'PENDING', 'PROCESSING', 'CANCELED', and 'COMPLETE'. Known values: CANCELED, COMPLETE, PENDING, PROCESSING

Referenced models: Batch create campaigns — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item, Create a campaign — response body

Batch retrieve campaigns — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
inputs	array	Required within parent	An array of PublicCampaignReadInput objects, each containing the ID of a campaign to be read. This property is required.
inputs[]	Model	Each item	Expand Batch retrieve campaigns — request body — body inputs item

Referenced models: Batch retrieve campaigns — request body — body inputs item

Batch retrieve campaigns — request body — body inputs item

Field	Type	Presence	Description and constraints
$	object	Root
id	string	Required within parent	The unique identifier for the campaign. It is a string and is required to retrieve the campaign details.

Batch retrieve campaigns — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Batch Response Public Campaign With Assets

Field	Type	Presence	Description and constraints
$	object	Root
completedAt	string	Required within parent	The date and time when the batch operation was completed, in ISO 8601 format. Format: date-time
links	object	Optional	A map of link names to associated URIs, providing additional resources or documentation related to the batch operation. Additional keys: see wildcard field
links.*	string	Additional keys
requestedAt	string	Optional	The date and time when the batch operation was requested, in ISO 8601 format. Format: date-time
results	array	Required within parent	An array of PublicCampaignWithAssets objects, representing the campaigns involved in the batch operation.
results[]	Model	Each item	Expand Retrieve a campaign — response body
startedAt	string	Required within parent	The date and time when the batch operation started, in ISO 8601 format. Format: date-time
status	string	Required within parent	The current status of the batch operation. Valid values include 'PENDING', 'PROCESSING', 'CANCELED', and 'COMPLETE'. Known values: CANCELED, COMPLETE, PENDING, PROCESSING

Referenced models: Retrieve a campaign — response body

Batch retrieve campaigns — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING — Batch Response Public Campaign With Assets With Errors

Field	Type	Presence	Description and constraints
$	object	Root
completedAt	string	Required within parent	The date and time when the batch operation was completed, in ISO 8601 format. Format: date-time
errors	array	Optional	An array of errors that occurred during the batch operation, each described by a standard error object.
errors[]	Model	Each item	Expand Batch create campaigns — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item
links	object	Optional	A map of link names to associated URIs that provide additional information about the batch operation. Additional keys: see wildcard field
links.*	string	Additional keys
numErrors	JSON	Optional
numErrors (anyOf 1)	integer	Alternative	The number of errors that occurred during the batch operation. Format: int32
numErrors (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
requestedAt	string	Optional	The date and time when the batch operation was requested, in ISO 8601 format. Format: date-time
results	array	Required within parent	An array of campaigns with their associated assets that were processed in the batch operation.
results[]	Model	Each item	Expand Retrieve a campaign — response body
startedAt	string	Required within parent	The date and time when the batch operation started, in ISO 8601 format. Format: date-time
status	string	Required within parent	The current status of the batch operation. Valid values include 'PENDING', 'PROCESSING', 'CANCELED', and 'COMPLETE'. Known values: CANCELED, COMPLETE, PENDING, PROCESSING

Referenced models: Batch create campaigns — response body — status: CANCELED, COMPLETE, PENDING, PROCESSING errors item, Retrieve a campaign — response body

Batch update campaigns — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
inputs	array	Required within parent	An array of PublicCampaignBatchUpdateItem objects, each containing the details required to update a specific campaign.
inputs[]	Model	Each item	Expand Batch update campaigns — request body — body inputs item

Referenced models: Batch update campaigns — request body — body inputs item

Batch update campaigns — request body — body inputs item

Field	Type	Presence	Description and constraints
$	object	Root
id	string	Required within parent	The unique identifier for the campaign to be updated. It is a string.
properties	object	Required within parent	An object containing key-value pairs of the campaign properties to be updated. Each key is a property name, and each value is the new value for that property, represented as a string. Additional keys: see wildcard field
properties.*	string	Additional keys

Clone a campaign — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
assetsToClone	object	Required within parent	A map of asset types to be cloned, where each key is an asset type and the value is an array of asset identifiers. It is an object. Additional keys: see wildcard field
assetsToClone.*	array	Additional keys
assetsToClone.*[]	string	Each item
audience	string	Optional	The target audience for the cloned campaign. It is a string.
currencyCode	string	Optional	The currency code for the cloned campaign's budget. It is a string. This value is optional.
endDate	string	Optional	The end date for the cloned campaign. It is a string in ISO 8601 format (YYYY-MM-DD). If omitted, this will match the start date of the source campaign.
name	string	Required within parent	The name for the new cloned campaign. It is a string. The name needs to be unique compared to other campaigns in the portal.
notes	string	Optional	Additional notes or comments about the cloned campaign. It is a string. This value is optional.
shouldCloneDraftNodes	boolean	Required within parent	A boolean indicating whether draft nodes should be cloned. By default this is true.
shouldCloneEdges	boolean	Required within parent	A boolean indicating whether edges should be cloned. By default this is true.
shouldCloneStickyNotes	boolean	Required within parent	A boolean indicating whether sticky notes should be cloned. By default this is true.
shouldCloneTasks	boolean	Required within parent	A boolean indicating whether tasks should be cloned. By default this is true.
shouldCloneTrackingUrls	boolean	Required within parent	A boolean indicating whether tracking URLs should be cloned. By default this is true.
sourceCampaignGuid	string	Required within parent	The unique identifier of the campaign to be cloned. It is a string.
startDate	string	Optional	The start date for the cloned campaign. It is a string in ISO 8601 format (YYYY-MM-DD). If omitted, this will match the start date of the source campaign.

Clone a campaign — response body

Field	Type	Presence	Description and constraints
$	object	Root
campaignGuid	string	Required within parent	The unique identifier for the newly cloned campaign.
status	string	Required within parent	The status of the cloning operation. Valid values include 'PENDING', 'COMPLETE', 'FAILED', and 'PARTIAL_FAILURE'. Known values: COMPLETE, FAILED, PARTIAL_FAILURE, PENDING

Create a campaign — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
properties	object	Required within parent	An object containing key-value pairs where each key is a property name and each value is a string representing the property's value. This object holds the various attributes of the campaign. Additional keys: see wildcard field
properties.*	string	Additional keys

Create a campaign — response body

Field	Type	Presence	Description and constraints
$	object	Root
businessUnits	array	Required within parent	An array of business units associated with the campaign, where each business unit is represented by its unique identifier.
businessUnits[]	Model	Each item	Expand Create a campaign — response body — business Units item
createdAt	string	Required within parent	The date and time when the campaign was created, in ISO 8601 format. Format: date-time
id	string	Required within parent	The unique identifier for the campaign.
properties	object	Required within parent	A map of custom property names to their values, representing specific attributes of the campaign. Additional keys: see wildcard field
properties.*	string	Additional keys
updatedAt	string	Required within parent	The date and time when the campaign was last updated, in ISO 8601 format. Format: date-time

Referenced models: Create a campaign — response body — business Units item

Create a campaign — response body — business Units item

Field	Type	Presence	Description and constraints
$	object	Root
id	JSON	Required within parent
id (anyOf 1)	integer	Alternative	The unique identifier for the business unit, represented as a 64-bit integer. Format: int64
id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Create spend item — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
amount	number	Required within parent	The monetary value of the spend item, represented as a number.
description	string	Optional	A string providing additional details or context about the spend item.
name	string	Required within parent	The name of the spend item, represented as a string.
order	integer	Required within parent	An integer indicating the order or sequence of the spend item within a list. Format: int32

Create spend item — response body

Field	Type	Presence	Description and constraints
$	object	Root
amount	JSON	Required within parent
amount (anyOf 1)	number	Alternative	The financial amount associated with the spend item, represented as a number.
amount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
createdAt	JSON	Required within parent
createdAt (anyOf 1)	integer	Alternative	A Unix timestamp in milliseconds indicating when the spend item was created. Format: int64
createdAt (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
description	string	Optional	A string providing additional details about the spend item.
id	string	Required within parent	The unique identifier for the spend item, represented as a string.
name	string	Required within parent	The name of the spend item, represented as a string.
order	JSON	Required within parent
order (anyOf 1)	integer	Alternative	An integer indicating the order or sequence of the spend item. Format: int32
order (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
updatedAt	JSON	Required within parent
updatedAt (anyOf 1)	integer	Alternative	A Unix timestamp in milliseconds indicating when the spend item was last updated. Format: int64
updatedAt (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Retrieve a campaign — response body

Field	Type	Presence	Description and constraints
$	object	Root
assets	object	Required within parent	A map of asset types to their respective collections of campaign assets, represented by CollectionResponsePublicCampaignAsset objects. Additional keys: see wildcard field
assets.*	Model	Additional keys	Expand Retrieve a campaign — response body — assets value
businessUnits	array	Required within parent	An array of business units associated with the campaign, each represented by a PublicBusinessUnit object.
businessUnits[]	Model	Each item	Expand Create a campaign — response body — business Units item
createdAt	string	Required within parent	The date and time when the campaign was created, in ISO 8601 format. Format: date-time
id	string	Required within parent	The unique identifier for the campaign, represented as a string.
properties	object	Required within parent	A map of custom property names to their values, where each value is a string. Additional keys: see wildcard field
properties.*	string	Additional keys
updatedAt	string	Required within parent	The date and time when the campaign was last updated, in ISO 8601 format. Format: date-time

Referenced models: Create a campaign — response body — business Units item, Retrieve a campaign — response body — assets value

Retrieve a campaign — response body — assets value

Field	Type	Presence	Description and constraints
$	object	Root
paging	Model	Optional	Expand Retrieve campaigns — response body — paging
results	array	Required within parent	An array of PublicCampaignAsset objects, each representing an individual campaign asset.
results[]	Model	Each item	Expand Retrieve assets — response body — results item

Referenced models: Retrieve campaigns — response body — paging, Retrieve assets — response body — results item

Retrieve asset types — response body

Field	Type	Presence	Description and constraints
$	object	Root
results	array	Required within parent	An array of strings representing the collection of results returned by the API. Each item in the array is a string.
results[]	string	Each item

Retrieve assets — response body

Field	Type	Presence	Description and constraints
$	object	Root
paging	Model	Optional	Expand Retrieve assets — response body — paging
results	array	Required within parent	An array of PublicCampaignAsset objects, each representing a campaign asset.
results[]	Model	Each item	Expand Retrieve assets — response body — results item

Referenced models: Retrieve assets — response body — paging, Retrieve assets — response body — results item

Retrieve assets — response body — paging

Field	Type	Presence	Description and constraints
$	object	Root	Paging information for forward-only pagination. Contains the next page reference when more results are available; omitted or empty on the last page.
next	Model	Optional	Expand Retrieve assets — response body — paging next

Referenced models: Retrieve assets — response body — paging next

Retrieve assets — response body — paging next

Field	Type	Presence	Description and constraints
$	object	Root	Specifies the paging information needed to retrieve the next set of results in a paginated API response
after	string	Required within parent	A string token that serves as the paging cursor, indicating the position after the last successfully read resource.
link	string	Optional	A string URL that provides a link to the next page of results.

Retrieve assets — response body — results item

Field	Type	Presence	Description and constraints
$	object	Root
id	string	Required within parent	The unique identifier for the campaign asset, represented as a string.
metrics	object	Optional	A collection of performance metrics for the campaign asset, represented as a map where each key is a metric name and each value is a number. Additional keys: see wildcard field
metrics.*	JSON	Additional keys
metrics.* (anyOf 1)	number	Alternative
metrics.* (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
name	string	Optional	The name of the campaign asset, represented as a string.

Retrieve budget details — response body

Field	Type	Presence	Description and constraints
$	object	Root
budgetItems	array	Required within parent	An array of budget items associated with the campaign, each represented by a PublicBudgetItem object.
budgetItems[]	Model	Each item	Expand Add budget item — response body
budgetTotal	JSON	Optional
budgetTotal (anyOf 1)	number	Alternative	The total amount of the budget allocated for the campaign, expressed as a number.
budgetTotal (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
currencyCode	string	Required within parent	The currency code used for the budget and spending amounts, represented as a string. Valid values include standard currency codes such as 'USD', 'EUR', 'JPY', etc. Known values: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STN, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USN, UYI, UYU, UZS, VEF, VND, VUV, WST, XAF, XAG, XAU, XBA, XBB, XBC, XBD, XCD, XDR, XOF, XPD, XPF, XPT, XSU, XUA, YER, ZAR, ZMW, ZWL
remainingBudget	JSON	Optional
remainingBudget (anyOf 1)	number	Alternative	The remaining budget available for the campaign, calculated as the difference between the budgetTotal and spendTotal, expressed as a number.
remainingBudget (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
spendItems	array	Required within parent	An array of spend items associated with the campaign, each represented by a PublicSpendItem object.
spendItems[]	Model	Each item	Expand Create spend item — response body
spendTotal	JSON	Optional
spendTotal (anyOf 1)	number	Alternative	The total amount spent in the campaign, expressed as a number.
spendTotal (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Add budget item — response body, Create spend item — response body

Retrieve campaigns — response body

Field	Type	Presence	Description and constraints
$	object	Root
paging	Model	Optional	Expand Retrieve campaigns — response body — paging
results	array	Required within parent	An array of PublicCampaign objects, each representing a campaign with its associated details.
results[]	Model	Each item	Expand Create a campaign — response body
total	JSON	Required within parent
total (anyOf 1)	integer	Alternative	An integer representing the total number of campaigns available. Format: int32
total (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Retrieve campaigns — response body — paging, Create a campaign — response body

Retrieve campaigns — response body — paging

Field	Type	Presence	Description and constraints
$	object	Root	Represents the pagination information for navigating through a list of results in the API. It provides details on how to access the previous or next set of results.
next	Model	Optional	Expand Retrieve assets — response body — paging next
prev	Model	Optional	Expand Retrieve campaigns — response body — paging prev

Referenced models: Retrieve assets — response body — paging next, Retrieve campaigns — response body — paging prev

Retrieve campaigns — response body — paging prev

Field	Type	Presence	Description and constraints
$	object	Root	specifies the paging information needed to retrieve the previous set of results in a paginated API response
before	string	Required within parent	A string token used to identify the position before the current page in the paginated results.
link	string	Optional	A URL string that provides a link to the previous page of results.

Retrieve contact I Ds — response body

Field	Type	Presence	Description and constraints
$	object	Root
paging	Model	Optional	Expand Retrieve assets — response body — paging
results	array	Required within parent	An array of contact references, each representing a contact associated with the campaign. Each item in the array is a ContactReference object.
results[]	Model	Each item	Expand Retrieve contact I Ds — response body — results item

Referenced models: Retrieve assets — response body — paging, Retrieve contact I Ds — response body — results item

Retrieve contact I Ds — response body — results item

Field	Type	Presence	Description and constraints
$	object	Root
id	string	Required within parent	The unique identifier for the contact reference, represented as a string.

Retrieve metrics — response body

Field	Type	Presence	Description and constraints
$	object	Root
influencedContacts	JSON	Required within parent
influencedContacts (anyOf 1)	integer	Alternative	The number of contacts that were influenced by the campaign. This is an integer value. Format: int32
influencedContacts (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
newContactsFirstTouch	JSON	Required within parent
newContactsFirstTouch (anyOf 1)	integer	Alternative	The number of new contacts that had their first interaction with the campaign. This is an integer value. Format: int32
newContactsFirstTouch (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
newContactsLastTouch	JSON	Required within parent
newContactsLastTouch (anyOf 1)	integer	Alternative	The number of new contacts that had their last interaction with the campaign. This is an integer value. Format: int32
newContactsLastTouch (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
sessions	JSON	Required within parent
sessions (anyOf 1)	integer	Alternative	The number of sessions associated with the campaign. This is an integer value. Format: int32
sessions (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Retrieve revenue report — response body

Field	Type	Presence	Description and constraints
$	object	Root
contactsNumber	JSON	Optional
contactsNumber (anyOf 1)	integer	Alternative	An integer representing the number of contacts associated with the campaign. Format: int32
contactsNumber (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
currencyCode	string	Optional	A string representing the currency code for the financial amounts, following ISO 4217 standards. Valid values include currency codes like 'USD', 'EUR', 'JPY', etc. Known values: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STN, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USN, UYI, UYU, UZS, VEF, VND, VUV, WST, XAF, XAG, XAU, XBA, XBB, XBC, XBD, XCD, XDR, XOF, XPD, XPF, XPT, XSU, XUA, YER, ZAR, ZMW, ZWL
dealAmount	JSON	Optional
dealAmount (anyOf 1)	number	Alternative	A number representing the total amount from deals associated with the campaign.
dealAmount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
dealsNumber	JSON	Optional
dealsNumber (anyOf 1)	integer	Alternative	An integer indicating the number of deals associated with the campaign. Format: int32
dealsNumber (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
revenueAmount	JSON	Optional
revenueAmount (anyOf 1)	number	Alternative	A number indicating the total revenue amount attributed to the campaign.
revenueAmount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$