ActiveTrail API Reference

https://webapi.mymarketing.co.il/api/docs
Admin
ActiveTrail API provides a comprehensive solution for managing email, SMS, and operational message...
Tokens:440,389
Snippets:1,361
Trust Score:7.2
Update:3 months ago
Show doc for...
Tokens:
Raw
### GET API Request Example

Source: https://webapi.mymarketing.co.il/api/docs/user/Api/GET-api-groups-id-members_CustomerStates_SearchTerm_FromDate_ToDate_Page_Limit

This example demonstrates how to construct a GET request to retrieve group members. It includes placeholders for group ID and various query parameters for filtering and pagination.

```http
GET https://webapi.mymarketing.co.il/api/groups/{id}/members?CustomerStates={CustomerStates}&SearchTerm={SearchTerm}&FromDate={FromDate}&ToDate={ToDate}&Page={Page}&Limit={Limit}
```

--------------------------------

### PHP GET Request Example

Source: https://webapi.mymarketing.co.il/api/docs/guides/GetView/get-started

Use this snippet to retrieve data from a specific API endpoint. Ensure you replace placeholders like [CONV_CODE] and [API_KEY].

```php
<?php
//next example will receive all messages for specific conversation
$service_url = 'http://example.com/api/conversations/[CONV_CODE]/messages&apikey=[API_KEY]';
$curl = curl_init($service_url);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
$curl_response = curl_exec($curl);
if ($curl_response === false) {
    $info = curl_getinfo($curl);
    curl_close($curl);
    die('error occurred during curl exec. Additional info: ' . var_export($info));
}
curl_close($curl);
$decoded = json_decode($curl_response);
if (isset($decoded->response->status) && $decoded->response->status == 'ERROR') {
    die('error occurred: ' . $decoded->response->errormessage);
}
echo 'response ok!';
var_export($decoded->response);
?>
```

--------------------------------

### JSON Response Example

Source: https://webapi.mymarketing.co.il/api/docs/user/Api/GET-api-salesLifeCycle-Lead-leadId

Example of a lead object returned in JSON format. Includes various fields for lead information, product details, and status.

```json
{
        "badge": "sample string 25",
        "salebadge": "sample string 26",
        "ext1": "sample string 27",
        "ext2": "sample string 28",
        "ext3": "sample string 29",
        "ext4": "sample string 30",
        "ext5": "sample string 31",
        "ext6": "sample string 32",
        "ext7": "sample string 33",
        "ext8": "sample string 34",
        "ext9": "sample string 35",
        "ext10": "sample string 36"
      }
    ],
    "url": "sample string 21",
    "expectedPurchaseDate": "2016-12-24T14:12:12",
    "lastUpdate": "2016-12-24T14:12:12",
    "purchaseType": "sample string 22",
    "status": "sample string 23",
    "storeId": 24,
    "locationType": "Unknown",
    "ext1": "sample string 25",
    "ext2": "sample string 26",
    "ext3": "sample string 27",
    "ext4": "sample string 28",
    "ext5": "sample string 29",
    "ext6": "sample string 30",
    "ext7": "sample string 31",
    "ext8": "sample string 32",
    "ext9": "sample string 33",
    "ext10": "sample string 34",
    "num1": 1,
    "num2": 1,
    "num3": 1,
    "num4": 1,
    "num5": 1,
    "date1": "2016-12-24T14:12:12",
    "date2": "2016-12-24T14:12:12",
    "date3": "2016-12-24T14:12:12",
    "subscriptionStatus": true,
    "createContact": true
  }
]
```

--------------------------------

### Example Path Parameters

Source: https://webapi.mymarketing.co.il/api/docs/Guides

Illustrates how to structure API URLs with resource identifiers. Replace placeholders like {group_id} and {email} with actual values.

```URL
https://webapi.mymarketing.co.il/groups/{group_id}/members/{email}
```

--------------------------------

### GET /api/automationtriggers/triggerTypes

Source: https://webapi.mymarketing.co.il/api/docs/user/Api/GET-api-automationtriggers-triggerTypes

Retrieves a collection of all available start trigger options for automations.

```APIDOC
## GET /api/automationtriggers/triggerTypes

### Description
Get all the start trigger options for automations.

### Method
GET

### Endpoint
https://webapi.mymarketing.co.il/api/automationtriggers/triggerTypes

### Parameters
#### Path Parameters
None.

#### Query Parameters
None.

#### Request Body
None.

### Response
#### Success Response (200)
- **id** (integer) - Trigger id
- **name** (string) - Trigger name
- **groupname** (string) - Trigger group name

#### Response Example
```json
[
  {
    "id": 1,
    "name": "sample string 2",
    "groupname": "sample string 3"
  },
  {
    "id": 1,
    "name": "sample string 2",
    "groupname": "sample string 3"
  }
]
```
```

--------------------------------

### Get Automation Details

Source: https://webapi.mymarketing.co.il/api/docs

Retrieves the setup details of a specific automation, excluding its steps.

```APIDOC
## GET api/automations/{id}/details

### Description
Get the details (excluding the steps) of a specific automation.

### Method
GET

### Endpoint
api/automations/{id}/details
```

--------------------------------

### Example Query String Parameters

Source: https://webapi.mymarketing.co.il/api/docs/Guides

Demonstrates the use of query string parameters for filtering and specifying resources. Parameters like Email, Page, and Limit are appended after a question mark.

```URL
https://webapi.mymarketing.co.il/api/groups?Email={Email}&Page={Page}&Limit={Limit}
```

--------------------------------

### Example Pagination Parameters

Source: https://webapi.mymarketing.co.il/api/docs/Guides

Shows how to paginate API requests using 'Page' and 'Limit' query string parameters. Default values are Page=0 and Limit=100.

```URL
https://webapi.mymarketing.co.il/api/groups? Page=0&Limit=100
```

```URL
https://webapi.mymarketing.co.il/api/groups
```

```URL
https://webapi.mymarketing.co.il/api/groups? Page=1&Limit=100
```

--------------------------------

### Get User Social Accounts

Source: https://webapi.mymarketing.co.il/api/docs

Retrieves all available social account options for starting triggers.

```APIDOC
## GET api/user-social/accounts/get

### Description
Get account's social.

### Method
GET

### Endpoint
api/user-social/accounts/get
```

--------------------------------

### Get Automation Flow Times Started

Source: https://webapi.mymarketing.co.il/api/docs

Retrieves the flow sequence of the automation's steps.

```APIDOC
## GET api/automations/{id}/FlowTimesStarted

### Description
Get the automation's steps flow.

### Method
GET

### Endpoint
api/automations/{id}/FlowTimesStarted
```

--------------------------------

### GET /api/automationreports/{id}/logautomation

Source: https://webapi.mymarketing.co.il/api/docs/user/Api/GET-api-automationreports-id-logautomation

Returns all contacts that started a specific automation and shows all their steps within that automation.

```APIDOC
## GET /api/automationreports/{id}/logautomation

### Description
Retrieves a list of contacts who have started a specific automation, along with their progression through the automation's steps.

### Method
GET

### Endpoint
/api/automationreports/{id}/logautomation

### Parameters
#### Path Parameters
- **id** (integer) - Required - The unique identifier of the automation.

#### Request Body
None.

### Response
#### Success Response (200)
- **total_items** (integer) - Total number of automation log items for contacts who have started the automation.
- **total_distinct_by_customer_id** (integer) - Total count of distinct contacts who started the automation.
- **log_automations** (Collection of ApiLogAutomation) - A list of automation log items for contacts who have started the automation.
  - **id** (integer)
  - **automation_id** (integer)
  - **contact_id** (integer)

### Response Example
```json
{
  "total_items": 1,
  "total_distinct_by_customer_id": 2,
  "log_automations": [
    {
      "id": 1,
      "automation_id": 2,
      "contact_id": 1
    },
    {
      "id": 1,
      "automation_id": 2,
      "contact_id": 1
    }
  ]
}
```
```

--------------------------------

### XML Response Sample for Flow Times Started

Source: https://webapi.mymarketing.co.il/api/docs/user/Api/GET-api-automations-id-FlowTimesStarted

This XML sample demonstrates the response format for automation flow times started. It mirrors the JSON structure, providing details on flow ID, step transitions, and initiation counts for each flow path.

```xml
<ArrayOfAutomationFlewsTimesStarted xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <AutomationFlewsTimesStarted>
    <FlowId>1</FlowId>
    <FromStepId>1</FromStepId>
    <ToStepId>1</ToStepId>
    <TimesStarted>2</TimesStarted>
  </AutomationFlewsTimesStarted>
  <AutomationFlewsTimesStarted>
    <FlowId>1</FlowId>
    <FromStepId>1</FromStepId>
    <ToStepId>1</ToStepId>
    <TimesStarted>2</TimesStarted>
  </AutomationFlewsTimesStarted>
</ArrayOfAutomationFlewsTimesStarted>
```

--------------------------------

### XML Response Sample

Source: https://webapi.mymarketing.co.il/api/docs/user/Api/GET-api-automations-id-WhatsAppCampaignSteps-stepId

This XML sample demonstrates the structure of the response for a WhatsApp campaign step, mirroring the data provided in the JSON format. It includes campaign details, user profile information, and step-specific configurations.

```xml
<ApiAutomationWhatsAppStepInfo xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <CampaignName>sample string 1</CampaignName>
  <UserWhatsAppProfileId>2</UserWhatsAppProfileId>
  <Content>sample string 3</Content>
  <IsLinkTracking>true</IsLinkTracking>
  <UnsubscribeText>sample string 5</UnsubscribeText>
  <Id>1</Id>
  <Type>EmailCampaign</Type>
  <ObjectId>1</ObjectId>
  <WorkingDays>
    <ApiAutomationExtendedDetailsWorkingDays>
      <WorkingDay>1</WorkingDay>
      <FromHour />
      <ToHour />
    </ApiAutomationExtendedDetailsWorkingDays>
    <ApiAutomationExtendedDetailsWorkingDays>
      <WorkingDay>1</WorkingDay>
      <FromHour />
      <ToHour />
    </ApiAutomationExtendedDetailsWorkingDays>
  </WorkingDays>
  <Holidays>
    <Countries>
      <string>sample string 1</string>
      <string>sample string 2</string>
    </Countries>
    <TimeZone>sample string 1</TimeZone>
  </Holidays>
  <CampaignId>c3e1a649-92c9-44f5-8b19-3aa99419b6e6</CampaignId>
  <TemplateId>sample string 7</TemplateId>
  <CampaignType>Template</CampaignType>
  <FilePath>sample string 8</FilePath>
  <RemovalWord>sample string 9</RemovalWord>
</ApiAutomationWhatsAppStepInfo>
```

--------------------------------

### GET /api/automationreports/{id}/ContactsStarted

Source: https://webapi.mymarketing.co.il/api/docs/user/Api/GET-api-automationreports-id-ContactsStarted_FromDate_ToDate_Filter_Page_Limit

Returns the contacts that started a specific automation. You can specify a date range, filter, and pagination parameters.

```APIDOC
## GET /api/automationreports/{id}/ContactsStarted

### Description
Returns the contacts that started a specific automation. Can be found using the endpoint "Get account's automations" or in the UI.

### Method
GET

### Endpoint
https://webapi.mymarketing.co.il/api/automationreports/{id}/ContactsStarted

### Parameters
#### Path Parameters
- **id** (integer) - Required - Automation id.

#### Query Parameters
- **FromDate** (string) - Optional - The start date for filtering.
- **ToDate** (string) - Optional - The end date for filtering.
- **Filter** (string) - Optional - Filter criteria for the contacts.
- **Page** (integer) - Optional - Get a specific page number. Range: inclusive between 1 and 2147483647.
- **Limit** (integer) - Optional - Limit the number of items returned. Default is 20. Range: inclusive between 1 and 100.

### Response
#### Success Response (200)
- **total_items** (integer) - The total number of contacts found.
- **contacts_steps** (Collection of ApiAutomationContactsStepsReport) - A list of contacts who started the automation.
  - **customer_id** (integer)
  - **first_name** (string)
  - **last_name** (string)
  - **email** (string)
  - **sms** (string)
  - **date_created_utc** (string) - The date and time the contact started the automation in UTC.

### Response Example
```json
{
  "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"
    }
  ]
}
```
```

--------------------------------

### Create SMS Campaign (XML)

Source: https://webapi.mymarketing.co.il/api/docs/user/Api/POST-api-smscampaign-Campaign

This sample demonstrates how to create a new SMS campaign using XML format. It includes parameters for content, sender information, tracking, and detailed segmentation and scheduling.

```xml
<ApiSMSCampaignDetailsCampaign xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ActiveTrail.RESTfulApi.Models.SmsCampaignReport">
  <content>sample string 4</content>
  <from_name>sample string 3</from_name>
  <is_link_tracking>true</is_link_tracking>
  <name>sample string 2</name>
  <scheduling>
    <is_sent>true</is_sent>
    <scheduled_date>2016-12-24T14:12:12</scheduled_date>
    <scheduled_time_zone>Israel</scheduled_time_zone>
  </scheduling>
  <segment>
    <extra_restrictions_data_json>sample string 1</extra_restrictions_data_json>
    <group_ids xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </group_ids>
    <limit_amount>1</limit_amount>
    <mailing_list_id>1</mailing_list_id>
    <restricated_campaign_ids xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:long>1</d3p1:long>
      <d3p1:long>2</d3p1:long>
    </restricated_campaign_ids>
    <restricated_group_ids xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:long>1</d3p1:long>
      <d3p1:long>2</d3p1:long>
    </restricated_group_ids>
    <sms_sending_profile_id>1</sms_sending_profile_id>
  </segment>
  <can_unsubscribe>true</can_unsubscribe>
  <unsubscribe_text>sample string 1</unsubscribe_text>
</ApiSMSCampaignDetailsCampaign>
```

--------------------------------

### Get MailingList by ID (JSON)

Source: https://webapi.mymarketing.co.il/api/docs/user/Api/GET-api-mailinglist-Id

Example of a JSON response when retrieving a mailing list by its ID. This format is typically used for web APIs.

```json
{
  "Id": 1,
  "Name": "sample string 2"
}
```

--------------------------------

### Update Campaign XML Example

Source: https://webapi.mymarketing.co.il/api/docs/user/Api/PUT-api-campaigns-id

This XML structure shows how to update a campaign, including A/B testing settings and e-commerce data.

```xml
<ApiCampaignPut xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ActiveTrail.RESTfulApi.Models">
  <a_b_settings>
    <ab_percent_split_groups>3.1</ab_percent_split_groups>
    <design>
      <content>sample string 1</content>
      <header_footer_language_type>IBM_EBCDIC_US_Canada</header_footer_language_type>
      <is_add_print_email>true</is_add_print_email>
      <is_auto_css_inliner>true</is_auto_css_inliner>
      <is_remove_system_links>false</is_remove_system_links>
      <language_type>IBM_EBCDIC_US_Canada</language_type>
    </design>
    <google_analytics_name>sample string 2</google_analytics_name>
    <scheduling>
      <is_limit_to_confirmed>true</is_limit_to_confirmed>
      <is_sent>true</is_sent>
      <scheduled_date_utc>2016-12-24T14:12:12</scheduled_date_utc>
    </scheduling>
    <subject>sample string 1</subject>
    <user_profile_id>1</user_profile_id>
    <wait_time>
      <interval_time>1</interval_time>
      <interval_type>Hour</interval_type>
    </wait_time>
    <winning_version_by>Highest_ClickThrough_Rate</winning_version_by>
  </a_b_settings>
  <carts>
    <ecommerce_data>
      <ApiEcommerceData>
        <products>
          <coupon>
            <amount>
              <amount>1.1</amount>
              <currency>sample string 2</currency>
            </amount>
            <code>sample string 1</code>
          </coupon>
          <created_on>2016-12-24T14:12:12</created_on>
          <items>
            <ApiItem>
              <product>
                <add_to_cart_url>sample string 8</add_to_cart_url>
                <additional_txt_1>sample string 4</additional_txt_1>
                <additional_txt_2>sample string 5</additional_txt_2>
                <description>sample string 3</description>
                <id>1</id>
                <new_price>
                  <amount>1.1</amount>
                  <currency>sample string 2</currency>
                </new_price>
                <product_page_url>sample string 9</product_page_url>
                <real_price>
                  <amount>1.1</amount>
                  <currency>sample string 2</currency>
                </real_price>
                <sku>sample string 6</sku>
                <tags>sample string 10</tags>
                <thumbnail_url>sample string 7</thumbnail_url>
                <title>sample string 2</title>
              </product>
              <quantity>1</quantity>
              <total_price>
                <amount>1.1</amount>
                <currency>sample string 2</currency>
              </total_price>
            </ApiItem>
            <ApiItem>
              <product>
                <add_to_cart_url>sample string 8</add_to_cart_url>
                <additional_txt_1>sample string 4</additional_txt_1>
                <additional_txt_2>sample string 5</additional_txt_2>
                <description>sample string 3</description>
                <id>1</id>
                <new_price>
                  <amount>1.1</amount>
                  <currency>sample string 2</currency>
                </new_price>
                <product_page_url>sample string 9</product_page_url>
                <real_price>
                  <amount>1.1</amount>
                  <currency>sample string 2</currency>
                </real_price>
                <sku>sample string 6</sku>
                <tags>sample string 10</tags>
                <thumbnail_url>sample string 7</thumbnail_url>
                <title>sample string 2</title>
              </product>
              <quantity>1</quantity>
              <total_price>
                <amount>1.1</amount>
                <currency>sample string 2</currency>
              </total_price>
            </ApiItem>
          </items>
        </products>
      </ApiEcommerceData>
    </ecommerce_data>
  </carts>
</ApiCampaignPut>
```

--------------------------------

### Contact Endpoint Operations (C#)

Source: https://webapi.mymarketing.co.il/api/docs/guides/GetView/get-started

This C# example demonstrates how to perform GET, POST, PUT, and DELETE operations on the contacts endpoint using HttpClient.

```APIDOC
## HTTP Operations for Contacts (C#)

### Description
This code snippet shows how to interact with the contacts endpoint using C# and HttpClient. It covers fetching a contact by ID, creating a new contact, updating an existing contact, and deleting a contact.

### Method
GET, POST, PUT, DELETE

### Endpoint
- `api/contacts/{id}` (GET, DELETE)
- `api/contacts` (POST)
- `api/contacts/{id}` (PUT)

### Parameters
#### Path Parameters
- **id** (int) - Required - The unique identifier for a contact.

#### Request Body (POST/PUT)
- **id** (int) - Optional - The unique identifier for a contact.
- **first_name** (string) - Required - The first name of the contact.
- **last_name** (string) - Required - The last name of the contact.
- **email** (string) - Required - The email address of the contact.
- **anniversary** (string) - Optional - The anniversary date of the contact.
- **birthday** (string) - Optional - The birthday of the contact.
- **city** (string) - Optional - The city of the contact.
- **encryptedext1** (string) - Optional - Encrypted extended field 1.
- **encryptedext2** (string) - Optional - Encrypted extended field 2.
- **encryptedext3** (string) - Optional - Encrypted extended field 3.
- **encryptedext4** (string) - Optional - Encrypted extended field 4.
- **ext1** (string) - Optional - Extended field 1.
- **ext2** (string) - Optional - Extended field 2.
- **ext3** (string) - Optional - Extended field 3.
- **ext4** (string) - Optional - Extended field 4.
- **ext5** (string) - Optional - Extended field 5.
- **ext6** (string) - Optional - Extended field 6.
- **fax** (string) - Optional - The fax number of the contact.
- **phone1** (string) - Optional - The primary phone number of the contact.
- **phone2** (string) - Optional - The secondary phone number of the contact.
- **street** (string) - Optional - The street address of the contact.
- **zip_code** (string) - Optional - The zip code of the contact.
- **is_do_not_mail** (bool) - Optional - Flag to indicate if the contact should not receive mail.

### Request Example (POST)
```json
{
  "first_name": "First Name",
  "last_name": "Last Name",
  "email": "agent@example.com"
}
```

### Response
#### Success Response (200 OK for GET)
Returns a Contact object with details.

#### Success Response (200 OK for POST/PUT)
Returns the created or updated Contact object.

#### Success Response (204 No Content for PUT)
Indicates the update was successful.

#### Error Response
- 400 Bad Request: Invalid input.
- 401 Unauthorized: Missing or invalid API token.
- 404 Not Found: Contact not found.

```

--------------------------------

### Create Smart Code Site (JSON)

Source: https://webapi.mymarketing.co.il/api/docs/user/Api/POST-api-smartcodesite

Use this JSON format to create a new Smart Code site. Ensure all required fields are provided.

```json
{
  "name": "sample string 2",
  "domains": "sample string 3",
  "group_id": 1,
  "mailing_list_id": 1,
  "allowed_ips": "sample string 4",
  "version": 1,
  "tracker_domain": "sample string 5"
}
```

--------------------------------

### Get Automation Design (XML)

Source: https://webapi.mymarketing.co.il/api/docs/user/Api/GET-api-automations-id-design

This XML sample illustrates the response format for fetching automation design. It mirrors the JSON structure with 'data' and 'stepsInfo' elements, suitable for XML-based integrations.

```xml
<ApiAutomationDesignInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ActiveTrail.RESTfulApi.Models">
  <data>sample string 1</data>
  <stepsInfo>
    <ApiAutomationStepDesignInfo>
      <id>1</id>
      <is_active>true</is_active>
      <object_id>1</object_id>
      <type>EmailCampaign</type>
    </ApiAutomationStepDesignInfo>
    <ApiAutomationStepDesignInfo>
      <id>1</id>
      <is_active>true</is_active>
      <object_id>1</object_id>
      <type>EmailCampaign</type>
    </ApiAutomationStepDesignInfo>
  </stepsInfo>
</ApiAutomationDesignInfo>
```

--------------------------------

### Get MailingList by ID (XML)

Source: https://webapi.mymarketing.co.il/api/docs/user/Api/GET-api-mailinglist-Id

Example of an XML response when retrieving a mailing list by its ID. This format is often used for broader compatibility or legacy systems.

```xml
<MailingListInfoDTO xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Id>1</Id>
  <Name>sample string 2</Name>
</MailingListInfoDTO>
```

--------------------------------

### Get Push Notification Campaign Statistics by Automation ID

Source: https://webapi.mymarketing.co.il/api/docs/user/Api/GET-api-automationreports-id-automationpushnotificationcampaignstatistic_FromDate_ToDate

Fetches push notification campaign statistics for a specified automation ID and date range. Requires the automation ID, start date, and end date as parameters.

```APIDOC
## GET https://webapi.mymarketing.co.il/api/automationreports/{id}/automationpushnotificationcampaignstatistic?FromDate={FromDate}&ToDate={ToDate}

### Description
Get Push Notification campaigns statistics for a specific automation.

### Method
GET

### Endpoint
/api/automationreports/{id}/automationpushnotificationcampaignstatistic

### Parameters
#### Path Parameters
- **id** (integer) - Required - 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)

#### Query Parameters
- **FromDate** (string) - Required - The start date for the statistics.
- **ToDate** (string) - Required - The end date for the statistics.

### Response
#### Success Response (200)
- **totalitems** (integer) - The total number of items.
- **count** (integer) - The count of items.
- **campaignreportslist** (Collection of ApiPushCampaignReportInfo) - A list of campaign reports.
  - **campaignid** (string) - The ID of the campaign.
  - **campaignname** (string) - The name of the campaign.
  - **sentdate** (string) - The date the campaign was sent.
  - **senttype** (integer) - The type of send.
  - **totalclicks** (integer) - The total number of clicks.
  - **clickers** (integer) - The number of unique clickers.
  - **unsubscribe** (integer) - The number of unsubscribes.
  - **failed** (integer) - The number of failed sends.
  - **failedPercentage** (number) - The percentage of failed sends.
  - **totalsent** (integer) - The total number of sent messages.
  - **opens** (integer) - The total number of opens.
  - **openedPercentage** (number) - The percentage of opens.
  - **totalDevices** (integer) - The total number of devices.
  - **purchases** (integer) - The number of purchases.
  - **revenue** (number) - The total revenue generated.

### Response Example
```json
{
  "totalitems": 2,
  "count": 2,
  "campaignreportslist": [
    {
      "campaignid": "51a14997-1030-4b91-810f-756fec99e99f",
      "campaignname": "sample string 2",
      "sentdate": "2016-12-24T14:12:12",
      "senttype": 1,
      "totalclicks": 3,
      "clickers": 4,
      "unsubscribe": 5,
      "failed": 6,
      "failedPercentage": 7.1,
      "totalsent": 8,
      "opens": 9,
      "openedPercentage": 10.1,
      "totalDevices": 11,
      "purchases": 12,
      "revenue": 13.1
    }
  ]
}
```
```

--------------------------------

### JSON Response Sample for Flow Times Started

Source: https://webapi.mymarketing.co.il/api/docs/user/Api/GET-api-automations-id-FlowTimesStarted

This JSON sample illustrates the structure of the response when retrieving flow times started for an automation. It details the flow ID, step transitions, and the number of times each flow path was initiated.

```json
[
  {
    "flow_id": 1,
    "from_step_id": 1,
    "to_step_id": 1,
    "times_started": 2
  },
  {
    "flow_id": 1,
    "from_step_id": 1,
    "to_step_id": 1,
    "times_started": 2
  }
]
```

--------------------------------

### GET /api/contacts/{id}/Statistics/OperationMessage/{messageId}

Source: https://webapi.mymarketing.co.il/api/docs/user/Api/GET-api-contacts-id-Statistics-OperationMessage-messageId

Gets customer statistics for a specific operation message associated with a contact.

```APIDOC
## GET /api/contacts/{id}/Statistics/OperationMessage/{messageId}

### Description
Retrieves detailed statistics for a specific contact's operation message.

### Method
GET

### Endpoint
https://webapi.mymarketing.co.il/api/contacts/{id}/Statistics/OperationMessage/{messageId}

### Parameters
#### Path Parameters
- **id** (integer) - Required - The unique identifier of the contact.
- **messageId** (integer) - Required - The unique identifier of the operation message.

### Response
#### Success Response (200)
- **sent** (integer) - The number of messages sent.
- **opens** (integer) - The number of times the message was opened.
- **open_date** (date) - The date and time of the last open.
- **clicks** (integer) - The number of times links in the message were clicked.
- **click_date** (date) - The date and time of the last click.
- **bounce** (boolean) - Indicates if the message resulted in a bounce.
- **bounceReason** (string) - The reason for the bounce, if applicable.
- **bounce_date** (date) - The date and time of the bounce.
- **unsubscribe** (boolean) - Indicates if the contact unsubscribed.
- **unsubscribe_date** (date) - The date and time of the unsubscribe action.
- **spam_complaint** (boolean) - Indicates if the contact reported the message as spam.
- **spam_complaint_date** (date) - The date and time of the spam complaint.
- **customer_id** (integer) - The identifier of the customer.

#### Response Example
```json
{
  "sent": 1,
  "opens": 1,
  "open_date": "2016-12-24T14:12:12",
  "clicks": 2,
  "click_date": "2016-12-24T14:12:12",
  "bounce": true,
  "bounceReason": "sample string 4",
  "bounce_date": "2016-12-24T14:12:12",
  "unsubscribe": true,
  "unsubscribe_date": "2016-12-24T14:12:12",
  "spam_complaint": true,
  "spam_complaint_date": "2016-12-24T14:12:12",
  "customer_id": 7
}
```
```

--------------------------------

### Create SMS Campaign (JSON)

Source: https://webapi.mymarketing.co.il/api/docs/user/Api/POST-api-smscampaign-Campaign

Use this sample to create a new SMS campaign with detailed segmentation and scheduling options in JSON format. Ensure all required fields are provided.

```json
{
  "unsubscribe_text": "sample string 1",
  "can_unsubscribe": true,
  "name": "sample string 2",
  "from_name": "sample string 3",
  "content": "sample string 4",
  "segment": {
    "group_ids": [
      1,
      2
    ],
    "restricated_group_ids": [
      1,
      2
    ],
    "restricated_campaign_ids": [
      1,
      2
    ],
    "mailing_list_id": 1,
    "limit_amount": 1,
    "sms_sending_profile_id": 1,
    "extra_restrictions_data_json": "sample string 1"
  },
  "scheduling": {
    "is_sent": true,
    "scheduled_time_zone": "Israel",
    "scheduled_date": "2016-12-24T14:12:12"
  },
  "is_link_tracking": true
}
```

--------------------------------

### XML Response Example

Source: https://webapi.mymarketing.co.il/api/docs/user/Api/GET-api-salesLifeCycle-Lead-leadId

Example of a lead object returned in XML format. This structure details lead and product information.

```xml
<ArrayOfApiPostLead xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ApiPostLead>
    <LeadId>sample string 6</LeadId>
    <LeadName>sample string 7</LeadName>
    <ExternalId>sample string 8</ExternalId>
    <ExternalName>sample string 9</ExternalName>
    <FirstName>sample string 10</FirstName>
    <LastName>sample string 11</LastName>
    <Email>sample string 12</Email>
    <Mobile>sample string 13</Mobile>
    <NetAmount>14.1</NetAmount>
    <Tax>15.1</Tax>
    <Coupon>sample string 16</Coupon>
    <Quantity>17.1</Quantity>
    <TotalAmount>18.1</TotalAmount>
    <Address>sample string 19</Address>
    <City>sample string 20</City>
    <Products>
      <Product>
        <Id>sample string 1</Id>
        <Name>sample string 2</Name>
        <Quantity>3.1</Quantity>
        <TotalAmount>4.1</TotalAmount>
        <Description>sample string 5</Description>
        <Sku>sample string 6</Sku>
        <Type>sample string 7</Type>
        <PrimaryCategory>sample string 8</PrimaryCategory>
        <Category>sample string 9</Category>
        <SubCategory>sample string 10</SubCategory>
        <Brand>sample string 11</Brand>
        <Color>sample string 12</Color>
        <Size>sample string 13</Size>
        <Gender>sample string 14</Gender>
        <Group>sample string 15</Group>
        <Weight>16.1</Weight>
        <UnitPrice>17.1</UnitPrice>
        <ShippingPrice>18.1</ShippingPrice>
        <Discount>19.1</Discount>
        <Tax>20.1</Tax>
        <EventDate>2016-12-24T14:12:12</EventDate>
        <ScheduledDate>2016-12-24T14:12:12</ScheduledDate>
        <PickupDate>2016-12-24T14:12:12</PickupDate>
        <Coupon>sample string 21</Coupon>
        <TotalPrice>22.1</TotalPrice>
        <Image>sample string 23</Image>
        <Url>sample string 24</Url>
        <Badge>sample string 25</Badge>
        <SaleBadge>sample string 26</SaleBadge>
        <Ext1>sample string 27</Ext1>
        <Ext2>sample string 28</Ext2>
        <Ext3>sample string 29</Ext3>
        <Ext4>sample string 30</Ext4>
        <Ext5>sample string 31</Ext5>
        <Ext6>sample string 32</Ext6>
        <Ext7>sample string 33</Ext7>
        <Ext8>sample string 34</Ext8>
        <Ext9>sample string 35</Ext9>
        <Ext10>sample string 36</Ext10>
      </Product>
      <Product>
        <Id>sample string 1</Id>
        <Name>sample string 2</Name>
        <Quantity>3.1</Quantity>
        <TotalAmount>4.1</TotalAmount>
        <Description>sample string 5</Description>
        <Sku>sample string 6</Sku>
        <Type>sample string 7</Type>
        <PrimaryCategory>sample string 8</PrimaryCategory>
        <Category>sample string 9</Category>
        <SubCategory>sample string 10</SubCategory>
        <Brand>sample string 11</Brand>
        <Color>sample string 12</Color>
        <Size>sample string 13</Size>
        <Gender>sample string 14</Gender>
        <Group>sample string 15</Group>
        <Weight>16.1</Weight>
        <UnitPrice>17.1</UnitPrice>
        <ShippingPrice>18.1</ShippingPrice>
        <Discount>19.1</Discount>
        <Tax>20.1</Tax>
        <EventDate>2016-12-24T14:12:12</EventDate>
        <ScheduledDate>2016-12-24T14:12:12</ScheduledDate>
        <PickupDate>2016-12-24T14:12:12</PickupDate>
        <Coupon>sample string 21</Coupon>
        <TotalPrice>22.1</TotalPrice>
        <Image>sample string 23</Image>
        <Url>sample string 24</Url>
        <Badge>sample string 25</Badge>
        <SaleBadge>sample string 26</SaleBadge>
        <Ext1>sample string 27</Ext1>
        <Ext2>sample string 28</Ext2>
      </Product>
    </Products>
  </ApiPostLead>
</ArrayOfApiPostLead>
```

--------------------------------

### XML Response for SMS Campaign Steps

Source: https://webapi.mymarketing.co.il/api/docs/user/Api/GET-api-automations-id-SMSCampaignSteps

This XML sample demonstrates the response format for retrieving SMS campaign steps. It mirrors the JSON structure, providing data for total items and a list of SMS step details.

```xml
<ApiAutomationSmsStepInfoList xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <TotalItems>1</TotalItems>
  <AutomationsSmsStepsInfo>
    <ApiAutomationSmsStepInfo>
      <CampaignName>sample string 1</CampaignName>
      <UserSmsProfileId>2</UserSmsProfileId>
      <FromName>sample string 3</FromName>
      <Content>sample string 4</Content>
      <IsLinkTracking>true</IsLinkTracking>
      <UnsubscribeText>sample string 6</UnsubscribeText>
      <Id>1</Id>
      <Type>EmailCampaign</Type>
      <ObjectId>1</ObjectId>
      <WorkingDays>
        <ApiAutomationExtendedDetailsWorkingDays>
          <WorkingDay>1</WorkingDay>
          <FromHour />
          <ToHour />
        </ApiAutomationExtendedDetailsWorkingDays>
        <ApiAutomationExtendedDetailsWorkingDays>
          <WorkingDay>1</WorkingDay>
          <FromHour />
          <ToHour />
        </ApiAutomationExtendedDetailsWorkingDays>
      </WorkingDays>
      <Holidays>
        <Countries>
          <string>sample string 1</string>
          <string>sample string 2</string>
        </Countries>
        <TimeZone>sample string 1</TimeZone>
      </Holidays>
    </ApiAutomationSmsStepInfo>
    <ApiAutomationSmsStepInfo>
      <CampaignName>sample string 1</CampaignName>
      <UserSmsProfileId>2</UserSmsProfileId>
      <FromName>sample string 3</FromName>
      <Content>sample string 4</Content>
      <IsLinkTracking>true</IsLinkTracking>
      <UnsubscribeText>sample string 6</UnsubscribeText>
      <Id>1</Id>
      <Type>EmailCampaign</Type>
      <ObjectId>1</ObjectId>
      <WorkingDays>
        <ApiAutomationExtendedDetailsWorkingDays>
          <WorkingDay>1</WorkingDay>
          <FromHour />
          <ToHour />
        </ApiAutomationExtendedDetailsWorkingDays>
        <ApiAutomationExtendedDetailsWorkingDays>
          <WorkingDay>1</WorkingDay>
          <FromHour />
          <ToHour />
        </ApiAutomationExtendedDetailsWorkingDays>
      </WorkingDays>
      <Holidays>
        <Countries>
          <string>sample string 1</string>
          <string>sample string 2</string>
        </Countries>
        <TimeZone>sample string 1</TimeZone>
      </Holidays>
    </ApiAutomationSmsStepInfo>
  </AutomationsSmsStepsInfo>
</ApiAutomationSmsStepInfoList>
```

--------------------------------

### GET /api/external Endpoint URI

Source: https://webapi.mymarketing.co.il/api/docs/user/Api/GET-api-external_Email_Sms

This is the URI for the GET /api/external endpoint. It requires 'Email' and 'Sms' as query parameters to filter contact information.

```http
GET https://webapi.mymarketing.co.il/api/external?Email={Email}&Sms={Sms}
```

--------------------------------

### XML Response Sample

Source: https://webapi.mymarketing.co.il/api/docs/user/Api/GET-api-campaignreports-id-domains_Page_Limit

This sample illustrates the XML format for campaign reports by domain. It mirrors the JSON structure, providing total domain counts and detailed performance metrics for each domain.

```xml
<ApiCampaignDomainsList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ActiveTrail.RESTfulApi.Models.CampaignReport">
  <campaign_domains>
    <ApiCampaignDomains>
      <bounces>8</bounces>
      <clickers>7</clickers>
      <clicks_rate>6.1</clicks_rate>
      <domain>sample string 1</domain>
      <opened_rate>2.1</opened_rate>
      <opens>3</opens>
      <sent>11</sent>
      <spam_complaints>10</spam_complaints>
      <unopened>5</unopened>
      <unopened_rate>4.1</unopened_rate>
      <unsubscribes>9</unsubscribes>
    </ApiCampaignDomains>
    <ApiCampaignDomains>
      <bounces>8</bounces>
      <clickers>7</clickers>
      <clicks_rate>6.1</clicks_rate>
      <domain>sample string 1</domain>
      <opened_rate>2.1</opened_rate>
      <opens>3</opens>
      <sent>11</sent>
      <spam_complaints>10</spam_complaints>
      <unopened>5</unopened>
      <unopened_rate>4.1</unopened_rate>
      <unsubscribes>9</unsubscribes>
    </ApiCampaignDomains>
  </campaign_domains>
  <total>1</total>
</ApiCampaignDomainsList>

```
Tokens:
Raw