# Get User Dashboard
source: https://developer.mastercard.com/priceless-planet-carbon-tracker/documentation/use-cases/get_dashboard/index.md

## Overview {#overview}

The `GET /issuers/users/{userid}/dashboards` endpoint retrieves a short-lived URL for the consumer's dashboard. The issuers should load this URL in their app so users can view their dashboard in their preferred language. For rendering customized images and brand experiences, contact the [support](mailto:carboncalculator@mastercard.com) team.

Currently, CCE supports the dashboard in five languages:

* US English
* Spanish (Latin America)
* Swedish
* Polish
* Malay

Note: A **short-lived URL** is an encrypted web URL that will expire after 15 minutes. To decrypt the URL, use the [Mastercard Encryption](https://developer.mastercard.com/platform/documentation/security-and-authentication/securing-sensitive-data-using-payload-encryption/#mastercard-encryption).

Inside the dashboard, consumers can view the following:

* Carbon footprints for payment transactions
* Carbon footprints against the Global Benchmark (country average and UN goal)
* Donations made to tree restoration projects

Note:   

* A **carbon footprint** is the total number of greenhouse gases generated by our actions.
* Greenhouse gases like carbon dioxide (CO~2~) are harmful to our planet. Many things go into your carbon footprint, including where you live, your daily habits, and your purchases.
* The Carbon Calculator Experience dashboard displays only the cleared transactions.
* The system takes the per-capita carbon footprint data from the [World in Data org site](https://ourworldindata.org/per-capita-co2) and the UN goal is half of the per-capita carbon emission in 2019.

### Sample Screenshots {#sample-screenshots}

The following screenshot shows a consumer's dashboard with a tutorial overlay which provides instructions to first time logged in Carbon Calculator Experience users.
![Tutorial Overlay](https://static.developer.mastercard.com/content/priceless-planet-carbon-tracker/uploads/tutorialfinal.png)

The following screenshot shows the consumer's dashboard based on the monthly spending.
![Get Dashboard](https://static.developer.mastercard.com/content/priceless-planet-carbon-tracker/uploads/Dashboard1.png)

The following screenshot shows the consumer's dashboard with carbon footprint against Global Benchmark (country average and UN goal)
![Average Monthly Tab](https://static.developer.mastercard.com/content/priceless-planet-carbon-tracker/uploads/Capture6.png)

The following screenshot shows the consumer's dashboard with carbon spending on each transaction based on their monthly spending.
![Transactions](https://static.developer.mastercard.com/content/priceless-planet-carbon-tracker/uploads/Capture5.png)

The following screenshot shows the consumer's dashboard and the way to donate to tree restoration projects.
![Donate](https://static.developer.mastercard.com/content/priceless-planet-carbon-tracker/uploads/donate.png)

The following screenshot shows the consumer's dashboard with Awareness feature educating consumers about the Carbon Calculator Experience API.
![Learn More](https://static.developer.mastercard.com/content/priceless-planet-carbon-tracker/uploads/learnMoreFinal.png)

## Pre-requisites {#pre-requisites}

To access this service, the issuer is required to fulfill these conditions:

* Read and understand the [Payload Encryption](https://developer.mastercard.com/platform/documentation/security-and-authentication/securing-sensitive-data-using-payload-encryption/) guide for secure data communication with the API.
* To know how to encrypt and decrypt the Carbon Calculator Experience API payloads, refer to the [Mastercard Encryption](https://developer.mastercard.com/platform/documentation/security-and-authentication/securing-sensitive-data-using-payload-encryption/#mastercard-encryption) topic .
* The consumer should enroll in the Carbon Calculator Experience platform.
* The issuer should store the `userid` for the requesting consumer.
* The issuer can pass a language code to render the dashboard in a specific language.

Tip: To create your project on Mastercard Developers, refer to the [Quick Start Guide](https://developer.mastercard.com/priceless-planet-carbon-tracker/documentation/quick-start-guide/index.md) for more information.

## Sequence Diagram {#sequence-diagram}

The following sequence diagram shows how an issuer can display a consumer dashboard.
Diagram get_dashboard

## Execution Steps {#execution-steps}

The following details the steps in the above sequence diagram:

1. The consumer opens the dashboard screen in the issuer application.
2. The issuer app sends the GET Dashboard request to the issuer server.
3. The issuer server sends the GET Dashboard request to the `GET /issuers/users/{userid}/dashboards` endpoint.
4. The Carbon Calculator Experience application validates the request.
5. The application checks if the user details exist.
6. The application returns an encrypted response to the issuer server, containing a web URL, the issuer's preferred language code, and the URL's expiry time.
7. The issuer server decrypts the response to retrieve the application URL.
8. The issuer server sends the decrypted URL back to the issuer app.
9. The issuer app loads the web URL in the issuer's preferred language in the WebView to display the consumer dashboard.   

## Error Messages {#error-messages}

You receive an error response for an invalid request or any missing request parameter.
Note: For more information about the error codes, refer to the [Code and Formats](https://developer.mastercard.com/priceless-planet-carbon-tracker/documentation/code-and-formats/index.md) section.

## Endpoint {#endpoint}


API Reference: `GET /issuers/users/{userid}/dashboards`

## Sample Request and Response {#sample-request-and-response}

For more details on the sample request and response, refer to the [How to Call the Get User Dashboard API](https://developer.mastercard.com/priceless-planet-carbon-tracker/tutorial/test-cases/step4/index.md) tutorial.