In This Article:

    Activity Form Summary - Targets

    In This Article:

      This API call returns the list of targets for specific targeted action form. 

      Request

      • Method: GET
      • URL: https://hq.salsalabs.org/api/developer/ext/v1/activities/UUID/summary/targets
      • Applicable to: Targeted Actions

      Parameters

      Name

      Type

      Mandatory/Optional

      Description

      UUID

      UUID

      mandatory

      Path param. UUID of the activity form

      count

      Integer

      optional

      Number of target records to be returned. Max = 25. Default = 10

      offset

      Integer

      optional

      Target records list offset for pagination

       

      Example: https://dev-api.salsalabs.org/api/developer/ext/v1/activities/ce5025ce-e519-4c6d-a604-54804c4dce23/summary/targets?count=15&offset=30

       

      Response

      General Fields

      Name
      Type
      Description
      total
      Integer total number of records available
      offset
      Integer starting offset for records
      count
      Integer count of records returned
      results
      Array Array of Targets objects

       

      Target Fields

      Name
      Type
      Description
      targetTitle
      String target title
      targetName
      String target name
      targetSet
      String target set name
      emailedLetters
      Integer number of emails sent
      phoneCalls
      Integer number of phone calls
      facebookPosts
      Integer number of facebook posts
      twitterPosts
      Integer number of twitter posts
      total
      Integer total: emails + calls + facebook posts + twitter posts
      targetType String

      Target type, will be one of:

      • Federal Executive
      • Federal Senate
      • Federal House
      • State Executive
      • State Senate
      • State House
      • US County
      • US Municipality
      • Custom Target
      politicalParty String political party name
       state String state
       districtName String district name
       

      Response

      {
        "id""7fa8e21f-5169-4591-845c-60968b4daaca",
        "timestamp""2018-02-07T15:18:08.856Z",
        "header": {
          "processingTime"98,
          "serverId""local"
        },
        "payload": {
            "total"2,
            "offset"0,
            "count"2,
            "results": [
              {
                "targetTitle""Ms",
                "targetName""John Show 0",
                "targetSet""Target Set 1",
                "emailedLetters"10,
                "phoneCalls"2,
                "facebookPosts"3,
                "twitterPosts"4,
                "total"19,
                "targetType""Federal House",
                "politicalParty""Dem",
                "districtName""NY"
              },
              {
                "targetTitle""Ms",
                "targetName""John Show 1",
                "targetSet""Target Set 1",
                "emailedLetters"10,
                "phoneCalls"2,
                "facebookPosts"3,
                "twitterPosts"4,
                "total"19,
                "targetType""Federal House",
                "politicalParty""Dem",
                "districtName""NY"
              }
            ]
        }
      }

       

       

      Was this article helpful?
      0 out of 0 found this helpful
      Have more questions? Submit a request

      Comments

      0 comments

      Please sign in to leave a comment.