メインコンテンツへスキップ
POST
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.
Not available in V5This endpoint is not yet available in V5. Use this V1 endpoint at POST /core-services/v1/campaigns/{parent_campaign_id}/executions until V5 support is added.

Information Retrieved

  • Child campaign IDs
  • Sent time for each execution
  • Status of each child campaign
  • Total number of times the parent campaign has been executed
Note
  • Currently, you can use this API to get the child of Periodic and Business Event-triggered Email and Push campaigns.
  • You can only retrieve child campaigns for campaigns created via the Create Campaign API.
  • Results are paginated with a maximum of 15 children per page.

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

パスパラメータ

parent_campaign_id
string
必須

The unique ID of the parent campaign (Periodic or Business Event-triggered).

You can fetch the parent campaign ID using the Search Campaigns API.

ボディ

application/json

Provide pagination parameters for retrieving child campaign executions.

You can request to retrieve child campaign execution details.

request_id
string
必須

A unique identifier for this child campaigns retrieval request.

例:

"child_req_12345"

limit
integer
必須

The number of child campaigns to display per page.

Maximum: 15

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

15

page
integer
必須

The page number to retrieve.

For example, if there are 100 child campaigns and limit is 10, there will be 10 pages.

必須範囲: x >= 1
例:

1

レスポンス

Successfully retrieved child campaign execution details

Response containing child campaign execution details.

executions
object[]

Array of child campaign execution details.

total_instances
integer

The total number of times the parent campaign has been executed.

例:

8