Get Dashboard Charts
curl --request GET \
--url https://api-{dc}.moengage.com/v5/analytics/dashboards/{dashboard_id}/charts \
--header 'Authorization: Basic <encoded-value>'{
"response_id": "b3f1c0d2-2a4e-4f9b-9c1a-6d2e8f0a1b23",
"type": "dashboard",
"data": {
"name": "Acquisition Overview",
"created_by": "john.doe@example.com",
"owned_by": "john.doe@example.com",
"chart_ids": [
{
"_id": "67f9d9df279348ecdc84415f",
"name": "New Users by Day"
},
{
"_id": "68f08c79d33bd238d3ef00e0",
"name": "Sign-ups by Channel"
}
]
}
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "Invalid dashboard_id.",
"doc_url": "https://www.moengage.com/docs/api/dashboards/get-chart-data"
},
"response_id": "b3f1c0d2-2a4e-4f9b-9c1a-6d2e8f0a1b23"
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Missing or invalid credentials.",
"doc_url": "https://www.moengage.com/docs/api/dashboards/get-chart-data"
},
"response_id": "b3f1c0d2-2a4e-4f9b-9c1a-6d2e8f0a1b23"
}{
"error": {
"code": "FORBIDDEN",
"message": "You do not have access to this dashboard.",
"doc_url": "https://www.moengage.com/docs/api/dashboards/get-chart-data"
},
"response_id": "b3f1c0d2-2a4e-4f9b-9c1a-6d2e8f0a1b23"
}{
"error": {
"code": "NOT_FOUND",
"message": "Dashboard not found.",
"doc_url": "https://www.moengage.com/docs/api/dashboards/get-chart-data"
},
"response_id": "b3f1c0d2-2a4e-4f9b-9c1a-6d2e8f0a1b23"
}{
"error_msg": {
"error": "rate_limit_exceeded",
"message": "Too many requests. Please try later."
}
}{
"error": {
"code": "INTERNAL_ERROR",
"message": "An unexpected error occurred while processing the request.",
"doc_url": "https://www.moengage.com/docs/api/dashboards/get-chart-data"
},
"response_id": "b3f1c0d2-2a4e-4f9b-9c1a-6d2e8f0a1b23"
}Get Dashboard Charts
Returns the details of a single dashboard, including its name, creator, and owner. It also returns the list of charts on the dashboard, in layout order. Each chart entry contains the chart’s ID and name.
GET
/
v5
/
analytics
/
dashboards
/
{dashboard_id}
/
charts
Get Dashboard Charts
curl --request GET \
--url https://api-{dc}.moengage.com/v5/analytics/dashboards/{dashboard_id}/charts \
--header 'Authorization: Basic <encoded-value>'{
"response_id": "b3f1c0d2-2a4e-4f9b-9c1a-6d2e8f0a1b23",
"type": "dashboard",
"data": {
"name": "Acquisition Overview",
"created_by": "john.doe@example.com",
"owned_by": "john.doe@example.com",
"chart_ids": [
{
"_id": "67f9d9df279348ecdc84415f",
"name": "New Users by Day"
},
{
"_id": "68f08c79d33bd238d3ef00e0",
"name": "Sign-ups by Channel"
}
]
}
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "Invalid dashboard_id.",
"doc_url": "https://www.moengage.com/docs/api/dashboards/get-chart-data"
},
"response_id": "b3f1c0d2-2a4e-4f9b-9c1a-6d2e8f0a1b23"
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Missing or invalid credentials.",
"doc_url": "https://www.moengage.com/docs/api/dashboards/get-chart-data"
},
"response_id": "b3f1c0d2-2a4e-4f9b-9c1a-6d2e8f0a1b23"
}{
"error": {
"code": "FORBIDDEN",
"message": "You do not have access to this dashboard.",
"doc_url": "https://www.moengage.com/docs/api/dashboards/get-chart-data"
},
"response_id": "b3f1c0d2-2a4e-4f9b-9c1a-6d2e8f0a1b23"
}{
"error": {
"code": "NOT_FOUND",
"message": "Dashboard not found.",
"doc_url": "https://www.moengage.com/docs/api/dashboards/get-chart-data"
},
"response_id": "b3f1c0d2-2a4e-4f9b-9c1a-6d2e8f0a1b23"
}{
"error_msg": {
"error": "rate_limit_exceeded",
"message": "Too many requests. Please try later."
}
}{
"error": {
"code": "INTERNAL_ERROR",
"message": "An unexpected error occurred while processing the request.",
"doc_url": "https://www.moengage.com/docs/api/dashboards/get-chart-data"
},
"response_id": "b3f1c0d2-2a4e-4f9b-9c1a-6d2e8f0a1b23"
}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 | 10 | 50 | 300 | 500 |
| DC-02 | 10 | 30 | 150 | 400 |
| DC-03 | 10 | 50 | 300 | 500 |
| DC-04 | 10 | 30 | 200 | 350 |
| DC-05 | 5 | 30 | 100 | 250 |
| DC-06 | 5 | 30 | 150 | 300 |
| DC-101 | 10 | 50 | 300 | 500 |
Chart data is not returned here. To fetch the data for a chart, use Get Chart Data with the dashboard ID and chart ID.
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). 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.
Path Parameters
The unique identifier of the dashboard. You can retrieve dashboard IDs from the List Dashboards response.
Example:
"6a10ae88f3a1896d59d5bf8f"
Response
This response is returned when the request is processed successfully.
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"
The type of resource returned in the data field.
Example:
"dashboard"
A dashboard's details and the charts laid out on it.
Show child attributes
Show child attributes