List All Drip Autoresponder¶

Getting Started¶

Introduction¶

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.

Request URL¶

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

Request Method¶

GET

Query Parameters¶

Parameter Name	Type	Description
analytics_start_at	String	`optional` The UTC start date for the analytics data in the YYYY-MM-DD (ISO 8601) format.
analytics_end_at	String	`optional` The UTC end date for the analytics data in the the YYYY-MM-DD (ISO 8601) format.
page	Number	`Default: 1`, `>=1` The page number for the requested data. The value should be greater than 1.
limit	Number	`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	Description
success	Boolean	Indicates whether the API call was successful or not.
data	Drip Autoresponder[]	An Array of Drip Autoresponder campaign object.
meta	Object	An object containing metadata for the response.
meta.total	Number	The total number of results.
meta.page	Number	The current page number.
meta.perPage	Number	The number of results per page.
meta.lastPage	Number	The last page number.

Drip Autoresponder¶

Property Name	Type	Description
drip_id	Number	The unique identifier for the Drip Autoresponder campaign.
campaign_name	String	The name of the Drip Autoresponder campaign.
drip_type	String	Valid values: `generic`, `welcome` Type of the Drip campaign.
status	String	Valid values: `draft`, `active`, `pause`, `deleted` The status of the Drip campaign.
site_id	Number	The unique identifier of the site associated with the Drip campaign.
created_at_utc	String	The UTC timestamp when the Drip campaign was created in ISO 8601 format.
updated_at_utc	String	The UTC timestamp when the Drip campaign was last updated in ISO 8601 format.
audience	Audience	Defines the target audience for the Drip campaign.
options	Object	An object containing extra options for the drip campaign.
options.result_name	String	The name of the goal used for Goal tracking in the Drip campaign.
analytics	Object	An object containing analytics information for the Drip campaign.
analytics.views	Number	The number of views for the notifications in the Drip campaign.
analytics.clicks	Number	The number of clicks on the notifications in the Drip campaign.
analytics.sentcount	Number	The number of notifications sent in the Drip campaign.
analytics.unsubscribed	Number	The number of unsubscribes for the Drip campaign.
analytics.ctr	Number	The click-through rate for the Drip campaign.
analytics.result	Array	An array of result/goal analytics object associated with the Drip campaign.
analytics.result.*.name	String	The name of the goal.
analytics.result.*.count	Number	The count of the goal.
analytics.result.*.value	Number	The value of the goal.
utm_params	Object	`optional` An object containing UTM parameters for the Drip campaign.
utm_params.utm_source	String	The UTM source parameter value included in the URL of the notifications for the campaign.
utm_params.utm_medium	String	The UTM medium parameter value included in the URL of the notifications for the campaign.
utm_params.utm_campaign	String	The UTM campaign parameter value included in the URL of the notifications for the campaign.
utm_params.utm_term	String	`optional` The UTM term parameter value included in the URL of the notifications for the campaign.
utm_params.utm_content	String	`optional` The UTM content parameter value included in the URL of the notifications for the 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.

Example¶

Request¶

cURLPHP

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
$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 OK401 Unauthorized400 Bad Request500 Internal Server Error

{
  "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
  }
}

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

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

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