Import One Charts Dashboard
Imports the Charts dashboard that the template specifies. Optionally, you can specify a dashboardId with override=true to import into an existing dashboard. To use this resource, the requesting Service Account or API Key must have the Project Data Access Read Only role.
Path parameters
-
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access.
NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
Format should match the following pattern:
^([a-f0-9]{24})$.
Query parameters
-
Flag that indicates whether Application wraps the response in an
envelopeJSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.Default value is
false. -
Setting this to true enables importing into an existing dashboard.
-
Id of the dashboard to override on import.
curl \
--request POST 'https://cloud.mongodb.com/api/atlas/v2/groups/32b6e34b3d91647abb20e7b8/chartsDashboards:import' \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "Content-Type: application/vnd.atlas.preview+json"{
"items": {
"item-1": {
"query": null,
"sample": false,
"calculatedFields": []
}
},
"queries": {},
"dashboards": {
"dashboard-1": {
"title": "Dashboard title",
"layout": [],
"filters": [],
"embedding": {
"anonymousAuthEnabled": true
},
"description": "Dashboard description"
}
},
"dataSources": {
"data-source-1": {
"alias": "Sample Data: Movies",
"database": "sample_data",
"collection": "movies",
"deployment": "sample-data-cluster",
"sourceType": "cluster"
}
},
"exportVersion": 9
}{
"dashboard": {
"embeddingId": "string",
"id": "string",
"title": "string"
},
"items": [
{
"embeddingId": "string",
"id": "string",
"title": "string"
}
]
}{
"error": 400,
"detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
"reason": "Bad Request",
"errorCode": "VALIDATION_ERROR"
}{
"error": 401,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Unauthorized",
"errorCode": "NOT_ORG_GROUP_CREATOR"
}{
"error": 403,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Forbidden",
"errorCode": "CANNOT_CHANGE_GROUP_NAME"
}{
"error": 404,
"detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
"reason": "Not Found",
"errorCode": "RESOURCE_NOT_FOUND"
}{
"error": 500,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Internal Server Error",
"errorCode": "UNEXPECTED_ERROR"
}