Skip to main content
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>' \
  --header 'MOE-APPKEY: <moe-appkey>'
{
  "response_id": "b3f1c0d2-2a4e-4f9b-9c1a-6d2e8f0a1b23",
  "type": "dashboard",
  "data": {
    "name": "Acquisition Overview",
    "created_by": "[email protected]",
    "owned_by": "[email protected]",
    "chart_ids": [
      {
        "_id": "67f9d9df279348ecdc84415f",
        "name": "New Users by Day"
      },
      {
        "_id": "68f08c79d33bd238d3ef00e0",
        "name": "Sign-ups by Channel"
      }
    ]
  }
}
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

​
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.

Path Parameters

​
dashboard_id
string
required

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.

​
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

A dashboard's details and the charts laid out on it.