For more information on using API

GET https://webapi.mymarketing.co.il/api/automationreports/{id}/ContactsStarted?Page={Page}&Limit={Limit}

Returns the contacts that started a specific automation.

Request Information

URI Parameters

Name

Description

Type

Additional information

id

Automation id. Can be found using the endpoint "Get account's automations" or in the UI (go to Automations->Automations Lists->click on the automation's reports -> you'll find the id int the URL)

integer

Required

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

ApiAutomationContactsStarted

Name

Description

Type

Additional information

total_items

integer
contacts_steps

Collection of ApiAutomationContactsStepsReport

Response Formats

application/json, text/json

Sample: 
{
  "total_items": 1,
  "contacts_steps": [
    {
      "customer_id": 1,
      "first_name": "sample string 2",
      "last_name": "sample string 3",
      "email": "sample string 4",
      "sms": "sample string 5",
      "date_created_utc": "2016-12-24T14:12:12"
    },
    {
      "customer_id": 1,
      "first_name": "sample string 2",
      "last_name": "sample string 3",
      "email": "sample string 4",
      "sms": "sample string 5",
      "date_created_utc": "2016-12-24T14:12:12"
    }
  ]
}

application/xml, text/xml

Sample: 
<ApiAutomationContactsStarted xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ActiveTrail.RESTfulApi.Models.AutomationReport">
  <contacts_steps>
    <ApiAutomationContactsStepsReport>
      <customer_id>1</customer_id>
      <date_created_utc>2016-12-24T14:12:12</date_created_utc>
      <email>sample string 4</email>
      <first_name>sample string 2</first_name>
      <last_name>sample string 3</last_name>
      <sms>sample string 5</sms>
    </ApiAutomationContactsStepsReport>
    <ApiAutomationContactsStepsReport>
      <customer_id>1</customer_id>
      <date_created_utc>2016-12-24T14:12:12</date_created_utc>
      <email>sample string 4</email>
      <first_name>sample string 2</first_name>
      <last_name>sample string 3</last_name>
      <sms>sample string 5</sms>
    </ApiAutomationContactsStepsReport>
  </contacts_steps>
  <total_items>1</total_items>
</ApiAutomationContactsStarted>