Skip to main content
GET
/
v5
/
analytics
/
dashboards
List Dashboards
curl --request GET \
  --url https://api-{dc}.moengage.com/v5/analytics/dashboards \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'MOE-APPKEY: <moe-appkey>'
{
  "response_id": "b3f1c0d2-2a4e-4f9b-9c1a-6d2e8f0a1b23",
  "type": "dashboard",
  "data": [
    {
      "_id": "63ede292b4c6a68b18c2c93f",
      "name": "Acquisition Overview"
    },
    {
      "_id": "63ef1f824da10b4fd96c6e3b",
      "name": "Retention Deep Dive"
    }
  ]
}
Only workspace-level (public) dashboards are returned. Private dashboards and team-level dashboards are not available through this API.

Authorizations

​
Authorization
string
header
required

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 Data API Key, which you can find in the MoEngage dashboard at Settings > Account > APIs.

For more information, see Authentication.

Headers

​
MOE-APPKEY
string
required

Your MoEngage workspace ID (also known as the App ID), which identifies the workspace the request applies to. You can find it in the MoEngage dashboard at Settings > Account > APIs > Workspace ID (earlier app id).

Example:

"ABCD1234EFGH56789"

​
MOE-Team-ID
string

The team ID, required only when MoEngage Teams is enabled for your workspace. Scopes the request to the specified team.

Response

This response is returned when the request is processed successfully.

Each item contains the dashboard ID and name. Use the dashboard ID with Get Dashboard Charts to retrieve the charts on a dashboard.

​
response_id
string

A unique identifier for this response. Include it when reporting issues to MoEngage Support to help trace the request.

Example:

"b3f1c0d2-2a4e-4f9b-9c1a-6d2e8f0a1b23"

​
type
string

The type of resource returned in the data field.

Example:

"dashboard"

​
data
object[]

The list of dashboards accessible to the workspace.