Get Campaign Details

Get Child Campaigns

This API retrieves child campaign execution details for Periodic or Business Event-triggered campaigns. Use this API to track execution history of recurring campaigns and monitor the performance of individual instances.

post/campaigns/{parent_campaign_id}/executions

Request

Path parameters

parent_campaign_idstring required

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

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

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 child campaigns retrieval request.

limitinteger required

The number of child campaigns to display per page.

Maximum: 15

pageinteger required

The page number to retrieve.

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

Example request

{
  "request_id": "child_req_12345",
  "limit": 15,
  "page": 1
}

Response

Successfully retrieved child campaign execution details

total_instancesinteger

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

Example response

{
  "executions": [
    {
      "campaign_id": "camp_child_001",
      "sent_time": "2024-06-24T14:30:18.908000"
    }
  ],
  "total_instances": 8
}

Changes

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