Growth History

View a summary of the month-by-month growth activity for a specific list.

Available methods

    • GET /lists/{list_id}/growth-history Get list growth history data
      GET /lists/{list_id}/growth-history/{month} Get list growth history by month

      Get list growth history data

      GET /lists/{list_id}/growth-history

      Get a month-by-month summary of a specific list’s growth activity.

      Path parameters

      list_id The unique id for the list.

      Query string parameters

      fields Type: Array Title: Fields Read only: false A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
      exclude_fields Type: Array Title: Exclude Fields Read only: false A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
      count Type: Integer Title: Count Read only: true The number of records to return. Default value is 10.
      offset Type: Integer Title: Offset Read only: false The number of records from a collection to skip. Iterating over large collections with this parameter can be slow. Default value is 0.

      Response body parameters

      history Type: Array Title: Members Read only: false An array of objects, each representing a monthly growth report for a list.
      Show properties
      list_id Type: String Title: List ID Read only: true The list id for the growth activity report.
      month Type: String Title: Month Read only: true The month that the growth history is describing.
      existing Type: Integer Title: Existing Read only: true Existing members on the list for a specific month.
      imports Type: Integer Title: Imports Read only: true Imported members on the list for a specific month.
      optins Type: Integer Title: Opt-in Read only: true Newly opted-in members on the list for a specific month.
      _links Type: Array Title: Links Read only: true A list of link types and descriptions for the API schema documents.
      Show properties
      rel Type: String Title: Rel Read only: true As with an HTML ‘rel’ attribute, this describes the type of link.
      href Type: String Title: Href Read only: true This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.
      method Type: String Title: Method Read only: true The HTTP method that should be used when accessing the URL defined in ‘href’.
      Possible Values:
      • GET
      • POST
      • PUT
      • PATCH
      • DELETE
      • OPTIONS
      • HEAD
      targetSchema Type: String Title: Target Schema Read only: true For GETs, this is a URL representing the schema that the response should conform to.
      schema Type: String Title: Schema Read only: true For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.
      list_id Type: String Title: List ID Read only: true The list id.
      total_items Type: Integer Title: Item Count Read only: false The total number of items matching the query regardless of pagination.
      _links Type: Array Title: Links Read only: true A list of link types and descriptions for the API schema documents.
      Show properties
      rel Type: String Title: Rel Read only: true As with an HTML ‘rel’ attribute, this describes the type of link.
      href Type: String Title: Href Read only: true This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.
      method Type: String Title: Method Read only: true The HTTP method that should be used when accessing the URL defined in ‘href’.
      Possible Values:
      • GET
      • POST
      • PUT
      • PATCH
      • DELETE
      • OPTIONS
      • HEAD
      targetSchema Type: String Title: Target Schema Read only: true For GETs, this is a URL representing the schema that the response should conform to.
      schema Type: String Title: Schema Read only: true For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.

      Example request

      
      curl --request GET \
      --url 'https://usX.api.mailchimp.com/3.0/lists/57afe96172/growth-history' \
      --user 'anystring:apikey' \
      --include
                                      

      Example response

      
      HTTP/1.1 200 OK
      Server: nginx
      Content-Type: application/json; charset=utf-8
      Content-Length: 1082
      Vary: Accept-Encoding
      X-Request-Id: 2ae25153-f561-4c61-aee3-87d07e767702
      Link: <https://api.mailchimp.com/schema/3.0/Lists/Growth/Collection.json>; rel="describedBy"
      Date: Wed, 16 Sep 2015 17:40:44 GMT
      Connection: keep-alive
      
      
      {
        "history": [
          {
            "list_id": "57afe96172",
            "month": "2015-09",
            "existing": 40,
            "imports": 202,
            "optins": 32,
            "_links": [
              {
                "rel": "self",
                "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/growth-history/2015-09",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Growth/Instance.json"
              },
              {
                "rel": "parent",
                "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/growth-history",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Growth/Collection.json",
                "schema": "https://api.mailchimp.com/schema/3.0/CollectionLinks/Lists/Growth.json"
              }
            ]
          }
        ],
        "list_id": "57afe96172",
        "total_items": 1,
        "_links": [
          {
            "rel": "self",
            "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/growth-history",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Growth/Collection.json",
            "schema": "https://api.mailchimp.com/schema/3.0/CollectionLinks/Lists/Growth.json"
          },
          {
            "rel": "parent",
            "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Instance.json"
          }
        ]
      }
                                      

      Error response

      type Type: String Title: Problem Type Read only: false An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.
      title Type: String Title: Error Title Read only: false A short, human-readable summary of the problem type. It shouldn’t change based on the occurrence of the problem, except for purposes of localization.
      status Type: Integer Title: HTTP Status Code Read only: false The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.
      detail Type: String Title: Error Message Read only: false A human-readable explanation specific to this occurrence of the problem. Learn more about errors.
      instance Type: String Title: Instance ID Read only: false A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.

      Get list growth history by month

      GET /lists/{list_id}/growth-history/{month}

      Get a summary of a specific list’s growth activity for a specific month and year.

      Path parameters

      list_id The unique id for the list.
      month A specific month of list growth history.

      Query string parameters

      fields Type: Array Title: Fields Read only: false A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
      exclude_fields Type: Array Title: Exclude Fields Read only: false A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

      Response body parameters

      list_id Type: String Title: List ID Read only: true The list id for the growth activity report.
      month Type: String Title: Month Read only: true The month that the growth history is describing.
      existing Type: Integer Title: Existing Read only: true Existing members on the list for a specific month.
      imports Type: Integer Title: Imports Read only: true Imported members on the list for a specific month.
      optins Type: Integer Title: Opt-in Read only: true Newly opted-in members on the list for a specific month.
      _links Type: Array Title: Links Read only: true A list of link types and descriptions for the API schema documents.
      Show properties
      rel Type: String Title: Rel Read only: true As with an HTML ‘rel’ attribute, this describes the type of link.
      href Type: String Title: Href Read only: true This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.
      method Type: String Title: Method Read only: true The HTTP method that should be used when accessing the URL defined in ‘href’.
      Possible Values:
      • GET
      • POST
      • PUT
      • PATCH
      • DELETE
      • OPTIONS
      • HEAD
      targetSchema Type: String Title: Target Schema Read only: true For GETs, this is a URL representing the schema that the response should conform to.
      schema Type: String Title: Schema Read only: true For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.

      Example request

      
      curl --request GET \
      --url 'https://usX.api.mailchimp.com/3.0/lists/57afe96172/growth-history/2015-09' \
      --user 'anystring:apikey' \
      --include
                                      

      Example response

      
      HTTP/1.1 200 OK
      Server: nginx
      Content-Type: application/json; charset=utf-8
      Content-Length: 569
      Vary: Accept-Encoding
      X-Request-Id: bd8e1d7e-7962-461f-817e-a76706e5626b
      Link: <https://api.mailchimp.com/schema/3.0/Lists/Growth/Instance.json>; rel="describedBy"
      Date: Wed, 16 Sep 2015 17:45:52 GMT
      Connection: keep-alive
      
      
      {
        "list_id": "57afe96172",
        "month": "2015-09",
        "existing": 40,
        "imports": 202,
        "optins": 32,
        "_links": [
          {
            "rel": "self",
            "href": "https://usX.api.mailchimp.com/3.0/lists/6b4cf57423/growth-history/2015-09",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Growth/Instance.json"
          },
          {
            "rel": "parent",
            "href": "https://usX.api.mailchimp.com/3.0/lists/6b4cf57423/growth-history",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Growth/Collection.json",
            "schema": "https://api.mailchimp.com/schema/3.0/CollectionLinks/Lists/Growth.json"
          }
        ]
      }
                                      

      Error response

      type Type: String Title: Problem Type Read only: false An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.
      title Type: String Title: Error Title Read only: false A short, human-readable summary of the problem type. It shouldn’t change based on the occurrence of the problem, except for purposes of localization.
      status Type: Integer Title: HTTP Status Code Read only: false The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.
      detail Type: String Title: Error Message Read only: false A human-readable explanation specific to this occurrence of the problem. Learn more about errors.
      instance Type: String Title: Instance ID Read only: false A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.