In This Article:

    Email Blasts List

    In This Article:

      This API call returns the list of email blasts with web version info. 

      Request

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

      Parameters

      Name

      Type

      Mandatory/Optional

      Description

      criteria

      String

      optional

      A string representing full or partial name/description

      sortField

      String

      optional

      sort field name. Supported values: "name", "description"

      sortOrder

      String

      optional

      sort order. Values: ASCENDING/DESCENDING

      count

      Integer

      optional

      number of results to be returned. Max = 25. Default = 10

      offset

      Integer

      optional

      records offset. Used for pagination

      startDate

      Date

      optional

      Means "from date". Blast created on or after specified dateformat: 2018-01-08T23:01:18.000Z

      endDate

      Date

      optional

      Means "to date". Blast created on or before specified dateformat: 2018-01-08T23:01:18.000Z

       

      Example: https://dev-api.salsalabs.org/api/developer/ext/v1/blasts?endDate=2018-02-06T23:01:18.999Z&startDate=2018-01-08T23:01:18.000Z&criteria=blast1&sortFIeld=description&sortOrder=ASCENDING&count=20&offset=40

      Response

      General Fields

      Name
      Type
      Description

      total

      Integer

      total results

      offset

      Integer

      offset. number of records (pagination)

      count

      Integer

      count of attendees in current response

      results

      Array

      Array of Email objects

       

      Email Fields

      Name

      type

      Description

      id

      UUID

      email blast id

      name

      String

      blast name

      description

      String

      blast description

      status

      String

      blast status. Values:

      • ARCHIVED

      • CANCELED

      • DRAFT

      • ERRORED

      • PUBLISHED

      • SCHEDULED

      • UNPUBLISHED

      • JUDGEMENT_STARTED

      • JUDGEMENT_COMPLETED

      • SEND_STARTED

      • COMPLETED

      • TEST_STARTED

      • TEST_COMPLETED

      topic

      String

      blast topic

      publishDate

      Date

      publish date. ISO_8601 formatted String with a GMT timezone

      scheduleDate

      Date

      schedule date. ISO_8601 formatted String with a GMT timezone

      content

      List

      List of Content used for the email - more than one would indicate an A/B split test. Each will have the following properties:

      • subject - email subject
      • webVersionEnabled - if the email can be viewed as a web page, if true, the following properties are applicable
      • pageTitle - title of the page
      • pageUrl - URL of the page
      • webVersionRedirectDate - when to stop showing the email
      • webVersionRedirectUrl - URL to redirect a viewer of the pageURL to 

       

      Json Example

       
      {
        "id""e804d72d-17c0-4d83-be14-c8548e7b595b",
        "timestamp""2018-02-06T23:14:49.768Z",
        "header": {
          "processingTime"98,
          "serverId""local"
        },
        "payload": {
          "total"20,
          "offset"10,
          "count"2,
          "results": [
            {
              "id""bdce226c-fa7a-463f-b4fd-b1fc93541433",
              "name""name1",
              "description""description1",
              "status""Published",
              "topic""General",
              "publishDate""2018-02-06T23:14:49.769Z",
              "scheduleDate""2018-02-06T23:14:49.769Z",
              "content": [
                {
                  "subject""Subject",
                  "pageTitle""Web Version Page Title",
                  "pageUrl""https://url1/index.html",
                  "webVersionEnabled"true,
                  "webVersionRedirectUrl""https://redirecturl1/index.html",
                  "webVersionRedirectDate""2018-02-06T23:14:49.770Z"
                }
              ]
            },
            {
              "id""46a53641-e123-4868-af7b-151a40103602",
              "name""name2",
              "description""description2",
              "status""Published",
              "topic""General",
              "publishDate""2018-02-06T23:14:49.770Z",
              "scheduleDate""2018-02-06T23:14:49.770Z",
              "content": [
                {
                  "subject""Subject",
                  "pageTitle""Web Version Page Title",
                  "pageUrl""https://url2/index.html",
                  "webVersionEnabled"true,
                  "webVersionRedirectUrl""https://redirecturl2/index.html",
                  "webVersionRedirectDate""2018-02-06T23:14:49.770Z"
                }
              ]
            }
          ]
        }
      }
       
      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.