---
title: "List survey reports"
method: GET
path: "/3.0/reporting/surveys"
tags: ["reporting"]
---

# List survey reports

`GET /3.0/reporting/surveys`

## Request

- Base URL: `https://api.mailchimp.com`
- URL: `https://api.mailchimp.com/3.0/reporting/surveys`
- Auth: one of:
  - HTTP bearer
  - OAuth 2
    - Authorization code: `https://login.mailchimp.com/oauth2/authorize`
    - Token URL: `https://login.mailchimp.com/oauth2/token`
- TypeScript: <https://skmtc.dev/mailchimp/apis/mailchimp-api/docs/3.0/reporting/surveys/get.ts> (a function with typed inputs; its response is checked against the schema)

Get reports for surveys.

## Query parameters

- `fields` string[]
- `exclude_fields` string[]
- `count` integer
- `offset` integer

## Response `200`

List of Survey Report Instances

- object
  - `_links` object[]: A list of link types and descriptions for the API schema documents.
    - `href` string: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.
    - `method` 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS' | 'HEAD': The HTTP method that should be used when accessing the URL defined in 'href'.
    - `rel` string: As with an HTML 'rel' attribute, this describes the type of link.
    - `schema` string: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.
    - `targetSchema` string: For GETs, this is a URL representing the schema that the response should conform to.
  - `surveys` object[]: The surveys that have reports available.
    - `created_at` string, date-time: The date and time the survey was created in ISO 8601 format.
    - `id` string: A string that uniquely identifies this survey.
    - `list_id` string: The ID of the list connected to this survey.
    - `list_name` string: The name of the list connected to this survey.
    - `published_at` string, date-time: The date and time the survey was published in ISO 8601 format.
    - `status` 'published' | 'unpublished': The survey's status.
    - `title` string: The title of the survey.
    - `total_responses` integer: The total number of responses to this survey.
    - `updated_at` string, date-time: The date and time the survey was last updated in ISO 8601 format.
    - `url` string: The URL for the survey.
    - `web_id` integer: The ID used in the Mailchimp web application. View this survey report in your Mailchimp account at `https://{dc}.admin.mailchimp.com/lists/surveys/results?survey_id={web_id}`.
  - `total_items` integer: The total number of items matching the query regardless of pagination.

## Other responses

- `default`: An error generated by the Mailchimp API.

---

[API](https://skmtc.dev/mailchimp/apis/mailchimp-api.md) - [All operations](https://skmtc.dev/mailchimp/apis/mailchimp-api/llms.txt) - [OpenAPI document](https://skmtc.dev/mailchimp/apis/mailchimp-api/revisions/53bf4b156855?raw)