Member Goals

Get information about recent goal events for a specific list member.

Available methods

    • GET /lists/{list_id}/members/{subscriber_hash}/goals Get the last 50 Goal events for a member on a specific list

      Get the last 50 Goal events for a member on a specific list

      GET /lists/{list_id}/members/{subscriber_hash}/goals

      Get the last 50 Goal events for a member on a specific list.

      Path parameters

      list_id The unique id for the list.
      subscriber_hash The MD5 hash of the lowercase version of the list member’s email address.

      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

      goals Type: Array Title: Goal Activity Read only: false The last 50 Goal events triggered by a member.
      Show properties
      goal_id Type: Integer Title: Goal ID Read only: false The id for a Goal event.
      event Type: String Title: Event Name Read only: false The name/type of Goal event triggered.
      last_visited_at Type: String Title: Last Visit Date Read only: false The date and time the user last triggered the Goal event.
      data Type: String Title: Additional Data Read only: false Any extra data passed with the Goal event.
      list_id Type: String Title: List ID Read only: true The list id.
      email_id Type: String Title: Email Hash Read only: true The MD5 hash of the lowercase version of the list member’s email address.
      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/members/62eeb292278cc15f5817cb78f7790b08/goals' \
      --user 'anystring:apikey' \
      --include
                                      

      Example response

      
      HTTP/1.1 200 OK
      Server: nginx
      Content-Type: application/json; charset=utf-8
      Content-Length: 814
      Vary: Accept-Encoding
      X-Request-Id: 32f7afb9-446c-468d-9c77-50a14cc01a50
      Link: <https://api.mailchimp.com/schema/3.0/Lists/Members/Goals/Collection.json>; rel="describedBy"
      Date: Wed, 16 Sep 2015 20:35:58 GMT
      Connection: keep-alive
      
      
      {
        "goals": [
          {
            "goal_id": 11869,
            "event": "new joke",
            "last_visited_at": "2015-09-15 14:42:51",
            "data": "a:4:{s:7:\"history\";a:1:{i:1442328171;a:1:{s:3:\"cid\";i:2181921;}}s:10:\"user_agent\";a:3:{s:4:\"type\";N;s:7:\"browser\";N;s:2:\"os\";N;}s:2:\"ip\";N;s:5:\"title\";N;}"
          }
        ],
        "list_id": "57afe96172",
        "email_id": "62eeb292278cc15f5817cb78f7790b08",
        "_links": [
          {
            "rel": "self",
            "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/members/62eeb292278cc15f5817cb78f7790b08/goals",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Members/Goals/Collection.json"
          },
          {
            "rel": "parent",
            "href": "https://usX.api.mailchimp.com/3.0/lists/57afe96172/members/62eeb292278cc15f5817cb78f7790b08",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Members/Instance.json"
          }
        ],
        "total_items": 1
      }
                                      

      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.