Generate Coupon List Usage Report

This API produces a detailed usage report for a specific coupon list, providing details on which user received which coupon from which locale or variation of which campaign at what time. After it is generated, this report is delivered directly to the requested email addresses. Using this API, a comprehensive analysis of critical data and coupon usage trends can be conducted efficiently.

API Endpoint

POST https://api-0X.moengage.com/v1/coupon-list/{{coupon_list_id}}/usage-report

Each customer is hosted on a different data center; you can find your data center number (value of X) by checking the data center and API endpoint mapping page.

Authentication

The API request will be authenticated through Basic Authentication. Basic Authentication sends a Base64-encoded string containing your username and password with every API request. It encodes a 'username: password' string in Base64 and appends the encoded string with 'Basic '. This string is included in the authorization header as shown below:

{"Authorization": "Basic Base64_ENCODED_APPKEY_APIKEY"}

You can obtain the username and password details from the MoEngage Dashboard.

Navigate to Settings > Account > APIs.
Copy the following details:
- Username: Under Workspace ID (earlier App ID), click the copy icon to copy the username.
- Password: In the API keys section, click the copy icon in the Campaign report/Business events/Custom templates/Catalog API tile to copy the API key.
Use these details to authenticate the API requests.

Request Headers

Key

Required

Sample Values

Description

Content-Type

Required

{"Content-Type": "application/json"}

Set the Content-Type header to application/json.

Authorization

Required

{"Authorization": "Basic Base64_ENCODED_APPKEY_APIKEY"}

This authentication parameter, used for access control, must be passed in the request. To generate the authentication header, refer to Authentication.

MOE-APPKEY

Required

{“MOE-APPKEY”: “Workspace ID”}

This is the workspace ID (earlier APP ID) of your MoEngage workspace. The MOE-APPKEY has to be passed in the request. You can find your MoEngage Workspace ID in the MoEngage Dashboard:

Settings -> Account -> APIs -> Workspace ID (earlier app id)

For more information, refer to Authentication.

Request Body

Key	Required	Values	Description
start_date	Required	string	This field consists of the start date of the coupon list usage report.
end_date	Required	string	This field consists of the end date of the coupon list usage report.
email_subscribers	Required	array	This field consists of the email address of the coupon list subscribers.

Response

Status

Key

Data Type

Description

Success

message

String

The following is the success message:

The usage report for the string coupons is being processed and will be sent to email alert subscribers shortly.

Failure

error

code

String

Each error codes are unique and serve as a shorthand representation for the type of error, providing a quick reference that can be used to diagnose, troubleshoot, and address the problem based on a predefined set of error conditions.

message

String

Along with the error code, a detailed message is also provided in the response, describing the specifics of the request failure and the nature of the error.

Refer to the Sample Response section for examples.

Response Codes

Status Code	Request State	Description
200	Success	Indicates that the request is successful and the coupon list usage report request is accepted.
400	Bad request	Possible issues include duplicates, such as coupon list names, invalid data types, or missing mandatory attributes. For more information, refer to Error Messages.
401	Unauthenticated	Your request is unauthorized.
403	Forbidden	Your account does not have access to the Coupon Management features.
500	Internal server error	This response is returned when the system runs into an unexpected error.

Error Messages

Status Code	Error code	Description
400	invalid-request	The requested JSON is incorrect. Verify and try again.
401	request-unauthenticated	Your request is unauthorized. Verify your credentials and try again.
403	request-forbidden	Your account does not have access to the Coupon Management features. Contact the MoEngage team for further assistance.
500	unexpected-error	Something went wrong with your request. Contact the MoEngage team for further assistance.

Sample cURL Request

curl --location 'https://api-0X.moengage.com/v1/coupon-list/{{coupon_list_id}}/usage-report' \
--header 'MOE-APPKEY: {{Workspace_ID or APP_ID}}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic {{Authorization_Key}}' \
--data-raw '{
  "start_date": "2024-11-21",
  "end_date": "2024-11-21",
  "email_subscribers": ["john.doe@example.com"]
}'

Sample Response

{
  "message": "The usage report for the {{coupon list name}} coupons is being processed and will be sent to email alert subscribers shortly."
}

{
  "error": {
    "code": "invalid-request",
    "message": "The start date cannot be earlier than the coupon list creation date. Please verify your dates and try again."
  }
}

{
  "error": {
    "code": "invalid-request",
    "message": "The end date cannot be set in the future. Please verify the dates and try again."
  }
}

{
  "error": {
    "code": "request-unauthenticated",
    "message": "Your request is unauthorized. Please verify your credentials and try again."
  }
}

{
  "error": {
    "code": "request-forbidden",
    "message": "Your account does not have access to the Coupon Management features. Please contact the MoEngage team for further assistance."
  }
}

{
  "error": {
    "code": "unexpected-error",
    "message": "Something went wrong with your request. Please contact the MoEngage team for further assistance."
  }
}

Postman Collections

We have made it easy for you to test the APIs. Click here to view it in Postman.