In This Article:

    Submissions

    In This Article:

      This API call returns the list of activity submissions. Allows advanced filtering. 

      Request

      • Method: POST
      • URL: https://hq.salsalabs.org/api/developer/ext/v1/submissions

      Parameters

      Parameter Location Description
      modifiedFrom payload Date from to retrieve activities - ISO_8601 formatted String with a GMT timezone
      modifiedTo payload Date to retrieve activities - ISO_8601 formatted String with a GMT timezone
      activityIds payload List of activity ids to retrieve - 36 character UUIDNote that the modifiedFrom and modifiedTo parameters cannot be provided when activity ids are provided 
      count payload Number of activities to retrieve - supports pagination and is only applicable when modifiedFrom and modifiedTo searching is used
      offset payload Starting count at which to retrieve activities - supports pagination and is only applicable when modifiedFrom and modifiedTo searching is used
      type payload The types of activities to search for - this is an optional parameter that is only applicable for retrieving activities using the modifiedFrom and modifiedTo parameters.Value must be one of the following if provided:
      • SUBSCRIPTION_MANAGEMENT
      • SUBSCRIBE
      • FUNDRAISE
      • PETITION
      • TARGETED_LETTER
      • TICKETED_EVENT
      • P2P_EVENT 

       

      Request Example

      Description Body
      Get any activities since a specific date
      {"payload":{"modifiedFrom":"2016-05-26T11:49:24.905Z",
      "offset":0,
      "count":20}
      }
      Get specific activities since a specific date
      {"payload":{"modifiedFrom":"2016-05-26T11:49:24.905Z","type":"SUBSCRIPTION_MANAGEMENT",
      "offset":0,"count":20}
      }
      Get activities within a date range
      {"payload":{"modifiedFrom":"2016-04-26T11:49:24.905Z","modifiedTo":"2016-05-26T11:49:24.905Z",
      "offset":0,"count":20}
      }
      Get specific activities by id
      {"payload":{"activityIds":[ "0B99B409-E56D-4530-A226-474C61461DB4",
      "7EEEED4B-40A4-4FCE-B107-AE643AD1D926",
      "9AC97182-671C-4364-B69A-1298A8C6D83D"]}
      }

       

      Response

      Fields

      Name
      Type
      Description
      id
      UUID submission id
      supporterId
      UUID supporter id
      activityDate
      Date activity date
      formName
      String activity form name
      formId
      UUID activity form id
      activityType
      String

      activity form type. Possible values:

      • SUBSCRIBE 
      • FUNDRAISE 
      • PETITION 
      • TARGETED_LETTER 
      • TICKETED_EVENT
      • P2P_EVENT
      modifiedDate
      Date modified date
      customFields
      Array

      Array of custom fields with values with the following attributes

      • 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
       

      JSON Example

      {
        "id""30e5eef8-e2be-40f8-b37b-c98e8f7cb638",
        "timestamp""2018-02-08T12:04:58.098Z",
        "header": {
          "processingTime": 98,
          "serverId""local"
        },
        "payload": {
          "total": 2,
          "offset": 0,
          "count": 2,
          "results": [
            {
              "id""55c34706-e886-4081-a279-9fbe9ae60bdd",
              "supporterId""2ca598a2-30af-4b71-9348-32a1aa6d690a",
              "activityDate""2018-02-08T12:04:58.098Z",
              "formName""Activity Form Name",
              "formId""be611b77-4e14-4737-9b84-6df5ba897f2b",
              "activityType""P2P_EVENT",
              "modifiedDate""2018-02-08T12:04:58.098Z",
              "customFields": [
                {
                  "name""activity_customfield_color",
                  "value""grey",
                  "type""STRING",
                  "customFieldType""Activity"
                },
                {
                  "name""supporter_customfield_color",
                  "value""blue",
                  "type""STRING",
                  "customFieldType""Activity"
                }
              ]
            },
            {
              "id""464de2d6-58cf-495f-8188-c0850172e5e6",
              "supporterId""64480801-bcce-49b9-ab23-dbfb6569b5b8",
              "activityDate""2018-02-08T12:04:58.098Z",
              "formName""Activity Form Name",
              "formId""17f97875-d310-4fd0-9582-8654e6221c39",
              "activityType""P2P_EVENT",
              "modifiedDate""2018-02-08T12:04:58.098Z",
              "customFields": [
                {
                  "name""activity_customfield_color",
                  "value""grey",
                  "type""STRING",
                  "customFieldType""Activity"
                },
                {
                  "name""supporter_customfield_color",
                  "value""blue",
                  "type""STRING",
                  "customFieldType""Activity"
                }
              ]
            }
          ]
        }
      }
       
      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.