View All Drip Autoresponders

This API endpoint provides a paginated list of all Drip Autoresponder campaigns. The campaigns are listed in descending order, with the most recently created campaigns appearing first.

GET

 https://api.pushengage.com/apiv1/drips

Query Parameters

Parameter Name	Type	Required	Description
analytics_start_at	String	No	The UTC start date for the analytics data in the YYYY-MM-DD (ISO 8601) format.
analytics_end_at	String	No	The UTC end date for the analytics data in the the YYYY-MM-DD (ISO 8601) format.
page	Number	No	Default: 1, >=1 The page number for the requested data. The value should be greater than 1.
limit	Number	No	Default: 10, [1..500] The number of items per page. The value should be between 1 to 500.

Response Object

The response object returned by the API endpoint contains the details about Drip Autoresponder campaigns. The response also includes metadata such as total number of results, current page, last page and results per page.

Property Name	Type	Required	Description
success	Boolean	Yes	Indicates whether the API call was successful or not.
data	Drip Autoresponder[]	Yes	An Array of Drip Autoresponder campaign object.
meta	Object	Yes	An object containing metadata for the response.
meta.total	Number	Yes	The total number of results.
meta.page	Number	Yes	The current page number.
meta.perPage	Number	Yes	The number of results per page.
meta.lastPage	Number	Yes	The last page number.

Drip Autoresponder

Property Name	Type	Required	Description
drip_id	Number	Yes	The unique identifier for the Drip Autoresponder campaign.
campaign_name	String	Yes	The name of the Drip Autoresponder campaign.
drip_type	String	Yes	Valid values: generic, welcome Type of the Drip campaign.
status	String	Yes	Valid values: draft, active, pause, deleted The status of the Drip campaign.
site_id	Number	Yes	The unique identifier of the site associated with the Drip campaign.
created_at_utc	String	Yes	The UTC timestamp when the Drip campaign was created in ISO 8601 format.
updated_at_utc	String	Yes	The UTC timestamp when the Drip campaign was last updated in ISO 8601 format.
audience	Audience	Yes	Defines the target audience for the Drip campaign.
options	Object	Yes	An object containing extra options for the drip campaign.
options.result_name	String	Yes	The name of the goal used for Goal tracking in the Drip campaign.
analytics	Analytics	Yes	An object containing analytics information for the Drip campaign.
utm_params	UTM Params	No	An object containing UTM parameters for the Drip campaign.

Audience

Property Name	Type	Description
filter	Object	Specifies the filter criteria for selecting the audience.
filter.value	Array	An Array of audience filter rule group. Each filter rule group contains an array of audience filter rule. An audience matching all of the filter rule in any of the filter rule group is selected for the Drip campaign.
filter.value.*.*.field	String	Valid values: segments, country, states, city, device, device_type Specifies the filter rule field to be used for filtering the audience.
filter.value.*.*.op	String	Valid values: all, in, nin Specifies the filter rule operation to be performed for filtering the audience.
filter.value.*.*.value	Number[] | String[]	Specifies the filter rule value to be used for filtering the audience.

Analytics Object

Property Name	Type	Required	Description
views	Number	Yes	The number of view for the notification.
clicks	Number	Yes	The number of clicks on the notification.
sentcount	Number	Yes	The number of notification sent.
unsubscribed	Number	Yes	The number of unsubscribes for the notification.
ctr	Number	Yes	The click-through rate for the the notification.
result	Array	No	An array of analytics result/goal object associated with the notification.
result.*.name	String	No	The name of the goal.
result.*.count	Number	No	The count of the goal.
result.*.value	Number	No	The value of the goal.

UTM params Object

Property Name	Type	Required	Description
utm_source	String	Yes	The UTM source parameter value included in the URL of the notifications for the campaign.
utm_medium	String	Yes	The UTM medium parameter value included in the URL of the notifications for the campaign.
utm_campaign	String	Yes	The UTM campaign parameter value included in the URL of the notifications for the campaign.
utm_term	String	No	The UTM term parameter value included in the URL of the notifications for the campaign.
utm_content	String	No	The UTM content parameter value included in the URL of the notifications for the campaign.

Example

Request

cURL

curl -X GET \
'https://api.pushengage.com/apiv1/drips?analytics_start_at=2023-02-30&analytics_end_at=2023-03-30&page=1&limit=10' \
-H 'Api-Key: <YOUR_API_KEY>'

PHP

<?php
    $curl = curl_init();

    curl_setopt_array($curl, array(
      CURLOPT_URL => "https://api.pushengage.com/apiv1/drips?analytics_start_at=2023-02-30&analytics_end_at=2023-03-30&page=1&limit=10",
      CURLOPT_RETURNTRANSFER => true,
      CURLOPT_ENCODING => "",
      CURLOPT_MAXREDIRS => 10,
      CURLOPT_TIMEOUT => 30,
      CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
      CURLOPT_CUSTOMREQUEST => "GET",
      CURLOPT_HTTPHEADER => array(
        "Api-Key: <YOUR_API_KEY>"
      ),
    ));

    $response = curl_exec($curl);
    $err = curl_error($curl);

    curl_close($curl);

    if ($err) {
      echo "cURL Error #:" . $err;
    } else {
      echo $response;
    }
?>

Response

200 OK

{
  "success": true,
  "data": [
    {
      "drip_id": 28298989,
      "campaign_name": "Drip Autoresponder Campaign",
      "audience": {
        "filter": {
          "value": [
            [
              {
                "field": "country",
                "op": "in",
                "value": ["India", "Canada", "United States", "Australia"]
              },
              { "field": "segments", "op": "in", "value": [746353, 98786] }
            ]
          ]
        }
      },
      "status": "active",
      "site_id": 3289073,
      "created_at_utc": "2023-02-27T08:56:45Z",
      "updated_at_utc": "2023-02-27T08:56:45Z",
      "drip_type": "generic",
      "utm_params": {
        "utm_source": "PushEngage",
        "utm_medium": "Push Notification",
        "utm_campaign": "Drip Autoresponder",
        "utm_term": "UTM Term",
        "utm_content": "UTM Content"
      },
      "options": {
        "result_name": "revenue"
      },
      "analytics": {
        "ctr": 10,
        "views": 100,
        "clicks": 10,
        "sentcount": 150,
        "unsubscribed": 10,
        "result": [
          {
            "name": "revenue",
            "count": 10,
            "value": 200
          }
        ]
      }
    }
  ],
  "meta": {
    "total": 1,
    "page": 1,
    "lastPage": 1,
    "perPage": 10
  }
}

401 Unauthorized

{
  "success": false,
  "message": "API KEY Invalid"
}

400 Bad Request

{
  "success": false,
  "error": {
    "name": "InvalidRequestException",
    "message": "Error Message"
  }
}

500 Internal Server Error

{
  "success": false,
  "message": "Error message"
}