メインコンテンツへスキップ
POST

Rate Limit

This API provides all version stats, and the call rate is limited to 100 API calls per minute per workspace.
  • Make sure to pass the relevant Campaign IDs in the request to fetch stats for flow-linked campaigns.
  • Stats data is retained for the entire lifetime of a campaign, from its start date, there is no fixed retention cutoff. The 30-day limit applies only to the date range of a single API call, not to how far back you can query.

承認

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

Request body to fetch campaign stats.

request_id
string
必須

This field shows the request ID created by a user. Helps to know the API calls made by the client.

start_date
string<date>
必須

This field shows the start date of the campaign in YYYY-MM-DD format. This date is interpreted in your MoEngage account's app timezone.

例:

"2024-12-22"

end_date
string<date>
必須

This field shows the campaign's end date in YYYY-MM-DD format. The days between the start and end dates should not exceed 30 days. This date is interpreted in your MoEngage account's app timezone.

例:

"2024-12-23"

attribution_type
enum<string>
必須

This field shows the attribution type that should be picked to show conversion stats.

利用可能なオプション:
VIEW_THROUGH,
CLICK_THROUGH,
IN_SESSION,
TOTAL_CONVERSIONS,
CLICK_CONVERSIONS
metric_type
enum<string>
必須

This field shows the total or unique values of all the metrics.

利用可能なオプション:
TOTAL,
UNIQUE
campaign_ids
string[]

This field shows the campaign IDs created, up to 10 max per call.

Maximum array length: 10
offset
integer
デフォルト:0

This field shows the position of a record in a dataset. The default value for the number of campaigns to skip is 0. For example, setting the offset to 50 skips the first 50 records. The resulting page number depends on your limit. With a limit of 10, an offset of 50 returns page 6.

limit
integer
デフォルト:10

This field shows the maximum number of campaigns displayed on a page. The default and max limit is up to 10 campaigns.

必須範囲: x <= 10

レスポンス

Successful response.

response_id
string

The response ID, which is the same as the request ID passed in the payload.

total_campaigns
integer

This field indicates the total number of campaigns that are requested in the payload.

current_page
integer

This field indicates the current page number.

total_pages
integer

This field indicates the total page. It is equal to the total campaigns, which is limited to 10 for each call and 10 to be displayed for each page.

data
object

This object contains the campaign stats. Keys are Campaign IDs.