Skip to content

Monitoring Dashboard ​

Overview ​

The Dashboard is the home page of the Partner's Portal. It brings together, on a single screen, the health indicators of your integrations with ME and the list of recent failures, so you can spot and investigate problems without jumping between screens.

Partner's Portal Dashboard with the indicators, the charts and the failure list

With the Dashboard you can quickly answer:

  • How many calls and integrations your system ran in the period, and what the success rate was;
  • Whether things got better or worse compared with the previous period;
  • Which API calls failed, which integrations were rejected, and which webhook notifications never reached your endpoint;
  • Where to open the full detail of each failure (the Traffic and Events screens).

ℹ️ Note

The Dashboard is a monitoring and troubleshooting tool. Its numbers are calculated from platform logs and must not be used as a transactional or reconciliation source. For that, query the APIs themselves or keep a log in your own system.


Monitored origins ​

Everything shown on the Dashboard comes from three activity origins:

OriginShown asWhat it representsWhen it counts as a failure
API trafficTrafficEach call your system makes to ME's public APIs (for example, POST /v1/orders).When the API answers with an HTTP status outside the 2xx range (includes 4xx and 5xx).
Integration resultIntegration result / Int. ResultThe result of the asynchronous processing of an integration — the same content as the integration.result webhook event.When the result's statusCode indicates the document was not processed successfully.
Webhook deliveryWebhook / ExhaustedThe delivery of the integration.result notification to the endpoint you registered in the Partner's Portal.When every retry attempt runs out without success (Exhausted status). See the retry logic.

❗️ Attention

A Webhook failure does not mean the operation failed in ME. It means the notification did not reach, or was not accepted by, your endpoint. The outcome of the operation itself is shown under the Integration result origin.


Period and reload ​

The period filter (default: Last 24 hours) and the Reload button sit at the top of the page. The selected period applies to every block of the Dashboard: indicators, charts and failure list.

PeriodRange considered
Last 24 hoursThe last 24 rolling hours up to now.
Last 7 daysFrom the start of the day 7 days ago up to now.
Last 30 daysFrom the start of the day 30 days ago up to now.
Specific periodA date range you choose.

Data is not refreshed automatically. Use Reload to fetch the indicators and the list again for the current period.


Indicators (KPIs) ​

The first row of the Dashboard shows four indicators. Each one has an information icon (ⓘ) explaining the metric.

IndicatorWhat it measures
Total executionsTotal executions recorded in the period, adding API traffic and integration results.
Success rateSuccessful executions divided by total executions (API traffic + integrations) in the period, shown as a percentage with one decimal place.
Total failuresExecutions that failed in the period, split by origin: Traffic and Integration result.
ExhaustedWebhook notifications that ran out of all retry attempts without success in the period.

Comparison with the previous period ​

Total executions and Success rate show the change against the previous period (vs. previous period). The previous period is the window of the same length immediately before the selected period. For example, with Last 24 hours selected, the comparison is against the 24 hours before that.

  • Total executions: change as a percentage (%).
  • Success rate: change in percentage points (pp). A drop from 98.0% to 95.5% shows as -2.5pp.
  • When there is no data in the previous period, the change shows as —.

Charts ​

API Traffic — Status distribution ​

Shows how many calls to ME APIs ended in 2xx, 4xx and 5xx over the period. Use it to spot error peaks and correlate them with changes on your side (deploys, batch loads, expired credentials, etc.).

  • All: shows the three status ranges.
  • Errors only: hides the 2xx range to highlight 4xx and 5xx. This filter only changes the chart view; the indicators do not change.

The time-axis granularity is chosen automatically from the length of the period:

Period lengthGrouping
Up to 48 hoursHourly
Up to 60 daysDaily
Up to 365 daysWeekly
More than 365 daysMonthly

Integration results ​

Donut chart with the distribution of integration results in the period, in three slices: Delivered, Failed and Exhausted.

When there is no data in the period, the charts show the message No data for the selected period.


Failures — drill-down ​

Below the charts is the list of failures for the period. It shows only records whose outcome is Failed or Exhausted: successful calls and integrations do not appear here.

Origin filters ​

FilterWhat it lists
AllFailures from every origin.
TrafficAPI calls that returned a status outside 2xx.
Integration ResultIntegrations that were not processed successfully.
Exhausted onlyWebhook notifications that ran out of delivery attempts.

The origin filter only affects the list. The counter above the list shows the total number of results; when it has a + (for example, N+ results), the value is a lower bound and the actual total may be higher.

Columns ​

ColumnDescription
Delivery DateDate and time the activity happened.
OriginTraffic, Int. Result or Webhook.
Integration / KeyResource involved (for example, orders, contracts) and the activity's Correlation ID.
ErrorError message extracted from the API response or from the integration result.
Delivery Status / AttemptOutcome (Failed or Exhausted) and, for webhooks, the attempt number.
ActionDetails button, which opens the activity detail panel.

The list is paginated, with 25, 50 or 100 records per page.

Activity detail ​

Clicking Details opens a side panel showing:

FieldDescription
OutcomeFailed or Exhausted. For exhausted webhooks, it says how many attempts were made and that the event will not be resent automatically.
Status codeHTTP status returned by the API (traffic), by the processing (integration result) or by your endpoint (webhook).
AttemptDelivery attempt number (webhooks).
OriginActivity origin.
Correlation IDIdentifier linking the activity to the original request. Use it to find the call in Traffic and when opening support tickets.
Event IDWebhook event identifier (integration result and webhook).
Source document IDIdentifier of the log record the activity came from.
Error messageFull error message.

The panel also offers a shortcut to the matching monitoring screen:

  • Open in Traffic: for Traffic failures. Opens the Traffic screen, where you can see the full request and response (headers, body and response time).
  • Open in Events: for Integration result and Webhook. Opens the Events screen already filtered by the Event ID and the activity date, with the event payload and the delivery attempt history.

How to investigate a failure ​

  1. Select the period in which the problem happened and look at the Success rate and Total failures indicators and the traffic chart to understand when the failure started and which origin was affected.
  2. In the Failures — drill-down list, filter by origin and open the record's Details.
  3. Follow the path for that origin:
OriginLikely causeWhat to do
Traffic with 400/422Payload outside the API contract (missing required field, invalid type or length).Open it in Traffic, read the response body, fix the payload according to the API Reference and send it again.
Traffic with 401/403Invalid or expired credential, or no permission for the resource.Review the API Key and the token. See Credentials.
Traffic with 429Rate limit reached.Lower the call rate and respect the ratelimit-* headers. See Rate Limit.
Traffic with 5xxInstability on ME's side.Retry with backoff. If it persists, open a ticket with the Correlation ID.
Integration resultThe request was accepted, but the document was not processed (business rule, missing master data, etc.).Read the Error message, fix the data at the source and send the document again.
Exhausted WebhookYour endpoint did not answer 2xx within 10 seconds during all retries.Check the endpoint's availability and the credentials registered in the Partner's Portal. See Webhooks.

Best practices ​

  • Send your own identifier in the X-ME-CORRELATION-ID header (for example, the order number in your ERP). The Integration / Key column and the Traffic and Events screens will then show a reference your team recognizes.
  • Answer webhooks quickly with 2xx and run your business logic asynchronously, to avoid exhausted notifications.
  • Watch the comparison with the previous period after every change to your system: a drop in Success rate right after a deploy usually points to the cause.
  • Share the Correlation ID when opening support tickets with ME.

FAQ ​

Why do 4xx errors count as failures if the problem is in my payload? The Dashboard measures integration health from your system's point of view: a call that did not produce the expected result is a failure, whatever the cause. The status code and the error message help you tell errors on your side (4xx) from errors on ME's side (5xx).

Why don't I see successful calls in the list? The Failures — drill-down list is for failures only. To see every call, successful ones included, use the Traffic screen.

Does the chart's "Errors only" filter change the indicators? No. It only hides the 2xx range of the traffic chart.