List Dashboards

Returns the custom dashboards available to the authenticated workspace. Archived dashboards are excluded.

GET /v5/analytics/dashboards

List Dashboards

cURL

curl --request GET \
  --url https://api-{dc}.moengage.com/v5/analytics/dashboards \
  --header 'Authorization: Basic <encoded-value>'

200

{
  "response_id": "b3f1c0d2-2a4e-4f9b-9c1a-6d2e8f0a1b23",
  "type": "dashboard",
  "data": [
    {
      "_id": "63ede292b4c6a68b18c2c93f",
      "name": "Acquisition Overview"
    },
    {
      "_id": "63ef1f824da10b4fd96c6e3b",
      "name": "Retention Deep Dive"
    }
  ]
}

Rate Limit

The rate limits are at the workspace level and vary by data center. The following table lists the maximum number of requests allowed per workspace.

Data center	Per second	Per minute	Per hour	Per day
DC-01	5	30	100	400
DC-02	5	25	80	350
DC-03	5	30	100	400
DC-04	5	25	50	350
DC-05	5	20	40	200
DC-06	5	25	50	350
DC-101	5	30	100	400

Only workspace-level (public) dashboards are returned. Private 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). Find it in the MoEngage dashboard at Settings > Account > API keys.
• Password: Use an API key from Settings > Account > API keys.

Refer to API Key Dashboard for details on creating and managing API keys.

Response

200

application/json

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.

Show child attributes