Search Campaigns

curl --request POST \
  --url https://api-{dc}.moengage.com/core-services/v1/campaigns/search \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --header 'MOE-APPKEY: <moe-appkey>' \
  --data '
{
  "request_id": "search_req_12345",
  "campaign_fields": {
    "channels": [
      "EMAIL"
    ]
  },
  "limit": 15,
  "page": 1
}
'

[
  {
    "campaign_id": "camp_email_123",
    "status": "Active",
    "channel": "EMAIL",
    "campaign_delivery_type": "PERIODIC",
    "created_by": "[email protected]",
    "created_at": "2024-07-04 08:00:54.847000",
    "sent_time": "2024-07-04 20:32:00",
    "basic_details": {
      "name": "Weekly Newsletter",
      "content_type": "PROMOTIONAL",
      "subscription_category": "marketing",
      "tags": [
        "newsletter"
      ]
    },
    "connector": {
      "connector_type": "SENDGRID",
      "connector_name": "default"
    }
  }
]

POST

campaigns

curl --request POST \
  --url https://api-{dc}.moengage.com/core-services/v1/campaigns/search \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --header 'MOE-APPKEY: <moe-appkey>' \
  --data '
{
  "request_id": "search_req_12345",
  "campaign_fields": {
    "channels": [
      "EMAIL"
    ]
  },
  "limit": 15,
  "page": 1
}
'

[
  {
    "campaign_id": "camp_email_123",
    "status": "Active",
    "channel": "EMAIL",
    "campaign_delivery_type": "PERIODIC",
    "created_by": "[email protected]",
    "created_at": "2024-07-04 08:00:54.847000",
    "sent_time": "2024-07-04 20:32:00",
    "basic_details": {
      "name": "Weekly Newsletter",
      "content_type": "PROMOTIONAL",
      "subscription_category": "marketing",
      "tags": [
        "newsletter"
      ]
    },
    "connector": {
      "connector_type": "SENDGRID",
      "connector_name": "default"
    }
  }
]

This API is available on request and isn’t enabled by default. To enable it for your workspace, contact your Customer Success Manager or raise a support ticket.

Search Capabilities

Filter by channel, delivery type, status, tags, name, ID, created by, created date
Include child campaigns (flow nodes, periodic children)
Include archived campaigns
Paginated results (max 15 per page)

Differences in V5The V5 Search Campaigns API (POST /v5/campaigns/search) introduces the following behavioral changes:

Single-campaign retrieval is no longer handled by the search endpoint. Use GET /v5/campaigns/{campaign_id} instead.
The campaign_fields.id field (string) is renamed to campaign_fields.ids (array of strings) in V5.
The campaign_fields.delivery_type field is renamed to campaign_fields.campaign_delivery_type in V5. Sending the V1 field name returns zero results with no error.
The response identifier field campaign_id is renamed to id in V5.

For a full comparison, see V1 vs. V5 Search Campaigns: Behavioral Differences.

Rate Limits

Rate Limit Name	Rate Limit
Search campaign per second	The total number of search campaign requests per second per client allowed is 10.
Search campaign per minute	The total number of search campaign requests per minute per client allowed is 100.
Search campaign per hour	The total number of search campaign requests per hour per client allowed is 6000.

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 and pagination parameters for finding campaigns.

request_id

string

必須

A unique identifier for this search request.

例:

"search_req_12345"

limit

integer

必須

The number of campaigns to display per page.

Maximum: 15

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

例:

10

page

integer

必須

The page number to retrieve.

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

必須範囲: x >= 1

例:

1

campaign_fields

object

Filter criteria for searching campaigns.

Show child attributes

include_child_campaigns

boolean

デフォルト:false

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_campaigns

boolean

デフォルト:false

Whether to include archived campaigns in the results.

レスポンス

Successfully retrieved campaign list

campaign_id

string

The unique ID of the campaign.

例:

"camp_abc123xyz"

status

enum<string>

The current status of the campaign.

利用可能なオプション:

ACTIVE,

SCHEDULED,

PAUSED,

SENT,

STOPPED,

ARCHIVED

channel

enum<string>

The communication channel.

利用可能なオプション:

PUSH,

EMAIL,

SMS

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

created_by

string<email>

The email ID of the user who created the campaign.

updated_by

string<email>

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

created_at

string

The timestamp when the campaign was created, in UTC.

例:

"2024-07-04 08:00:54.847000"

updated_at

string

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

sent_time

string

The timestamp when the campaign was sent, in UTC.

例:

"2024-07-04 20:32:00"

flow_id

string

The flow ID (only for flow campaigns).

Only applicable when include_child_campaigns is true.

flow_name

string

The flow name (only for flow campaigns).

Only applicable when include_child_campaigns is true.

parent_id

string

The campaign ID of the parent campaign.

Only applicable for periodic child campaigns when include_child_campaigns is true.

basic_details

object

Basic details of the campaign.

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

campaign_content

object

The campaign content including locales and variations.

trigger_condition

object

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

segmentation_details

object

Defines the target audience for the campaign.

Show child attributes

scheduling_details

object

Defines when the campaign should be sent. All date-time values must be passed in UTC.

Show child attributes

delivery_controls

object

Delivery control settings for the campaign.

advanced

object

Advanced campaign settings (for Push campaigns).

conversion_goal_details

object

Configuration for tracking campaign conversion goals.

Show child attributes

control_group_details

object

Configuration for control groups.

Show child attributes

utm_params

object

UTM parameters for tracking campaign performance.

Show child attributes

connector

object

Connector configuration (for Email and SMS campaigns).

Show child attributes

sender_name

string

The sender name configured for the campaign.

Only applicable for SMS campaigns.

campaign_audience_limit

object

Configuration for limiting campaign audience.

Show child attributes

APIドキュメント

エンドポイント

Search Capabilities

Rate Limits

承認

ヘッダー

ボディ

レスポンス