MOmoengage
Get Campaign Details

Search Campaigns

This API fetches a list of Push, Email, or SMS campaigns with all current fields and status. You can pass multiple filters to find specific campaigns.

post/campaigns/search

Request

Headers

MOE-APPKEYstring required

This is the Workspace ID of your MoEngage account that must be passed with the request. You can find it in the MoEngage dashboard at Settings > Account > APIs > Workspace ID (earlier app id).

Request body

request_idstring required

A unique identifier for this search request.

include_child_campaignsboolean

Whether to include child campaigns (flow nodes and periodic children).

Set to true to fetch details of periodic child campaigns and flow campaign nodes. Flow campaigns can be identified by the presence of flow_id and flow_name in the response.

include_archive_campaignsboolean

Whether to include archived campaigns in the results.

limitinteger required

The number of campaigns to display per page.

Maximum: 15

pageinteger required

The page number to retrieve.

For example, if there are 200 campaigns and the limit is 10, there will be 20 pages.

Example request

{
  "request_id": "search_req_12345",
  "campaign_fields": {
    "channels": [
      "PUSH",
      "EMAIL"
    ],
    "created_by": [
      "john.doe@example.com"
    ],
    "created_date": {
      "from_date": "2024-01-01",
      "to_date": "2024-12-31"
    },
    "delivery_type": [
      "ONE_TIME",
      "PERIODIC"
    ],
    "id": "camp_abc123xyz",
    "name": "Summer Sale Campaign",
    "status": [
      "ACTIVE",
      "SCHEDULED"
    ],
    "tags": [
      "sale",
      "promotion"
    ]
  },
  "limit": 10,
  "page": 1
}

Response

Successfully retrieved campaign list

campaign_idstring

The unique ID of the campaign.

status'ACTIVE' | 'SCHEDULED' | 'PAUSED' | 'SENT' | 'STOPPED' | 'ARCHIVED'

The current status of the campaign.

channel'PUSH' | 'EMAIL' | 'SMS'

The communication channel.

campaign_delivery_type'ONE_TIME' | 'PERIODIC' | 'EVENT_TRIGGERED' | 'BUSINESS_EVENT_TRIGGERED' | 'DEVICE_TRIGGERED' | 'LOCATION_TRIGGERED' | 'BROADCAST_LIVE_ACTIVITY'

The delivery type of the campaign.

created_bystring email

The email ID of the user who created the campaign.

updated_bystring email

The email ID of the user who last updated the campaign.

created_atstring

The timestamp when the campaign was created, in UTC.

updated_atstring

The timestamp when the campaign was last updated, in UTC.

sent_timestring

The timestamp when the campaign was sent, in UTC.

flow_idstring

The flow ID (only for flow campaigns).

Only applicable when include_child_campaigns is true.

flow_namestring

The flow name (only for flow campaigns).

Only applicable when include_child_campaigns is true.

parent_idstring

The campaign ID of the parent campaign.

Only applicable for periodic child campaigns when include_child_campaigns is true.

basic_detailsobject

Basic details of the campaign.

Structure varies by channel (Push/Email/SMS).

campaign_contentobject

The campaign content including locales and variations.

trigger_conditionobject

Trigger condition details for event-triggered campaigns. Structure varies by channel (Push supports INTELLIGENT_DELAY, Email does not).

delivery_controlsobject

Delivery control settings for the campaign.

advancedobject

Advanced campaign settings (for Push campaigns).

sender_namestring

The sender name configured for the campaign.

Only applicable for SMS campaigns.

Example response

[
  {
    "campaign_id": "camp_abc123xyz",
    "created_at": "2024-07-04 08:00:54.847000",
    "sent_time": "2024-07-04 20:32:00",
    "scheduling_details": {
      "bts_details": {
        "window_end_time": "6:43 am"
      }
    },
    "conversion_goal_details": {
      "attribution_window_in_hours": 36,
      "goals": [
        {
          "goal_name": "Goal 1"
        }
      ]
    },
    "utm_params": {
      "utm_source": "google",
      "utm_medium": "email",
      "utm_campaign": "summer_sale"
    },
    "connector": {
      "connector_type": "SENDGRID",
      "connector_name": "default"
    }
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.