curl --request POST \
--url https://api-{dc}.moengage.com/v5/campaigns/meta \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"request_id": "{{request_id}}",
"limit": 15,
"page": 1,
"campaign_fields": {
"id": "{{campaign_id}}",
"status": [
"SCHEDULED",
"ACTIVE",
"PAUSED",
"DRAFT"
]
}
}
'{
"response_id": "resp-meta-001",
"type": "campaign",
"data": {
"campaigns": [
{
"campaign_id": "64a1b2c3d4e5f6a7b8c9d0e1",
"channel": "PUSH",
"platform": [
"ANDROID",
"IOS"
],
"created_by": "[email protected]",
"campaign_delivery_type": "ONE_TIME",
"campaign_name": "Summer Sale Campaign",
"campaign_team": "Growth Team",
"campaign_tags": [
"promotional",
"seasonal"
],
"campaign_status": "SCHEDULED",
"campaign_start_time": "2024-11-28T12:18:00",
"reachability_details": {
"count": 18182,
"last_updated_time": "2024-11-27T09:05:42.661000"
}
}
]
}
}Get Campaign Meta (V5)
Returns lightweight metadata for one or more campaigns without loading their full configuration.
POST
/
v5
/
campaigns
/
meta
curl --request POST \
--url https://api-{dc}.moengage.com/v5/campaigns/meta \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"request_id": "{{request_id}}",
"limit": 15,
"page": 1,
"campaign_fields": {
"id": "{{campaign_id}}",
"status": [
"SCHEDULED",
"ACTIVE",
"PAUSED",
"DRAFT"
]
}
}
'{
"response_id": "resp-meta-001",
"type": "campaign",
"data": {
"campaigns": [
{
"campaign_id": "64a1b2c3d4e5f6a7b8c9d0e1",
"channel": "PUSH",
"platform": [
"ANDROID",
"IOS"
],
"created_by": "[email protected]",
"campaign_delivery_type": "ONE_TIME",
"campaign_name": "Summer Sale Campaign",
"campaign_team": "Growth Team",
"campaign_tags": [
"promotional",
"seasonal"
],
"campaign_status": "SCHEDULED",
"campaign_start_time": "2024-11-28T12:18:00",
"reachability_details": {
"count": 18182,
"last_updated_time": "2024-11-27T09:05:42.661000"
}
}
]
}
}Supported Channels
- Push
- SMS
- Google Ads
- Connectors
Reachability Information
- Available only for scheduled campaigns (one-time, business event-triggered, and event-triggered).
- Not available for
API_TRIGGEREDcampaigns. A shell has no audience to measure, soreachability_detailsisnull. - Provides estimated user count that will receive the campaign.
- Calculated once daily and cached for 24 hours. Multiple API calls within the same day return the cached value.
- May vary due to app installations/uninstalls or subscription changes.
Rate Limits
| Rate Limit Name | Rate Limit |
|---|---|
| get campaign meta per second | The total number of get campaign meta requests per second per client allowed is 10. |
| get campaign meta per minute | The total number of get campaign meta requests per minute per client allowed is 100. |
| get campaign meta per hour | The total number of get campaign meta requests per hour per client allowed is 6000. |
Notes
- Breaching the limits will reject the request.
- Per-hour and per-day limits use a rolling window of the last 1 hour and last 24 hours respectively.
承認
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). Find it in the MoEngage dashboard at Settings > Account > API keys.
- Password: Use an API key from Settings > Account > API keys.
Refer to API Key Dashboard for details on creating and managing API keys.
ヘッダー
ボディ
application/json
Provide the search criteria for retrieving campaign metadata and reachability information.
When true, returns child campaign metadata for periodic campaigns.
Activates the following response fields on each campaign object:
total_child_campaigns- number of child campaigns (present on the parent campaign).parent_campaign_id- the parent campaign's ID (present on each child campaign).
Defaults to false.
レスポンス
Campaign meta rows