MOmoengage
Get Campaign Details

Get Campaign Meta (V1 — Legacy)

This API retrieves campaign details and reachability information for scheduled campaigns.

post/campaigns/meta

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 metadata retrieval request.

include_child_campaignsboolean

Whether to include child campaign information.

Set to true to fetch details of child campaigns (flow nodes and periodic children). Use flow_id, flow_name, or parent_campaign_id in the response to identify relationships.

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 limit is 10, there will be 20 pages.

Example request

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

Response

Successfully retrieved campaign metadata

campaign_idstring

The unique ID of the campaign.

channel'EMAIL' | 'PUSH' | 'SMS' | 'WHATSAPP' | 'FACEBOOK' | 'GOOGLE ADS' | 'CONNECTORS'

The communication channel.

platformstring[]

The platform types supported for the campaign (applicable for Push).

created_bystring email

The email ID of the user who created the campaign.

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

The delivery type of the campaign.

campaign_namestring

The name of the campaign.

campaign_teamstring

The team name associated with the campaign.

campaign_tagsstring[]

Tags associated with the campaign.

campaign_status'SCHEDULED' | 'ACTIVE' | 'PAUSED' | 'SENT' | 'STOPPED' | 'RETIRED' | 'ARCHIVED'

The current status of the campaign.

RETIRED is a terminal status applied automatically to campaigns that have reached their end condition. Retired campaigns cannot be reactivated and are distinct from STOPPED (manually halted) and ARCHIVED (explicitly archived).

campaign_start_timestring date-time

The start time of the campaign in ISO 8601 format. This value is returned in UTC.

parent_campaign_idstring

The campaign ID of the parent campaign.

Only shown if the requested campaign_id belongs to a child campaign and include_child_campaigns is true.

total_child_campaignsinteger

The number of child campaigns.

Only shown if the campaign_id belongs to a parent campaign. Only applicable for periodic campaigns.

Example response

[
  {
    "campaign_id": "camp_abc123xyz",
    "campaign_name": "Summer Sale Campaign",
    "campaign_start_time": "2024-11-28T12:18:00",
    "reachability_details": {
      "count": 18182,
      "last_updated_time": "2024-11-27T09:05:42.661000"
    }
  }
]

Changes

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