DoCurious API Reference / types / SurveyCampaign

Interface: SurveyCampaign

Defined in: types/school.types.ts:416

A distribution campaign targeting a specific audience within a school for a Survey.

Remarks

A single survey can have multiple campaigns targeting different audiences. The platform tracks how many users received the notification and how many clicked through to the external survey URL.

Extends

• BaseEntity

Properties

clickedCount

clickedCount: number

Defined in: types/school.types.ts:430

Number of users who clicked through to the external survey URL

---

createdAt

createdAt: string

Defined in: types/common.types.ts:154

ISO 8601 datetime when the entity was created

Inherited from

BaseEntity.createdAt

---

distributedCount

distributedCount: number

Defined in: types/school.types.ts:428

Number of users who received the survey notification

---

id

id: string

Defined in: types/common.types.ts:167

Inherited from

BaseEntity.id

---

scheduledAt?

optional scheduledAt: string

Defined in: types/school.types.ts:436

ISO datetime for delayed delivery (if scheduled, not sent immediately)

---

schoolId

schoolId: string

Defined in: types/school.types.ts:418

---

sentAt?

optional sentAt: string

Defined in: types/school.types.ts:433

---

status

status: "completed" | "scheduled" | "sent"

Defined in: types/school.types.ts:432

---

survey?

optional survey: Survey

Defined in: types/school.types.ts:439

---

surveyId

surveyId: string

Defined in: types/school.types.ts:417

---

targetAudience

targetAudience: "all_students" | "all_teachers" | "specific_class" | "specific_grade"

Defined in: types/school.types.ts:421

Who should receive this survey notification

---

targetClassId?

optional targetClassId: string

Defined in: types/school.types.ts:423

Target class UUID (when targetAudience is 'specific_class')

---

targetGradeLevel?

optional targetGradeLevel: string

Defined in: types/school.types.ts:425

Target grade level (when targetAudience is 'specific_grade')

---

updatedAt

updatedAt: string

Defined in: types/common.types.ts:156

ISO 8601 datetime when the entity was last modified

Inherited from

BaseEntity.updatedAt