curl --location 'https://sdk-01.moengage.com/v1/experiences/metadata' \
--header 'Accept: */*' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic <base64(workspaceId:personalizeApiKey)>' \
--header 'MOE-APPKEY: <Your Workspace ID>'{
"metadata": {
"count": 3,
"experiences": [
{
"experience_name": "Homepage Banner — Free Shipping",
"experience_key": "homepage-banner",
"status": "Active"
},
{
"experience_name": "Cart Upsell Widget",
"experience_key": "cart-upsell",
"status": "Paused"
},
{
"experience_name": "Christmas Sale Strip",
"experience_key": "christmas-sale-strip",
"status": "Scheduled"
}
]
}
}Fetch Experience Metadata
This API fetches a list of currently Active, Scheduled, and Paused experiences within a workspace.
curl --location 'https://sdk-01.moengage.com/v1/experiences/metadata' \
--header 'Accept: */*' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic <base64(workspaceId:personalizeApiKey)>' \
--header 'MOE-APPKEY: <Your Workspace ID>'{
"metadata": {
"count": 3,
"experiences": [
{
"experience_name": "Homepage Banner — Free Shipping",
"experience_key": "homepage-banner",
"status": "Active"
},
{
"experience_name": "Cart Upsell Widget",
"experience_key": "cart-upsell",
"status": "Paused"
},
{
"experience_name": "Christmas Sale Strip",
"experience_key": "christmas-sale-strip",
"status": "Scheduled"
}
]
}
}Rate Limit
The default rate limit is 10,000 RPM (requests per minute), applicable at the workspace (App) level. This limit is shared by Fetch Experience, Fetch Experience Metadata, and Track Experience Events. Requests to all three endpoints count toward the same 10,000 RPM.?status=Active so your Fetch Experience calls only include keys that are currently live.Authorizations
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 Personalize tile.
Note: After you generate and save the Personalize API Key (SECRET KEY), DO NOT generate a new key unless there is a security breach. After you generate a different key and save it, API calls using the older key won't work.
For more information on authentication and getting your credentials, refer here.
Headers
Query Parameters
Filter experiences by status. Pass one or more comma-separated values. If omitted, all statuses are returned.
Accepted values: Active, Paused, Scheduled (case-sensitive). Unknown values (for example, active in lowercase) silently return an empty list rather than an error — verify spelling and casing.
| Status | Description |
|---|---|
Active | Experience is live and being served to matching users. |
Paused | Experience is not being served. Fetching its key via Fetch Experience returns an empty payload — not an error. |
Scheduled | Experience is configured but has not started yet. Fetching its key returns an empty payload. |
"Active,Paused"