For more information on using API

GET https://webapi.mymarketing.co.il/api/automations?StateType={StateType}&Page={Page}&Limit={Limit}

Get account's automations

Request Information

URI Parameters

Name

Description

Type

Additional information

state_type

Get status type from list

TypesAutomationStateTypes
page

Get a specific page (number of pages is limited)

integer

Range: inclusive between 1 and 2147483647

limit

Limit the number of items you get in the results. (Removing the "limit" will, by default, display only 20 records)

integer

Range: inclusive between 1 and 100

Body Parameters

None.

Response Information

Resource Description

Collection of ApiAutomationInfo

Name

Description

Type

Additional information

id

Automation id

integer
template_id

The id of the template that was selected

integer
triggered_count

Number of times that a contact started the automation

integer
trigger_type_id

Trigger type from the triggers list

TypesAutomationTriggerTypes
trigger_object_id

Id of the object that activates the trigger (email/ sign up form, etc.)

integer
segmentation_id

Segmentation id

integer
details

Object that contains the automation details (name, dates, etc.) See AutomationDetailsInfo for more information

ApiAutomationDetailsInfo
design

Object that contains the automation design (data and flow steps.) See AutomationDesignInfo for more information

ApiAutomationDesignInfo
activation

Object that contains the automation activation (scheduled time for the automation and if it is active or not.) See AutomationActivationInfo for more information

ApiAutomationActivationInfo

Response Formats

application/json, text/json

Sample: 
[
  {
    "id": 1,
    "template_id": 1,
    "triggered_count": 1,
    "trigger_type_id": "AbandonedCartRecovery",
    "trigger_object_id": 1,
    "segmentation_id": 1,
    "details": {
      "name": "sample string 1",
      "allow_trigger_multiple_times": true,
      "report_interval_type": "Immediate",
      "report_send_to": "sample string 2",
      "is_send_report": true,
      "date_updated_utc": "2016-12-24T14:12:12",
      "date_created_utc": "2016-12-24T14:12:12",
      "extended_details": {
        "rerun_trigger": true,
        "working_days": [
          {
            "day": 1,
            "from": "00:00:00.1234567",
            "to": "00:00:00.1234567"
          },
          {
            "day": 1,
            "from": "00:00:00.1234567",
            "to": "00:00:00.1234567"
          }
        ]
      }
    },
    "design": {
      "data": "sample string 1",
      "stepsInfo": [
        {
          "id": 1,
          "type": "EmailCampaign",
          "object_id": 1,
          "is_active": true
        },
        {
          "id": 1,
          "type": "EmailCampaign",
          "object_id": 1,
          "is_active": true
        }
      ]
    },
    "activation": {
      "is_published": true,
      "scheduled_time": "2016-12-24T14:12:12"
    }
  },
  {
    "id": 1,
    "template_id": 1,
    "triggered_count": 1,
    "trigger_type_id": "AbandonedCartRecovery",
    "trigger_object_id": 1,
    "segmentation_id": 1,
    "details": {
      "name": "sample string 1",
      "allow_trigger_multiple_times": true,
      "report_interval_type": "Immediate",
      "report_send_to": "sample string 2",
      "is_send_report": true,
      "date_updated_utc": "2016-12-24T14:12:12",
      "date_created_utc": "2016-12-24T14:12:12",
      "extended_details": {
        "rerun_trigger": true,
        "working_days": [
          {
            "day": 1,
            "from": "00:00:00.1234567",
            "to": "00:00:00.1234567"
          },
          {
            "day": 1,
            "from": "00:00:00.1234567",
            "to": "00:00:00.1234567"
          }
        ]
      }
    },
    "design": {
      "data": "sample string 1",
      "stepsInfo": [
        {
          "id": 1,
          "type": "EmailCampaign",
          "object_id": 1,
          "is_active": true
        },
        {
          "id": 1,
          "type": "EmailCampaign",
          "object_id": 1,
          "is_active": true
        }
      ]
    },
    "activation": {
      "is_published": true,
      "scheduled_time": "2016-12-24T14:12:12"
    }
  }
]

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.