Skip to main content

Campaigns

getAllActiveCampaigns

Get all active campaigns

Return List of ParsedCampaignListElement

local activeCampaigns = getAllActiveCampaigns()

getAllCampaigns

Get all campaigns

Return List of ParsedCampaignListElement

local campaigns = getAllCampaigns()

getAllRunningCampaigns

Get all running campaigns

Return List of ParsedCampaignListElement

local runningCampaigns = getAllRunningCampaigns()

getCampaignById

Get campaign by id

Arguments

  • id: int the id of the campaign

Return ParsedCampaignListElement

local campaign = getCampaignById(campaignId)

getCompanyActiveCampaigns

Get company active campaigns

Arguments

  • companyUuid: UuidValue the uuid of the company

Return List of ParsedCampaignListElement

local activeCampaigns = getCompanyActiveCampaigns(companyUuid)

getCompanyCampaigns

Get company campaigns

Arguments

  • companyUuid: UuidValue the uuid of the company

Return List of ParsedCampaignListElement

local campaigns = getCompanyCampaigns(companyUuid)

getCompanyRunningCampaigns

Get company running campaigns

Arguments

  • companyUuid: UuidValue the uuid of the company

Return List of ParsedCampaignListElement

local runningCampaigns = getCompanyRunningCampaigns(companyUuid)

Table

Function NameDescriptionFirst ArgumentReturn
getAllActiveCampaignsGet all active campaignsList of ParsedCampaignListElement
getAllCampaignsGet all campaignsList of ParsedCampaignListElement
getAllRunningCampaignsGet all running campaignsList of ParsedCampaignListElement
getCampaignByIdGet campaign by idid: the id of the campaignParsedCampaignListElement
getCompanyActiveCampaignsGet company active campaignscompanyUuid: the uuid of the companyList of ParsedCampaignListElement
getCompanyCampaignsGet company campaignscompanyUuid: the uuid of the companyList of ParsedCampaignListElement
getCompanyRunningCampaignsGet company running campaignscompanyUuid: the uuid of the companyList of ParsedCampaignListElement