Skip to main content

View Drip Autoresponder

This API endpoint returns a Drip Autoresponder campaign by id. The response includes the list of notifications in the Drip Autoresponder campaign.

GET
 https://api.pushengage.com/apiv1/drips/{drip_id}

Path Parameters

Property NameTypeRequiredDescription
drip_idNumberYesThe unique identifier of the Drip Autoresponder campaign.

Query Parameters

Parameter NameTypeRequiredDescription
analytics_start_atStringNoThe UTC start date for the analytics data in the YYYY-MM-DD (ISO 8601) format.
analytics_end_atStringNoThe UTC end date for the analytics data in the the YYYY-MM-DD (ISO 8601) format.

Response Object

The response object returned by the API endpoint contains the details about the Drip Autoresponder campaign.

Property NameTypeRequiredDescription
successBooleanYesIndicates whether the API call was successful or not.
dataDrip AutoresponderYesThe Drip Autoresponder campaign object.

Drip Autoresponder

Property NameTypeRequiredDescription
drip_idNumberYesThe unique identifier for the Drip Autoresponder campaign.
campaign_nameStringYesThe name of the Drip Autoresponder campaign.
drip_typeStringYesValid values: generic, welcome
Type of the Drip campaign.
statusStringYesValid values: draft, active, pause, deleted
The status of the Drip campaign.
site_idNumberYesThe unique identifier of the site associated with the Drip campaign.
created_at_utcStringYesThe UTC timestamp when the Drip campaign was created in ISO 8601 format.
updated_at_utcStringYesThe UTC timestamp when the Drip campaign was last updated in ISO 8601 format.
audienceAudienceYesDefines the target audience for the Drip campaign.
optionsObjectYesAn object containing extra options for the drip campaign.
options.result_nameStringYesThe name of the goal used for Goal tracking in the Drip campaign.
analyticsAnalyticsYesAn object containing analytics information for the Drip campaign.
notificationsDrip Notification[]YesAn array of notifications in the Drip campaign.
utm_paramsUTM ParamsNoAn object containing UTM parameters for the Drip campaign.

Audience

Property NameTypeDescription
filterObjectSpecifies the filter criteria for selecting the audience.
filter.valueArrayAn 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.*.*.fieldStringValid values: segments, country, states, city, device, device_type
Specifies the filter rule field to be used for filtering the audience.
filter.value.*.*.opStringValid values: all, in, nin
Specifies the filter rule operation to be performed for filtering the audience.
filter.value.*.*.valueNumber[] | String[]Specifies the filter rule value to be used for filtering the audience.

Drip Notification

Property NameTypeRequiredDescription
idNumberYesThe unique id of the notification in the Drip campaign.
orderNumberYesThe order of the notification.
titleStringYesTitle of the notification.
messageStringYesThe message to be displayed in the push notification.
urlStringYesThe URL that opens upon clicking the received push notification.
image_urlStringYesURL of the notification icon image.
big_image_urlStringYesURL of the notification large image.
require_interactionNumberYesValid values: 1, 0
Indicates that on devices with sufficiently large screens, the notification should remain active until the user clicks or dismisses it.
expiryNumberYesThe expiry time of on notification in seconds. The notification will be expired if the device does not come back online within this time. The maximum time is 28 days.
schedule_optionsObjectYesAn object containing the scheduling details of the notification.
schedule_options.typeStringYesValid values: after, rightaway
Specifies when to send this notification after sending the previous notification in the Drip campaign. The type of first notifications can be either rightaway or after and the rest of the following notifications it should be after.
schedule_options.valueNumberYesThe value specifies the time to wait before sending the notification after sending the previous notification in the campaign. It is required when the type is set to after.
schedule_options.unitNumberYesValid values: minutes, days, dow
The unit of the value is required when the type is set to after. The value will be treated based on its unit. If the unit is minutes, then the value will indicate the number of minutes. If the unit is days, then the value will indicate the number of days. If the unit is dow, then the value will be 0 for Sunday, 1 for Monday, 2 for Tuesday, 3 for Wednesday, 4 for Thursday, 5 for Friday, and 6 for Saturday.
schedule_options.atStringYesThe sending time of the notification in the HH:mm:ss format. It is required when the unit is days or dow.
analyticsAnalyticsYesAn object containing analytics information for the Drip notification.
actionsAction[]NoAn array of action button to display in the notification. It accept maximum two action.

Analytics Object

Property NameTypeRequiredDescription
viewsNumberYesThe number of view for the notification.
clicksNumberYesThe number of clicks on the notification.
sentcountNumberYesThe number of notification sent.
unsubscribedNumberYesThe number of unsubscribes for the notification.
ctrNumberYesThe click-through rate for the the notification.
resultArrayNoAn array of analytics result/goal object associated with the notification.
result.*.nameStringNoThe name of the goal.
result.*.countNumberNoThe count of the goal.
result.*.valueNumberNoThe value of the goal.

UTM params Object

Property NameTypeRequiredDescription
utm_sourceStringYesThe UTM source parameter value included in the URL of the notifications for the campaign.
utm_mediumStringYesThe UTM medium parameter value included in the URL of the notifications for the campaign.
utm_campaignStringYesThe UTM campaign parameter value included in the URL of the notifications for the campaign.
utm_termStringNoThe UTM term parameter value included in the URL of the notifications for the campaign.
utm_contentStringNoThe UTM content parameter value included in the URL of the notifications for the campaign.

Action Object

Property NameTypeRequiredDescription
labelStringYesThe text to be shown to the user on action button.
urlStringYesThe URL that opens upon clicking the action button.
image_urlStringNoThe URL of an icon to display with the action button.

Example

Request

curl -X GET \
'https://api.pushengage.com/apiv1/drips/{drip_id}?analytics_start_at=2023-02-30&analytics_end_at=2023-03-30' \
-H 'api_key: <YOUR_API_KEY>'

Response

{
"success": true,
"data": {
"drip_id": 28909029,
"campaign_name": "Drip Autoresponder Cmpaign",
"audience": {
"filter": {
"value": [
[
{
"field": "country",
"op": "in",
"value": ["India", "Canada", "United States", "Australia"]
},
{ "field": "segment", "op": "in", "value": [746353, 98786] }
]
]
}
},
"status": "active",
"site_id": 3290873,
"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
}
]
},
"notifications": [
{
"id": 5397090,
"order": 0,
"title": "Notification Title",
"message": "Notification Message",
"url": "https://example.com/landing-page/",
"image_url": "https://example.com/img/notification-icon-image.jpg",
"big_image_url": "https://example.com/img/notification-large-image.jpg",
"expiry": 1040520,
"require_interaction": 1,
"actions": [
{
"label": "Action 1",
"url": "https://example.com/action-1-landing-page/",
"image_url": "https://example.com/img/action-1-icon-16x16.jpg"
},
{
"label": "Action 2",
"url": "https://example.com/action-2-landing-page/"
}
],
"schedule_options": {
"type": "after",
"value": 2,
"unit": "days",
"at": "16:30:00"
},
"analytics": {
"ctr": 10,
"views": 100,
"clicks": 10,
"sentcount": 150,
"unsubscribed": 10,
"result": [
{
"name": "revenue",
"count": 10,
"value": 200
}
]
}
}
]
}
}