reporting

List survey reports

Get reports for surveys.

get/3.0/reporting/surveys

Request

Base URL
https://api.mailchimp.com
Auth
- HTTP bearer
- or OAuth 2
  Authorization codehttps://login.mailchimp.com/oauth2/authorize
  Token URLhttps://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.

Query parameters

fieldsstring[]

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

exclude_fieldsstring[]

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

countinteger

The number of records to return. Default value is 10. Maximum value is 1000

offsetinteger

Used for pagination, this is the number of records from a collection to skip. Default value is 0.

Response

List of Survey Report Instances

total_itemsinteger

The total number of items matching the query regardless of pagination.

Example response

{
  "surveys": [
    {
      "created_at": "2017-08-04T11:09:01+00:00",
      "id": "040d2c2e1f0",
      "published_at": "2017-08-04T11:09:01+00:00",
      "status": "published",
      "title": "New product ideas",
      "total_responses": 810,
      "updated_at": "2017-08-04T11:09:01+00:00",
      "web_id": 165
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.