Attributes

id integer
Unique identifier for the campaign.

name string
The name of the current campaign.

code string
The unique code of the current campaign.

lang string
The language code of the current campaign.

url string
The unique join link for the current campaign.

reach string
The reach of the current campaign (how many people it’s reached)

status enum
Shows the campaign status. Possible values could be: launched, draft, paused.

starts_at nullable date
Shows if the campaign will be started at a date in the future. If this value is null it means that campaign is already live.

ends_at nullable date
Shows if the campaign will expire at a date in the future. If this value is null it means the campaign will be live forever, unless it is manually paused or deleted from the dashboard.

created_at date
Shows when campaign was created.

fields associative array

Shows extra fields added in campaign.

fields . person_referring array of associative arrays
Details about each object.

fields . person_referring . * . id string
Unique identifier for the object.

fields . person_referring . * . type enum
Type of each extra field. Possible values could be: input, select

fields . person_referring . * . label string
Label of current field item.

fields . person_referring . * . value string
Value of current field item.

fields . person_referring . * . required boolean
Shows if current field item is required.

fields . person_invited array of associative arrays
Details about each object.

fields . person_invited . * . id string
Unique identifier for the object.

fields . person_invited . * . type enum
Type of each extra field. Possible values could be: input, select

fields . person_invited . * . label string
Label of current field item.

fields . person_invited . * . value string
Value of current field item.

fields . person_invited . * . required boolean
Shows if current field item is required.

assets associative array

assets . logo associative array
Details about logo object.

assets . logo . type enum
Type of each extra field. Possible values could be: circle, rectangle, square

assets . logo . path nullable string
Shows path of image if exists.

analytics associative array

🚧
This property will be in response only if you have with=campaign.analytics parameter in request.

analytics . reach integer
Shows number of total unique reaches in current campaign.

analytics . users integer
Shows number of total users in current campaign.

analytics . referrals integer
Shows number of total referrals in current campaign.

analytics . qualified_referrals integer
Shows number of total qualified referrals in current campaign.