In This Article:

    Activity Form Summary

    In This Article:

      This API call returns the list of activity forms with basic info. 

      Request

      • Method: GET
      • URL: https://dev-api.salsalabs.org/api/developer/ext/v1/activities/UUID/summary

      Parameters

      Name

      Type

      Mandatory/Optional

      Description

      UUID

      UUID

      mandatory

      Path param. UUID of the activity form

      count

      Integer

      optional

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

      offset

      Integer

      optional

      Submission records list offset for pagination

       

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

      Response

      • Sign-up Form Summary
      • Petition Form Summary
      • Targeted Action Form Summary
      • Fundraise Form Summary
      • Ticketed Event Form Summary
      • P2P Form Summary

      Generic Response Fields

      There are two generic response sections for the summary calls, the first is the general information in the main payload and consists of the following properties.

      Results Wrapper

      Name

      Type

      Description

      total

      Integer

      total number of items available

      offset

      Integer

      the starting offset of the items returned

      count

      integer

      the number of items returned

      results

      array

      array of items

      type

      string

      activity form type. Possible values:

      • SUBSCRIBE 
      • FUNDRAISE 
      • PETITION 
      • TARGETED_LETTER 
      • TICKETED_EVENT
      • P2P_EVENT

       

      {
        "id""503c3f55-c976-44e0-b8a3-1e98cd977ee1",
        "timestamp""2018-02-07T14:11:22.111Z",
        "header": {
          "processingTime"98,
          "serverId""local"
        },
        "payload": {
              "total"1,
              "offset"0,
              "count"1,
              "results": [ ... ]
           }
        }
      }

       

      Submission Fields

      All submissions are tied to a supporter and each submission in the results will contain the following attributes.

      Name
      Type
      Description
      id UUID submission id
      firstName String first name
      middleName String middle name
      lastName String last name
      gender String

      gender:

      • FEMALE
      • MALE
      • OTHER
      dateOfBirth Date date of birth. ISO_8601 formatted String with a GMT timezone
      title String title
      suffix String suffix
      email String email
      homePhone String homePhone
      cellPhone String cellPhone
      workPhone String workPhone
      city String city
      addressLine1 String address line 1
      addressLine2 String address line 2
      preferred language String preferredLanguage
      state String state
      stateCode String state code
      zipCode String zip code
      country String country
      countryCode String country code
      supporterId UUID supporter id
      supporterExternalId String supporter external id
      activityDate Date activity date. ISO_8601 formatted String with a GMT timezone
      formName String form name
      referringUrl String referring URL
      salsaTrack String salsa track value
      confirmationCheckbox Boolean has supporter accepted terms and conditions
      keepInformed Boolean keep supporter informed of organization's activities
      customFields Array

      Array of custom fields with values with the following attribtues

      • name - name of the custom field
      • value - value of the custom field
      • type - data type of the custom field. Values:
        • NUMBER
        • BOOLEAN
        • DOUBLE
        • STRING
        • DATE
      • customFieldType. Possible values: 
        • Activity
        • Supporter
      activityType String form activity type

       

       

      "payload": {
            "total"100,
            "offset"10,
            "count"1
            "results": [{
                "id""f5f977fb-f3d1-4291-881f-6fab85ea16ee",
                "firstName""FirstName",
                "middleName""MiddleName",
                "lastName""LastName",
                "gender""OTHER",
                "dateOfBirth""1996-01-21T16:31:58.801Z",
                "title""Title",
                "suffix""Suf",
                "email""email@mail.com",
                "homePhone""19111111111",
                "cellPhone""19111111111",
                "workPhone""19111111111",
                "city""City",
                "addressLine1""Addr1",
                "addressLine2""Addr2",
               "preferredLanguage" "en-US",
                "state""New York",
                "stateCode""NY",
                "zipCode""61000",
                "country""United States",
                "countryCode""US",
                "supporterId""1e310a85-3b95-4990-a43f-0c2b8594272f",
                "supporterExternalId""extId",
                "activityDate""2018-02-07T13:08:32.828Z",
                "formName""Form Name",
                "referringUrl""http://refurl.salsalabs.org",
                "salsaTrack""trackvalue123",
                "customFields": [
                  {
                    "name""customfield_color",
                    "value""blue",
                    "type""STRING",
                    "customFieldType""Supporter"
                  }
                ],
                "activityType""SUBSCRIBE"
              }
            ]
          }

        

      Fundraise Form Summary 

      Response Fields

      General Fields

      Name

      Type

      Description

      newDonors

      Integer

      count of new donors

      returningDonors

      Integer

      count of returning donors

      dollarsRaised

      Double

      Total dollars raised

       

      Submission Fields

      Extend the general submission with the following:

      Name

      Type

      Description

      donationId

      UUID

      donation id

      donationAmount

      Double

      donation amount

      donationType

      String

      donation type. Values:

      • ONE_TIME

      • RECURRING

      donationCreatedDate

      Double

      donation record creation date

      designation

      String

      designation

      dedicationType

      String

      dedication type. Values:

      • IN_HONOR_OF

      • IN_MEMORY_OF

      dedication

      String

      dedication

      notify

      String

      notify

      transactionId

      UUID

      transaction id

      transactionType

      String

      transaction type. Values:

      • AUTHORIZE

      • CHARGE

      • FAILURE

      • CARD_EXPIRED

      • DECLINED

      • CANCEL

      • INSTALLMENT

      • CHARGEBACK

      • CREDIT

      • REFUND

      • COMPLETE

      • PARTIAL_REFUND

      • COMPLIMENTARY

      • OFFLINE

      transactionDate

      Date

      transaction date. ISO_8601 formatted String with a GMT timezone

      paymentGateway

      String

      payment gateway name

      transactionPnref

      String

      transaction pnref

      transactionAmount

      Double

      transaction amount

      transactionFeesPaid

      Double

      transaction fees

      transactionDeductibleAmount

      Double

      deductible

      creditCardType

      String

      credit card type. Values:

      • CREDIT_CARD

      • ECHECK

      • OTHER

      creditCardNumber

      String

      credit card number (last 4 digits)

      creditCardExp

      Date

      credit card expiration date. ISO_8601 formatted String with a GMT timezone

      coverFees

      Boolean

      increase donation amount to cover fees

       

      Response

      {
        "id""503c3f55-c976-44e0-b8a3-1e98cd977ee1",
        "timestamp""2018-02-07T14:11:22.111Z",
        "header": {
          "processingTime"98,
          "serverId""local"
        },
        "payload": {
          "total"1,
          "offset"0,
          "count"1,
          "results": [
            {
              "id""02e4e978-5050-40a9-9291-e817caa94429",
              "firstName""FirstName",
              "middleName""MiddleName",
              "lastName""LastName",
              "gender""OTHER",
              "dateOfBirth""1996-01-21T16:31:58.801Z",
              "title""Title",
              "suffix""Suf",
              "email""email@mail.com",
              "homePhone""19111111111",
              "cellPhone""19111111111",
              "workPhone""19111111111",
              "city""City",
              "addressLine1""Addr1",
              "addressLine2""Addr2",
              "preferredLanguage" "en-US",
              "state""New York",
              "stateCode""NY",
              "zipCode""61000",
              "country""United States",
              "countryCode""US",
              "supporterId""ea0a2af0-35c5-4432-b185-bfeb8896faae",
              "supporterExternalId""extId",
              "formName""Form Name",
              "formId""b0e8cda5-e091-46b4-b586-1ce203abd4c2",
              "referringUrl""http://refurl.salsalabs.org",
              "salsaTrack""trackvalue123",
              "confirmationCheckbox"true,
              "keepInformed"true,
              "customFields": [
                {
                  "name""customfield_color",
                  "value""blue",
                  "type""STRING",
                  "customFieldType""Supporter"
                }
              ],
              "activityType""FUNDRAISE",
              "donationId""355da2bb-61a7-4b7b-845c-c0b9738b0349",
              "donationAmount"34.0,
              "donationType""ONETIME",
              "donationCreatedDate""2018-02-07T14:11:22.117Z",
              "designation""Designation",
              "dedicationType""IN_MEMORY_OF",
              "dedication""Dedication",
              "coverFees"true,
              "notify""Notify",
              "transactionId""1044081568",
              "transactionDate""2018-02-07T14:11:22.121Z",
              "transactionType""INSTALLMENT",
              "paymentGateway""gateway1",
              "transactionPnref""transactionPnref",
              "transactionAmount"34.0,
              "transactionFeesPaid"2.45,
              "transactionDeductibleAmount"10.0,
              "creditCardType""visa",
              "creditCardNumber""************1111",
              "creditCardExp""2018-02-07T14:11:22.121Z"
            }
          ],
          "newDonors"5,
          "returningDonors"10,
          "dollarsRaised"5543.45
        }
      }

       

      P2P Form Summary

      Response Fields

      General Fields

      Extend the generic fields with the following:

      Name

      Type

      Description

      registrationsOnly

      Integer

      number of registrations with no donations

      donationsOnly

      Integer

      number of donations with no registrations

      registrationsWithDonations

      Integer

      number of donations with registrations

      raisedTotal

      Double

      total raised

      raisedRegistrations

      Double

      raised through registrations

      raisedDonations

      Double

      raised through donations

      fundraisers

      Integer

      number of fundraisers

      teams

      Integer

      number of teams

      raisedPurchases

      Integer

      number of purchases


      Submission Fields

      Extend the submission fields with the following:

      Name
      Type
      Description

      transactionType

      String

      transaction type. Possible values:

      • DONATION_ONLY

      • DONATION_AND_TICKETS

      • TICKETS

      • COMPLIMENTARY

      amount

      Double

      transaction amount

      transactionDate

      Date

      date. ISO_8601 formatted String with a GMT timezone

      onlineTransaction

      Boolean

      online transaction: true/false

      registrationAmount

      Double

      registration amount

      donationAmount

      Double

      donation amount

      purchaseAmount

      Double

      purchase amount

      donatedTo

      String

      donated to (donation to a Fundraiser page)

      isParticipant

      Boolean

      is participant

      fundraiserType

      String

      fundraiser type

      fundraiserUrl

      String

      fundraiser URL

      fundraiserPageName

      String

      fundraiser page name

      designation

      String

      donation designation

      dedicationType

      String

      donation dedication type. Values:

      • IN_HONOR_OF

      • IN_MEMORY_OF

      dedication

      String

      donation dedication

      anonymous

      Boolean

      display donation anonymously

      coverFees

      Boolean

      increase donation amount to cover fees

      notify

      String

      please notify the following person(s) that a donation has been made

       

      Response

      {
        "id""ffc8a359-fc6e-4805-868c-59855a274686",
        "timestamp""2018-02-07T15:02:08.510Z",
        "header": {
          "processingTime"98,
          "serverId""local"
        },
        "payload": {
          "total"100,
          "offset"10,
          "count"1,
          "results": [
            {
              "id""39a100e9-7650-4c4a-a3bd-c705e166475a",
              "firstName""FirstName",
              "middleName""MiddleName",
              "lastName""LastName",
              "gender""OTHER",
              "dateOfBirth""1996-01-21T16:31:58.801Z",
              "title""Title",
              "suffix""Suf",
              "email""email@mail.com",
              "homePhone""19111111111",
              "cellPhone""19111111111",
              "workPhone""19111111111",
              "city""City",
              "addressLine1""Addr1",
              "addressLine2""Addr2",
              "preferredLanguage" "en-US",
              "state""New York",
              "stateCode""NY",
              "zipCode""61000",
              "supporterId""33d395c2-370e-49f4-a240-ee46f6e106ac",
              "supporterExternalId""extId",
              "referringUrl""http://refurl.salsalabs.org",
              "salsaTrack""trackvalue123",
              "confirmationCheckbox"true,
              "keepInformed"true,
              "customFields": [
                {
                  "name""customfield_color",
                  "value""blue",
                  "type""STRING",
                  "customFieldType""Supporter"
                }
              ],
              "activityType""P2P_EVENT",
              "transactionType""DONATION_AND_TICKETS",
              "amount"50.0,
              "transactionDate""2018-02-07T15:02:08.512Z",
              "onlineTransaction"true,
              "registrationAmount"35.5,
              "donationAmount"14.5,
              "purchaseAmount"25.0,
              "donatedTo""DonatedTo",
              "isParticipant"true,
              "designation""Designation",
              "dedicationType""IN_HONOR_OF",
              "dedication""Dedication",
              "anonymous"true,
              "coverFees"true,
              "notify""Notify",
            }
          ],
          "registrationsOnly"10,
          "donationsOnly"5,
          "registrationsWithDonations"10,
          "raisedTotal"35.0,
          "raisedRegistrations"15.0,
          "raisedDonations"20.0,
          "fundraisers"10,
          "teams"3,
          "raisedPurchases"215.00
        }
      }

       

      Petition Form Summary

      Response Fields

      Submission Fields

      Extend the general submission fields with the following:

      Name

      Type

      Description

      signatureDate

      Date

      signature date. ISO_8601 formatted String with a GMT timezone

      comment

      String

      comment text

      displayComment

      boolean

      display comment: yes/no

      commentModerationState

      String

      comment moderation state

       

      Response

      {
        "id""7064e580-c35c-4d8f-a9ba-feb5659da9bc",
        "timestamp""2018-02-07T13:27:10.893Z",
        "header": {
          "processingTime"98,
          "serverId""local"
        },
        "payload": {
          "total"100,
          "offset"10,
          "count"1,
          "results": [
            {
              "id""0077e1a1-d1b6-4ae0-b32a-3dd295f7d0a7",
              "firstName""FirstName",
              "middleName""MiddleName",
              "lastName""LastName",
              "gender""OTHER",
              "dateOfBirth""1996-01-21T16:31:58.801Z",
              "title""Title",
              "suffix""Suf",
              "email""email@mail.com",
              "homePhone""19111111111",
              "cellPhone""19111111111",
              "workPhone""19111111111",
              "city""City",
              "addressLine1""Addr1",
              "addressLine2""Addr2",
              "preferredLanguage" "en-US",
              "state""New York",
              "stateCode""NY",
              "zipCode""61000",
              "country""United States",
              "countryCode""US",
              "supporterId""bccb7cd7-e6bb-4326-bcff-34169fe97597",
              "supporterExternalId""extId",
              "activityDate""2018-02-07T13:27:10.895Z",
              "formName""Form Name",
              "formId""6ad1da43-fd93-4b05-9da3-bc13fdcb7a53",
              "referringUrl""http://refurl.salsalabs.org",
              "salsaTrack""trackvalue123",
              "confirmationCheckbox"true,
              "keepInformed"true,
              "displaySignature"true,
              "customFields": [
                {
                  "name""customfield_color",
                  "value""blue",
                  "type""STRING",
                  "customFieldType""Supporter"
                }
              ],
              "activityType""PETITION",
              "signatureDate""2018-02-07T13:27:10.895Z",
              "comment""custom comment",
              "displayComment"true,
              "commentModerationState""APPROVED"
            }
          ]
        }
      }



      Sign-up Form Summary

      Response Fields

      Generic Fields

      Response

      {
        "id""be4f3a9d-0bfc-40a9-9938-639791d4f87a",
        "timestamp""2018-02-07T13:08:32.825Z",
        "header": {
          "processingTime"98,
          "serverId""local"
        },
        "payload": {
          "total"100,
          "offset"10,
          "count"1,
          "results": [
            {
              "id""f5f977fb-f3d1-4291-881f-6fab85ea16ee",
              "firstName""FirstName",
              "middleName""MiddleName",
              "lastName""LastName",
              "gender""OTHER",
              "dateOfBirth""1996-01-21T16:31:58.801Z",
              "title""Title",
              "suffix""Suf",
              "email""email@mail.com",
              "homePhone""19111111111",
              "cellPhone""19111111111",
              "workPhone""19111111111",
              "city""City",
              "addressLine1""Addr1",
              "addressLine2""Addr2",
              "preferredLanguage" "en-US",
              "state""New York",
              "stateCode""NY",
              "zipCode""61000",
              "country""United States",
              "countryCode""US",
              "supporterId""1e310a85-3b95-4990-a43f-0c2b8594272f",
              "supporterExternalId""extId",
              "activityDate""2018-02-07T13:08:32.828Z",
              "formName""Form Name",
              "formId""7941fb46-3db8-42fc-a516-baefd28bff1b",
              "referringUrl""http://refurl.salsalabs.org",
              "salsaTrack""trackvalue123",
              "confirmationCheckbox"true,
              "keepInformed"true,
              "customFields": [
                {
                  "name""customfield_color",
                  "value""blue",
                  "type""STRING",
                  "customFieldType""Supporter"
                }
              ],
              "activityType""SUBSCRIBE"
            }
          ]
        }
      }

       

      Targeted Action Form Summary

      Response Fields

      Submission Fields

      Extend the general submission fields with the following:

      Name

      Type

      Description

      inDistrict

      Boolean

      in district: yes/no

      emailedLetters

      Integer

      number of emails

      phoneCalls

      Integer

      number fo calls

      facebookPosts

      Integer

      number of facebook posts

      twitterPosts

      Integer

      number of twitter posts

      total

      Integer

      total: emails + calls + facebook posts + twitter posts

       

      Response

      {
        "id""a003122f-5c7f-480b-b86b-77abd4b52454",
        "timestamp""2018-02-07T13:36:43.383Z",
        "header": {
          "processingTime"98,
          "serverId""local"
        },
        "payload": {
          "total"1,
          "offset"0,
          "count"1,
          "results": [
            {
              "id""c65639ff-8e3c-4632-8142-9c2887c9293a",
              "firstName""FirstName",
              "middleName""MiddleName",
              "lastName""LastName",
              "gender""OTHER",
              "dateOfBirth""1996-01-21T16:31:58.801Z",
              "title""Title",
              "suffix""Suf",
              "email""email@mail.com",
              "homePhone""19111111111",
              "cellPhone""19111111111",
              "workPhone""19111111111",
              "city""City",
              "addressLine1""Addr1",
              "addressLine2""Addr2",
              "preferredLanguage" "en-US",
              "state""New York",
              "stateCode""NY",
              "zipCode""61000",
              "country""United States",
              "countryCode""US",
              "supporterId""abd1de14-dac6-4c97-a3b5-6718e02db727",
              "supporterExternalId""extId",
              "activityDate""2018-02-07T13:36:43.384Z",
              "referringUrl""http://refurl.salsalabs.org",
              "salsaTrack""trackvalue123",
              "confirmationCheckbox"true,
              "keepInformed"true,
              "customFields": [
                {
                  "name""customfield_color",
                  "value""blue",
                  "type""STRING",
                  "customFieldType""Supporter"
                }
              ],
              "activityType""TARGETED_LETTER",
              "inDistrict"true,
              "emailedLetters"10,
              "phoneCalls"2,
              "facebookPosts"4,
              "twitterPosts"6,
              "total"22
            }
          ]
        }
      }

       

      Ticketed Event Form Summary

       

      Response Fields

      Generic Fields

      Extend the general fields with the following
      Name
      Type
      Description
      registrationsOnly
      Integer number of registrations with no donations
      donationsOnly
      Integer number of donations with no registrations
      registrationsWithDonations
      Integer number of registrations with donations
      raisedTotal
      Double total raised
      raisedRegistrations
      Double raised through registrations
      raisedDonations
      Double raised through donations

       

      Submissions Fields

      Extend the submission fields with the following:

      Name
      Type
      Description
      transactionType
      String

      transaction type. Values:

      • DONATION_ONLY
      • DONATION_AND_TICKET
      • TICKETS_ONLY
      • COMPLIMENTARY
      amount
      Double transaction amount
      transactionDate
      Date date. ISO_8601 formatted String with a GMT timezone
      onlineTransaction
      Boolean online transaction: true/false
      registrationAmount
      Double registration amount
      donationAmount
      Double donation amount
      ticketsPurchased
      Integer tickets purchased
      designation String donation designation
      dedicationType String

      donation dedication type. Values:

      • IN_HONOR_OF
      • IN_MEMORY_OF
      dedication String donation dedication
      anonymous Boolean display donation anonymously
      coverFees Boolean increase donation amount to cover fees
      notify String please notify the following person(s) that a donation has been made

       

      Response

      {
        "id""ee12c0f9-daad-4fcf-bbec-a3a0fffaf6bc",
        "timestamp""2018-02-07T14:54:32.132Z",
        "header": {
          "processingTime"98,
          "serverId""local"
        },
        "payload": {
          "total"100,
          "offset"10,
          "count"1,
          "results": [
            {
              "id""7b4d4d41-33e6-4e92-9fe9-f632886c59e0",
              "firstName""FirstName",
              "middleName""MiddleName",
              "lastName""LastName",
              "gender""OTHER",
              "dateOfBirth""1996-01-21T16:31:58.801Z",
              "title""Title",
              "suffix""Suf",
              "email""email@mail.com",
              "homePhone""19111111111",
              "cellPhone""19111111111",
              "workPhone""19111111111",
              "city""City",
              "addressLine1""Addr1",
               "addressLine2""Addr2",
              "preferredLanguage" "en-US",
              "state""New York",
              "stateCode""NY",
              "zipCode""61000",
              "supporterId""057a75d5-b0f2-4ba5-8800-84199daf4c61",
              "supporterExternalId""extId",
              "referringUrl""http://refurl.salsalabs.org",
              "salsaTrack""trackvalue123",
              "confirmationCheckbox"true,
              "keepInformed"true,
              "customFields": [
                {
                  "name""customfield_color",
                  "value""blue",
                  "type""STRING",
                  "customFieldType""Supporter"
                }
              ],
              "activityType""TICKETED_EVENT",
              "transactionType""DONATION_AND_TICKETS",
              "amount"50.0,
              "transactionDate""2018-02-07T14:54:32.133Z",
              "onlineTransaction"true,
              "registrationAmount"35.5,
              "donationAmount"14.5,
              "ticketsPurchased"3,
              "designation""Designation",
              "dedicationType""IN_HONOR_OF",
              "dedication""Dedication",
              "anonymous"true,
              "coverFees"true,
              "notify""Notify",
            }
          ],
          "registrationsOnly"10,
          "donationsOnly"5,
          "registrationsWithDonations"10,
          "raisedTotal"35.0,
          "raisedRegistrations"15.0,
          "raisedDonations"20.0
        }
      }
       
      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.