{"title":"Developer dashboard","category":"default","creationDate":1706535240,"content":"<p>The Developer dashboard shows a performance overview of your integration. We recommend that you use it for monitoring your integration's health, for example to detect increased failure rates, and to fix errors.<\/p>\n<h2>Requirements<\/h2>\n<p>Before you begin, take into account the following requirements, limitations, and preparations.<\/p>\n<table>\n<thead>\n<tr>\n<th style=\"text-align: left;\">Requirement<\/th>\n<th style=\"text-align: left;\">Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td style=\"text-align: left;\"><strong>Integration type<\/strong><\/td>\n<td style=\"text-align: left;\">Any integration with Adyen.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><strong><a href=\"\/account\/user-roles\">Customer Area roles<\/a><\/strong><\/td>\n<td style=\"text-align: left;\">Make sure that you have one of the following roles: <ul><li><strong>Merchant admin<\/strong><\/li> <li><strong>Merchant technical integrator<\/strong><\/li><\/ul><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><strong>Limitations<\/strong><\/td>\n<td style=\"text-align: left;\">The dashboard shows only <a href=\"#included\">specific APIs and webhooks<\/a>.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h2>Integration and account information<\/h2>\n<p>The Developer dashboard shows the activity and errors that occurred with your API requests and webhooks in the past seven days. You can select a different time range and time interval.<\/p>\n<p>The <strong>Integration activity<\/strong> panel shows a graph with the number of API requests from your server and webhooks that we sent to your server.<\/p>\n<p>The <strong>Errors<\/strong> panel shows a list of errors from your API requests and webhooks. You can select each error item to navigate to the logs with more details.<\/p>\n<p>The <strong>Integration types<\/strong> panel shows an overview of the different integration types that your account uses. Depending on what you use, the widget can show the following tabs:<\/p>\n<ul>\n<li><strong>APIs<\/strong>: The APIs that you integrated with.<\/li>\n<li><strong>Libraries<\/strong>: The <a href=\"https:\/\/github.com\/Adyen\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Adyen libraries<\/a> that you use in your integration.<\/li>\n<li><strong>Plugins<\/strong>: The <a href=\"\/plugins\">plugin<\/a> that you use for processing payments with Adyen.<\/li>\n<li><strong>Checkout SDKs<\/strong>: Our <a href=\"https:\/\/github.com\/Adyen#online-payments\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">client-side Drop-in and Components<\/a>.<\/li>\n<\/ul>\n<div class=\"accordion-shortcode adl-accordion adl-accordion--max-height-transition\" data-expand=\"true\" data-ignore=\"anchorjs-link\">\n    \n    <div class=\"adl-accordion__item\" style=\"\">\n        <div tabindex=\"0\" role=\"item\" aria-expanded=\"false\" class=\"adl-accordion__header\">\n            <i class=\"adl-accordion__toggle adl-icon-chevron-down\"><\/i>\n            <div class=\"adl-accordion__title-wrapper\" data-accordion=\"#integration-types\">\n                                    <h4 class=\"adl-accordion__title\">Integration types<\/h4>\n                            <\/div>\n        <\/div>\n        <div role=\"region\" class=\"adl-accordion__content\">\n            \n<p>The following list shows the types of payments integrations that can show up in the <strong>Integration types<\/strong> panel.<\/p>\n<p><strong>Online Payments<\/strong><\/p>\n<ul>\n<li><a href=\"\/payment-methods\/cards\/custom-card-integration\">Checkout API with Client-Side Encryption<\/a><\/li>\n<li><a href=\"\/payment-methods\/cards\/custom-card-integration\">Checkout API with JSON Web Encryption<\/a><\/li>\n<li><a href=\"\/payment-methods\/cards\/raw-card-data\">Checkout API with raw card data<\/a><\/li>\n<li><a href=\"\/online-payments\/build-your-integration\/sessions-flow\/\">Checkout API - Sessions flow<\/a><\/li>\n<li><a href=\"\/online-payments\/build-your-integration\/advanced-flow\/\">Checkout API - Advanced flow<\/a><\/li>\n<li><a href=\"\/payment-methods\/cards\/web-component\/\">Checkout API with Card Component<\/a><\/li>\n<li><a href=\"\/online-payments\/build-your-integration\/sessions-flow\/?platform=Web&amp;integration=Hosted%2BCheckout\">Hosted Checkout<\/a><\/li>\n<li><a href=\"\/online-payments\/classic-integrations\/classic-api-integration\/client-side-encryption\">Classic API with Client-Side Encryption (deprecated)<\/a><\/li>\n<li><a href=\"\/online-payments\/classic-integrations\/classic-api-integration\">Classic API with raw card data  (deprecated)<\/a><\/li>\n<li><a href=\"\/online-payments\/classic-integrations\/classic-api-integration\/\">Classic API  (deprecated)<\/a>: This is a catch-all for Classic API use cases that are not captured by the other listed items.<\/li>\n<\/ul>\n<p><strong>In person payments<\/strong><\/p>\n<ul>\n<li><a href=\"\/point-of-sale\/design-your-integration\/terminal-api\">Terminal API<\/a><\/li>\n<li><a href=\"\/point-of-sale\/ipp-mobile\">POS Mobile SDK<\/a><\/li>\n<li><a href=\"\/point-of-sale\/ipp-mobile\">Adyen Payments App<\/a><\/li>\n<li><a href=\"\/plugins\/oracle-xstore\">Oracle Payment Interface<\/a><\/li>\n<li><a href=\"\/point-of-sale\/classic-library-deprecation\">Classic Library (deprecated)<\/a><\/li>\n<li><a href=\"\/point-of-sale\">IPP<\/a>: This is a catch-all for in-person payments APIs that are not captured by the other listed items.<\/li>\n<\/ul>\n<p><strong>Omnichannel<\/strong><\/p>\n<ul>\n<li><a href=\"\/unified-commerce\/pay-by-link\">Pay by Link<\/a><\/li>\n<li><a href=\"\/point-of-sale\/mail-and-telephone-order-moto\">MOTO Call Center<\/a><\/li>\n<li><a href=\"\/unified-commerce\/mail-order-telephone-order\/customer-area\">Virtual Terminal<\/a><\/li>\n<\/ul>\n\n        <\/div>\n    <\/div>\n<\/div>\n\n<p>The Developer dashboard also includes panels with:<\/p>\n<ul>\n<li><strong>Live URL prefix<\/strong>: The <a href=\"\/development-resources\/live-endpoints#live-url-prefix\">URL prefix<\/a> for the live URL where you send your API requests. This is only available in your live Customer Area.<\/li>\n<li><strong>Account details<\/strong>: The information that you used to set up your Adyen account, such as account ID and legal entity name.<\/li>\n<li><strong>Company contacts<\/strong>: The names and email addresses of people in your organization. For example, the Customer Area account administrator.<\/li>\n<li><strong>Helpful resources<\/strong>: Links that can help you complete, maintain, and update your integration. For example, a link to Adyen's Postman collections.<\/li>\n<\/ul>\n<h2>Monitor your integration's performance<\/h2>\n<p>To access the developer dashboard, you must have one of the following <a href=\"\/account\/user-roles\">user roles<\/a>:<\/p>\n<ul>\n<li><strong>Merchant admin<\/strong><\/li>\n<li><strong>Merchant technical integrator<\/strong><\/li>\n<\/ul>\n<ol>\n<li>In your <a href=\"https:\/\/ca-test.adyen.com\/\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Customer Area<\/a>, go to <strong>Developers<\/strong> &gt; <strong>Dashboard<\/strong>.<\/li>\n<li>To track trends in the success of API requests and webhooks, in the <strong>Integration activity<\/strong> panel:\n<ul>\n<li>Select different time ranges and intervals.<\/li>\n<li>Switch between viewing the success rate of requests and webhooks, or a count of successful and failed requests and webhooks.<\/li>\n<\/ul><\/li>\n<li>\n<p>To drill down on errors, open the relevant page in the <a href=\"\/development-resources\/logs-resources\/api-logs\">API logs<\/a> or <a href=\"\/development-resources\/logs-resources\/webhook-event-logs\">webhook event logs<\/a> in any of the following ways:<\/p>\n<ul>\n<li>In the <strong>Integration activity<\/strong> panel, hold your cursor over a data point in the graph and select <strong>View logs<\/strong>.<\/li>\n<li>In the <strong>Errors<\/strong> panel, select <strong>View logs<\/strong> for the error that interests you.<\/li>\n<\/ul>\n<p>In the logs, you can then select a log item to inspect it further.<\/p>\n<\/li>\n<\/ol>\n<h2>See also<\/h2>\n<div class=\"see-also-links output-inline\" id=\"see-also\">\n<ul><li><a href=\"\/development-resources\/webhooks\"\n                        target=\"_self\"\n                        >\n                    Webhooks\n                <\/a><\/li><li><a href=\"\/development-resources\/logs-resources\/\"\n                        target=\"_self\"\n                        >\n                    Logs\n                <\/a><\/li><li><a href=\"\/account\"\n                        target=\"_self\"\n                        >\n                    Account\n                <\/a><\/li><\/ul><\/div>\n","url":"https:\/\/docs.adyen.com\/development-resources\/developer-dashboard","articleFields":{"description":"Keep an eye on the technical performance of your integration.","feedback_component":true,"filters_component":false,"decision_tree":"[]","page_id":"dde81073-cc20-4674-98c7-729b16a62c89"},"algolia":{"url":"https:\/\/docs.adyen.com\/development-resources\/developer-dashboard","title":"Developer dashboard","content":"The Developer dashboard shows a performance overview of your integration. We recommend that you use it for monitoring your integration's health, for example to detect increased failure rates, and to fix errors.\nRequirements\nBefore you begin, take into account the following requirements, limitations, and preparations.\n\n\n\nRequirement\nDescription\n\n\n\n\nIntegration type\nAny integration with Adyen.\n\n\nCustomer Area roles\nMake sure that you have one of the following roles: Merchant admin Merchant technical integrator\n\n\nLimitations\nThe dashboard shows only specific APIs and webhooks.\n\n\n\nIntegration and account information\nThe Developer dashboard shows the activity and errors that occurred with your API requests and webhooks in the past seven days. You can select a different time range and time interval.\nThe Integration activity panel shows a graph with the number of API requests from your server and webhooks that we sent to your server.\nThe Errors panel shows a list of errors from your API requests and webhooks. You can select each error item to navigate to the logs with more details.\nThe Integration types panel shows an overview of the different integration types that your account uses. Depending on what you use, the widget can show the following tabs:\n\nAPIs: The APIs that you integrated with.\nLibraries: The Adyen libraries that you use in your integration.\nPlugins: The plugin that you use for processing payments with Adyen.\nCheckout SDKs: Our client-side Drop-in and Components.\n\n\n    \n    \n        \n            \n            \n                                    Integration types\n                            \n        \n        \n            \nThe following list shows the types of payments integrations that can show up in the Integration types panel.\nOnline Payments\n\nCheckout API with Client-Side Encryption\nCheckout API with JSON Web Encryption\nCheckout API with raw card data\nCheckout API - Sessions flow\nCheckout API - Advanced flow\nCheckout API with Card Component\nHosted Checkout\nClassic API with Client-Side Encryption (deprecated)\nClassic API with raw card data  (deprecated)\nClassic API  (deprecated): This is a catch-all for Classic API use cases that are not captured by the other listed items.\n\nIn person payments\n\nTerminal API\nPOS Mobile SDK\nAdyen Payments App\nOracle Payment Interface\nClassic Library (deprecated)\nIPP: This is a catch-all for in-person payments APIs that are not captured by the other listed items.\n\nOmnichannel\n\nPay by Link\nMOTO Call Center\nVirtual Terminal\n\n\n        \n    \n\n\nThe Developer dashboard also includes panels with:\n\nLive URL prefix: The URL prefix for the live URL where you send your API requests. This is only available in your live Customer Area.\nAccount details: The information that you used to set up your Adyen account, such as account ID and legal entity name.\nCompany contacts: The names and email addresses of people in your organization. For example, the Customer Area account administrator.\nHelpful resources: Links that can help you complete, maintain, and update your integration. For example, a link to Adyen's Postman collections.\n\nMonitor your integration's performance\nTo access the developer dashboard, you must have one of the following user roles:\n\nMerchant admin\nMerchant technical integrator\n\n\nIn your Customer Area, go to Developers &gt; Dashboard.\nTo track trends in the success of API requests and webhooks, in the Integration activity panel:\n\nSelect different time ranges and intervals.\nSwitch between viewing the success rate of requests and webhooks, or a count of successful and failed requests and webhooks.\n\n\nTo drill down on errors, open the relevant page in the API logs or webhook event logs in any of the following ways:\n\nIn the Integration activity panel, hold your cursor over a data point in the graph and select View logs.\nIn the Errors panel, select View logs for the error that interests you.\n\nIn the logs, you can then select a log item to inspect it further.\n\n\nSee also\n\n\n                    Webhooks\n                \n                    Logs\n                \n                    Account\n                \n","type":"page","locale":"en","boost":18,"hierarchy":{"lvl0":"Home","lvl1":"Development resources","lvl2":"Developer dashboard"},"hierarchy_url":{"lvl0":"https:\/\/docs.adyen.com\/","lvl1":"https:\/\/docs.adyen.com\/development-resources","lvl2":"\/development-resources\/developer-dashboard"},"levels":3,"category":"Development Resources","category_color":"green","tags":["Developer","dashboard"]}}
