Skip to main content
POST
V1 endpointThis page documents the V1 Get Campaign Meta endpoint. The V5 equivalent is available at Get Campaign Meta (V5). Both V1 and V5 use Basic Auth with a MOE-APPKEY header.

​
Supported Channels

  • EMAIL: Email campaigns
  • PUSH: Push notification campaigns
  • SMS: SMS campaigns
  • WHATSAPP: WhatsApp campaigns
  • FACEBOOK: Facebook campaigns
  • GOOGLE ADS: Google Ads campaigns
  • CONNECTORS: Connector-based campaigns

​
Reachability Information

  • Available only for scheduled campaigns (one-time, business event-triggered, and event-triggered).
  • Provides estimated user count that will receive the campaign.
  • Calculated once daily and cached for 24 hours.
  • May vary due to app installations/uninstalls or subscription changes.
  • Reachability is an estimated value and may vary over time. It is calculated once per day and cached for 24 hours. Multiple API calls within the same day will return the cached value.

​
Rate Limits

Notes
  • Breaching the limits will reject the request.
  • Per hour and per day limits will consider the calculation based on the last hour and last 24 hrs respectively.

承認

​
Authorization
string
header
必須

Authentication is done via Basic Auth. This requires a base64-encoded string of your credentials in the format 'username:password'.

  • Username: Use your MoEngage workspace ID (also known as the App ID). You can find it in the MoEngage dashboard at Settings > Account > APIs > Workspace ID (earlier app id).
  • Password: Use your API Key, which you can find within the Campaign report/Business events/Custom templates/Catalog API/Inform Report tile.

For more information on authentication and getting your credentials, refer here.

ヘッダー

​
MOE-APPKEY
string
必須

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).

ボディ

application/json

Provide the search criteria for retrieving campaign metadata and reachability information.

​
request_id
string
必須

A unique identifier for this metadata retrieval request.

例:

"meta_req_12345"

​
limit
integer
必須

The number of campaigns to display per page.

Maximum: 15

必須範囲: 1 <= x <= 15
例:

15

​
page
integer
必須

The page number to retrieve.

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

必須範囲: x >= 1
例:

1

​
campaign_fields
object

Filter criteria for retrieving campaign metadata.

​
include_child_campaigns
boolean
デフォルト:false

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.

レスポンス

Successfully retrieved campaign metadata

​
campaign_id
string

The unique ID of the campaign.

例:

"camp_abc123xyz"

​
channel
enum<string>

The communication channel.

利用可能なオプション:
EMAIL,
PUSH,
SMS,
WHATSAPP,
FACEBOOK,
GOOGLE ADS,
CONNECTORS
​
platform
enum<string>[]

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

利用可能なオプション:
ANDROID,
IOS,
WEB
​
created_by
string<email>

The email ID of the user who created the campaign.

​
campaign_delivery_type
enum<string>

The delivery type of the campaign.

利用可能なオプション:
ONE_TIME,
PERIODIC,
EVENT_TRIGGERED,
BUSINESS_EVENT_TRIGGERED,
DEVICE_TRIGGERED,
LOCATION_TRIGGERED,
BROADCAST_LIVE_ACTIVITY
​
campaign_name
string

The name of the campaign.

例:

"Summer Sale Campaign"

​
campaign_team
string

The team name associated with the campaign.

​
campaign_tags
string[]

Tags associated with the campaign.

​
campaign_status
enum<string>

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).

利用可能なオプション:
SCHEDULED,
ACTIVE,
PAUSED,
SENT,
STOPPED,
RETIRED,
ARCHIVED
​
campaign_start_time
string<date-time>

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

例:

"2024-11-28T12:18:00"

​
parent_campaign_id
string

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_campaigns
integer

The number of child campaigns.

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

​
reachability_details
object

Reachability information for the campaign.

Important: Only populated for scheduled campaigns (one-time, business event-triggered, and event-triggered). Reachability is calculated once daily and cached for 24 hours.