> For the complete documentation index, see [llms.txt](https://docs.sparkloop.app/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.sparkloop.app/api-v3/objects-schema/survey-object.md).

# Survey Object

## Survey Object

| Field                   | Type    | Description                                                              |
| ----------------------- | ------- | ------------------------------------------------------------------------ |
| `uuid`                  | String  | Survey UUID.                                                             |
| `created_at`            | String  | When the survey was created (ISO 8601).                                  |
| `active_in_signup_flow` | Boolean | Whether the survey step is switched on in the publication's signup flow. |
| `custom_terms`          | Object  | Custom consent terms: `enabled`, `text`, `url`.                          |
| `stats`                 | Object  | Survey-step completion funnel. Present only with `expand=stats`.         |

**`stats`** (only with `expand=stats`)

| Field                   | Type    | Description                                        |
| ----------------------- | ------- | -------------------------------------------------- |
| `impressions`           | Integer | Times the survey step was shown in the date range. |
| `completions`           | Integer | Times it was completed in the date range.          |
| `completions_per_visit` | Number  | Completions divided by impressions.                |

**Example (`expand=stats`)**

```json
{
  "uuid": "svy_12ab34cd",
  "created_at": "2025-06-01T00:00:00.000Z",
  "active_in_signup_flow": true,
  "custom_terms": { "enabled": false, "text": null, "url": null },
  "stats": { "impressions": 3200, "completions": 2100, "completions_per_visit": 0.66 }
}
```