List All Triggered Campaign¶

Getting Started¶

Introduction¶

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

Request URL¶

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

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 Triggered 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	Array [Triggered Campaign]	An Array of Triggered 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.

Triggered Campaign¶

Property Name	Type	Description
trigger_id	Number	The unique identifier for the campaign.
campaign_name	String	The name of the campaign.
campaign_type	String	Valid values: `generic`, `browse`, `trigger`, `price_drop`, `inventory` Type of the Triggered campaign.
status	String	Valid values: `draft`, `active`, `pause`, `deleted` The status of the Triggered campaign.
site_id	Number	The unique identifier of the site associated with the campaign.
created_at_utc	String	The UTC timestamp when the campaign was created in ISO 8601 format.
updated_at_utc	String	The UTC timestamp when the campaign was last updated in ISO 8601 format.
daily_trigger_limit	Number	This specifies the maximum number of notifications that can be sent to a user in a day.
weekly_trigger_limit	Number	This specifies the maximum number of notifications that can be sent to a subscriber in a week, which includes the last seven days.
rules	Object	The object includes the settings for the start and stop event names of the Triggered campaign.
rules.start_event_name	String	This is the name of the event that triggers the start of the campaign when it is fired by a user.
rules.stop_event_name	String	This is the name of the event that triggers the stop of the campaign when it is fired by a user.
options	Object	`optional` An object that contains extra options for a triggered campaign.
options.result_name	String	`optional` A string that specifies the name of the goal that the campaign will track.
options.campaign	Object	`optional` An object that contains options related to the campaign settings.
options.campaign.expiry	String	`Default: 2592000 (30 days)` A number that specifies the time duration in seconds until the campaign expires. Applicable only when campaign type is `price_drop` or `inventory`
options.campaign.price_drop_threshold	Object	`optional` An object that contains options related to the price drop threshold. Required only when campaign type is set to `price_drop`.
options.campaign.price_drop_threshold.type	String	Valid values: `absolute`, `percentage` A string that specifies the type of threshold.
options.campaign.price_drop_threshold.value	Object	A number that specifies the value of the threshold.
analytics	Object	An object containing analytics information for the Triggered campaign.
analytics.views	Number	The number of views for the notifications in the campaign.
analytics.clicks	Number	The number of clicks on the notifications in the campaign.
analytics.sentcount	Number	The number of notifications sent in the campaign.
analytics.unsubscribed	Number	The number of unsubscribes for the campaign.
analytics.ctr	Number	The click-through rate for the campaign.
analytics.result	Array	An array of result/goal analytics object associated with the 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 Triggered 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.

Example¶

Request¶

cURLPHP

curl --location --request GET 'https://api.pushengage.com/apiv1/triggers?analytics_start_at=2023-02-30&analytics_end_at=2023-03-30&page=1&limit=10' \
--header 'API_key: <YOUR_API_KEY>'

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://api.pushengage.com/apiv1/triggers?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_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'API_key: <YOUR_API_KEY>'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Response¶

200 OK401 Unauthorized400 Bad Request500 Internal Server Error

{
  "success": true,
  "data": [
    {
      "trigger_id": 30987606,
      "campaign_name": "Triggered Campaign",
      "campaign_type": "generic",
      "utm_params": {
        "utm_source": "PushEngage",
        "utm_medium": "Push Notification",
        "utm_campaign": "Triggered Campaign",
        "utm_term": "UTM Term",
        "utm_content": "UTM Content"
      },
      "status": "active",
      "site_id": 3288973,
      "created_at_utc": "2023-02-27T06:53:27Z",
      "updated_at_utc": "2023-02-27T06:53:27Z",
      "daily_trigger_limit": 1,
      "weekly_trigger_limit": 7,
      "options": {
        "result_name": "revenue"
      },
      "analytics": {
        "ctr": 10,
        "views": 100,
        "clicks": 10,
        "sentcount": 150,
        "unsubscribed": 10,
        "result": [
          {
            "name": "revenue",
            "count": 10,
            "value": 300
          }
        ]
      },
      "rules": {
        "start_event_name": "start",
        "stop_event_name": "end"
      }
    }
  ],
  "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"
}