Skip to main content

Addon

Survey or CTA record exposed through a shared addon shape, with permissions derived from the current session and some fields resolved lazily. Returned by addonDetail and addonList.

type Addon {
id: String!
siteId: Int!
name: String!
content: String
permissions: AddonPermissions!
createdAt: Int!
publishedAt: Int
lastActiveChange: Int
addonTemplateId: Int
suggestionId: Int
responseCount: Int
hasData: Boolean!
active: Boolean!
goal: GoalLinked
draftName: String
draftContent: String
primaryAudience: AddonAudience
draftAudience: AddonAudience
formatVersion: Int!
createdBy: String!
totalViews: Int!
totalConversions: Int
type: AddonType!
}

Fields​

Addon.id ● String! non-null scalar​

Add-on UUID accepted by addonDetail and add-on mutations.

Addon.siteId ● Int! non-null scalar​

Addon.name ● String! non-null scalar​

The name/title of the survey or CTA

Addon.content ● String scalar​

The serialized JSON content of the survey or CTA

Addon.permissions ● AddonPermissions! non-null object​

Addon.createdAt ● Int! non-null scalar​

Creation time in Unix seconds.

Addon.publishedAt ● Int scalar​

First publication time in Unix seconds; null before publication.

Addon.lastActiveChange ● Int scalar​

Last activation change in Unix seconds; null if no activation change was recorded.

Addon.addonTemplateId ● Int scalar​

Source template ID from addonTemplatesList; null when none is linked.

Addon.suggestionId ● Int scalar​

Source suggestion ID; null when none is linked.

Addon.responseCount ● Int scalar​

Survey response groups or CTA click events; zero when no count is available.

Addon.hasData ● Boolean! non-null scalar​

Survey has response groups, or CTA has views, clicks, or conversions.

Addon.active ● Boolean! non-null scalar​

Stored activation state; use publishedAt to distinguish unpublished drafts.

Addon.goal ● GoalLinked object​

The linked goal; null when no goal is linked or the goal is unavailable

Addon.draftName ● String scalar​

Saved unpublished survey or CTA name; null when no draft name is stored

Addon.draftContent ● String scalar​

Saved unpublished content encoded as JSON; null or empty when no draft content is stored

Addon.primaryAudience ● AddonAudience object​

Attached primary audience; null when absent or accessed through a shared link.

Addon.draftAudience ● AddonAudience object​

Attached draft audience; null when absent or accessed through a shared link.

Addon.formatVersion ● Int! non-null scalar​

Stored survey or CTA content format version

Addon.createdBy ● String! non-null scalar​

Creator name or login, falling back to the stored name or Deleted User

Addon.totalViews ● Int! non-null scalar​

Recorded survey or CTA view events.

Addon.totalConversions ● Int scalar​

Recorded CTA conversion events; null for surveys.

Addon.type ● AddonType! non-null enum​

Returned By​

addonDetail query

Member Of​

AddonListMeta object ● CtaCreated object ● CtaEdited object ● CtaToggled object ● CtaViewResponses object ● SurveyCreated object ● SurveyEdited object ● SurveyToggled object ● SurveyViewResponses object